Invite workspace team member

POST/v1/api/team/members

Invite a workspace team member through OAuth team-management access.

Scope
team:write
Token
OAuth access token only
Role
Owner or admin
MCP tool
invite_team_member · preview: MCP write tools are in preview
What scopes, tokens and roles mean →
Request
curl -X POST "https://api.crawle.io/v1/api/team/members" \
  -H "Authorization: Bearer $CRAWLE_ACCESS_TOKEN" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "X-Crawle-Confirmation: $CONFIRMATION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"email":"[email protected]","role":"example"}'
const response = await fetch("https://api.crawle.io/v1/api/team/members", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.CRAWLE_ACCESS_TOKEN}`,
    "Idempotency-Key": crypto.randomUUID(),
    "X-Crawle-Confirmation": confirmationToken, // from the preview response
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "email": "[email protected]",
    "role": "example"
  }),
});
const data = await response.json();
import os
import uuid

import requests

response = requests.request(
    "POST",
    "https://api.crawle.io/v1/api/team/members",
    headers={
        "Authorization": f"Bearer {os.environ['CRAWLE_ACCESS_TOKEN']}",
        "Idempotency-Key": str(uuid.uuid4()),
        "X-Crawle-Confirmation": confirmation_token,  # from the preview response
    },
    json={
      "email": "[email protected]",
      "role": "example"
    },
)
data = response.json()
$CRAWLE_ACCESS_TOKEN
is an OAuth access token from your integration's sign-in.
$CONFIRMATION_TOKEN
is the confirmation_token the preview step returned.
Idempotency-Key
is a new unique value for each new request.

Response 201: a JSON object. Its fields are not described in the API contract yet, so no example is shown.

Parameters

X-Crawle-Confirmationheader · stringrequired
One-use confirmation_token returned by the matching preview route.1–256 characters
Idempotency-Keyheader · stringrequired
1–180 characters

Request body

emailstring (email)required
rolestringrequired
admin, editor, or viewer

Response 201

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. detail lists each problem.
  • 429

    When
    Rate limited. Wait for Retry-After seconds.

All errors and what to do →

Generated from the API contract at 7e7039b0b, synced October 30, 2026.