Sign in

v1

latestSwagger 2.02026-08-06114161439.7 KB
SMS Broadcast

Add contact numbers to a contact list

Add multiple contact numbers to an existing contact list with validation for duplicates

post/contact-lists/{id}/contacts

Path parameters

idinteger required

The ID of the contact list to add numbers to

Request body

status'active' | 'inactive' | 'deleted'

Status of the contacts (defaults to 'active'). Type: enum (string); Allowed values: active, inactive, deleted.

Example request

{
  "numbers": [
    {
      "contact_name": "John",
      "country_code": "+1",
      "phone_number": "1234567890"
    }
  ]
}

Response

Contact numbers added successfully

statusstring

Status of the operation. Type: string.

messagestring

SMS message body. String. Max length set by carrier (typically 160 chars for single-segment, up to 1600 for concatenated).

insertedinteger

Number of contacts inserted. Type: integer.

Example response

{
  "status": "success",
  "message": "Contact numbers added successfully",
  "inserted": 5
}