[lightMode]

Deactivate Webhook

DELETE/webhooks/unsubscribe

[updatedIn] 2 months ago

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

:::tip[Note]

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

:::

:::caution[Alert]

Using url will delete all registered webhooks to this URL.
:::

`webhooks.read_write`- Webhooks Read & Write

Request

Authorization: OAuth 2.0

Add the parameter

Authorization

to [header]，whose value is to concatenate the Token after the Bearer.

[api.label.example]

Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c

[message.queryParameter]

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.

Request samples

[api.label.responses]

Object Deleted Successfully.(202)

Record Not Found(404)

Error Validation(422)

Object Deleted Successfully.

HTTP Code: 202

Content Type : JSONapplication/json

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.

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

[updatedIn] 2 months ago