Preview workspace team invite
POST
/v1/api/team/invite-previewPreview a workspace team invite before sending email.
- Scope
team:write- Token
- OAuth access token only
- Role
- Owner or admin
- MCP tool
preview_team_invite· preview: MCP write tools are in preview- What scopes, tokens and roles mean →
Request
cURL
curl -X POST "https://api.crawle.io/v1/api/team/invite-preview" \
-H "Authorization: Bearer $CRAWLE_ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{"email":"[email protected]","role":"example"}'JavaScript
const response = await fetch("https://api.crawle.io/v1/api/team/invite-preview", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CRAWLE_ACCESS_TOKEN}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"email": "[email protected]",
"role": "example"
}),
});
const data = await response.json();Python
import os
import requests
response = requests.request(
"POST",
"https://api.crawle.io/v1/api/team/invite-preview",
headers={
"Authorization": f"Bearer {os.environ['CRAWLE_ACCESS_TOKEN']}",
},
json={
"email": "[email protected]",
"role": "example"
},
)
data = response.json()$CRAWLE_ACCESS_TOKEN- is an OAuth access token from your integration's sign-in.
Response 200: a JSON object. Its fields are not described in the API contract yet, so no example is shown.
Request body
emailstring (email)requiredrolestringrequired- admin, editor, or viewer
Response 200
Returns a JSON object. Its fields are not described in the API contract yet.
Errors
401
- When
- Missing, invalid, or expired token.
403
- When
- The token has none of the accepted scopes (
team:write).
403
- When
- Called with an API key. This endpoint needs an OAuth access token.
403
- When
- The person is not a workspace owner or admin.
422
- When
- The request did not match the schema.
detaillists each problem.
429
- When
- Rate limited. Wait for
Retry-Afterseconds.
Generated from the API contract at 7e7039b0b, synced October 30, 2026.