Unsubscribe from Customer events

DELETE 
/customer-events/subscriptions/:eventSubscriptionId

Unsubscribe from Customer events

Request

Path Parameters

eventSubscriptionId stringrequired

The unique id of this subscription to be unsubscribed.

Responses

200

Webhook deleted

403

Operation forbidden

application/json

Schema

Schema

code stringrequired

Possible values: [InvalidTriggeredBy]

The type of error

message stringrequired

A short text describing the error

moreInfo string

A link to the online documentation describing the error in detail

correlationId string

Identifies the conversation within which the error got generated

details

object

Contains additional details of the error

validationErrorReasons

object[]

A collection of Validation error details

Array [

fieldName string

name of filed that failed validation

errorMessage stringrequired

error message

]

Example (from schema)

{
  "code": "InvalidTriggeredBy",
  "message": "string",
  "moreInfo": "https://developer.example.com/ExampleService/v1.0/errors/validation",
  "correlationId": "ce8056cd-ae4d-4f2d-87de-7562c92f92cc",
  "details": {
    "validationErrorReasons": [
      {
        "fieldName": "customerId",
        "errorMessage": "Value must not be empty"
      }
    ]
  }
}

404

Subscription not found

application/json

Schema

Schema

code stringrequired

Possible values: [SubscriptionNotFound]

The type of error

message stringrequired

A short text describing the error

moreInfo string

A link to the online documentation describing the error in detail

correlationId string

Identifies the conversation within which the error got generated

details

object

Contains additional details of the error

validationErrorReasons

object[]

A collection of Validation error details

Array [

fieldName string

name of filed that failed validation

errorMessage stringrequired

error message

]

Example (from schema)

{
  "code": "SubscriptionNotFound",
  "message": "string",
  "moreInfo": "https://developer.example.com/ExampleService/v1.0/errors/validation",
  "correlationId": "ce8056cd-ae4d-4f2d-87de-7562c92f92cc",
  "details": {
    "validationErrorReasons": [
      {
        "fieldName": "customerId",
        "errorMessage": "Value must not be empty"
      }
    ]
  }
}

500

Unexpected technical error

application/json

Schema

Schema

code stringrequired

Possible values: [GeneralErrorOccurred]

The type of error

message stringrequired

A short text describing the error

moreInfo string

A link to the online documentation describing the error in detail

correlationId string

Identifies the conversation within which the error got generated

details

object

Contains additional details of the error

validationErrorReasons

object[]

A collection of Validation error details

Array [

fieldName string

name of filed that failed validation

errorMessage stringrequired

error message

]

Example (from schema)

{
  "code": "GeneralErrorOccurred",
  "message": "string",
  "moreInfo": "https://developer.example.com/ExampleService/v1.0/errors/validation",
  "correlationId": "ce8056cd-ae4d-4f2d-87de-7562c92f92cc",
  "details": {
    "validationErrorReasons": [
      {
        "fieldName": "customerId",
        "errorMessage": "Value must not be empty"
      }
    ]
  }
}

Loading...