Deactivate Webhook

This endpoint allows you to unsubscribe/deactivate a webhook from the active webhooks list at your store.

Note

You can define which webhook to delete by using url and/or id in the query parameters.

Alert

Using url will delete all registered webhooks to this URL.

Scopes

webhooks.read_write- Webhooks Read & Write

Request

Authorization

Add the parameter

Authorization

to Headers，whose value is to concatenate the Token after the Bearer.

Example:

Authorization: Bearer ********************

Query Params

number

optional

Webhook ID. requiredif no URL passed. List of Webhook IDs can be found here.

url

string

optional

Webhook registered URL. requiredif no ID is passed.

Responses

🟢202Object Deleted Successfully.

application/json

Body

status

number

optional

Response status code, a numeric or alphanumeric identifier used to convey the outcome or status of a request, operation, or transaction in various systems and applications, typically indicating whether the action was successful, encountered an error, or resulted in a specific condition.Response status Code

success

boolean

optional

Response flag, boolean indicator used to signal a particular condition or state in the response of a system or application, often representing the presence or absence of certain conditions or outcomes.

data

object (DeleteSuccess)

optional

message

string

required

A message or data structure that is generated or returned when a deletion operation is successful.

code

number

required

A numerical or alphanumeric code that is used in various software and web development contexts to convey information about the outcome of a request or operation.

Example

{
    "status": 202,
    "success": true,
    "data": {
        "message": "The Object has been removed successfully",
        "code": 202
    }
}

🟠404Record Not Found

🟠422Error Validation

🟠401Unauthorized

Request

Request samples

Responses