Detach Webhook API Reference

Serverhttps://api.pinnacle.sh/

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.

Authorization

Pinnacle API key

PINNACLE-API-KEY<token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

webhookIdstring

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

Length

1 <= length

Example

"webhook_01J8K3R7M9"

sendersarray<string>

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

Items

1 <= items <= 50

Each item

Example

"+14155550100"

Response Body

`application/json`

Pinnacle client libraries

import { PinnacleClient } from "rcs-js";

const client = new PinnacleClient({
  apiKey: process.env.PINNACLE_API_KEY!,
});

await client.webhooks.detach({
    webhookId: "webhookId",
    senders: ["+14155551234", "agent_abc123"]
});

Responses

{  "webhookId": "wh_1234567890",  "senders": [    "+14155551234"  ],  "failed": []}

Detach Webhook

Request body

Authorization

Request Body

Response Body

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

Try asking

Detach Webhook

AuthorizationCopy Anchor Link

Request BodyCopy Anchor Link

Response BodyCopy Anchor Link

200application/json

400application/json

401application/json

404application/json

500application/json

Authorization

Request Body

Response Body

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`