channels

Update Channel

Changed on

Update account-level notification channel.

Updates an existing channel. Only provided fields are updated.

patch/api/v1/notifications/channels/{channel_id}

Request

  • Base URL
    https://platform.unstructuredapp.io
  • URL
    https://platform.unstructuredapp.io/api/v1/notifications/channels/{channel_id}
  • Auth
    none declared

Path parameters

channel_idstring required

Headers

unstructured-api-keystring nullable

Request body

channel_type'webhook' | 'email'

Notification delivery channel types.

descriptionstring nullable

Channel description

event_typesNotificationEventType[] nullable

Event types to subscribe to

enabledboolean nullable

Enable/disable channel

urlstring nullable

Webhook endpoint URL (HTTPS required)

secretstring nullable

Consumer-supplied signing secret (24-75 bytes). Pass empty string to remove custom secret.

Response

Successful Response

OR

Changes