Skip to main content
POST
/
v1
/
numbers
Create number (PILOT_STATUS)
curl --request POST \
  --url https://pilotstatus.com.br/v1/numbers \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "name": "Suporte",
  "number": "5511999999999"
}
'
{
  "instance": {
    "id": "num_01HZX...",
    "number": "5511999999999",
    "name": "Suporte",
    "provider": "PILOT_STATUS",
    "status": "CONNECTING",
    "isFullyConnected": false
  },
  "qrcodeBase64": "data:image/png;base64,iVBORw0KGgo...",
  "pairingCode": "ABCD-1234",
  "linkedApiKeyId": "key_01HZX..."
}

Authorizations

​
x-api-key
string
header
required

Your ps_ API key

Body

application/json
​
name
string
required

Display name for the number.

Example:

"Suporte"

​
number
string
required

Phone number (min 10 digits, optional +).

Example:

"5511999999999"

​
linkToApiKey
boolean

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

Example:

"true"

Response

Create number