Skip to main content
POST
Remote pairing (connection link)

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"

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

Example:

"true"

Response

PILOT_STATUS link