Update notification channel

PUT

/v1/notification-channels/{id}

curl --request PUT \
  --url https://example.com/v1/notification-channels/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <X-API-Key>' \
  --header 'X-Tenant-ID: 2489E9AD-2EE2-8E00-8EC9-32D5F69181C0' \
  --data '{ "name": "example", "config": {}, "enabled": true, "event_filters": [ "example" ] }'

Authorizations

• ApiKeyAuth

Parameters

Path Parameters

id

required

string format: uuid

Header Parameters

X-Tenant-ID

required

string format: uuid

Tenant identifier. Must match the tenant associated with the credential. Returns 403 tenant_mismatch if the credential and header belong to different tenants.

Request Body ^required

Media type application/json

object

name

string

config

Full replacement of provider config. Omit to keep existing config.

object

key

additional properties

any

enabled

boolean

event_filters

Full replacement of event filters. Omit to keep existing filters.

Array<string>

Example ^generated

{
  "name": "example",
  "config": {},
  "enabled": true,
  "event_filters": [
    "example"
  ]
}

Responses

200

OK

Media type application/json

object

id

required

string format: uuid

name

required

string

channel_type

required

Channel provider type. Immutable after creation.

string

Allowed values: email slack_webhook generic_webhook aws_sns slack_bot

config

required

Provider-specific configuration. Shape depends on channel_type.

object

key

additional properties

any

enabled

required

boolean

event_filters

required

Event names this channel subscribes to. Empty array means all events.

Array<string>

created_at

required

string format: date-time

updated_at

required

string format: date-time

Example

{
  "channel_type": "email"
}

400

Invalid input

Media type application/json

object

code

required

Machine-readable error code (e.g. “not_found”, “tenant_mismatch”).

string

message

required

Human-readable description of the error.

string

details

Optional additional context about the error.

object

key

additional properties

any

notices

Policy notices from determining Cedar rules, if applicable.

Array<string>

Example ^generated

{
  "code": "example",
  "message": "example",
  "details": {},
  "notices": [
    "example"
  ]
}

401

Unauthenticated

Media type application/json

object

code

required

Machine-readable error code (e.g. “not_found”, “tenant_mismatch”).

string

message

required

Human-readable description of the error.

string

details

Optional additional context about the error.

object

key

additional properties

any

notices

Policy notices from determining Cedar rules, if applicable.

Array<string>

Example ^generated

{
  "code": "example",
  "message": "example",
  "details": {},
  "notices": [
    "example"
  ]
}

403

Forbidden

Media type application/json

object

code

required

Machine-readable error code (e.g. “not_found”, “tenant_mismatch”).

string

message

required

Human-readable description of the error.

string

details

Optional additional context about the error.

object

key

additional properties

any

notices

Policy notices from determining Cedar rules, if applicable.

Array<string>

Example ^generated

{
  "code": "example",
  "message": "example",
  "details": {},
  "notices": [
    "example"
  ]
}

404

Not found

Media type application/json

object

code

required

Machine-readable error code (e.g. “not_found”, “tenant_mismatch”).

string

message

required

Human-readable description of the error.

string

details

Optional additional context about the error.

object

key

additional properties

any

notices

Policy notices from determining Cedar rules, if applicable.

Array<string>

Example ^generated

{
  "code": "example",
  "message": "example",
  "details": {},
  "notices": [
    "example"
  ]
}