Delete a Subscription

Endpoint

DELETE https://api.parcelengineering.com/api/v1/workspace/signal-subscriptions/{id}

Removes a signal subscription by its row id. Signals of the deleted type leave the workspace queue immediately and no further alerts are sent. Re-subscribing later starts a fresh queue watermark.

This operation is idempotent. Deleting a subscription that does not exist returns a success response with no error.

Delete costs 0 credits.

Caution

The Workspace API requires the Pro plan. A request from a non-Pro workspace receives 403 forbidden.

Path parameters

Parameter	Description
id	UUID of the subscription row to delete. Returned as id in the List Subscriptions response.

Query parameters

Parameter	Type	Required	Description
workspace_id	string (UUID)	No	Override the workspace resolved from your API key.

Example

cURL

Delete a signal subscription

curl -X DELETE \
  "https://api.parcelengineering.com/api/v1/workspace/signal-subscriptions/7c3f1a2b-0001-4e8d-bf6a-000000000001" \
  -H "Authorization: Bearer pcl_your_api_key"

JavaScript

Delete a signal subscription

const response = await fetch(
  'https://api.parcelengineering.com/api/v1/workspace/signal-subscriptions/7c3f1a2b-0001-4e8d-bf6a-000000000001',
  {
    method: 'DELETE',
    headers: {
      'Authorization': 'Bearer pcl_your_api_key',
    },
  }
);

const { data, metadata } = await response.json();

Response

Response

{
  "data": { "deleted": true },
  "metadata": { "credits": 0 }
}

Delete costs 0 credits.