EmailGuard

API reference

Download spec
put

Update notification channel

Updates a channel's display name or configuration. Send only fields you want to change.

Required API key scope
notifications:update
/api/v1/team/notifications/channels/{channelId}

Code samples

curl --request PUT \
  --url https://api.emailguard.co/api/v1/team/notifications/channels/YOUR_ID \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{}'

Parameters

Path parameters

NameTypeDescription
channelIdrequiredstring

UUID of the notification channel to update

Request body

Updated channel name and/or configuration

configobject

Updated type-specific configuration. Omit to leave unchanged.

namestring

Updated display name. Omit to leave unchanged.

Responses

200
OK
OK
codestringrequired

Machine-readable status code (for example OK or INVALID_BODY).

configobject

Type-specific configuration. Sensitive values may be redacted in responses.

created_atstring

When the channel was created (RFC3339).

idstring

Channel record ID.

is_verifiedboolean

Whether the channel has completed verification (email link or webhook test).

namestring

Display name in notification settings.

typestring

Channel type (for example email or webhook).

messagestring

Human-readable detail when the code is not OK.

400
Bad Request
Bad Request
codestringrequired

Machine-readable status code (for example OK or INVALID_BODY).

messagestring

Human-readable detail when the code is not OK.

401
Unauthorized
Unauthorized
codestringrequired

Machine-readable status code (for example OK or INVALID_BODY).

messagestring

Human-readable detail when the code is not OK.

403
Forbidden
Forbidden
codestringrequired

Machine-readable status code (for example OK or INVALID_BODY).

messagestring

Human-readable detail when the code is not OK.