Sign in

v4

latestSwagger 2.02026-08-0343714211.7 MB
event_channels
Event Channels

Update Event Channel

Update Event Channel

patch/event_channels/{id}

Path parameters

idinteger required

Event Channel ID.

Response

The EventChannels object.

idinteger

Event Channel ID

namestring

Event Channel name.

workspace_idinteger

Workspace ID. 0 means the default workspace.

descriptionstring

Event Channel description.

enabledboolean

Whether this Event Channel can dispatch events.

default_channelboolean

Whether this Event Channel is the default destination for newly published events.

created_atstring date-time

Event Channel create date/time.

updated_atstring date-time

Event Channel update date/time.

Example response

{
  "id": 1,
  "name": "example",
  "workspace_id": 1,
  "description": "example",
  "enabled": true,
  "default_channel": true,
  "created_at": "2000-01-01T01:00:00Z",
  "updated_at": "2000-01-01T01:00:00Z"
}