Create a new send

Creates a new email send in the system. The send configuration includes the email to send, the list to send to, optional segments, sender information, and timing configuration based on the send type.

Send Types

Different send types require different fields:

ABSOLUTE

Send at a specific date and time.

  • Requires: sendAtDateTime (ISO-8601 format with time)

SMART_SEND

Send on a specific date using AI-optimized sending times for each subscriber.

  • Requires: sendAtDate (YYYY-MM-DD format)

RELATIVE_AFTER_DATE

Send relative to a date field (e.g., 5 days after signup date).

  • Requires: referenceField, relativeDays, relativeHours, relativeMinutes, relativeDaysName
  • relativeDaysName: Allowed days (e.g., "MON-TUE-WED-THU-FRI")

RELATIVE_AFTER_MINUTES

Send after a specified number of hours and minutes from a reference field.

  • Requires: referenceField, relativeHoursNumber, relativeMinutesNumber
  • Useful for short-term follow-ups (e.g., 2 hours after action)

SUBSCRIPTION

Trigger on subscription event.

  • Optional: formId (if null, triggers on any subscription; if specified, only on that form)

DATA_UPDATE

Trigger on data modification event.

  • Optional: formId (if null, triggers on any update; if specified, only on that form)

Default Behavior

  • If name is not provided, it will be auto-generated from the email name
  • If subject is not provided, the email's subject will be used
  • If fromName is not provided, only the email address will be shown
  • Sends are created in inactive state by default (activate via update)

Validation

  • listId must be a valid list belonging to your account
  • emailId must be a valid email belonging to your account
  • fromEmail must be an authenticated sender email for your account
  • segmentIds must be valid segments belonging to the specified list
  • referenceField must be a valid date/datetime field in the list
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
integer
required

The ID of the list to send to

segmentIds
array of integers

Optional array of segment IDs to filter recipients

segmentIds
string
required

The sender email address (must be authenticated for your account)

string

The sender name (optional)

string

The email subject (optional, defaults to email's subject)

integer
required

The ID of the email to send

string
enum
required

The type of send

Allowed:
date-time

Required for ABSOLUTE type. ISO-8601 format with time (e.g., 2026-01-10T08:00:00Z)

date

Required for SMART_SEND type. Date in YYYY-MM-DD format

string

Required for RELATIVE_AFTER_DATE and RELATIVE_AFTER_MINUTES types. The date/datetime field name

integer

Required for RELATIVE_AFTER_DATE. Number of days (can be negative for before)

integer
0 to 23

Required for RELATIVE_AFTER_DATE. Number of hours (0-23)

integer
0 to 59

Required for RELATIVE_AFTER_DATE. Number of minutes (0-59)

string

Required for RELATIVE_AFTER_DATE. Allowed days separated by dash (e.g., "MON-TUE-WED-THU-FRI")

integer

Required for RELATIVE_AFTER_MINUTES. Number of hours to wait (can be negative)

integer
0 to 59

Required for RELATIVE_AFTER_MINUTES. Additional minutes to wait (0-59)

integer | null

Optional for SUBSCRIPTION and DATA_UPDATE types. If null, triggers on any form; if specified, only on that form

string

Optional name for the send (auto-generated if not provided)

Responses

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json