Skip to content
Docs
Operation

Accept an invitation as the signed-in person

POST/me/invitations/redeem
Accept an invitation to an organisation as the person already signed in: the invitation must have been sent to their email address (403 INVITATION_EMAIL_MISMATCH otherwise, and it is left for that address to accept). They become a member with the roles it names, and it is spent: 409 INVITATION_ALREADY_REDEEMED a second time, 410 INVITATION_EXPIRED after its expiry. Takes the person's own access token from the Ticketlayer identity issuer, pinned to an organisation or not, and does not need X-Ticketlayer-Org. Then pin the session to the organisation it answers. Someone not signed in accepts through the issuer instead (`POST /auth/invitations/start`).

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.

Body

Returns

Accepted

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

curl -X POST "https://api.ticketlayer.com/v1/me/invitations/redeem" \  -H "Authorization: Bearer tlak_..." \  -H "X-Ticketlayer-Org: your-org-slug" \  -H "Content-Type: application/json" \  -d '{    "invitation": "inv_BvQ8mKx2..."  }'
Response 200
{
  "organisation": {
    "id": "org_abc123",
    "slug": "acme-events",
    "name": "Acme Events"
  },
  "userId": "usr_abc123",
  "created": true
}

Try it in test mode