Skip to main content
POST
/
api
/
partner_webhooks
/
{partner_webhooks_id}
/
disable
curl -X POST \
  'https://platform.returnqueen.dev/api/partner_webhooks/ep_2KtRQ8fTStWPKrXP/disable' \
  -H 'X-API-KEY: your-api-key'

{
  "id": "ep_2KtRQ8fTStWPKrXP",
  "url": "https://example.com/webhook",
  "filterTypes": ["shipment.created", "shipment.address.updated", "pickup.completed"],
  "active": false,
  "created_at": "2024-01-15T10:00:00Z",
  "description": "Production webhook endpoint"
}

​
Request Parameters

​
Path Parameters

​
id
string
required
Webhook endpoint ID
curl -X POST \
  'https://platform.returnqueen.dev/api/partner_webhooks/ep_2KtRQ8fTStWPKrXP/disable' \
  -H 'X-API-KEY: your-api-key'

{
  "id": "ep_2KtRQ8fTStWPKrXP",
  "url": "https://example.com/webhook",
  "filterTypes": ["shipment.created", "shipment.address.updated", "pickup.completed"],
  "active": false,
  "created_at": "2024-01-15T10:00:00Z",
  "description": "Production webhook endpoint"
}
Disabled webhooks will not receive any events. You can re-enable them at any time using the enable endpoint.

​
Response Fields

​
id
string
Unique identifier for the webhook endpoint
​
url
string
HTTPS URL where webhook events are sent
​
filterTypes
array
Event types this endpoint is subscribed to
​
active
boolean
Whether the endpoint is active (will be false after disabling)
​
created_at
string
When the endpoint was created (ISO 8601 format)
​
description
string
Description of the webhook endpoint