Templates

List templates

GET /api/v1/templates

Query parameters

curl "https://app.salesbyte.in/api/v1/templates?channel=business&status=APPROVED" \
  -H "Authorization: Bearer YOUR_API_KEY"

Each template includes its status, rejection_reason, updated_at, the full WhatsApp components, and a ready-to-use summary — enough to show and send a template without parsing WhatsApp's format:

{
  "id": "template-uuid",
  "name": "test_policy_doc_link",
  "channel": "business",
  "category": "UTILITY",
  "status": "APPROVED",
  "summary": {
    "body": "Hi {{1}}, your policy document {{2}} is attached. Tap below to view your dashboard.",
    "header_type": "DOCUMENT",
    "header_text": null,
    "footer": "Incremint",
    "variable_count": 2,
    "named_placeholders": [],
    "buttons": [{ "type": "URL", "text": "View dashboard", "url": "https://team.incremint.in/{{1}}" }],
    "send_requires": ["header_url (optional — defaults to the saved sample)", "button_values"]
  }
}

variable_count is how many values to pass in variables; send_requires lists any extra fields a send needs.

Send a template

POST /api/v1/templates/:id/send

Send an approved template to a phone number, with variable substitution. :id is the template's id from GET /api/v1/templates, or its name (e.g. /api/v1/templates/order_update/send). If a name exists in more than one language, also pass language (e.g. "en") or use the id.

Request body

{
  "to": "+919876543210",
  "variables": ["Rahul", "Order #1234", "tomorrow"]
}

Parameters

Business WhatsApp templates

Templates approved for Business WhatsApp (source: "meta" in GET /api/v1/templates) are sent from your Business number and can be sent at any time — unlike free-form messages, they aren't limited to the 24 hours after the customer's last message.

• Pass exactly one value in variables for each {{1}}, {{2}}… in the template body.
• For a template with a photo, video or PDF header, pass the file in header_url (and header_filename for a PDF) — for example a different invoice for each customer.
• Buttons defined on the template are sent automatically.
• Each send is charged to your wallet at the template's category rate (marketing, utility…).

curl -X POST https://app.salesbyte.in/api/v1/templates/template-uuid/send \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "to": "+919876543210",
    "variables": ["Rahul", "INV-1234"],
    "header_url": "https://example.com/invoices/INV-1234.pdf",
    "header_filename": "Invoice-INV-1234.pdf"
  }'

The response also includes "channel": "business" and the connection_id it was sent from.

Login / OTP (authentication) templates: pass the code as the first value in variables. It fills both the message and the Copy code (or one-tap) button — you don't send it twice.

curl -X POST https://app.salesbyte.in/api/v1/templates/template-uuid/send \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "to": "+919876543210", "variables": ["482913"] }'

Link button with a per-customer URL: if the template's button URL ends in {{1}} (for example https://example.com/track/{{1}}), pass the ending in button_values — one value per such button, in order:

curl -X POST https://app.salesbyte.in/api/v1/templates/template-uuid/send \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "to": "+919876543210", "variables": ["Rahul"], "button_values": ["order/1234"] }'

The customer's button then opens https://example.com/track/order/1234. If a required value is missing, the API returns 400 naming the button.

Named and custom-field placeholders

A template body can contain named placeholders like {{name}}, {{company}}, {{address_as}}, and any workspace custom field by its field_key, e.g. {{bni_date}}. These resolve from the recipient's contact record. See Variables & Personalisation for the full placeholder syntax, including fallback text ({{bni_date|TBD}}).

To set a custom field's value as part of the same send — rather than requiring it to already be on the contact — pass it in custom_fields:

curl -X POST https://app.salesbyte.in/api/v1/templates/template-uuid/send \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "to": "+919876543210",
    "custom_fields": {
      "bni_date": "15 Oct 2026",
      "bni_time": "9:00 AM"
    }
  }'

Example

curl -X POST https://app.salesbyte.in/api/v1/templates/template-uuid/send \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "to": "+919876543210",
    "variables": ["Rahul", "your order", "tomorrow at 3 PM"]
  }'

Response

{
  "success": true,
  "message_id": "3EB0A1B2C3D4E5",
  "text": "Hi Rahul, your order ships tomorrow at 3 PM."
}

text is the fully resolved message as sent — useful for confirming your variables and custom fields resolved as expected while testing.

Create a template

POST /api/v1/templates

Personal WhatsApp template

Ready to use immediately (no review). Supports a body and an optional media header.

{
  "name": "welcome_message",
  "body": "Hi {{name|there}}! Thanks for reaching out. We'll get back to you shortly."
}

Business WhatsApp template

Pass "channel": "business". The template is submitted to WhatsApp for approval and returns status PENDING; approval usually arrives within minutes to a few hours.

Link button with a per-customer URL: end the button's url with {{1}} and give an example — you'll pass the actual ending with button_values when sending.

{
  "name": "order_shipped",
  "channel": "business",
  "category": "UTILITY",
  "body": "Hi {{1}}, your order has shipped.",
  "variables": [{ "name": "1", "sample": "Rahul" }],
  "buttons": [
    { "type": "URL", "text": "Track order", "url": "https://example.com/track/{{1}}", "url_example": "https://example.com/track/order-1234" }
  ]
}

Login / OTP (authentication) template

WhatsApp writes the message itself — "<code> is your verification code." — with a Copy code button, so you don't pass a body, header, footer or buttons. Optional settings:

{
  "name": "login_otp",
  "channel": "business",
  "category": "AUTHENTICATION",
  "code_expiration_minutes": 10
}

Once approved, send it with POST /api/v1/templates/:id/send and "variables": ["482913"] — the code fills both the message and the Copy code button.