Create a campaign

post

https://api.getaisa.ai/customers/{customerId}/campaigns

Creates a new outbound messaging campaign. At least one of 'selection' or 'contacts' must be provided to define the campaign recipients. Messages are sent every day inside the daily window defined in 'config' ('dailyStartAt' to 'dailyEndAt'), spreading up to 'maxContactsPerDay' messages evenly, until every contact has been processed. If the campaign is activated while today's window is already open it starts immediately, sending only the share of the daily quota proportional to the remaining time; if today's window is already closed, it starts the next day.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

customerId

string

required

The ID of the customer account.

Body Params

Recipients ('selection', 'contacts' or 'phoneNumbers') are optional: a campaign created without any stays scheduled and idle, sending nothing until contacts are added via the add-contacts endpoint. The config must define the daily send window ('dailyStartAt' + 'dailyEndAt', or 'immediate'); the legacy 'distributionDuration' field is still accepted and converted server-side.

name

string

required

Name of the campaign.

template

object

required

Represents a message template identifier.

startAt

date-time

required

ISO 8601 timestamp for the day the campaign starts. Only the DATE part matters and it must not be in the past (today is valid even when the daily window is already open or closed: sending starts right away with a prorated batch, or the next day). The daily send times are defined in 'config'.

status

string

enum

required

Allowed:

config

object

selection

object

contacts

array of objects

List of contacts to include in the campaign.

contacts

Responses

200Campaign created successfully.

400Bad Request (missing required fields, invalid template, no recipients, etc.)

500Internal server error