Skip to main content
PATCH
/
notifications
/
v1
/
subscriptions
/
{id}
Update a webhook subscription.
curl --request PATCH \
  --url https://sandbox-api.sandbox.lemmax.com/notifications/v1/subscriptions/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "description": "My webhooks",
  "endpoint": "https://example.org/webhooks"
}
'
{
  "data": {
    "description": "My webhooks",
    "endpoint": "https://example.org/webhooks",
    "id": "f89eccda-f284-4e30-984f-2f6620238cd2",
    "status": "enabled",
    "version": "1"
  }
}

Authorizations

​
Authorization
string
header
required

access_token returned by the /auth/v1/oauth2/tokens API call.

Path Parameters

​
id
string<uuid>
required

ID of the webhook subscription.

Required string length: 36
Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$

Body

application/json

Subscription attributes.

Update a webhook subscription.

​
description
string

New description for the webhook subscription.

Maximum string length: 200
Example:

"My webhooks"

​
endpoint
string

New endpoint for the webhook subscription.

Maximum string length: 2500
Example:

"https://example.org/webhooks"

​
version
string

New version for the webhook subscription.

Maximum string length: 20
Pattern: ^[a-zA-Z0-9]*$
Example:

"1"

Response

Update subscriptions response.

Update webhook subscription response.

​
data
object