DELETE api/hooks

This endpoint allows a client to unsubscribe from an event of interest. Afterwards, when the event occurs, the no data will be sent to the previously specified url.

Request Information

URI Parameters

Query String:

None.

Body Parameters

Structure used to terminate a subscription to an event. Required.

Type: WebHookUnsubscription

NameDescriptionTypeAdditional information
web_hook_id

The unique ID of the new subscription.

 globally unique identifier

None.

Request Formats

application/json, text/json

Sample: 
{
  "web_hook_id": "6a71c3d1-3457-4204-a9b8-0844730a2935"
}

application/xml, text/xml

Sample: 
<unsubscription xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <web_hook_id>6a71c3d1-3457-4204-a9b8-0844730a2935</web_hook_id>
</unsubscription>

Response Information

Resource Description

[HTTP Status 200 - OK]

None.