/channels/{id} (PATCH)

PATCH

/channels/{id}

curl --request PATCH \
  --url https://culipulse.dev/v1/channels/mon_123 \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "name": "example", "enabled": true, "all_monitors": true, "monitor_ids": [ "example" ] }'

• Production

Authorizations

• bearerAuth
  write

Parameters

Path Parameters

id

required

string

Example

mon_123

Request Body

Media typeapplication/json

Changing type or sending url returns 400. Delete and recreate the channel instead.

object

name

string

enabled

boolean

all_monitors

boolean

monitor_ids

Replaces the whole routing list, atomically: a failed request leaves the previous list untouched. Duplicates and ids that are not yours are ignored. More distinct ids than your plan’s monitor limit (or than the monitors you own, if that is higher) returns 400 too_many_monitors.

Array<string>

Example^generated

{
  "name": "example",
  "enabled": true,
  "all_monitors": true,
  "monitor_ids": [
    "example"
  ]
}

Responses

200

Updated

Media typeapplication/json

object

ok

required

boolean

Example

{
  "ok": true
}

400

Invalid request, or more monitor ids than the plan allows (code: too_many_monitors)

Media typeapplication/json

object

error

required

string

request_id

string

code

Present on some 400s so a client can branch without parsing error. Known values: channel_limit_reached, too_many_monitors, duplicate_webhook_url.

string

field

The request field the error is about, when there is one.

string

limit

The limit that was hit, when code names one.

integer

Example

{
  "error": "not found",
  "request_id": "req_abc123",
  "code": "channel_limit_reached"
}

404

Not found

Media typeapplication/json

object

error

required

string

request_id

string

code

Present on some 400s so a client can branch without parsing error. Known values: channel_limit_reached, too_many_monitors, duplicate_webhook_url.

string

field

The request field the error is about, when there is one.

string

limit

The limit that was hit, when code names one.

integer

Example

{
  "error": "not found",
  "request_id": "req_abc123",
  "code": "channel_limit_reached"
}