REST Endpoints

Raw HTTP API reference for all Convoup REST endpoints.

Base URL

bash

https://api.convoup.com/api

Authentication

All requests require the x-api-key header:

bash

x-api-key: YOUR_API_KEY

POST /api/v1/templates

Send a template message.

Headers

Header	Value
`Content-Type`	`application/json`
`x-api-key`	Your API key

Body

Field	Type	Required	Description
`to`	`string`	Yes	Recipient phone in international format
`template_name`	`string`	Yes	Name of the approved template
`language`	`string`	Yes	Language code (e.g. `en_US`)
`body_params`	`array`	No	Body placeholder values
`header_params`	`array`	No	Text header placeholder values
`header_media`	`object`	No	`{ type, link }` for media headers
`button_params`	`array`	No	Dynamic button values

cURL

bash

curl -X POST https://api.convoup.com/api/v1/templates \
  -H "Content-Type: application/json" \
  -H "x-api-key: YOUR_API_KEY" \
  -d '{
    "to": "+918851479441",
    "template_name": "test_welcome_template",
    "language": "en_US",
    "body_params": [{"type": "text", "text": "123456"}]
  }'

Response

JSON

{
  "messageId": "meta-msg-abc123",
  "waId": "918851479441"
}

GET /api/v1/templates

List all approved templates with parameter information.

Headers

Header	Value
`x-api-key`	Your API key

cURL

bash

curl https://api.convoup.com/api/v1/templates \
  -H "x-api-key: YOUR_API_KEY"

Response

JSON

{
  "success": true,
  "data": [
    {
      "id": "tmpl_abc123",
      "name": "test_welcome_template",
      "language": "en_US",
      "category": "TRANSACTIONAL",
      "components": [...],
      "parameters": [...]
    }
  ]
}

POST /api/v1/messages

Send a free-form text message (within 24h conversation window).

Not fully documented

This endpoint is referenced in the SDK summary but not fully detailed. Contact Convoup support for the complete specification.

Headers

Header	Value
`Content-Type`	`application/json`
`x-api-key`	Your API key

GET /api/v1/contacts/window-status

Check 24-hour conversation window status.

Not fully documented

Query parameters and response schema are not documented in the current SDK reference.

Response Format

All endpoints return JSON. Successful responses include the data directly. Error responses include an error field.

Next Steps

Template Discovery - List templates with GET endpoint
SDK vs REST - When to use the SDK vs raw HTTP
Error Codes - All error codes and responses