RevKeenDocs
StatusSupport
API Reference

Send a message

Send a direct message to a customer via email, SMS, or WhatsApp --- **Related endpoints** - `GET /comms/threads` — List conversation threads - `GET /comms/threads/{threadId}/messages` — List messages in a thread **Common errors** - `400 invalid_request` — malformed payload or failed validation. **Idempotency** Pass an `Idempotency-Key` header (UUID v4 recommended) to make retries safe. Keys are valid for 24 hours; see [the idempotency guide](/docs/fundamentals/idempotency).

POST
/comms/send

Send a direct message to a customer via email, SMS, or WhatsApp

Related endpoints

  • GET /comms/threads — List conversation threads
  • GET /comms/threads/{threadId}/messages — List messages in a thread

Common errors

  • 400 invalid_request — malformed payload or failed validation.

Idempotency

Pass an Idempotency-Key header (UUID v4 recommended) to make retries safe. Keys are valid for 24 hours; see the idempotency guide.

Authorization

x-api-key<token>

Your RevKeen merchant API key. Create and manage keys in Dashboard → Settings → Developer. Use rk_sandbox_* for staging/test and rk_live_* for production. The same key may be sent as Authorization: Bearer <key> if that suits your HTTP client better. A missing, invalid, expired, or revoked key returns 401 with a WWW-Authenticate: Bearer challenge; a valid key without the required scope returns 403.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

Stuck on an error response? Ask the RevKeen assistant to explain it.
curl -X POST "https://api.revkeen.com/v2/comms/send" \
  -H "x-api-key: $REVKEEN_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "channel": "email",
    "body": "string"
  }'
{  "success": true,  "conversation_id": "cc71b11a-25cd-4c2d-9950-df2cc38e3407",  "message_id": "d7d9d9fd-478f-40e6-b651-49b7f19878a2",  "notification_id": "f96afe21-aef9-465c-a9f6-813055655b04",  "customer_id": "160c0c4b-9966-4dc1-a916-8407eb10d74e"}

List messages in a thread GET

List all messages in a conversation thread --- **Related endpoints** - `POST /comms/send` — Send a message - `GET /comms/threads` — List conversation threads **Common errors** - `404 resource_missing` — the referenced resource does not exist or is not visible to your key. **Pagination** Offset-based with `limit` (default 25, max 100) and `offset`. The response `pagination` block includes `total` and `hasMore`. See [the pagination guide](/docs/fundamentals/pagination) for SDK auto-paging helpers.

List conversation threads GET

List conversation threads for the authenticated merchant --- **Related endpoints** - `POST /comms/send` — Send a message - `GET /comms/threads/{threadId}/messages` — List messages in a thread **Pagination** Offset-based with `limit` (default 25, max 100) and `offset`. The response `pagination` block includes `total` and `hasMore`. See [the pagination guide](/docs/fundamentals/pagination) for SDK auto-paging helpers.