Invite a workspace member
Creates a one-time invitation. Only the workspace owner can delegate administration (role administrator). The invitation secret is shown once and stored only as a hash.
POST
/v1/workspace/invitationsAuthorization
AuthorizationBearer token (Clerk owner session) · headerrequiredOwner identity required.
Request body
requiredapplication/jsonnamestringrequiredmin length 1 · max length 64
rolestringdefault: "operator"
Allowed:
operatoradministratorttlSecondsintegermin 60 · max 3600 · default: 600
Responses
201
Successful response
dataWorkspaceInvitationrequiredShow propertiesHide properties
invitationstringrequiredOne-time invitation secret; shown once, stored only as a hash, expires at expiresAt.
expiresAtintegerrequired400
Invalid request or validation failure
errorobjectrequiredShow propertiesHide properties
codestringrequiredmessagestringissuesobject[]Show propertiesHide properties
Array of
objectpathstringmessagestring401
Missing or invalid credential
errorobjectrequiredShow propertiesHide properties
codestringrequiredmessagestringissuesobject[]Show propertiesHide properties
Array of
objectpathstringmessagestring403
Insufficient access or grant
errorobjectrequiredShow propertiesHide properties
codestringrequiredmessagestringissuesobject[]Show propertiesHide properties
Array of
objectpathstringmessagestring404
Resource not found
errorobjectrequiredShow propertiesHide properties
codestringrequiredmessagestringissuesobject[]Show propertiesHide properties
Array of
objectpathstringmessagestring413
Request body exceeds the 16 KiB limit
errorobjectrequiredShow propertiesHide properties
codestringrequiredmessagestringissuesobject[]Show propertiesHide properties
Array of
objectpathstringmessagestring429
Rate limit or workspace capacity limit
errorobjectrequiredShow propertiesHide properties
codestringrequiredmessagestringissuesobject[]Show propertiesHide properties
Array of
objectpathstringmessagestring500
Internal error
errorobjectrequiredShow propertiesHide properties
codestringrequiredmessagestringissuesobject[]Show propertiesHide properties
Array of
objectpathstringmessagestring503
Service or required integration is not configured
errorobjectrequiredShow propertiesHide properties
codestringrequiredmessagestringissuesobject[]Show propertiesHide properties
Array of
objectpathstringmessagestring