API reference · Invitations
Cancel a pending invitation
/v1/orgs/{org_id}/invitations/{invitation_id}Withdraws a pending invitation so it can no longer be accepted. An invitation that is no longer pending is returned unchanged.
Console session only: no API key can be granted the member:invite permission it needs. Requires the member:invite permission (a key's scope, or a role that includes it).
Request
Path parameters
org_idstringYour organization. The SDKs and the CLI fill it in from the API key.
ID with prefix org_
invitation_idstringrequiredID of the invitation
ID with prefix inv_
Response
200 Invitation — The canceled invitation
objectstringrequiredAlways `invitation`: the type of this object
One of
invitationidstringrequiredUnique ID (`inv_…`)
ID with prefix inv_
org_idstringrequiredOrganization it belongs to
ID with prefix org_
emailstringrequiredEmail address the invitation was sent to
rolestring | nullrequiredRole the invitee gets on accepting; null when none was recorded
One of
owneradmindeveloperbillingviewerstatusstringrequired`pending` (can still be accepted until `expires_at`), `accepted`, `rejected` or `canceled`
expires_atstring (date-time)requiredWhen it expires (null: never) (ISO 8601, UTC)
inviter_user_idstringrequiredID of the inviter user
inviterobject | nullrequiredWho sent the invitation
ShowHide 3 fields of
inviterobjectstringrequiredAlways `person`
One of
personidstringrequiredThe person’s user ID (`usr_…`)
namestring | nullrequiredTheir name as they set it; null when they are no longer a member of the organization
created_atstring (date-time)requiredWhen it was created (ISO 8601, UTC)
Example response
{
"object": "invitation",
"id": "inv_01jc5zq4m8k3v6x9t2w7r0b1e4",
"org_id": "org_01jc5zq4m8k3v6x9t2w7r0b1e4",
"email": "string",
"role": "owner",
"status": "pending",
"expires_at": "2026-01-01T00:00:00.000Z",
"inviter_user_id": "string",
"inviter": {
"object": "person",
"id": "string",
"name": "string"
},
"created_at": "2026-01-01T00:00:00.000Z"
}Errors
Errors use the standard envelope. What this operation can answer:
| Status | Type | When |
|---|---|---|
400 | invalid_request_error | A parameter or body field is missing or not allowed; param names it. |
401 | authentication_error | The key or session is missing, revoked or expired. |
403 | permission_error | The credential lacks the permission this needs, or the organization is suspended. |
404 | not_found_error | No such resource in this project (an ID from another project is answered the same way). |
409 | conflict_error | The resource's current state does not allow this. |
429 | rate_limit_error rate_limited | Too many requests; retry after retry-after seconds. |