Deletes a webhook subscription.

  • Published on Feb 20, 2025
  • 7 minute(s) read
Prev Next
Delete
/subscriptions/{subscription_id}

Deletes an existing webhook subscription.

Security
OAuth

OAuth Grant type, Private JWT

FlowClient Credentials
Token URL$(host)/oauth/token
Scopes:
subscriptions.deleteDelete Access - private_key_jwt
Header parameters
x-client-id
stringRequired

Identifies the client of the api

Min length36
Max length36
Pattern^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$
Examplea1b30a84-7bf3-442e-84a0-e935d8163b5a
Path parameters
subscription_id
stringRequired

Identifies a subscription for the current client

Min length36
Max length36
Pattern^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$
Example2507b89c-b680-46df-9505-e0b6f78cf295
Responses
204

No content

400

Bad request

err400Example
{
  "errors": [
    {
      "code": "BAD_REQUEST",
      "level": "FATAL",
      "message": "Bad Request",
      "description": "Error validating schema"
    }
  ]
}
Expand All
object

Data structure containing the details for errors

errors
Array of object (Error)

Array of errors

Min items1
Max items50
object

Data structure containing the error details

code
string

Unique alphanumeric human readable error code

Min length1
Max length255
Pattern^[a-zA-Z_0-9 ]*$
ExampleCODE
message
string

Brief summary of the reported issue

Min length1
Max length255
Pattern^[a-zA-Z0-9. /_-]*$
ExampleJSON invalid
level
string

Level of the reported issue.

The possible values are:

  • ERROR
  • FATAL
  • INFO
  • WARNING
Valid values[ "ERROR", "FATAL", "INFO", "WARNING" ]
ExampleERROR
description
string

Detailed description of the reported issue

Min length1
Max length255
ExampleJSON invalid
401

Unauthorized

err401Example
{
  "errors": [
    {
      "code": "UNAUTHORIZED",
      "message": "Unauthorized",
      "level": "ERROR",
      "description": "Authorization credentials are missing or invalid"
    }
  ]
}
Expand All
object

Data structure containing the details for errors

errors
Array of object (Error)

Array of errors

Min items1
Max items50
object

Data structure containing the error details

code
string

Unique alphanumeric human readable error code

Min length1
Max length255
Pattern^[a-zA-Z_0-9 ]*$
ExampleCODE
message
string

Brief summary of the reported issue

Min length1
Max length255
Pattern^[a-zA-Z0-9. /_-]*$
ExampleJSON invalid
level
string

Level of the reported issue.

The possible values are:

  • ERROR
  • FATAL
  • INFO
  • WARNING
Valid values[ "ERROR", "FATAL", "INFO", "WARNING" ]
ExampleERROR
description
string

Detailed description of the reported issue

Min length1
Max length255
ExampleJSON invalid
403

Forbidden

err403Example
{
  "errors": [
    {
      "code": "FORBIDDEN",
      "level": "FATAL",
      "message": "Forbidden",
      "description": "Logged in user is not authorized to access data"
    }
  ]
}
Expand All
object

Data structure containing the details for errors

errors
Array of object (Error)

Array of errors

Min items1
Max items50
object

Data structure containing the error details

code
string

Unique alphanumeric human readable error code

Min length1
Max length255
Pattern^[a-zA-Z_0-9 ]*$
ExampleCODE
message
string

Brief summary of the reported issue

Min length1
Max length255
Pattern^[a-zA-Z0-9. /_-]*$
ExampleJSON invalid
level
string

Level of the reported issue.

The possible values are:

  • ERROR
  • FATAL
  • INFO
  • WARNING
Valid values[ "ERROR", "FATAL", "INFO", "WARNING" ]
ExampleERROR
description
string

Detailed description of the reported issue

Min length1
Max length255
ExampleJSON invalid
404

Not found

err404Example
{
  "errors": [
    {
      "code": "NOT_FOUND",
      "level": "FATAL",
      "message": "Not Found",
      "description": "Requested resource was not found but may be available later"
    }
  ]
}
Expand All
object

Data structure containing the details for errors

errors
Array of object (Error)

Array of errors

Min items1
Max items50
object

Data structure containing the error details

code
string

Unique alphanumeric human readable error code

Min length1
Max length255
Pattern^[a-zA-Z_0-9 ]*$
ExampleCODE
message
string

Brief summary of the reported issue

Min length1
Max length255
Pattern^[a-zA-Z0-9. /_-]*$
ExampleJSON invalid
level
string

Level of the reported issue.

The possible values are:

  • ERROR
  • FATAL
  • INFO
  • WARNING
Valid values[ "ERROR", "FATAL", "INFO", "WARNING" ]
ExampleERROR
description
string

Detailed description of the reported issue

Min length1
Max length255
ExampleJSON invalid
406

Not acceptable

err406Example
{
  "errors": [
    {
      "code": "NOT_ACCEPTABLE",
      "level": "FATAL",
      "message": "Not Acceptable",
      "description": "Request content not acceptable"
    }
  ]
}
Expand All
object

Data structure containing the details for errors

errors
Array of object (Error)

Array of errors

Min items1
Max items50
object

Data structure containing the error details

code
string

Unique alphanumeric human readable error code

Min length1
Max length255
Pattern^[a-zA-Z_0-9 ]*$
ExampleCODE
message
string

Brief summary of the reported issue

Min length1
Max length255
Pattern^[a-zA-Z0-9. /_-]*$
ExampleJSON invalid
level
string

Level of the reported issue.

The possible values are:

  • ERROR
  • FATAL
  • INFO
  • WARNING
Valid values[ "ERROR", "FATAL", "INFO", "WARNING" ]
ExampleERROR
description
string

Detailed description of the reported issue

Min length1
Max length255
ExampleJSON invalid
409

Conflict

err409Example
{
  "errors": [
    {
      "code": "CONFLICT",
      "level": "FATAL",
      "message": "Conflict",
      "description": "Request conflicts with the current state of the target resource"
    }
  ]
}
Expand All
object

Data structure containing the details for errors

errors
Array of object (Error)

Array of errors

Min items1
Max items50
object

Data structure containing the error details

code
string

Unique alphanumeric human readable error code

Min length1
Max length255
Pattern^[a-zA-Z_0-9 ]*$
ExampleCODE
message
string

Brief summary of the reported issue

Min length1
Max length255
Pattern^[a-zA-Z0-9. /_-]*$
ExampleJSON invalid
level
string

Level of the reported issue.

The possible values are:

  • ERROR
  • FATAL
  • INFO
  • WARNING
Valid values[ "ERROR", "FATAL", "INFO", "WARNING" ]
ExampleERROR
description
string

Detailed description of the reported issue

Min length1
Max length255
ExampleJSON invalid
414

URI too long

err414Example
{
  "errors": [
    {
      "code": "URI_TOO_LONG",
      "level": "FATAL",
      "message": "URI Too Long",
      "description": "URI is longer than the maximum size allowed by the server"
    }
  ]
}
Expand All
object

Data structure containing the details for errors

errors
Array of object (Error)

Array of errors

Min items1
Max items50
object

Data structure containing the error details

code
string

Unique alphanumeric human readable error code

Min length1
Max length255
Pattern^[a-zA-Z_0-9 ]*$
ExampleCODE
message
string

Brief summary of the reported issue

Min length1
Max length255
Pattern^[a-zA-Z0-9. /_-]*$
ExampleJSON invalid
level
string

Level of the reported issue.

The possible values are:

  • ERROR
  • FATAL
  • INFO
  • WARNING
Valid values[ "ERROR", "FATAL", "INFO", "WARNING" ]
ExampleERROR
description
string

Detailed description of the reported issue

Min length1
Max length255
ExampleJSON invalid
422

Unprocessable entity

err422Example
{
  "errors": [
    {
      "code": "UNPROCESSABLE_ENTITY",
      "level": "FATAL",
      "message": "Unprocessable Entity",
      "description": "Request was well formed but there are semantic errors"
    }
  ]
}
Expand All
object

Data structure containing the details for errors

errors
Array of object (Error)

Array of errors

Min items1
Max items50
object

Data structure containing the error details

code
string

Unique alphanumeric human readable error code

Min length1
Max length255
Pattern^[a-zA-Z_0-9 ]*$
ExampleCODE
message
string

Brief summary of the reported issue

Min length1
Max length255
Pattern^[a-zA-Z0-9. /_-]*$
ExampleJSON invalid
level
string

Level of the reported issue.

The possible values are:

  • ERROR
  • FATAL
  • INFO
  • WARNING
Valid values[ "ERROR", "FATAL", "INFO", "WARNING" ]
ExampleERROR
description
string

Detailed description of the reported issue

Min length1
Max length255
ExampleJSON invalid
429

Too many requests

err429Example
{
  "errors": [
    {
      "code": "TOO_MANY_REQUESTS",
      "level": "ERROR",
      "message": "Too Many Requests",
      "description": "User has sent too many requests"
    }
  ]
}
Expand All
object

Data structure containing the details for errors

errors
Array of object (Error)

Array of errors

Min items1
Max items50
object

Data structure containing the error details

code
string

Unique alphanumeric human readable error code

Min length1
Max length255
Pattern^[a-zA-Z_0-9 ]*$
ExampleCODE
message
string

Brief summary of the reported issue

Min length1
Max length255
Pattern^[a-zA-Z0-9. /_-]*$
ExampleJSON invalid
level
string

Level of the reported issue.

The possible values are:

  • ERROR
  • FATAL
  • INFO
  • WARNING
Valid values[ "ERROR", "FATAL", "INFO", "WARNING" ]
ExampleERROR
description
string

Detailed description of the reported issue

Min length1
Max length255
ExampleJSON invalid
500

Internal server error

err500Example
{
  "errors": [
    {
      "code": "INTERNAL_SERVER_ERROR",
      "level": "FATAL",
      "message": "Internal server error",
      "description": "Server has encountered an error"
    }
  ]
}
Expand All
object

Data structure containing the details for errors

errors
Array of object (Error)

Array of errors

Min items1
Max items50
object

Data structure containing the error details

code
string

Unique alphanumeric human readable error code

Min length1
Max length255
Pattern^[a-zA-Z_0-9 ]*$
ExampleCODE
message
string

Brief summary of the reported issue

Min length1
Max length255
Pattern^[a-zA-Z0-9. /_-]*$
ExampleJSON invalid
level
string

Level of the reported issue.

The possible values are:

  • ERROR
  • FATAL
  • INFO
  • WARNING
Valid values[ "ERROR", "FATAL", "INFO", "WARNING" ]
ExampleERROR
description
string

Detailed description of the reported issue

Min length1
Max length255
ExampleJSON invalid
503

Service unavailable

err503Example
{
  "errors": [
    {
      "code": "SERVICE_UNAVAILABLE",
      "level": "ERROR",
      "message": "Service unavailable",
      "description": "Server is not ready to handle the request"
    }
  ]
}
Expand All
object

Data structure containing the details for errors

errors
Array of object (Error)

Array of errors

Min items1
Max items50
object

Data structure containing the error details

code
string

Unique alphanumeric human readable error code

Min length1
Max length255
Pattern^[a-zA-Z_0-9 ]*$
ExampleCODE
message
string

Brief summary of the reported issue

Min length1
Max length255
Pattern^[a-zA-Z0-9. /_-]*$
ExampleJSON invalid
level
string

Level of the reported issue.

The possible values are:

  • ERROR
  • FATAL
  • INFO
  • WARNING
Valid values[ "ERROR", "FATAL", "INFO", "WARNING" ]
ExampleERROR
description
string

Detailed description of the reported issue

Min length1
Max length255
ExampleJSON invalid
504

Gateway timeout

err504Example
{
  "errors": [
    {
      "code": "GATEWAY_TIMEOUT",
      "level": "ERROR",
      "message": "Gateway timeout",
      "description": "Server cannot get a gateway response in time"
    }
  ]
}
Expand All
object

Data structure containing the details for errors

errors
Array of object (Error)

Array of errors

Min items1
Max items50
object

Data structure containing the error details

code
string

Unique alphanumeric human readable error code

Min length1
Max length255
Pattern^[a-zA-Z_0-9 ]*$
ExampleCODE
message
string

Brief summary of the reported issue

Min length1
Max length255
Pattern^[a-zA-Z0-9. /_-]*$
ExampleJSON invalid
level
string

Level of the reported issue.

The possible values are:

  • ERROR
  • FATAL
  • INFO
  • WARNING
Valid values[ "ERROR", "FATAL", "INFO", "WARNING" ]
ExampleERROR
description
string

Detailed description of the reported issue

Min length1
Max length255
ExampleJSON invalid
default

Default error

errDefaultExample
{
  "errors": [
    {
      "code": "Error code",
      "level": "ERROR",
      "message": "Error message",
      "description": "Error description"
    }
  ]
}
Expand All
object

Data structure containing the details for errors

errors
Array of object (Error)

Array of errors

Min items1
Max items50
object

Data structure containing the error details

code
string

Unique alphanumeric human readable error code

Min length1
Max length255
Pattern^[a-zA-Z_0-9 ]*$
ExampleCODE
message
string

Brief summary of the reported issue

Min length1
Max length255
Pattern^[a-zA-Z0-9. /_-]*$
ExampleJSON invalid
level
string

Level of the reported issue.

The possible values are:

  • ERROR
  • FATAL
  • INFO
  • WARNING
Valid values[ "ERROR", "FATAL", "INFO", "WARNING" ]
ExampleERROR
description
string

Detailed description of the reported issue

Min length1
Max length255
ExampleJSON invalid