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"
}
}{
"errors": [
{
"status": "<string>",
"code": "unknown_field",
"detail": "<string>",
"id": "<string>",
"links": {
"about": "<string>"
},
"title": "<string>",
"source": {
"pointer": "<string>",
"parameter": "<string>",
"header": "<string>"
},
"meta": {}
}
]
}{
"errors": [
{
"status": "<string>",
"code": "unknown_field",
"detail": "<string>",
"id": "<string>",
"links": {
"about": "<string>"
},
"title": "<string>",
"source": {
"pointer": "<string>",
"parameter": "<string>",
"header": "<string>"
},
"meta": {}
}
]
}Subscriptions
Update a subscription
Update an existing subscription by its id. Only the fields provided in the request body will be updated.
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"
}
}{
"errors": [
{
"status": "<string>",
"code": "unknown_field",
"detail": "<string>",
"id": "<string>",
"links": {
"about": "<string>"
},
"title": "<string>",
"source": {
"pointer": "<string>",
"parameter": "<string>",
"header": "<string>"
},
"meta": {}
}
]
}{
"errors": [
{
"status": "<string>",
"code": "unknown_field",
"detail": "<string>",
"id": "<string>",
"links": {
"about": "<string>"
},
"title": "<string>",
"source": {
"pointer": "<string>",
"parameter": "<string>",
"header": "<string>"
},
"meta": {}
}
]
}OAuth2 scopes required:
write:event-subscription. See Scopes for OAuth apps.Set
is_active to false to pause event delivery without deleting the subscription.Authorizations
HTTPBasicAuthOAuth2ClientCreds
Basic Authentication using API key and secrets is currently the main authentication mechanism.
Path Parameters
The id of the subscription.
Body
application/json
Request body for updating an existing subscription. All fields are optional.
Response
OK
Updated subscription
A subscription routes a specific event type to a connection for delivery.
Show child attributes
Show child attributes