See api-docs Menu

Delete a Hook

Early Preview

This API is in early preview and may be subject to change. Please contact your account manager if you are interested in trying Smart Hooks.

Use this API to delete a Hook function.

Be careful, this operation is final and can not be undone.





Resource URL

https://<api-domain>/api/2/hooks/:id

Header Parameters

Authorization

required

string

Set to bearer <access_token>.

Set <access_token> to the access token you generated using the Generate Token API.

The access token must have been generated using an API credential pair created using the scope required to call this API. This API can be called using any one of the following scopes: Read All, or Manage All.

In order to use Smart Hooks your API Credentials must be created after 21st October 2020.

Resource Parameter

id

required

string

Set to the id of the Hook that you want to delete.

Sample Responses

Success. The hook function has been queued for deletion. This typically happens within seconds of making the request.

Typically, this error means that your Authorization header value is missing or incorrectly formatted. The Authorization header value should use this format: bearer:<access_token>.

{
    "name": "UnauthorizedError",
    "message": "The request requires user authentication."
}

You attempted to delete an app that does not exist.

{
    "message": "The resource with the given id could not be found",
    "name": "NotFoundError"
}

Postman Collection

Replace sample variables indicated by {{ }} with your actual values.

Download for the Smart Hooks API

Sample Code

cURL

Replace sample values indicated by < > with your actual values.

Delete App Parameter

curl 'https://<api-domain>/api/2/hooks/:id' \
-X DELETE \
-H "Authorization: bearer <access_token>"

Have a Question?

Have a how-to question? Seeing a weird error? Ask us about it on StackOverflow.

Found a bug? Submit a support ticket.

Have a product idea or request? Share it with us in our Ideas Portal.