Sign in
latestOpenAPI 3.1.02026-07-234140131.3 KB

eaf9cf96606a

Notification Subscriptions API

Overwrite subscription list

put/subscriptions/{id}

Path parameters

idstring required

Unique ID of the subscription list.

Headers

Authorizationstring required

Token <Your_API_Key>.

Request body

namestring

An optional free-form name for the list.

subscription_typestring required

Currently only webhook subscription type is supported. There may be different subscription type in the future.

target_endpointstring required

Partner notification URL.

Response

Successful operation.

successboolean
is_activeboolean

Subscription list status.

idnumber

Unique ID created for this subscription list.

namestring

Name of the list.

subscription_typestring

Currently only webhook subscription type is supported. There may be different subscription type in the future.

target_endpointstring

Partner notification URL.

target_emailstring

Will be supported in the future. Partner email address for the notification.