Skip to main content
POST
Send a test message through a channel

Authorizations

Authorization
string
header
required

A Barndoor API key, sent as Authorization: Bearer <key>. Keys are prefixed bdai_ and are opaque — do not attempt to decode one. Interchangeable with an OAuth 2.0 access token.

Path Parameters

channel_id
string<uuid>
required

Response

Successful Response

Result of sending a stock connectivity-test message through a channel's real transport.

Delivery failure is reported here as ok: false with a 200 status, not as an HTTP error: the request to test succeeded, the transport is what failed.

ok
boolean
required

Whether the test message reached the destination transport.

error
string | null

Why delivery failed, when ok is false. null on success.