Add recipients to a broadcast

Add recipients by contact IDs, raw phone numbers, or from the broadcast's segment filters.

Authorization

AuthorizationBearer <token>

API key authentication - use your Zernio API key as a Bearer token

In: header

Path Parameters

broadcastIdstring

Request Body

contactIds?array<string>

Specific contact IDs to add

phones?array<string>

Raw phone numbers (auto-creates contacts). Useful for WhatsApp/Telegram manual entry

useSegment?boolean

Auto-populate from broadcast segment filters

Response Body

application/json

import Zernio from '@zernio/node';const zernio = new Zernio({ apiKey: process.env.ZERNIO_API_KEY });const { data } = await zernio.broadcasts.addBroadcastRecipients({  path: {    broadcastId: 'broadcast_abc123',  },  body: {    contactIds: [      'contact_abc123',    ],    phones: [      'string',    ],    useSegment: false,  },});console.log(data);

{
  "success": true,
  "added": 0,
  "skipped": 0
}

{
  "error": "Unauthorized"
}

{
  "error": "Not found"
}

Authorization

AuthorizationBearer <token>

API key authentication - use your Zernio API key as a Bearer token

In: header

Path Parameters

broadcastIdstring

Request Body

contactIds?array<string>

Specific contact IDs to add

phones?array<string>

Raw phone numbers (auto-creates contacts). Useful for WhatsApp/Telegram manual entry

useSegment?boolean

Auto-populate from broadcast segment filters

Response Body

application/json

import Zernio from '@zernio/node';

const zernio = new Zernio({ apiKey: process.env.ZERNIO_API_KEY });

const { data } = await zernio.broadcasts.addBroadcastRecipients({
  path: {
    broadcastId: 'broadcast_abc123',
  },
  body: {
    contactIds: [
      'contact_abc123',
    ],
    phones: [
      'string',
    ],
    useSegment: false,
  },
});
console.log(data);

import Zernio from '@zernio/node';const zernio = new Zernio({ apiKey: process.env.ZERNIO_API_KEY });const { data } = await zernio.broadcasts.addBroadcastRecipients({  path: {    broadcastId: 'broadcast_abc123',  },  body: {    contactIds: [      'contact_abc123',    ],    phones: [      'string',    ],    useSegment: false,  },});console.log(data);

{
  "success": true,
  "added": 0,
  "skipped": 0
}

{
  "error": "Unauthorized"
}

{
  "error": "Not found"
}

Add recipients to a broadcast

200application/json

401application/json

404application/json

Add recipients to a broadcast

200application/json

401application/json

404application/json

application/json

application/json

application/json

application/json

application/json

application/json