API ReferenceWebhooks

Detach Webhook

Detach a webhook from one or more senders (phone numbers or RCS agent IDs) to stop receiving event notifications.

The webhook itself is not deleted and remains available for use with other senders. Works regardless of webhook status. Supports bulk operations with up to 50 senders per request.

Authentication

PINNACLE-API-KEYstring
API Key authentication via header

Request

This endpoint expects an object.
webhookIdstringRequired>=1 character

Webhook ID to detach (starts with wh_). Must be a webhook owned by your team.

senderslist of stringsRequired
Array of senders to detach the webhook from. Can be phone numbers in E.164 format or RCS agent IDs.

Response

Successfully detached webhook from the specified senders.

Senders that could not be found are returned in the failed array with error details.

webhookIdstring
The webhook that was detached from the senders.
senderslist of strings

Senders that were successfully detached (phone numbers in E.164 format or RCS agent IDs).

failedlist of objects
Senders that could not be detached, with error details.

Errors

400
Bad Request Error
401
Unauthorized Error
404
Not Found Error
500
Internal Server Error