Skip to main content
POST
/
api
/
campaigns
/
auto-segment
Calculate auto-segmented campaign schedule
curl --request POST \
  --url https://your-instance.example.com/api/campaigns/auto-segment \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "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": []
}

Authorizations

​
Authorization
string
header
required

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

Body

application/json
​
totalContacts
integer
required
Required range: x >= 1
​
firstSegmentDate
string

Optional YYYY-MM-DD date in the user/browser local timezone for the first segment.

​
firstSegmentTime
string

Optional HH:mm time in the user/browser local timezone. Defaults to 10:00 when omitted.

Response

Auto-segment plan returned

​
success
boolean
required
​
segments
object[]
required
​
totalSegments
integer
required
​
warnings
string[]
required