Skip to main content
POST
/
api
/
messages
/
quick-bulk-send
Send quick bulk SMS to multiple contacts
curl --request POST \
  --url https://your-instance.example.com/api/messages/quick-bulk-send \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "contactIds": [
    "<string>"
  ],
  "message": "<string>",
  "templateId": "<string>"
}
'
{
  "success": true,
  "summary": {
    "total": 123,
    "success": 123,
    "failed": 123
  },
  "results": [
    {
      "contactId": "<string>",
      "success": true,
      "name": "<string>",
      "messageId": "<string>",
      "messageDocId": "<string>",
      "status": "<string>",
      "error": "<string>"
    }
  ]
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Either message or templateId must be provided, but not both

contactIds
string[]
required
message
string
templateId
string

Response

Bulk send results

success
boolean
summary
object
results
object[]