Webhooks

Update Webhooks

patch/v1/Webhooks({ID})

Request

  • Base URL: https://api.channeladvisor.com
  • URL: https://api.channeladvisor.com/v1/Webhooks({ID})
  • Auth: OAuth 2 (authorization code, authorization URL https://api.channeladvisor.com/oauth2/authorize, token URL https://api.channeladvisor.com/oauth2/token; implicit, authorization URL https://api.channeladvisor.com/oauth2/authorize, scopes: orders, inventory) and HTTP bearer

Path parameters

IDnumber required

The unique identifier of Webhook

Request body

Namestring nullable
Status'Deleted' | 'Enabled' | 'Disabled' | 'Suspended'
WebhookUristring nullable
EventTypesChannelAdvisorRestApiV1ModelsWebhookEventType[]

Example request

{
  "Name": "string",
  "Status": "Deleted",
  "WebhookUri": "string",
  "EventTypes": [
    "Unknown"
  ]
}

Response

Success

Changes

No recorded changes to this operation across all 1 revision of this API.