Operation
Cancel Invitation
DELETE
/users/invitations/{id}Revoke a pending invitation.
The invitation code will stop working immediately. Use this if you sent an
invitation to the wrong person or changed your mind.
You can always send a new invitation later if needed.
When to use this
- Revoking an invitation sent to the wrong email
- Cancelling access before someone joins
- Cleaning up expired invitations
Path parameters
idstringRequired
Headers
Idempotency-KeystringOptional- Makes the write safe to retry. The first request with a key does the work and its response is stored for 24 hours; a repeat with the same key and the same request (method, path, query, X-Ticketlayer-Channel, TL-Version and body) gets that stored status and body back, marked `Idempotent-Replay: true`, without running again. The key is scoped to your organisation and your credential. The same key with a different request is 422 IDEMPOTENCY_KEY_REUSED; a repeat while the first is still running waits for it, then answers 409 IDEMPOTENT_REQUEST_IN_PROGRESS if it has not finished. Only a 2xx is stored: after an error the key is free again. Omit the header and the request behaves as it always has.
Returns
Invitation cancelled successfully
Errors
- 400
- Bad Request - Invalid input
- 401
- Unauthorized - Authentication required
- 403
- Forbidden - Insufficient permissions
- 404
- Not Found - Resource not found
- 500
- Internal Server Error
Every error names its code and links to it. All error codes
Notes
Note
Cancelling an invitation is immediate-the code stops working right away.
Tip
If someone's already accepted, you'll need to remove their roles instead.
Related
import { BackstageClient } from '@ticketlayer/backstage';const client = new BackstageClient({ organisationSlug: 'your-org',});client.setAccessToken('YOUR_ACCESS_TOKEN');// Cancel User Invitationconst result = await client.userinvitation.cancelUserInvitation('{{ID}}');console.log('Operation completed:', result);Response 200
{
"success": true,
"id": "inv_abc123"
}