Update a channel

patchhttps://api.mentio.dev/v1/channels/{id}

Authentication

AuthorizationBearer <token>Required

An API key (mk_live_...) from the dashboard or an OAuth access token. See Authentication.

Path parameters

idstringRequired

Channel id (dest_...).

1 to ∞ characters

Body

application/json

labelstringOptional

Your name for the channel.

1 to 80 characters

urlstringOptional

Webhooks only.

uri

headersobjectOptional

Webhooks only; replaces the whole set.

eventsarray<string>Optional

Replaces the account events the channel receives; empty unsubscribes it from all. A webhook takes any; Slack, email and Telegram take the attention events only. See Account events.

0 to 12 items

+Show 12 enum values

keyword.cappedkeyword.paused_for_balancekeyword.resumedwallet.lowwallet.pausedwallet.resumedmention.spikesentiment.negative_spikekeyword.noisychannel.failingfeed.failingfeed.recovered

Response

200The updated channel

idstringRequired

Channel id (dest_...).

labelstringRequired

Your name for the channel.

statsobjectRequired

Computed over this workspace's deliveries.

+Show 4 properties

alertsintegerRequired

Alerts sending to this channel.

0 to ∞

activeAlertsintegerRequired

Of those, enabled ones; 0 means the channel receives nothing right now.

0 to ∞

lastDeliveryAtstringnullableRequired

Newest delivery attempt, successful or not.

last7dobjectRequired

Deliveries in the last 7 days.

+Show 2 properties

totalintegerRequired

Sends attempted.

0 to ∞

failedintegerRequired

Sends that failed.

0 to ∞

createdAtstringRequired

ISO 8601 timestamp, UTC.

kindstringRequired

Channel kind.

One ofslack

configobjectRequired

The channel's settings for its kind; secrets are never returned.

+Show 3 properties

channelIdstringRequired

Slack channel id.

channelNamestringRequired

Slack channel name, without the #.

eventsarray<string>Required

The attention events this channel receives on its own, no rule involved: one short message when an item opens (GET /v1/attention). Empty when it receives none.

+Show 6 enum values

mention.spikesentiment.negative_spikekeyword.noisychannel.failingfeed.failingfeed.recovered

400An event this kind of channel cannot receive: Slack, email and Telegram take the attention events only

+Show 1 property

errorobjectRequired

The error.

+Show 4 properties

codestringRequired

Stable machine-readable code; branch on this, never on the message. Codes are additive: a client should treat one it does not know as a generic failure of the same status.

+Show 46 enum values

unauthorizedforbiddenread_only_keyvalidation_errornot_foundinvalid_cursorpayload_too_largeidempotency_key_in_useidempotency_key_reusedrate_limitedduplicate_keywordinsufficient_balancekeyword_limit_reachedbilling_not_configuredorder_not_creditedschedule_requiredunknown_channelnot_a_digesthourly_email_unsupportedslack_not_connectedslack_not_configuredtelegram_not_configuredfeed_unreadablefeed_login_requiredfeed_login_expiredfeed_limit_reachedfeed_auth_not_configuredemail_not_configuredinvalid_assigneeclassification_pendinginvalid_memberalready_memberlast_ownerduplicate_segmentfilter_too_complexduplicate_viewduplicate_groupdefault_groupdefault_group_contextgroup_changedinvalid_signaturewebhook_not_configuredinvalid_tokenprotected_userupstream_unavailableinternal_error

messagestringRequired

Human-readable detail; may change between releases.

requestIdstringOptional

The id of this request (also the X-Request-Id response header); quote it to support.

retryAfterSecondsintegerOptional

For rate_limited and other retryable errors: how long to wait before retrying (mirrors the Retry-After header).

401Missing or invalid API key

+Show 1 property

errorobjectRequired

The error.

+Show 4 properties

codestringRequired

Stable machine-readable code; branch on this, never on the message. Codes are additive: a client should treat one it does not know as a generic failure of the same status.

+Show 46 enum values

messagestringRequired

Human-readable detail; may change between releases.

requestIdstringOptional

The id of this request (also the X-Request-Id response header); quote it to support.

retryAfterSecondsintegerOptional

For rate_limited and other retryable errors: how long to wait before retrying (mirrors the Retry-After header).

404Channel not found

+Show 1 property

errorobjectRequired

The error.

+Show 4 properties

codestringRequired

Stable machine-readable code; branch on this, never on the message. Codes are additive: a client should treat one it does not know as a generic failure of the same status.

+Show 46 enum values

messagestringRequired

Human-readable detail; may change between releases.

requestIdstringOptional

The id of this request (also the X-Request-Id response header); quote it to support.

retryAfterSecondsintegerOptional

For rate_limited and other retryable errors: how long to wait before retrying (mirrors the Retry-After header).

https://api.mentio.dev/v1/channels/{id}

const response = await fetch('https://api.mentio.dev/v1/channels/{id}', {
  method: 'PATCH',
  headers: {
    Authorization: `Bearer ${process.env.MENTIO_API_KEY}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "label": "string",
    "url": "https://example.com",
    "headers": {}
  }),
});

const data = await response.json();
console.log(data);

Response

{
  "id": "string",
  "label": "string",
  "stats": {
    "alerts": 0,
    "activeAlerts": 0,
    "lastDeliveryAt": "string",
    "last7d": {
      "total": 0,
      "failed": 0
    }
  },
  "createdAt": "string",
  "kind": "slack",
  "config": {
    "channelId": "string",
    "channelName": "string",
    "events": [
      "mention.spike"
    ]
  }
}

View as Markdown Ask ChatGPT about this page Ask Claude about this page OpenAPI specification Get an API key