Skip to main content
PATCH
/
v1
/
webhooks
/
{id}
Update webhook
curl --request PATCH \
  --url https://pilotstatus.com.br/v1/webhooks/{id} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "active": false
}
'
{
  "id": "wh_01HZX...",
  "tenantId": "tenant_01HZX...",
  "name": "n8n",
  "url": "https://hooks.acme.com/whatsapp",
  "environment": "LIVE",
  "active": false,
  "events": [
    "message.received",
    "message.delivered"
  ],
  "createdAt": "2026-06-01T11:59:00.000Z",
  "updatedAt": "2026-07-03T12:05:00.000Z"
}

Authorizations

​
x-api-key
string
header
required

Your ps_ API key

Headers

​
x-whatsapp-number-id
string

Scopes to a single number (required for per-number OAuth grants).

Path Parameters

​
id
string
required

Webhook id.

Body

application/json
​
name
string

New display name.

Example:

"n8n-prod"

​
url
string

New endpoint.

Example:

"https://hooks.acme.com/whatsapp-v2"

​
active
boolean

false pauses deliveries; true resumes.

Example:

"false"

​
events
string[]

Full REPLACEMENT list of subscriptions; "*" = all.

Example:

"[\"message.received\"]"

Response

Pause deliveries