Send a test to a channel

posthttps://api.mentio.dev/v1/channels/{id}/test

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

Header parameters

idempotency-keystringOptional

A unique value (a UUID) for this request. Retrying with the same key within 24 hours returns the first response instead of creating twice.

1 to 255 characters

Response

200A test message was attempted on the channel (webhooks receive event "test")

outcomesarray<object>Required

The test send's result.

+Show 3 properties

channelIdstringRequired

The channel (dest_...).

okbooleanRequired

Whether the channel accepted it.

errorstringnullableRequired

Why it failed; null when it did not.

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

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).

404Channel not found