Linhas telefônicas

Atualizar webhook de linha

⚠️ Efeito colateral real. Muda os campos que você enviar e responde { "webhook": { … } }; um campo ausente fica como está. active: false pausa o webhook (ele não recebe entregas — uma entrega que já está nas retentativas é marcada como falha na próxima tentativa) e active: true o retoma; eventos ocorridos enquanto ele estava pausado nunca são enviados.

O webhook resultante é validado como na criação. Só uma URL que muda é conferida de novo contra destinos internos, então um webhook sempre pode ser pausado ou ter os eventos editados. Um name enviado em branco vira o host da URL (nova ou a guardada). Editar nunca muda o segredo de assinatura, e o segredo não é devolvido.

Permissões: com um token OAuth / MCP, o usuário precisa ser Proprietário ou Administrador (phone_lines:webhooks) — caso contrário, 403 PERMISSION_DENIED.

Todo endpoint /v1/phone-lines aceita só uma chave com escopo de tenant: os webhooks das linhas pertencem ao workspace, não a um número de WhatsApp, então uma chave com escopo de número (ou uma concessão OAuth por número) recebe 403 NUMBER_SCOPE_NOT_ALLOWED antes de qualquer verificação de papel. Um 403 PERMISSION_DENIED / WORKSPACE_MEMBERSHIP_REQUIRED é enviado com Cache-Control: no-store.

Estes são os webhooks das linhas — um cadastro separado de /v1/webhooks: recebem só eventos phone_line.*, e um webhook de número nunca recebe um deles.

Requer uma chave com escopo de tenant.

PATCH

phone-lines

webhooks

{id}

Editar ou pausar um webhook de linha

curl --request PATCH \
  --url https://pilotstatus.com.br/v1/phone-lines/webhooks/{id} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "active": false
}
'

import requests

url = "https://pilotstatus.com.br/v1/phone-lines/webhooks/{id}"

payload = { "active": False }
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({active: false})
};

fetch('https://pilotstatus.com.br/v1/phone-lines/webhooks/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://pilotstatus.com.br/v1/phone-lines/webhooks/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'active' => false
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://pilotstatus.com.br/v1/phone-lines/webhooks/{id}"

	payload := strings.NewReader("{\n  \"active\": false\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("x-api-key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://pilotstatus.com.br/v1/phone-lines/webhooks/{id}")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"active\": false\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://pilotstatus.com.br/v1/phone-lines/webhooks/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"active\": false\n}"

response = http.request(request)
puts response.read_body

{
  "webhook": {
    "id": "cmh1w8b2k0001wh8example3d",
    "name": "hooks.example.com",
    "url": "https://hooks.example.com/pilot/phone-lines",
    "events": [
      "*"
    ],
    "active": false,
    "lastDeliveryAt": "2026-10-27T14:11:51.000Z",
    "lastStatusCode": 200,
    "createdAt": "2026-10-27T13:58:02.000Z"
  }
}

Autorizações

x-api-key

string

header

obrigatório

Sua chave de API ps_

Parâmetros de caminho

string

obrigatório

O id do webhook (de GET /v1/phone-lines/webhooks ou da resposta da criação).

Corpo

application/json

name

string

Opcional, até 100 caracteres (acima disso, 400 INVALID_WEBHOOK_NAME). Em branco ou ausente → o host da URL.

Maximum string length: 100

Exemplo:

"Linhas — produção"

url

string

Precisa ser https e apontar para um endereço público. Uma URL que aponte para um endereço interno ou de rede privada — localhost, um IP de loopback ou privado, um host sem ponto, ou um nome que resolva para um desses — → 400 WEBHOOK_URL_REFUSED.

Exemplo:

"https://hooks.example.com/pilot/phone-lines"

events

enum<string>[]

Um ou mais eventos de linha, ou "*" para todos (neste cadastro, "*" significa todos os eventos de linha, inclusive os adicionados depois). Duplicados são removidos. Lista vazia ou evento desconhecido → 400 INVALID_WEBHOOK.

Minimum array length: 1

Opções disponíveis:

phone_line.purchased,

phone_line.audio_received,

phone_line.code_received,

phone_line.code_failed,

phone_line.renewed,

phone_line.payment_failed,

phone_line.suspended,

phone_line.returned,

phone_line.canceled,

phone_line.verification_updated,

*

Exemplo:

["*"]

active

boolean

false pausa, true retoma.

Exemplo:

false

Resposta

O webhook depois da mudança

webhook

object

Show child attributes

Editar ou pausar um webhook de linha

curl --request PATCH \
  --url https://pilotstatus.com.br/v1/phone-lines/webhooks/{id} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "active": false
}
'

import requests

url = "https://pilotstatus.com.br/v1/phone-lines/webhooks/{id}"

payload = { "active": False }
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({active: false})
};

fetch('https://pilotstatus.com.br/v1/phone-lines/webhooks/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://pilotstatus.com.br/v1/phone-lines/webhooks/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'active' => false
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://pilotstatus.com.br/v1/phone-lines/webhooks/{id}"

	payload := strings.NewReader("{\n  \"active\": false\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("x-api-key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://pilotstatus.com.br/v1/phone-lines/webhooks/{id}")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"active\": false\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://pilotstatus.com.br/v1/phone-lines/webhooks/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"active\": false\n}"

response = http.request(request)
puts response.read_body

{
  "webhook": {
    "id": "cmh1w8b2k0001wh8example3d",
    "name": "hooks.example.com",
    "url": "https://hooks.example.com/pilot/phone-lines",
    "events": [
      "*"
    ],
    "active": false,
    "lastDeliveryAt": "2026-10-27T14:11:51.000Z",
    "lastStatusCode": 200,
    "createdAt": "2026-10-27T13:58:02.000Z"
  }
}

Endpoints

Workspace

Atualizar webhook de linha

Autorizações

Parâmetros de caminho

Corpo

Resposta