Skip to main content
POST
/
partner-links
Send Linking Invite
curl --request POST \
  --url https://playground.answeringagent.com/api/v1/partner-links \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "email": "jsmith@example.com",
  "external_id": "<string>"
}
'
{
  "id": 123,
  "email": "<string>",
  "external_id": "<string>",
  "status": "pending"
}

Documentation Index

Fetch the complete documentation index at: https://docs.answeringagent.com/llms.txt

Use this file to discover all available pages before exploring further.

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