Campaigns

Calculate auto-segmented campaign schedule

POST
/api/campaigns/auto-segment

Returns a suggested segment schedule for a campaign given the total contact count. For limited plans the response respects the organization's daily SMS quota and skips fully booked days; for unlimited plans contacts are split into 100-per-day segments. Each segment carries a UTC ISO scheduledDate.

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

curl -X POST "https://example.com/api/campaigns/auto-segment" \  -H "Content-Type: application/json" \  -d '{    "totalContacts": 500,    "firstSegmentDate": "2026-05-20",    "firstSegmentTime": "10:00"  }'
{  "success": true,  "segments": [    {      "id": "seg-1",      "scheduledDate": "2026-05-20T17:00:00.000Z",      "contactCount": 100    },    {      "id": "seg-2",      "scheduledDate": "2026-05-21T17:00:00.000Z",      "contactCount": 100    }  ],  "totalSegments": 5,  "warnings": []}