Skip to main content

organization_invitations.revoke

Withdraw an invitation

Request
DELETE/api/v1/organizations/{organizationSlug}/invitations/{invitationId}
Scope required
organization_members:write
Effect
Deletes something. Confirm with a person before calling it.
Acts on
Acts on an organization, and names it in the path.
MCP tool
organization_invitations_revoke
Environment
Live and sandbox alike.
Request body
JSON.

What it does

Withdraws an invitation nobody has answered yet, which stops its accept link working immediately and frees the applicant seat it was holding. Owners and admins may revoke any invitation; a coach may revoke only the ones they sent. The row stays in `organization_invitations.list` with a `revoked` status, because the organization is entitled to the record that the invitation happened. Answers 204 with no body.

Parameters

Parameters this endpoint accepts, where each one goes, and whether it is required
NameSent inRequirementAccepts
organizationSlugpathRequiredstring
invitationIdpathRequiredstring

Response

Answers 204 with no body.

Examples

Withdraw an invitation sent to the wrong address

Withdraw an invitation sent to the wrong address — request
curl -s -X DELETE https://www.jobapplicationtracking.com/api/v1/organizations/northside-career-center/invitations/inv_9b1d4f30-6c2a-4c1e-8f7b-2d3e4f5a6b7c \
  -H "Authorization: Bearer $JAT_KEY"
Withdraw an invitation sent to the wrong address — response
null

Related operations