Skip to main content
POST
Send 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

create an onboarding invite first and get the inviteId

inviteId
string
required

The inviteId of the onboarding invite.

Example:

""

Response

Onboarding invite successfully sent.

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 has been sent"

data
object

The response payload.

Last modified on July 14, 2026