Skip to main content
POST
/
v1
/
numbers
/
remote-pairing
Remote pairing (connection link)
curl --request POST \
  --url https://pilotstatus.com.br/v1/numbers/remote-pairing \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "name": "Cliente Acme",
  "number": "5511988887777"
}
'
{
  "provider": "PILOT_STATUS",
  "remotePairingToken": "rp_01HZX...",
  "remotePairingUrl": "https://pilotstatus.com.br/connect/rp_01HZX...",
  "numberId": "num_01HZX..."
}

Authorizations

​
x-api-key
string
header
required

Your ps_ API key

Body

application/json
​
provider
string

Link kind (default PILOT_STATUS).

Example:

"PILOT_STATUS"

​
name
string

Required for PILOT_STATUS; ignored for META.

Example:

"Cliente Acme"

​
number
string

Required for PILOT_STATUS; ignored for META.

Example:

"5511988887777"

​
sendViaWhatsApp
boolean

Send the link over WhatsApp (PILOT_STATUS). Default false.

Example:

"false"

​
redirectUrl
string

Redirect URL after completion (META).

Example:

"https://app.acme.com/done"

​
externalRef
string

Optional external reference for correlation (META).

Example:

"customer-42"

​
linkToApiKey
boolean

Link the resulting number to the calling API key (default true).

Example:

"true"

Response

PILOT_STATUS link