Unsubscribe from Redirect Session events

DELETE 
/redirect-session-events/subscriptions/:eventSubscriptionId

Unsubscribe from Redirect Session 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. Used for defining which sub-element will be present in the details property.

message stringrequired

A short text describing the error.

moreInfo string

A link to the online documentation describing the error in detail.

correlationId uuid

Identifies the conversation within which the error got generated.

details

object

Contains additional details of the error

customerPermissionDeniedReason CustomerPermissionDeniedReason (string)

The reason for CustomerPermissionDenied declineReason

validationErrorReasons

object[]

A collection of Validation error details

Array [

fieldName string

name of filed that failed validation

errorMessage stringrequired

error message

]

limitThresholdExceededReason LimitThresholdExceededReason (string)

The reason for LimitThresholdExceeded declineReason

Example (from schema)

{
  "code": "InvalidTriggeredBy",
  "message": "The field \"customerId\" could not be validated.",
  "moreInfo": "https://developer.example.com/v1.0/reference#error-handling",
  "correlationId": "ce8056cd-ae4d-4f2d-87de-7562c92f92cc",
  "details": {
    "customerPermissionDeniedReason": "string",
    "validationErrorReasons": [
      {
        "fieldName": "customerId",
        "errorMessage": "Value must not be empty"
      }
    ],
    "limitThresholdExceededReason": "string"
  }
}

404

Subscription not found

application/json

Schema

Schema

code stringrequired

Possible values: [SubscriptionNotFound]

The type of error. Used for defining which sub-element will be present in the details property.

message stringrequired

A short text describing the error.

moreInfo string

A link to the online documentation describing the error in detail.

correlationId uuid

Identifies the conversation within which the error got generated.

details

object

Contains additional details of the error

customerPermissionDeniedReason CustomerPermissionDeniedReason (string)

The reason for CustomerPermissionDenied declineReason

validationErrorReasons

object[]

A collection of Validation error details

Array [

fieldName string

name of filed that failed validation

errorMessage stringrequired

error message

]

limitThresholdExceededReason LimitThresholdExceededReason (string)

The reason for LimitThresholdExceeded declineReason

Example (from schema)

{
  "code": "SubscriptionNotFound",
  "message": "The field \"customerId\" could not be validated.",
  "moreInfo": "https://developer.example.com/v1.0/reference#error-handling",
  "correlationId": "ce8056cd-ae4d-4f2d-87de-7562c92f92cc",
  "details": {
    "customerPermissionDeniedReason": "string",
    "validationErrorReasons": [
      {
        "fieldName": "customerId",
        "errorMessage": "Value must not be empty"
      }
    ],
    "limitThresholdExceededReason": "string"
  }
}

500

Unexpected technical error

application/json

Schema

Schema

code stringrequired

Possible values: [GeneralErrorOccurred]

The type of error. Used for defining which sub-element will be present in the details property.

message stringrequired

A short text describing the error.

moreInfo string

A link to the online documentation describing the error in detail.

correlationId uuid

Identifies the conversation within which the error got generated.

details

object

Contains additional details of the error

customerPermissionDeniedReason CustomerPermissionDeniedReason (string)

The reason for CustomerPermissionDenied declineReason

validationErrorReasons

object[]

A collection of Validation error details

Array [

fieldName string

name of filed that failed validation

errorMessage stringrequired

error message

]

limitThresholdExceededReason LimitThresholdExceededReason (string)

The reason for LimitThresholdExceeded declineReason

Example (from schema)

{
  "code": "GeneralErrorOccurred",
  "message": "The field \"customerId\" could not be validated.",
  "moreInfo": "https://developer.example.com/v1.0/reference#error-handling",
  "correlationId": "ce8056cd-ae4d-4f2d-87de-7562c92f92cc",
  "details": {
    "customerPermissionDeniedReason": "string",
    "validationErrorReasons": [
      {
        "fieldName": "customerId",
        "errorMessage": "Value must not be empty"
      }
    ],
    "limitThresholdExceededReason": "string"
  }
}

Loading...