Skip to main content
PATCH
/
event-subscriptions
/
subscriptions
/
{id}
curl --request PATCH \
  --url https://panel.sendcloud.sc/api/v3/event-subscriptions/subscriptions/{id} \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "is_active": false
}
'
{
  "data": {
    "id": 1,
    "connection_id": 2,
    "event_type": "parcels.event.created",
    "is_active": false,
    "created_at": "2026-01-15T11:00:00Z",
    "updated_at": "2026-01-20T14:30:00Z"
  }
}

Documentation Index

Fetch the complete documentation index at: https://sendcloud.dev/llms.txt

Use this file to discover all available pages before exploring further.

Update an existing subscription. You can change the connection, event type, or toggle the active state.
Set is_active to false to pause event delivery without deleting the subscription.

Authorizations

​
Authorization
string
header
required

Basic Authentication using API key and secrets is currently the main authentication mechanism.

Path Parameters

​
id
integer
required

The id of the subscription.

Body

application/json

Request body for updating an existing subscription. All fields are optional.

​
connection_id
integer<int64>

The identifier of the connection to deliver events to.

Required range: x >= 1
​
event_type
enum<string>

The type of event to subscribe to.

Available options:
parcels.event.created
​
is_active
boolean

Whether the subscription should be active.

Response

OK

Updated subscription

​
data
Subscription · object

A subscription routes a specific event type to a connection for delivery.