API ReferencePhone Numbers

Detach Webhook

Disconnect a webhook from your phone number to stop receiving event notifications for that specific number.

The webhook configuration itself remains intact and available for use with other phone numbers.

Authentication

PINNACLE-API-KEYstring
API Key authentication via header

Path parameters

phonestringRequired

The phone number you want to attach the webhook to in E.164 format. Make sure it is url encoded (i.e. replace the leading + with %2B).

Must be a phone number that you own and currently has the specified webhook attached.

webhookIdstringRequired

The unique identifier of the webhook you want to detach from the phone number.

This must be a valid webhook ID that is currently attached to the specified phone number. This identifier is a string that always begins with the prefix wh_, for example: wh_1234567890.

Response

Successfully detached the webhook.
messagestring
Confirmation message.
webhookIdstring

Unique identifier of the webhook within the account. This identifier is a string that always begins with the prefix wh_, for example: wh_1234567890.

phoneNumberstring
Phone number the webhook was detached from in E.164 format.

Errors