Update Subscription
This endpoint is used to update an existing subscription.
patch
https://api.claimsmanagertest.crawco.co.uk/webhooks/{webhookid}/subscriptions/{subscriptionId}
Path parameters
| Parameter Name | Description | Type | Example Data |
|---|---|---|---|
webhookId
|
The unique id of the webhook that the subscription resides under. | numeric | 1 |
subscriptionId
|
The unique id of the subscription to update. | numeric | 1 |
Request body parameters
| Parameter Name | Description | Type | Example Data |
|---|---|---|---|
name
|
A unique name given to the subscription. This optional field is for your personal use in identifying the subscription while interacting with the API. It is not used by Claims Manager. | string | Test Subscription |
webhookEvent
|
The name of the webhook event that this subscription is subscribing to. | string | New Event |
isActive
|
When set to false, this subscription is disabled. |
string | true |
filters
|
Object containing any filters defined for this subscription. | object | See Filters |
Only fields supplied in the request body will be updated, any fields omitted will not be updated.
If you change the webhookEvent field, you need to ensure that any filters applied are still relevant. In particular, filters at the field level will no longer apply as a different payload will be delivered.
Example request
curl --location --request PATCH 'https://api.claimsmanagertest.crawco.co.uk/webhooks/1/subscriptions/1' \
--header 'Authorization: Bearer {access token} \
--header 'Content-Type: application/json' \
--data-raw '{
"name": "Updated Subscription"
}'Example response
200 OK