Documentation menu
Organization Invitations

Accept an invitation

POST /api/v1/invitations/{invitationId}/accept

Join the Organization and Projects named by an invitation sent to your verified email. Supply the invitation token, not an inviter API key. Acceptance does not switch your current Organization or change existing API key scopes.

Parameters

path

NameTypeRequiredDescription
invitationIdstringrequiredIdentifies the organization invitation being addressed. Applies to Accept an invitation.

Request body

Required — Request body for: Accept an invitation.

application/json

NameTypeRequiredDescription
tokenstringrequired

Responses

StatusDescriptionBody
200Response for status 200application/json — object — data: object (required)
400The request is malformed or cannot be processed.application/json — PublicApiError — error: object (required)
401Authentication failed. The Authorization header is missing, or the credential is invalid or expired.application/json — PublicApiError — error: object (required)
403Access denied. The authenticated user does not have permission to perform this action.application/json — PublicApiError — error: object (required)
404Resource not found.application/json — PublicApiError — error: object (required)
409Request conflicts with current state of the resource, including safe deployment conflict classifications.application/json — PublicApiError — error: object (required)
422Request validation failed. Check the request body, query parameters, or path parameters.application/json — PublicApiError — error: object (required)
429Too many requests.application/json — PublicApiError — error: object (required)
500The server could not complete the request.application/json — PublicApiError — error: object (required)
503Service temporarily unavailable (e.g. execution capacity exhausted). The response carries a Retry-After header; retry with backoff.application/json — PublicApiError — error: object (required)