v45

latestOpenAPI 3.0.0raw.githubusercontent.com2026-08-0114775543.6 KB
Audience

Add audience members

Add new members to an existing audience.

Each member object must include a key matching the audience's phoneNumberColumnName. If it's missing, the API returns 400: "Each member must have a <phoneNumberColumnName> field". Adding members that would exceed the audience limit also returns 400.

Note: if the audience belongs to a different organization, the API returns 404 (not 403).

post/audience/{id}/members

Path parameters

idstring required
Example:60d0fe4f5311236168a109ca

The unique identifier of the audience

Request body

membersobject[] required

Array of member objects with dynamic structure based on audience configuration

Example request

{
  "members": [
    {
      "phoneNumber": "+1234567890",
      "name": "John Doe",
      "email": "john@example.com"
    }
  ]
}

Response

Members added successfully

statusboolean

Example response

{
  "status": true,
  "data": [
    {
      "message": "5 members added successfully",
      "data": {
        "added": 5,
        "skipped": 2
      }
    }
  ]
}