Cancel Invitation

DELETE 
/api/partner/v1/onboarding/:ref/invitations/:id

Cancel an invitation. Its hosted link stops working immediately (the invited person then sees a gone page when they open it). Use this when the details were wrong, for example a typo in the e-mail or phone number.

Invitations in a terminal state (completed, expired, cancelled) cannot be cancelled and return 422. The response echoes the invitation with its status now set to cancelled.

Requires scope onboarding:write.

Request

Responses

200

Invitation cancelled; its hosted link no longer works.

401

Missing or invalid partner bearer key.

403

The partner key lacks the onboarding:write scope.

404

No such invitation for this onboarding - unknown ref or id, or the invitation belongs to another merchant.

409

Onboarding is already completed - its data can no longer be edited.

422

The invitation is in a terminal state (completed, expired, cancelled) and can no longer be cancelled.