Sign in
Channel Endpoints

Update a channel endpoint

Update an existing channel endpoint by its unique identifier.

patch/v1/channel-endpoints/{identifier}

Path parameters

identifierstring required

The unique identifier of the channel endpoint

Request body

Example request

{
  "endpoint": {
    "channelId": "C123456789"
  }
}

Response

OK

identifierstring required

The unique identifier of the channel endpoint.

channel'in_app' | 'email' | 'sms' | 'chat' | 'push' | 'tool' nullable required

The channel type (email, sms, push, chat, etc.).

providerId'anypost' | 'emailjs' | 'mailgun' | 'mailjet' | 'mandrill' | 'nodemailer' | 'postmark' | 'sendgrid' | 'sendinblue' | 'ses' | 'netcore' | 'infobip-email' | 'resend' | 'plunk' | 'mailersend' | 'mailtrap' | 'clickatell' | 'outlook365' | 'novu-email' | 'sparkpost' | 'email-webhook' | 'braze' | 'novu-email-agent' | 'nexmo' | 'plivo' | 'sms77' | 'sms-central' | 'sns' | 'telnyx' | 'twilio' | 'gupshup' | 'firetext' | 'infobip-sms' | 'burst-sms' | 'bulk-sms' | 'isend-sms' | 'forty-six-elks' | 'kannel' | 'maqsam' | 'termii' | 'africas-talking' | 'novu-sms' | 'sendchamp' | 'generic-sms' | 'clicksend' | 'bandwidth' | 'messagebird' | 'simpletexting' | 'azure-sms' | 'ring-central' | 'brevo-sms' | 'eazy-sms' | 'mobishastra' | 'afro-message' | 'unifonic' | 'smsmode' | 'imedia' | 'sinch' | 'isendpro-sms' | 'cm-telecom' | 'ruach-sms' | 'fcm' | 'apns' | 'expo' | 'one-signal' | 'pushpad' | 'push-webhook' | 'pusher-beams' | 'appio' | 'novu' | 'slack' | 'discord' | 'msteams' | 'webex-messaging' | 'mattermost' | 'ryver' | 'zulip' | 'grafana-on-call' | 'getstream' | 'rocket-chat' | 'whatsapp-business' | 'line' | 'chat-webhook' | 'novu-slack' | 'telegram' | 'sendblue' | 'novu-web-chat' | 'anthropic' | 'novu-anthropic' | 'anthropic-aws' | 'pagerduty' | 'opsgenie' | 'grafana' | 'tool-webhook' nullable required

The provider identifier (e.g., sendgrid, twilio, slack, etc.).

integrationIdentifierstring nullable required

The identifier of the integration to use for this channel endpoint.

connectionIdentifierstring nullable required

The identifier of the channel connection used for this endpoint.

subscriberIdstring nullable required

The subscriber ID to which the channel endpoint is linked

contextKeysstring[] required

The context of the channel connection

type'slack_channel' | 'slack_user' | 'webhook' | 'phone' | 'ms_teams_channel' | 'ms_teams_user' | 'telegram_chat' | 'webex_room' | 'webex_person' | 'line_user' | 'pagerduty_service' | 'opsgenie_integration' | 'grafana_oncall_integration' | 'tool_webhook' required

Type of channel endpoint

createdAtstring required

The timestamp indicating when the channel endpoint was created, in ISO 8601 format.

updatedAtstring required

The timestamp indicating when the channel endpoint was last updated, in ISO 8601 format.

Example response

{
  "providerId": "slack",
  "integrationIdentifier": "slack-prod",
  "connectionIdentifier": "slack-connection-abc123",
  "subscriberId": "subscriber-123",
  "contextKeys": [
    "tenant:org-123",
    "region:us-east-1"
  ],
  "type": "slack_channel",
  "endpoint": {
    "channelId": "C123456789"
  }
}

Changes

Changed in 5 of the 13 revisions of this API.2204

  • 8bc1670bbd1311See the full diff
    • ●

      added the new novu-web-chat enum value to the response property for the response status

      response-property-enum-value-added

    • ○

      removed the novu-agent-chat enum value from the response property for the response status

      response-property-enum-value-removed

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • d7137c47680a11See the full diff
    • ●

      added the new novu-agent-chat enum value to the response property for the response status

      response-property-enum-value-added

    • ○

      removed the novu-web-chat enum value from the response property for the response status

      response-property-enum-value-removed

  • 47f16ff4d427141See the full diff
    • ▲

      added to the response property oneOf list for the response status

      response-property-one-of-added

    • ●

      added the new grafana enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new grafana_oncall_integration enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new novu-web-chat enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new tool_webhook enum value to the response property for the response status

      response-property-enum-value-added

    • ○

      added to the request property oneOf list

      request-property-one-of-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • d48666bd89141See the full diff
    • ●

      added the new ruach-sms enum value to the response property for the response status

      response-property-enum-value-added

  • 2e115ea8160c1131See the full diff
    • ▲

      added to the response property oneOf list for the response status

      response-property-one-of-added

    • ●

      added the new anypost enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new line enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new line_user enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new opsgenie enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new opsgenie_integration enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new pagerduty enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new pagerduty_service enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new sendblue enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new tool enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new tool-webhook enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new webex-messaging enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new webex_person enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new webex_room enum value to the response property for the response status

      response-property-enum-value-added

    • ○

      added to the request property oneOf list

      request-property-one-of-added