List
Preview
GET
https://api.senditly.ai/v1/campaigns
List campaigns
This API is in preview. It may be changed in the future.
Headers
Authorization
string
required
Bearer authentication of the form "Bearer <API_KEY>", where API_KEY is your api key.
Query
limit
integer
optional
A limit on the number of items to return. Defaults to 10. The value must be between 1 and 100.
startingAfter
string
optional
A cursor to start the list from. Defaults to the first item.
endingBefore
string
optional
A cursor to end the list at. Defaults to the last item.
label
string
optional
Response
items
array
required
hasMore
boolean
required
Whether there are more items to fetch.
cursor
string
optional
A cursor to start the next list from.
Count
Preview
GET
https://api.senditly.ai/v1/campaigns/count
Count campaigns
This API is in preview. It may be changed in the future.
Headers
Authorization
string
required
Bearer authentication of the form "Bearer <API_KEY>", where API_KEY is your api key.
Query
after
string
optional
A cursor to start the count from.
before
string
optional
A cursor to end the count at.
label
string
optional
Response
count
integer
required
The total number of items.
Create
Preview
POST
https://api.senditly.ai/v1/campaigns
Create a campaign
This API is in preview. It may be changed in the future.
Headers
Authorization
string
required
Bearer authentication of the form "Bearer <API_KEY>", where API_KEY is your api key.
Request
name
string
required
setting
union
required
The setting of the campaign.
standard
type
literal
required
mailingListId
string
optional
The id of the mailing list that the campaign will be sent to.
If it's specified,
- the campaign will be treated as a marketing campaign
- and sent to the subscribers of the mailing list
If it's not specified,
- the campaign will be treated as a system campaign
- and sent to the all contacts of the segment ignoring the mailing list status.
- Don't use this option if you want to send a marketing campaign.
message
union
required
The data of the message.
email
type
literal
required
from
object
required
The sender of the email.
name
string
optional
The name of the address.
address
string
required
The email address of the address.
replyTo
array
optional
The reply-to email addresses.
subject
string
required
The subject of the email.
preview
string
optional
The preview of the email.
template
ref
required
The template of the email.
raw
object
optional
The raw parts of the email. When this is specified, the template will not be used.
html
string
optional
The raw HTML part of the email. When this is specified, the template will not be used.
text
string
optional
The raw TEXT part of the email. When this is specified, the template will not be used.
listUnsubscribe
string
optional
The raw list unsubscribe url of the email. When this is specified, the template will not be used.
schedule
union
required
The setting of the schedule.
immediate
type
literal
required
later
type
literal
required
at
string
required
A date string in ISO 8601 format when the campaign will be scheduled.
segment
object
required
The segment setting.
filter
union
required
The segment filter.
string
type
literal
required
key
string
required
operator
enum
required
value
string
required
existence
type
literal
required
key
string
required
operator
enum
required
number
type
literal
required
key
string
required
operator
enum
required
value
float
required
numberrange
type
literal
required
key
string
required
operator
enum
required
range
object
required
min
float
required
max
float
required
date
type
literal
required
key
string
required
operator
enum
required
value
string
required
A date string in ISO 8601 format
daterange
type
literal
required
key
string
required
operator
enum
required
range
object
required
from
string
required
A date string in ISO 8601 format
to
string
required
A date string in ISO 8601 format
boolean
type
literal
required
key
string
required
value
boolean
required
logical
type
literal
required
operator
enum
required
filters
array
required
tracking
object
optional
The setting of the tracking.
link
boolean
optional
Whether to enable link tracking. By default, `false`. If enabled, the link will be wrapped with the tracking link.
open
boolean
optional
Whether to enable open tracking. By default, `false`. If enabled, the open will be tracked.
throttling
object
optional
The throttling policy.
backoffCoefficient
float
optional
The backoff coefficient. By default, `2.0`
initialReleasePercent
float
optional
The initial release percent. By default, `1`%
maxReleasePercent
float
optional
The max release percent. By default, `30`%
minRecipientsPerRelease
integer
optional
The minimum recipients per release. By default, `10`
window
string
optional
The window of the throttling. By default, `3m`. 'm' is for minutes, 'h' is for hours, 'd' is for days.
labels
record
optional
Response
id
string
required
The unique identifier for the campaign.
name
string
required
The name of the campaign.
status
enum
required
The status of the campaign.
setting
union
required
The setting of the campaign.
standard
type
literal
required
mailingListId
string
optional
The id of the mailing list that the campaign will be sent to.
If it's specified,
- the campaign will be treated as a marketing campaign
- and sent to the subscribers of the mailing list
If it's not specified,
- the campaign will be treated as a system campaign
- and sent to the all contacts of the segment ignoring the mailing list status.
- Don't use this option if you want to send a marketing campaign.
message
union
required
The data of the message.
email
type
literal
required
from
object
required
The sender of the email.
name
string
optional
The name of the address.
address
string
required
The email address of the address.
replyTo
array
optional
The reply-to email addresses.
subject
string
required
The subject of the email.
preview
string
optional
The preview of the email.
template
ref
required
The template of the email.
raw
object
optional
The raw parts of the email. When this is specified, the template will not be used.
html
string
optional
The raw HTML part of the email. When this is specified, the template will not be used.
text
string
optional
The raw TEXT part of the email. When this is specified, the template will not be used.
listUnsubscribe
string
optional
The raw list unsubscribe url of the email. When this is specified, the template will not be used.
schedule
union
required
The setting of the schedule.
immediate
type
literal
required
later
type
literal
required
at
string
required
A date string in ISO 8601 format when the campaign will be scheduled.
segment
object
required
The segment setting.
filter
union
required
The segment filter.
string
type
literal
required
key
string
required
operator
enum
required
value
string
required
existence
type
literal
required
key
string
required
operator
enum
required
number
type
literal
required
key
string
required
operator
enum
required
value
float
required
numberrange
type
literal
required
key
string
required
operator
enum
required
range
object
required
min
float
required
max
float
required
date
type
literal
required
key
string
required
operator
enum
required
value
string
required
A date string in ISO 8601 format
daterange
type
literal
required
key
string
required
operator
enum
required
range
object
required
from
string
required
A date string in ISO 8601 format
to
string
required
A date string in ISO 8601 format
boolean
type
literal
required
key
string
required
value
boolean
required
logical
type
literal
required
operator
enum
required
filters
array
required
tracking
object
optional
The setting of the tracking.
link
boolean
optional
Whether to enable link tracking. By default, `false`. If enabled, the link will be wrapped with the tracking link.
open
boolean
optional
Whether to enable open tracking. By default, `false`. If enabled, the open will be tracked.
throttling
object
optional
The throttling policy.
backoffCoefficient
float
optional
The backoff coefficient. By default, `2.0`
initialReleasePercent
float
optional
The initial release percent. By default, `1`%
maxReleasePercent
float
optional
The max release percent. By default, `30`%
minRecipientsPerRelease
integer
optional
The minimum recipients per release. By default, `10`
window
string
optional
The window of the throttling. By default, `3m`. 'm' is for minutes, 'h' is for hours, 'd' is for days.
labels
record
required
The labels of the campaign.
ownerId
string
required
The account id for the owner of the campaign.
createdAt
string
required
A date string in ISO 8601 format when the campaign was created.
updatedAt
string
required
A date string in ISO 8601 format when the campaign was last updated.
Retrieve
Preview
GET
https://api.senditly.ai/v1/campaigns/:id
Retrieve a campaign
This API is in preview. It may be changed in the future.
Headers
Authorization
string
required
Bearer authentication of the form "Bearer <API_KEY>", where API_KEY is your api key.
Parameters
id
string
required
The unique identifier for the campaign.
Response
id
string
required
The unique identifier for the campaign.
name
string
required
The name of the campaign.
status
enum
required
The status of the campaign.
setting
union
required
The setting of the campaign.
standard
type
literal
required
mailingListId
string
optional
The id of the mailing list that the campaign will be sent to.
If it's specified,
- the campaign will be treated as a marketing campaign
- and sent to the subscribers of the mailing list
If it's not specified,
- the campaign will be treated as a system campaign
- and sent to the all contacts of the segment ignoring the mailing list status.
- Don't use this option if you want to send a marketing campaign.
message
union
required
The data of the message.
email
type
literal
required
from
object
required
The sender of the email.
name
string
optional
The name of the address.
address
string
required
The email address of the address.
replyTo
array
optional
The reply-to email addresses.
subject
string
required
The subject of the email.
preview
string
optional
The preview of the email.
template
ref
required
The template of the email.
raw
object
optional
The raw parts of the email. When this is specified, the template will not be used.
html
string
optional
The raw HTML part of the email. When this is specified, the template will not be used.
text
string
optional
The raw TEXT part of the email. When this is specified, the template will not be used.
listUnsubscribe
string
optional
The raw list unsubscribe url of the email. When this is specified, the template will not be used.
schedule
union
required
The setting of the schedule.
immediate
type
literal
required
later
type
literal
required
at
string
required
A date string in ISO 8601 format when the campaign will be scheduled.
segment
object
required
The segment setting.
filter
union
required
The segment filter.
string
type
literal
required
key
string
required
operator
enum
required
value
string
required
existence
type
literal
required
key
string
required
operator
enum
required
number
type
literal
required
key
string
required
operator
enum
required
value
float
required
numberrange
type
literal
required
key
string
required
operator
enum
required
range
object
required
min
float
required
max
float
required
date
type
literal
required
key
string
required
operator
enum
required
value
string
required
A date string in ISO 8601 format
daterange
type
literal
required
key
string
required
operator
enum
required
range
object
required
from
string
required
A date string in ISO 8601 format
to
string
required
A date string in ISO 8601 format
boolean
type
literal
required
key
string
required
value
boolean
required
logical
type
literal
required
operator
enum
required
filters
array
required
tracking
object
optional
The setting of the tracking.
link
boolean
optional
Whether to enable link tracking. By default, `false`. If enabled, the link will be wrapped with the tracking link.
open
boolean
optional
Whether to enable open tracking. By default, `false`. If enabled, the open will be tracked.
throttling
object
optional
The throttling policy.
backoffCoefficient
float
optional
The backoff coefficient. By default, `2.0`
initialReleasePercent
float
optional
The initial release percent. By default, `1`%
maxReleasePercent
float
optional
The max release percent. By default, `30`%
minRecipientsPerRelease
integer
optional
The minimum recipients per release. By default, `10`
window
string
optional
The window of the throttling. By default, `3m`. 'm' is for minutes, 'h' is for hours, 'd' is for days.
labels
record
required
The labels of the campaign.
ownerId
string
required
The account id for the owner of the campaign.
createdAt
string
required
A date string in ISO 8601 format when the campaign was created.
updatedAt
string
required
A date string in ISO 8601 format when the campaign was last updated.
Update
Preview
POST
https://api.senditly.ai/v1/campaigns/:id
Update a campaign
This API is in preview. It may be changed in the future.
Headers
Authorization
string
required
Bearer authentication of the form "Bearer <API_KEY>", where API_KEY is your api key.
Parameters
id
string
required
The unique identifier for the campaign.
Request
name
string
optional
setting
union
optional
The setting of the campaign.
standard
type
literal
required
mailingListId
string
optional
The id of the mailing list that the campaign will be sent to.
If it's specified,
- the campaign will be treated as a marketing campaign
- and sent to the subscribers of the mailing list
If it's not specified,
- the campaign will be treated as a system campaign
- and sent to the all contacts of the segment ignoring the mailing list status.
- Don't use this option if you want to send a marketing campaign.
message
union
required
The data of the message.
email
type
literal
required
from
object
required
The sender of the email.
name
string
optional
The name of the address.
address
string
required
The email address of the address.
replyTo
array
optional
The reply-to email addresses.
subject
string
required
The subject of the email.
preview
string
optional
The preview of the email.
template
ref
required
The template of the email.
raw
object
optional
The raw parts of the email. When this is specified, the template will not be used.
html
string
optional
The raw HTML part of the email. When this is specified, the template will not be used.
text
string
optional
The raw TEXT part of the email. When this is specified, the template will not be used.
listUnsubscribe
string
optional
The raw list unsubscribe url of the email. When this is specified, the template will not be used.
schedule
union
required
The setting of the schedule.
immediate
type
literal
required
later
type
literal
required
at
string
required
A date string in ISO 8601 format when the campaign will be scheduled.
segment
object
required
The segment setting.
filter
union
required
The segment filter.
string
type
literal
required
key
string
required
operator
enum
required
value
string
required
existence
type
literal
required
key
string
required
operator
enum
required
number
type
literal
required
key
string
required
operator
enum
required
value
float
required
numberrange
type
literal
required
key
string
required
operator
enum
required
range
object
required
min
float
required
max
float
required
date
type
literal
required
key
string
required
operator
enum
required
value
string
required
A date string in ISO 8601 format
daterange
type
literal
required
key
string
required
operator
enum
required
range
object
required
from
string
required
A date string in ISO 8601 format
to
string
required
A date string in ISO 8601 format
boolean
type
literal
required
key
string
required
value
boolean
required
logical
type
literal
required
operator
enum
required
filters
array
required
tracking
object
optional
The setting of the tracking.
link
boolean
optional
Whether to enable link tracking. By default, `false`. If enabled, the link will be wrapped with the tracking link.
open
boolean
optional
Whether to enable open tracking. By default, `false`. If enabled, the open will be tracked.
throttling
object
optional
The throttling policy.
backoffCoefficient
float
optional
The backoff coefficient. By default, `2.0`
initialReleasePercent
float
optional
The initial release percent. By default, `1`%
maxReleasePercent
float
optional
The max release percent. By default, `30`%
minRecipientsPerRelease
integer
optional
The minimum recipients per release. By default, `10`
window
string
optional
The window of the throttling. By default, `3m`. 'm' is for minutes, 'h' is for hours, 'd' is for days.
labels
record
optional
Response
id
string
required
The unique identifier for the campaign.
name
string
required
The name of the campaign.
status
enum
required
The status of the campaign.
setting
union
required
The setting of the campaign.
standard
type
literal
required
mailingListId
string
optional
The id of the mailing list that the campaign will be sent to.
If it's specified,
- the campaign will be treated as a marketing campaign
- and sent to the subscribers of the mailing list
If it's not specified,
- the campaign will be treated as a system campaign
- and sent to the all contacts of the segment ignoring the mailing list status.
- Don't use this option if you want to send a marketing campaign.
message
union
required
The data of the message.
email
type
literal
required
from
object
required
The sender of the email.
name
string
optional
The name of the address.
address
string
required
The email address of the address.
replyTo
array
optional
The reply-to email addresses.
subject
string
required
The subject of the email.
preview
string
optional
The preview of the email.
template
ref
required
The template of the email.
raw
object
optional
The raw parts of the email. When this is specified, the template will not be used.
html
string
optional
The raw HTML part of the email. When this is specified, the template will not be used.
text
string
optional
The raw TEXT part of the email. When this is specified, the template will not be used.
listUnsubscribe
string
optional
The raw list unsubscribe url of the email. When this is specified, the template will not be used.
schedule
union
required
The setting of the schedule.
immediate
type
literal
required
later
type
literal
required
at
string
required
A date string in ISO 8601 format when the campaign will be scheduled.
segment
object
required
The segment setting.
filter
union
required
The segment filter.
string
type
literal
required
key
string
required
operator
enum
required
value
string
required
existence
type
literal
required
key
string
required
operator
enum
required
number
type
literal
required
key
string
required
operator
enum
required
value
float
required
numberrange
type
literal
required
key
string
required
operator
enum
required
range
object
required
min
float
required
max
float
required
date
type
literal
required
key
string
required
operator
enum
required
value
string
required
A date string in ISO 8601 format
daterange
type
literal
required
key
string
required
operator
enum
required
range
object
required
from
string
required
A date string in ISO 8601 format
to
string
required
A date string in ISO 8601 format
boolean
type
literal
required
key
string
required
value
boolean
required
logical
type
literal
required
operator
enum
required
filters
array
required
tracking
object
optional
The setting of the tracking.
link
boolean
optional
Whether to enable link tracking. By default, `false`. If enabled, the link will be wrapped with the tracking link.
open
boolean
optional
Whether to enable open tracking. By default, `false`. If enabled, the open will be tracked.
throttling
object
optional
The throttling policy.
backoffCoefficient
float
optional
The backoff coefficient. By default, `2.0`
initialReleasePercent
float
optional
The initial release percent. By default, `1`%
maxReleasePercent
float
optional
The max release percent. By default, `30`%
minRecipientsPerRelease
integer
optional
The minimum recipients per release. By default, `10`
window
string
optional
The window of the throttling. By default, `3m`. 'm' is for minutes, 'h' is for hours, 'd' is for days.
labels
record
required
The labels of the campaign.
ownerId
string
required
The account id for the owner of the campaign.
createdAt
string
required
A date string in ISO 8601 format when the campaign was created.
updatedAt
string
required
A date string in ISO 8601 format when the campaign was last updated.
Duplicate
Preview
POST
https://api.senditly.ai/v1/campaigns/:id/duplicate
Duplicate a campaign
This API is in preview. It may be changed in the future.
Headers
Authorization
string
required
Bearer authentication of the form "Bearer <API_KEY>", where API_KEY is your api key.
Parameters
id
string
required
The unique identifier for the campaign.
Request
name
string
optional
labels
record
optional
Response
id
string
required
The unique identifier for the campaign.
name
string
required
The name of the campaign.
status
enum
required
The status of the campaign.
setting
union
required
The setting of the campaign.
standard
type
literal
required
mailingListId
string
optional
The id of the mailing list that the campaign will be sent to.
If it's specified,
- the campaign will be treated as a marketing campaign
- and sent to the subscribers of the mailing list
If it's not specified,
- the campaign will be treated as a system campaign
- and sent to the all contacts of the segment ignoring the mailing list status.
- Don't use this option if you want to send a marketing campaign.
message
union
required
The data of the message.
email
type
literal
required
from
object
required
The sender of the email.
name
string
optional
The name of the address.
address
string
required
The email address of the address.
replyTo
array
optional
The reply-to email addresses.
subject
string
required
The subject of the email.
preview
string
optional
The preview of the email.
template
ref
required
The template of the email.
raw
object
optional
The raw parts of the email. When this is specified, the template will not be used.
html
string
optional
The raw HTML part of the email. When this is specified, the template will not be used.
text
string
optional
The raw TEXT part of the email. When this is specified, the template will not be used.
listUnsubscribe
string
optional
The raw list unsubscribe url of the email. When this is specified, the template will not be used.
schedule
union
required
The setting of the schedule.
immediate
type
literal
required
later
type
literal
required
at
string
required
A date string in ISO 8601 format when the campaign will be scheduled.
segment
object
required
The segment setting.
filter
union
required
The segment filter.
string
type
literal
required
key
string
required
operator
enum
required
value
string
required
existence
type
literal
required
key
string
required
operator
enum
required
number
type
literal
required
key
string
required
operator
enum
required
value
float
required
numberrange
type
literal
required
key
string
required
operator
enum
required
range
object
required
min
float
required
max
float
required
date
type
literal
required
key
string
required
operator
enum
required
value
string
required
A date string in ISO 8601 format
daterange
type
literal
required
key
string
required
operator
enum
required
range
object
required
from
string
required
A date string in ISO 8601 format
to
string
required
A date string in ISO 8601 format
boolean
type
literal
required
key
string
required
value
boolean
required
logical
type
literal
required
operator
enum
required
filters
array
required
tracking
object
optional
The setting of the tracking.
link
boolean
optional
Whether to enable link tracking. By default, `false`. If enabled, the link will be wrapped with the tracking link.
open
boolean
optional
Whether to enable open tracking. By default, `false`. If enabled, the open will be tracked.
throttling
object
optional
The throttling policy.
backoffCoefficient
float
optional
The backoff coefficient. By default, `2.0`
initialReleasePercent
float
optional
The initial release percent. By default, `1`%
maxReleasePercent
float
optional
The max release percent. By default, `30`%
minRecipientsPerRelease
integer
optional
The minimum recipients per release. By default, `10`
window
string
optional
The window of the throttling. By default, `3m`. 'm' is for minutes, 'h' is for hours, 'd' is for days.
labels
record
required
The labels of the campaign.
ownerId
string
required
The account id for the owner of the campaign.
createdAt
string
required
A date string in ISO 8601 format when the campaign was created.
updatedAt
string
required
A date string in ISO 8601 format when the campaign was last updated.
Delete
Preview
DELETE
https://api.senditly.ai/v1/campaigns/:id
Delete a campaign
This API is in preview. It may be changed in the future.
Headers
Authorization
string
required
Bearer authentication of the form "Bearer <API_KEY>", where API_KEY is your api key.
Parameters
id
string
required
The unique identifier for the campaign.
Response
id
string
required
The unique identifier for the campaign.
deletedAt
string
required
A date string in ISO 8601 format when the campaign was deleted.
Schedule
Preview
POST
https://api.senditly.ai/v1/campaigns/:id/schedule
Schedule a campaign
This API is in preview. It may be changed in the future.
Headers
Authorization
string
required
Bearer authentication of the form "Bearer <API_KEY>", where API_KEY is your api key.
Parameters
id
string
required
The unique identifier for the campaign.
Response
id
string
required
The unique identifier for the campaign.
name
string
required
The name of the campaign.
status
enum
required
The status of the campaign.
setting
union
required
The setting of the campaign.
standard
type
literal
required
mailingListId
string
optional
The id of the mailing list that the campaign will be sent to.
If it's specified,
- the campaign will be treated as a marketing campaign
- and sent to the subscribers of the mailing list
If it's not specified,
- the campaign will be treated as a system campaign
- and sent to the all contacts of the segment ignoring the mailing list status.
- Don't use this option if you want to send a marketing campaign.
message
union
required
The data of the message.
email
type
literal
required
from
object
required
The sender of the email.
name
string
optional
The name of the address.
address
string
required
The email address of the address.
replyTo
array
optional
The reply-to email addresses.
subject
string
required
The subject of the email.
preview
string
optional
The preview of the email.
template
ref
required
The template of the email.
raw
object
optional
The raw parts of the email. When this is specified, the template will not be used.
html
string
optional
The raw HTML part of the email. When this is specified, the template will not be used.
text
string
optional
The raw TEXT part of the email. When this is specified, the template will not be used.
listUnsubscribe
string
optional
The raw list unsubscribe url of the email. When this is specified, the template will not be used.
schedule
union
required
The setting of the schedule.
immediate
type
literal
required
later
type
literal
required
at
string
required
A date string in ISO 8601 format when the campaign will be scheduled.
segment
object
required
The segment setting.
filter
union
required
The segment filter.
string
type
literal
required
key
string
required
operator
enum
required
value
string
required
existence
type
literal
required
key
string
required
operator
enum
required
number
type
literal
required
key
string
required
operator
enum
required
value
float
required
numberrange
type
literal
required
key
string
required
operator
enum
required
range
object
required
min
float
required
max
float
required
date
type
literal
required
key
string
required
operator
enum
required
value
string
required
A date string in ISO 8601 format
daterange
type
literal
required
key
string
required
operator
enum
required
range
object
required
from
string
required
A date string in ISO 8601 format
to
string
required
A date string in ISO 8601 format
boolean
type
literal
required
key
string
required
value
boolean
required
logical
type
literal
required
operator
enum
required
filters
array
required
tracking
object
optional
The setting of the tracking.
link
boolean
optional
Whether to enable link tracking. By default, `false`. If enabled, the link will be wrapped with the tracking link.
open
boolean
optional
Whether to enable open tracking. By default, `false`. If enabled, the open will be tracked.
throttling
object
optional
The throttling policy.
backoffCoefficient
float
optional
The backoff coefficient. By default, `2.0`
initialReleasePercent
float
optional
The initial release percent. By default, `1`%
maxReleasePercent
float
optional
The max release percent. By default, `30`%
minRecipientsPerRelease
integer
optional
The minimum recipients per release. By default, `10`
window
string
optional
The window of the throttling. By default, `3m`. 'm' is for minutes, 'h' is for hours, 'd' is for days.
labels
record
required
The labels of the campaign.
ownerId
string
required
The account id for the owner of the campaign.
createdAt
string
required
A date string in ISO 8601 format when the campaign was created.
updatedAt
string
required
A date string in ISO 8601 format when the campaign was last updated.
Cancel
Preview
POST
https://api.senditly.ai/v1/campaigns/:id/cancel
Cancel a campaign
This API is in preview. It may be changed in the future.
Headers
Authorization
string
required
Bearer authentication of the form "Bearer <API_KEY>", where API_KEY is your api key.
Parameters
id
string
required
The unique identifier for the campaign.
Response
id
string
required
The unique identifier for the campaign.
name
string
required
The name of the campaign.
status
enum
required
The status of the campaign.
setting
union
required
The setting of the campaign.
standard
type
literal
required
mailingListId
string
optional
The id of the mailing list that the campaign will be sent to.
If it's specified,
- the campaign will be treated as a marketing campaign
- and sent to the subscribers of the mailing list
If it's not specified,
- the campaign will be treated as a system campaign
- and sent to the all contacts of the segment ignoring the mailing list status.
- Don't use this option if you want to send a marketing campaign.
message
union
required
The data of the message.
email
type
literal
required
from
object
required
The sender of the email.
name
string
optional
The name of the address.
address
string
required
The email address of the address.
replyTo
array
optional
The reply-to email addresses.
subject
string
required
The subject of the email.
preview
string
optional
The preview of the email.
template
ref
required
The template of the email.
raw
object
optional
The raw parts of the email. When this is specified, the template will not be used.
html
string
optional
The raw HTML part of the email. When this is specified, the template will not be used.
text
string
optional
The raw TEXT part of the email. When this is specified, the template will not be used.
listUnsubscribe
string
optional
The raw list unsubscribe url of the email. When this is specified, the template will not be used.
schedule
union
required
The setting of the schedule.
immediate
type
literal
required
later
type
literal
required
at
string
required
A date string in ISO 8601 format when the campaign will be scheduled.
segment
object
required
The segment setting.
filter
union
required
The segment filter.
string
type
literal
required
key
string
required
operator
enum
required
value
string
required
existence
type
literal
required
key
string
required
operator
enum
required
number
type
literal
required
key
string
required
operator
enum
required
value
float
required
numberrange
type
literal
required
key
string
required
operator
enum
required
range
object
required
min
float
required
max
float
required
date
type
literal
required
key
string
required
operator
enum
required
value
string
required
A date string in ISO 8601 format
daterange
type
literal
required
key
string
required
operator
enum
required
range
object
required
from
string
required
A date string in ISO 8601 format
to
string
required
A date string in ISO 8601 format
boolean
type
literal
required
key
string
required
value
boolean
required
logical
type
literal
required
operator
enum
required
filters
array
required
tracking
object
optional
The setting of the tracking.
link
boolean
optional
Whether to enable link tracking. By default, `false`. If enabled, the link will be wrapped with the tracking link.
open
boolean
optional
Whether to enable open tracking. By default, `false`. If enabled, the open will be tracked.
throttling
object
optional
The throttling policy.
backoffCoefficient
float
optional
The backoff coefficient. By default, `2.0`
initialReleasePercent
float
optional
The initial release percent. By default, `1`%
maxReleasePercent
float
optional
The max release percent. By default, `30`%
minRecipientsPerRelease
integer
optional
The minimum recipients per release. By default, `10`
window
string
optional
The window of the throttling. By default, `3m`. 'm' is for minutes, 'h' is for hours, 'd' is for days.
labels
record
required
The labels of the campaign.
ownerId
string
required
The account id for the owner of the campaign.
createdAt
string
required
A date string in ISO 8601 format when the campaign was created.
updatedAt
string
required
A date string in ISO 8601 format when the campaign was last updated.
Senditly© 2025 Unbounded Pioneering Inc.
Privacy PolicyTerms of ServiceAnti-Spam PolicyData Processing AgreementInformation Security PolicyService Level Agreement