Skip to main content
POST
Cancel an invite

Authorizations

Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Body

application/json
inviteId
string
required

The inviteId of the onboarding invite.

Example:

"c23b205a-244b-4962-9337-a5b68f1c874f"

Response

Onboarding invite successfully cancelled.

success
boolean

Whether the request was processed successfully. Declines return HTTP 200 with success: false.

Example:

true

code
string

Machine-readable result code. See the Error Codes reference.

Example:

"0"

message
string

Human-readable result message.

Example:

"Invite deleted"

Last modified on July 14, 2026