Skip to main content
POST
Send Linking Invite

Authorizations

X-API-KEY
string
header
required

Body

application/json
email
string<email>
required

Email address of the existing AA user to invite.

external_id
string
required

Your unique identifier for this user. Must be unique across all your users.

Maximum string length: 255

Response

Invite sent (or generic acknowledgment).

id
integer
email
string
external_id
string
status
enum<string>
Available options:
pending