DELETE/api/organizations/{organization_id}/invitations/{invitation_id}Authenticated

Revoke an invitation

Revokes a pending invitation so it can no longer be accepted. Organization owners and platform administrators only; invitations that are no longer pending cannot be revoked.

operationId delete_api_organizations_organization_id_invitations_invitation_idOrganizations

Authentication & permissionsAuthenticated

Any authenticated user

Accepted credentials
Who may call
Any authenticated user
Notes
Only organization owners or platform administrators may revoke invitations.

Path parameters

NameTypeDescription
organization_id*string

Organization id (URL-safe slug)

invitation_id*string (uuid)

Id of the invitation

Responses

application/json
PropertyTypeDescription
success*true
message*string
data*object
invitationOrganizationInvitation

An invitation for a user to join an organization.

invitation_id*string (uuid)
organization_id*string

minLength: 4maxLength: 32pattern: ^[a-z][a-z0-9_-]+$

organization_namestring
inviter_uid*string (uuid)
inviter_emailstring (email)
invitee_uid*string (uuid)
invitee_emailstring (email)
status*"pending" | "accepted" | "declined" | "revoked" | "expired"
created_at*number

exclusiveMinimum: 0

expires_at*number

exclusiveMinimum: 0

responded_atnumber | null | null

exclusiveMinimum: 0

JSONExample
"success"true
"message""string"
"data"
"invitation"
"invitation_id""123e4567-e89b-12d3-a456-426614174000"
"organization_id""string"
"organization_name""string"
"inviter_uid""123e4567-e89b-12d3-a456-426614174000"
"inviter_email""user@example.com"
"invitee_uid""123e4567-e89b-12d3-a456-426614174000"
"invitee_email""user@example.com"
"status""pending"
"created_at"1.5
"expires_at"1.5
"responded_at"1.5

Example request

bashcurl
curl -X DELETE 'https://auth.schemavaults.com/api/organizations/<organization_id>/invitations/<invitation_id>' \
  -b 'refresh_token_<auth_server_app_id>=<value>'

Other methods on this path