Partner API ExplorerVguests
Send a guest invite
Required scopes
partner:guests:readandpartner:guests:pii:readPOST
Emails a verified-guest invitation. Requires both partner:guests:read (declared on the controller) and partner:guests:pii:read (on the handler) — the guard ANDs them.
header
AuthorizationBearer <token>WorkOS access token (JWT) for a user who is a member of the partner organization. The organization the request is scoped to is taken from the token, not from a header or query parameter.
Only a JWT is accepted in this header. A Journey jny_ API key sent as a bearer token is rejected
with 401 Invalid or expired token; send it in X-API-Key instead.
WorkOS organization API keys are not accepted yet.
application/json- body
brandId?numberchannel*stringValue in
"email""sms"contactValue*stringMatch
^\+[1-9]\d{1,14}$Format
emailexternalReservationId?stringguestFirstName?stringsourceApp*stringvenueId?numbervguestProfileId?numberThe created invitation.
application/json- response
channel*stringValue in
"email""sms"contactValue*stringexpiresAt*stringinviteId*stringcurl -X POST 'https://api-prd.cf.journey.com/v1/partner/vguests/guest-invites' \ -H 'Content-Type: application/json' \ -d '{ "channel": "email", "contactValue": "user@example.com", "sourceApp": "string"}'{ "channel": "email", "contactValue": "string", "expiresAt": "string", "inviteId": "string"}