Quick Start - Notifique

From zero to your first RCS in the queue in a few steps. Start with sk_test_... in Sandbox. Not every device receives RCS, keep SMS as plan B.

In short

Send RCS to one or more numbers in international format (E.164, no +).
Query a send by the id returned in the response.
Cancel only while status is QUEUED or SCHEDULED.

Each RCS message consumes 60 credits. Context: Introduction. Scopes: API Key scopes.

Before you start

Key with rcs:send (and rcs:read / rcs:cancel to query or cancel)
Numbers in E.164 (e.g. 5511999999999, no +)
Auth: Authorization: Bearer sk_live_... or x-api-key
Base URL: https://api.notifique.dev

1. Send RCS

Two paths, pick what fits your integration:

1A, Via dashboard

RCS → New send
Choose type (BASIC, CARD, etc.) and fill content
Enter number(s) and dispatch

1B, Via API

to is always an array (up to 100 recipients). One message is created per number.

POST /v1/rcs/messages
Content-Type: application/json
Authorization: Bearer sk_live_xxxxx

{
  "to": ["5511999999999"],
  "type": "basic",
  "payload": {
    "message": "Hello! This is a simple text RCS test."
  }
}

Expected response: 202

{
  "success": true,
  "data": {
    "status": "QUEUED",
    "count": 1,
    "messageIds": ["clrcs1..."],
    "rcsIds": ["clrcs1..."]
  }
}

messageIds is the canonical field; rcsIds is a compatibility alias. Scope: rcs:send.

Send with template

{
  "to": ["5511999999999"],
  "type": "template",
  "payload": {
    "templateId": "TEMPLATE_ID",
    "variables": { "code": "482910" }
  }
}

See template-api. Lowercase type is canonical. Uppercase messageType alias (e.g. "BASIC") is still accepted. Schedule, include "schedule": { "sendAt": "2026-12-31T14:00:00.000Z" } (plan-dependent). In options: priority, per-send webhook (url + secret), metadata.

2. Other types (CARD, CAROUSEL, FILE)

Change type and payload. CARD example:

{
  "to": ["5511999999999"],
  "type": "card",
  "payload": {
    "message": "Check out our promotion",
    "cardImage": "https://yoursite.com/image.jpg",
    "cardTitle": "Special offer",
    "cardMessage": "Valid until Sunday",
    "buttons": [
      { "text": "View offer", "url": "https://yoursite.com/promo" }
    ]
  }
}

CAROUSEL and FILE payloads: API reference on the RCS tab.

3. Query status

GET /v1/rcs/messages/:id
Authorization: Bearer sk_live_xxxxx

Expected response: 200

{
  "success": true,
  "data": {
    "rcsId": "clrcs1...",
    "to": "5511999999999",
    "messageType": "BASIC",
    "status": "DELIVERED",
    "sentAt": "2025-02-20T14:00:00.000Z",
    "deliveredAt": "2025-02-20T14:00:30.000Z"
  }
}

Scope: rcs:read.

4. Cancel

Only with status QUEUED or SCHEDULED:

POST /v1/rcs/messages/:id/cancel
Authorization: Bearer sk_live_xxxxx

If already SENT or DELIVERED, the API returns 400. Scheduled credits return to the workspace when applicable. Scope: rcs:cancel.

5. Avoid duplicates

Idempotency-Key header on the send POST. Repeats within 24 h do not create duplicate sends. See Security and reliability.

6. Webhooks (optional)

Configure rcs.sent, rcs.delivered, rcs.clicked, rcs.failed, and rcs.cancelled to track without polling. Guide: Webhook events.

All send types

In the API reference (RCS tab), open Send RCS and pick an example in the playground: Basic, Card, Carousel, File, Template, Scheduled.

Next steps

Introduction: when to use and message types
Scopes: key permissions
Webhook events: real-time status
Error responses: HTTP codes and code

​In short

​Before you start

​1. Send RCS

​1A, Via dashboard

​1B, Via API

​Send with template

​2. Other types (CARD, CAROUSEL, FILE)

​3. Query status

​4. Cancel

​5. Avoid duplicates

​6. Webhooks (optional)

​All send types

​Next steps

In short

Before you start

1. Send RCS

1A, Via dashboard

1B, Via API

Send with template

2. Other types (CARD, CAROUSEL, FILE)

3. Query status

4. Cancel

5. Avoid duplicates

6. Webhooks (optional)

All send types

Next steps