curl --request PATCH \
--url https://panel.sendcloud.sc/api/v3/event-subscriptions/connections/{id} \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"configuration": {
"url": "https://example.com/webhooks/sendcloud-v2"
}
}
'{
"data": {
"id": 1,
"type": "webhook",
"configuration": {
"url": "https://example.com/webhooks/sendcloud-v2",
"auth_type": "api_key",
"extra_headers": {
"X-Custom-Header": "my-value"
}
},
"created_at": "2026-01-15T10:30:00Z",
"updated_at": "2026-01-20T14:00:00Z"
}
}{
"errors": [
{
"detail": "Enter a valid URL.",
"status": "400",
"source": {
"pointer": "/data/configuration/url"
},
"code": "invalid"
}
]
}{
"errors": [
{
"status": "<string>",
"code": "unknown_field",
"detail": "<string>",
"id": "<string>",
"links": {
"about": "<string>"
},
"title": "<string>",
"source": {
"pointer": "<string>",
"parameter": "<string>",
"header": "<string>"
},
"meta": {}
}
]
}Connections
Update a connection
Update an existing connection by its id. Only the fields provided in the request body will be updated.
PATCH
/
event-subscriptions
/
connections
/
{id}
curl --request PATCH \
--url https://panel.sendcloud.sc/api/v3/event-subscriptions/connections/{id} \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"configuration": {
"url": "https://example.com/webhooks/sendcloud-v2"
}
}
'{
"data": {
"id": 1,
"type": "webhook",
"configuration": {
"url": "https://example.com/webhooks/sendcloud-v2",
"auth_type": "api_key",
"extra_headers": {
"X-Custom-Header": "my-value"
}
},
"created_at": "2026-01-15T10:30:00Z",
"updated_at": "2026-01-20T14:00:00Z"
}
}{
"errors": [
{
"detail": "Enter a valid URL.",
"status": "400",
"source": {
"pointer": "/data/configuration/url"
},
"code": "invalid"
}
]
}{
"errors": [
{
"status": "<string>",
"code": "unknown_field",
"detail": "<string>",
"id": "<string>",
"links": {
"about": "<string>"
},
"title": "<string>",
"source": {
"pointer": "<string>",
"parameter": "<string>",
"header": "<string>"
},
"meta": {}
}
]
}Update the configuration of an existing connection.
Only the fields provided in the request body will be updated. For example, you can update just the webhook URL or authentication settings without changing other fields.
Updating a connection’s configuration may affect all subscriptions that use this connection.
Authorizations
HTTPBasicAuthOAuth2ClientCreds
Basic Authentication using API key and secrets is currently the main authentication mechanism.
Path Parameters
The id of the connection.
Body
application/json
Request body for updating an existing connection. All fields are optional.
The type of connection.
Available options:
webhook, klaviyo The configuration for the connection. The shape depends on the connection type.
For webhook connections, see the webhook configuration fields.
For klaviyo connections, configuration can be an empty object as credentials are managed via OAuth2.
Response
OK
Updated connection
A connection defines an external endpoint where event notifications are delivered.
Show child attributes
Show child attributes