Partner API ExplorerVguests
Cancel a guest invite
Required scopes
partner:guests:readandpartner:guests:pii:readDELETE
Revokes an invitation that has not been accepted. 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.
inviteId*integerInternal numeric invitation id — not an external id. A non-integer value is rejected with 400 before the handler runs.
The invitation was cancelled.
curl -X DELETE 'https://api-prd.cf.journey.com/v1/partner/vguests/guest-invites/0'Empty