Skip to content

Update a notification channel

Change a channel's name, events, configuration or whether it is on.

Updated

patch

https://cloud.cahaves.com/api/notification-channels/{id}

Authorization

cahaves.cloud.sessionstringcookierequired

The session cookie Cloud sets when a customer signs in to the console with GitHub or Google. It is HttpOnly, so scripts cannot read it, and there are no API keys or tokens yet.

Path parameters

idstring<uuid>required

Example: "a1c3e5f7-9b1d-4f3a-8c5e-7a9b1d3f5a7c"

Headers

X-Cloud-Organizationstring<uuid>

The id of the organization the request works in, one the signed-in customer owns. Left out or empty, the request works in their oldest organization. Any other value answers 404 with `reason: "organization"`. A customer with no organization yet gets 409 "Create an organization first." from every route that works in one.

Example: "2f6c8e0a-4b1d-4e7f-9a3c-5d7e9f1b3a5c"

Body

application/jsonrequired

namestring

configobject

The shape follows the channel's kind.

eventsstring[]

enabledboolean

Responses

application/json

The channel.

notification_channelobjectrequired

Sending config replaces the stored configuration as a whole.