Modify Subscription

Updates an existing webhook’s configuration. This may include changing the callback URL or updating whether the webhook is currently active.

PUT /core/v1/notifications/{id}

Modify Subscription

cURL

curl --request PUT \
  --url https://api.dev.name.com/core/v1/notifications/{id} \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "url": "https://example2.com",
  "active": false
}
'

200

{
  "subscription": {
    "active": true,
    "createDate": "<string>",
    "eventName": "<string>",
    "id": 123,
    "updateDate": "<string>",
    "url": "<string>"
  }
}

Authorizations

Authorization · string · header · required

Authenticate via HTTP Basic with your account username and API token. Examples use an explicit 'Authorization: Basic <base64(username:token)>' header; 'curl -u username:token' is equivalent. For sandbox, append "-test" to your username and use your sandbox token on api.dev.name.com.

Path Parameters

id · integer<int32> · required

ID of the subscription to update.

Body

application/json

Option 1

Option 2

url · string<uri> · required

Optionally update the URL we send the webhook data to

Example:

"https://example2.com"

active · boolean

Optionally update if the subscription is currently active

Example:

false

Response

200

application/json

A successful response.

subscription · * The record for each notification you have subscribed to · object

Show child attributes