POST/v1/support/exchange

Exchange a support handoff token for the support cookie

Rate limit class public

Body

tokenstringrequiredmin length 10max length 200

Returns

2 fields of the 201 answer

sessionobjectrequired

13 fields

idstringrequired

organisationIdstringrequired

adminNamestringrequired

adminEmailstringrequired

reasonstringrequired

startedAtdate-timerequired

expiresAtdate-timerequired

endedAtdate-time or nullrequired

endedByenum or nullrequired

ADMINEXPIRYORGANISATION

exchangedAtdate-time or nullrequired

blockedCountintegerrequired

statusenumrequired

ACTIVEENDED

remainingSecondsintegerrequired

organisationobjectrequired

4 fields

idstringrequired

namestringrequired

slugstringrequired

localeenumrequired

nlen

Responses

201Success

422Validation failed

429Rate limited for this API key and class; wait Retry-After seconds

otherError (RFC 9457 problem details)

import { PostBuddyClient } from '@postbuddy/sdk'; const client = new PostBuddyClient({ apiKey: process.env.POSTBUDDY_API_KEY! }); const result = await client.support.exchange({ body: { token: 'Examplexxx', }, });

{ "session": { "id": "ses_01J9Y2K8QF4T6W8Z0B2D4F6H8K", "organisationId": "org_01J9Y2K8QF4T6W8Z0B2D4F6H8K", "adminName": "Example", "adminEmail": "sanne@example.com", "reason": "Example", "startedAt": "2026-10-16T09:14:02.000Z", "expiresAt": "2026-10-16T09:14:02.000Z", "endedAt": "2026-10-16T09:14:02.000Z", "endedBy": "ADMIN", "exchangedAt": "2026-10-16T09:14:02.000Z", "blockedCount": 3, "status": "ACTIVE", "remainingSeconds": 1 }, "organisation": { "id": "org_01J9Y2K8QF4T6W8Z0B2D4F6H8K", "name": "Welcome card", "slug": "Example", "locale": "nl" } }

{ "type": "https://docs.postbuddy.nl/errors/validation_failed", "title": "Validation failed", "status": 422, "code": "validation_failed", "detail": "Validation failed", "requestId": "req_01J9Y2K8QF4T6W8Z0B2D4F6H8K", "errors": [ { "field": "recipient.postalCode", "code": "invalid_string", "message": "Invalid postal code" } ] }