Skip to main content
PUT
Update Channel

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string<uuid>
required

Body

application/json
pattern
string

Updated channel pattern

Minimum string length: 1
Example:

"order:%"

description
string

Updated description

Example:

"Updated order channel"

webhookUrls
string<uri>[]

Updated webhook URLs

Example:
enabled
boolean

Updated enabled status

Example:

false

Response

Channel updated successfully

id
string<uuid>
required

Unique identifier for the channel

Example:

"550e8400-e29b-41d4-a716-446655440000"

pattern
string
required

Channel pattern for subscription matching. Uses SQL LIKE wildcards, for example "order:%".

Minimum string length: 1
Example:

"order:%"

enabled
boolean
required

Whether the channel is currently active

Example:

true

createdAt
string<date-time>
required

Timestamp when the channel was created

Example:

"2024-01-15T10:30:00Z"

updatedAt
string<date-time>
required

Timestamp when the channel was last updated

Example:

"2024-01-15T10:30:00Z"

description
string | null

Human-readable description of the channel

Example:

"Order updates channel"

webhookUrls
string<uri>[] | null

URLs to receive webhook notifications for messages on this channel

Example: