Cakemail API

Schemas

APIVersion

string · enum

Enum values:

An enumeration.

AcceptListPolicyResponse

id

integer · required

object

string

Default: list

policy_accepted

boolean

Default: true

AccountFullResponse

id

string · required

Unique account identifier

lineage

string · required

Hierarchical path showing account parentage (e.g. "1-2-3")

status

string · enum · required

Account status

Enum values:

trial

active

suspended

suspended_by_partner

deleted

incomplete

pending

object · required

Mailing address (required for CAN-SPAM compliance)

object · required

Owner user of this account

logo

string · required

Account logo URL

object · required

Plan limits and feature flags

last_activity_on

integer · required

Last activity timestamp

created_on

integer · required

Account creation timestamp

partner

boolean · required

Whether this account has partner privileges

organization

boolean · required

Whether this account has been converted to an organization

object · required

Account-level feature overrides

name

string

Account display name

fax

string

phone

string

website

string

Website URL

stripe_customer_id

string

Stripe customer ID for billing

metadata

object

Custom key-value metadata

AccountOverrides

bypass_recaptcha

boolean · required

Whether reCAPTCHA verification is bypassed for forms

inject_address

boolean · required

Whether the mailing address is auto-injected into campaigns

inject_unsubscribe_link

boolean · required

Whether an unsubscribe link is auto-injected

AccountOwner

user_id

integer · min: 1 · required

ID of the user to set as account owner

AccountOwnerResponse

user_id

string

ID of the user who owns this account, null if no owner is set

AccountOwnerUser

first_name

string · required

First name

last_name

string · required

Last name

email

string · email · required

Email address, used as the login username

title

string

Job title

office_phone

string

Office phone number

mobile_phone

string · pattern: [0-9]+

Mobile phone number (digits only)

language

string · enum

Preferred language (e.g. en_US, fr_FR)

Enum values:

da_DK

de_DE

el_GR

en_US

timezone

string

IANA timezone identifier (e.g. America/Montreal)

password

string · minLength: 8 · maxLength: 128

password_strength_requirement

string · enum

Minimum entropy requirement for the password

Enum values:

VERY_WEAK

WEAK

MODERATE

STRONG

VERY_STRONG

Default: VERY_WEAK

AccountResponse

object · required

AccountStatResponse

active_contacts

integer · required

Total active contacts in the account

sent_emails

integer · required

Total emails sent across all channels

sent_campaign_emails

integer · required

Emails sent via campaigns

sent_action_emails

integer · required

Emails sent via automations

sent_email_emails

integer · required

Emails sent via transactional email

open_rate

number · required

Overall open rate percentage

bounce_rate

number · required

Overall bounce rate percentage

click_rate

number · required

Overall click rate percentage

spam_rate

number · required

Overall spam complaint rate percentage

unsubscribe_rate

number · required

Overall unsubscribe rate percentage

emails_usage

number · required

Email quota usage percentage

contacts_usage

number · required

Contact quota usage percentage

bounces_hard

integer · required

Total hard bounces

bounce_hard_rate

number · required

Hard bounce rate percentage

spams

integer · required

Total spam complaints

current_lists

integer · required

Number of contact lists in the account

object

Email API statistics

AccountStatsResponse

object · required

Account statistics

AccountStatus

string · enum

Enum values:

trial

active

suspended

suspended_by_partner

deleted

incomplete

pending

An enumeration.

AccountSummaryResponse

id

string · required

Unique account identifier

lineage

string · required

Hierarchical path showing account parentage

status

string · enum · required

Account status

Enum values:

trial

active

suspended

suspended_by_partner

deleted

incomplete

pending

partner

boolean · required

Whether this account has partner privileges

object · required

Owner user of this account

object · required

Plan limits and feature flags

created_on

integer · required

Account creation timestamp

name

string

Account display name

stripe_customer_id

string

Stripe customer ID for billing

expires_on

integer

Account expiration timestamp

AccountsResponse

object · required

object[] · required

Action

name

string · required

condition

string · enum · required

An enumeration.

Enum values:

opened

not_opened

clicked

not_clicked

none

delay

integer · required

type

string · enum · required

An enumeration.

Enum values:

parent_id

string

object

ActionBlueprint

id

string · required

name

string · required

condition

string · enum · required

An enumeration.

Enum values:

opened

not_opened

clicked

not_clicked

none

delay

integer · required

type

string · enum · required

An enumeration.

Enum values:

created_on

integer

updated_on

integer

parent_id

string

object

ActionCondition

string · enum

Enum values:

opened

not_opened

clicked

not_clicked

none

An enumeration.

ActionContent

subject

string · minLength: 1

Email subject line

html

string · minLength: 1

HTML content of the email

text

string · minLength: 1

Plain text content of the email

json

object

JSON content of the email (BEE editor format)

type

string · enum

Content type of the email

Enum values:

custom

html

bee

Default: html

encoding

string · enum

Character encoding of the email content

Enum values:

utf-8

armscii-8

ascii

big-5

cp51932

cp866

cp936

euc-cn

object

Template to use for the campaign content

ActionDefaultEmailSettings

object · required

ActionEmailBlueprintSettings

object · required

object

Default: {"opens":true,"clicks_html":true,"clicks_text":true}

ActionEmailSettings

object · required

object

Default: {"opens":true,"clicks_html":true,"clicks_text":true}

ActionLogResponse

contact_id

integer · required

occurrences

integer · required

id

integer

email

string

type

string · enum

exposed_string = database_string

Enum values:

clickthru

click

open

bounce

bounce_ac

bounce_cr

bounce_df

bounce_fm

timestamp

integer

object

ActionLogsResponse

object · required

object[] · required

ActionResponse

id

string · required

name

string · required

condition

string · enum · required

An enumeration.

Enum values:

opened

not_opened

clicked

not_clicked

none

delay

integer · required

type

string · enum · required

An enumeration.

Enum values:

thumbnail_url

string · required

created_on

integer

updated_on

integer

parent_id

string

object

ActionStatResponse

bounces

integer · required

bounces_address_changed

integer · required

bounces_challenge_response

integer · required

bounces_dns_failure

integer · required

bounces_full_mailbox

integer · required

bounces_hard

integer · required

bounces_mail_blocked

integer · required

bounces_soft

integer · required

bounces_transient

integer · required

unique_clicks

integer · required

forwards

integer · required

implied_opens

integer · required

unique_opens

integer · required

unopens

integer · required

clicks

integer · required

opens

integer · required

spams

integer · required

spam_rate

number · required

unsubscribes

integer · required

sent_emails

integer · required

ActionStatsResponse

object · required

ActionSummaryResponse

id

string · required

name

string · required

condition

string · enum · required

An enumeration.

Enum values:

opened

not_opened

clicked

not_clicked

none

delay

integer · required

type

string · enum · required

An enumeration.

Enum values:

thumbnail_url

string · required

parent_id

string

created_on

integer

updated_on

integer

ActionTracking

opens

boolean

Default: true

clicks_html

boolean

Default: true

clicks_text

boolean

Default: true

ActionType

string · enum

Enum values:

An enumeration.

ActionsResponse

object · required

object[] · required

ActivateMFARequest

code

string · minLength: 6 · maxLength: 6 · pattern: ^[0-9]+$ · required

6 digit code from this MFA method

ActivateMFAResponse

id

string · required

MFA method id

object

string

Object type

Default: mfa

activated

boolean

Whether the MFA method was activated

Default: true

ActivateWorkflowResponse

id

string · required

object

string

Default: workflow

activated

boolean

Default: true

AddInterestsToContacts

interests

string[] · maxItems: 16 · required

contact_ids

integer[] · min: 1 · maxItems: 1024

query

string

fiql

string

json

object

AddInterestsToMultipleContactsResponse

object

string

Object type

Default: interests

added

boolean

Whether interests were added

Default: true

AdditionalEmailHeader

name

string · required

Header name (cc and bcc are not allowed)

value

string · required

Header value

Address

address1

string · minLength: 1 · required

Primary street address

country

string · minLength: 1 · required

Country name or code

address2

string

Secondary address line (suite, unit, etc.)

city

string

City name

province

string

Province, state, or region

postal_code

string

Postal or ZIP code

AddressResponse

address1

string

Address line 1

address2

string

Address line 2

city

string

City

country

string

Country

province

string

Province or state

postal_code

string

Postal or ZIP code

ArchiveCampaignResponse

id

integer · required

object

string

Default: campaign

archived

boolean

Default: true

ArchiveListResponse

id

integer · required

object

string

Default: list

archived

boolean

Default: true

ArchiveWebhookResponse

id

string · required

Unique identifier for the webhook

object · required

Archived webhook details

object

string

Default: Webhook

archived

boolean

Default: true

Attachment

filename

string · pattern: ^[a-zA-Z0-9-_]+\.(cs… · required

File name

type

string · enum · required

Content Type

Enum values:

csv

doc

docx

calendar

jpeg

pdf

png

xls

content

string · pattern: ^(?:[A-Za-z0-9+/]{4}… · required

Attachment content

AttachmentType

string · enum

Enum values:

csv

doc

docx

calendar

jpeg

pdf

png

xls

An enumeration.

Audience

list_id

integer · min: 1

ID of the contact list to send to

segment_id

integer · min: 1

ID of the segment to send to

AudienceResponse

list_id

integer

ID of the target list

name

string

List name

segment_id

integer

ID of the target segment

AudienceSummaryResponse

list_id

integer

ID of the target list

segment_id

integer

ID of the target segment

BadRequestMessage

msg

string · required

loc

string[]

type

string

Default: bad_request

Body_createToken

grant_type

string · enum

An enumeration.

Enum values:

password

refresh_token

Default: password

username

string · email

password

string · maxLength: 128

account_id

integer

scopes

string · pattern: ^(user|admin|interna…

A comma separated list of scopes.

Default: user

expiration_seconds

integer · min: 600

refresh_token

string

Body_refreshToken

refresh_token

string · required

grant_type

string · enum

An enumeration.

Enum values:

refresh_token

Default: refresh_token

expiration_seconds

integer · min: 600

Body_submitForm

email

string · email · required

language

string · enum

Supported Locales

Enum values:

da_DK

de_DE

el_GR

en_US

g-recaptcha-response

string

interests

object

tags

object

custom_attributes

object

BrowserInfo

family

string

Browser name

version

string

Browser version

CampaignBlueprintId

id

integer · required

CampaignBlueprintResponse

object · required

Template details

CampaignBlueprintSummaryResponse

id

integer · required

Unique identifier of the blueprint

name

string · required

Name of the blueprint

created_on

integer · required

Creation timestamp

updated_on

integer · required

Last update timestamp

description

string

tags

string[]

Tags associated with the blueprint

thumbnail_url

string

URL to the blueprint thumbnail image

thumbnail

string · deprecated · required

Thumbnail URL (deprecated)

CampaignBlueprintsResponse

object · required

object[] · required

CampaignContent

subject

string · minLength: 1

Email subject line

html

string · minLength: 1

HTML content of the email

text

string · minLength: 1

Plain text content of the email

json

object

JSON content of the email (BEE editor format)

type

string · enum

Content type of the email

Enum values:

custom

html

bee

Default: html

encoding

string · enum

Character encoding of the email content

Enum values:

utf-8

armscii-8

ascii

big-5

cp51932

cp866

cp936

euc-cn

object

Template to use for the campaign content

object

Blueprint to use for the campaign content

default_unsubscribe_link

boolean

Include a default unsubscribe link in the email

CampaignContentResponse

subject

string

Email subject line

html

string

HTML content of the email

text

string

Plain text content of the email

json

object

JSON representation of the email content

type

string · enum

Content type (HTML, text, or both)

Enum values:

html

bee

custom

hash

string

Content hash for change detection

last_updated_on

integer

Last content update timestamp

encoding

string · enum

Character encoding of the content

Enum values:

utf-8

armscii-8

ascii

big-5

cp51932

cp866

cp936

euc-cn

default_unsubscribe_link

boolean

Whether the default unsubscribe link is included

social_bar

boolean

Whether the social sharing bar is included

footer

string

Email footer content

CampaignFullResponse

id

integer · required

Unique campaign identifier

name

string

Campaign name

object

Target audience (list and optional segment)

type

string · enum

Campaign type

Enum values:

standard

recurring

absplit

object

Open and click tracking settings

created_on

integer

Creation timestamp

scheduled_for

integer

Scheduled delivery timestamp

scheduled_on

integer

When the campaign was scheduled

delivery_finished_on

integer

When delivery completed

object

Sender name and email

reply_to_email

string

Reply-to email address

object

Email content (subject, HTML, text)

next_building_step

string

Next step needed before scheduling

status

string · enum

Campaign lifecycle status

Enum values:

active

delivering

delivered

archived

deleted

incomplete

scheduled

suspended

boolean

Whether the campaign is suspended/paused

over_limit

boolean

Whether the campaign is over the limits of your plan

under_review

boolean

Whether the campaign is under review and on hold

heatmap_link

string

URL to the click heatmap visualization

web_email_link

string

URL to view the campaign in a browser

thumbnail_url

string

URL to the campaign thumbnail image

updated_on

integer

Last update timestamp

CampaignLinkStatsResponse

id

integer · required

Link ID

link

string · required

The tracked URL

unique

integer · required

Number of unique clicks

total

integer · required

Total number of clicks

unique_rate

number · required

Unique click rate percentage

total_rate

number · required

Total click rate percentage

CampaignLinksStatsResponse

object · required

Pagination details

object[] · required

Link click statistics

CampaignLogExportFullResponse

id

string · required

Export task id

campaign_id

integer · required

Campaign id

status

string · enum · required

Export status

Enum values:

pending

ready

deleted

failed

object · required

User who requested the export

created_on

integer · required

Creation date (Unix time)

expires_on

integer · required

Expiration date (Unix time)

progress

number · required

Export progress percentage

description

string

Export description

CampaignLogExportRequestedBy

id

integer · required

User id

email

string · required

User email

CampaignLogExportStatus

string · enum

Enum values:

pending

ready

deleted

failed

An enumeration.

CampaignLogExportsResponse

object · required

Pagination details

object[] · required

List of campaign log exports

CampaignLogResponse

id

integer · required

Log entry ID

contact_id

integer · required

ID of the contact

email

string

Contact email address

type

string · enum

Type of event

Enum values:

clickthru

click

open

bounce

bounce_ac

bounce_cr

bounce_df

bounce_fm

timestamp

integer

Timestamp of the event

occurrences

integer

Number of times this event occurred

clickthru_url

string

URL that was clicked

object

User agent details

CampaignLogsResponse

object · required

Pagination details

object[] · required

List of campaign log entries

CampaignResponse

object · required

CampaignRevision

id

integer · required

date

string · required

CampaignRevisionsResponse

object · required

object[] · required

CampaignStatResponse

active_emails

integer · required

Number of active email addresses

bounces

integer · required

Total number of bounced emails

bounce_rate

number · required

Percentage of emails that bounced

bounces_address_changed

integer · required

Bounces due to address change

bounces_challenge_response

integer · required

Bounces due to challenge-response

bounces_dns_failure

integer · required

Bounces due to DNS failure

bounces_full_mailbox

integer · required

Bounces due to full mailbox

bounces_hard

integer · required

Number of hard bounces

bounces_mail_blocked

integer · required

Bounces due to mail being blocked

bounces_soft

integer · required

Number of soft bounces

bounces_transient

integer · required

Number of transient bounces

clicks

integer · required

Total number of link clicks

click_rate

number · required

Percentage of delivered emails clicked

clickthru_rate

number · required

Percentage of opened emails clicked

forwards

integer · required

Number of email forwards

implied_opens

integer · required

Opens inferred from clicks

opens

integer · required

Total number of email opens

open_rate

number · required

Percentage of delivered emails opened

spams

integer · required

Number of spam complaints

unique_clicks

integer · required

Number of unique email clicks

unique_opens

integer · required

Number of unique email opens

unopens

integer · required

Number of emails never opened

unopen_rate

number · required

Percentage of emails never opened

unsubscribes

integer · required

Number of unsubscribes

unsubscribe_rate

number · required

Percentage of unsubscribes

spam_rate

number · required

Percentage of spam complaints

sent_emails

integer · required

Total number of emails sent

sent_rate

number · required

Percentage of emails successfully sent

CampaignStatsResponse

object · required

Campaign statistics

CampaignStatus

string · enum

Enum values:

active

delivering

delivered

archived

deleted

incomplete

scheduled

An enumeration.

CampaignSummaryResponse

id

integer · required

Unique campaign identifier

name

string

Campaign name

object

Target audience (list and optional segment)

type

string · enum

Campaign type

Enum values:

standard

recurring

absplit

created_on

integer

Creation timestamp

scheduled_for

integer

Scheduled delivery timestamp

scheduled_on

integer

When the campaign was scheduled

object

Sender name and email

next_building_step

string

Next step needed before scheduling

status

string · enum

Campaign lifecycle status

Enum values:

active

delivering

delivered

archived

deleted

incomplete

scheduled

suspended

boolean

Whether the campaign is suspended/paused

over_limit

boolean

Whether the campaign is over the limits of your plan

under_review

boolean

Whether the campaign is under review and on hold

web_email_link

string

URL to view the campaign in a browser

thumbnail_url

string

URL to the campaign thumbnail image

updated_on

integer

Last update timestamp

CampaignType

string · enum

Enum values:

standard

recurring

absplit

An enumeration.

CampaignsReportsExportResponse

id

string · required

Task id

status

string · enum · required

Task status

Enum values:

pending

ready

error

deleted

created_on

integer · required

Creation date (Unix time)

expires_on

integer · required

Expiration date (Unix time)

object · required

User who requested the task

payload

object · required

Task parameters

progress

integer · min: 0

Task progress percentage

Default: 0

type

string · enum

Task type

Enum values:

contactsexport

campaignlogexport

campaignsreportsexport

suppressedemailsexport

listlogsexport

unknown

Default: campaignsreportsexport

description

string

Task description

CampaignsResponse

object · required

object[] · required

CancelCampaignResponse

id

integer · required

object

string

Default: campaign

cancelled

boolean

Default: true

ChallengeResponse

challenge

string · required

MFA challenge identifier to submit to /token/challenge with a code

ChallengeResponseRequest

challenge

string · required

required

scopes

string[] · unique

Enum values:

user

admin

internal

auth

email_api

Default: ["user"]

expiration_seconds

integer · min: 600

ChangePassword

new

string · minLength: 8 · maxLength: 128 · required

New password

current

string

Current password (required unless caller has admin override)

password_strength_requirement

string · enum

An enumeration.

Enum values:

VERY_WEAK

WEAK

MODERATE

STRONG

VERY_STRONG

Default: VERY_WEAK

ConfirmAccount

confirmation

string · required

ConfirmAccountResponse

id

string · required

object

string

Default: account

email

string · email

object

metadata

string

confirmed

boolean

Default: true

ConfirmSender

confirmation_id

string · minLength: 1 · required

Confirmation token from the verification email

ConfirmSenderResponse

object · required

Confirmed sender details

confirmed

boolean

Whether the sender was confirmed

Default: true

object

string

Object type

Default: sender

ConfirmUserResponse

id

string · required

object · required

object

string

Default: user

confirmed

boolean

Default: true

Contact

email

string · email · required

Contact's email address

object[]

Custom attributes to set on the contact

ContactFullResponse

id

integer · required

Unique contact identifier

email

string · required

Contact email address

status

string · required

Subscription status: active, unsubscribed, or deleted

subscribed_on

integer · required

Subscription timestamp

last_bounce_type

string · required

Type of last bounce (none, soft, or hard)

bounces_count

integer · required

Total number of bounces for this contact

object[] · required

Custom attribute name-value pairs

tags

string[]

Tags assigned to this contact

Default: []

interests

string[]

Interests assigned to this contact

Default: []

ContactResponse

object · required

ContactSimpleResponse

id

integer · required

Unique contact identifier

email

string · required

Contact email address

ContactStatus

string · enum

Enum values:

active

unsubscribed

deleted

An enumeration.

ContactsExportDeleteResponse

id

string · required

ID of the deleted export

object · required

Deleted export details

object

string

Object type

Default: contactsexport

deleted

boolean

Whether the export was deleted

Default: true

ContactsExportFullResponse

id

string · required

Unique identifier for the export task

status

string · enum · required

Current status of the export

Enum values:

pending

ready

deleted

failed

created_on

integer · required

When the export was created

expires_on

integer · required

When the export expires

progress

number · required

Export progress percentage

description

string

Description of the export

segment_id

integer

ID of the segment being exported

filter

string

Filter query string

query

string

SQL query used for the export

fiql

string

FIQL filter expression

json

object

JSON filter object

ContactsExportResponse

object · required

Export details

ContactsExportStatus

string · enum

Enum values:

pending

ready

deleted

failed

An enumeration.

ContactsExportsResponse

object · required

Pagination metadata

object[] · required

List of contact exports

ContactsResponse

object · required

object[] · required

ContentType

string · enum

Enum values:

custom

html

bee

An enumeration.

ContentTypeResponse

string · enum

Enum values:

html

bee

custom

An enumeration.

ConvertAccount

migrate_owner

boolean

Migrate the account owner from the original account to the Organization.

Default: true

CreateAccount

name

string · minLength: 1 · required

Account display name

object

Mailing address of the account

object

User to set as account owner

fax

string · minLength: 1

phone

string · minLength: 1

website

string · uri · minLength: 1 · maxLength: 2083

Account website URL

object

Account usage limits and feature flags

Default: {}

object

Custom domain configuration

Default: {}

trial

boolean

Whether this is a trial account

Default: false

partner

boolean

Whether this is a partner account

Default: false

CreateAccountResponse

id

string · required

object

string

Default: account

email

string · email

object

metadata

string

created

boolean

Default: true

object[]

Default: []

CreateActionResponse

id

string · required

object · required

object

string

Default: action

created

boolean

Default: true

CreateAttributeResponse

name

string · required

Name of the created custom attribute

object · required

Created custom attribute details

object

string

Object type

Default: attribute

created

boolean

Whether the attribute was created

Default: true

CreateCampaign

name

string · minLength: 1 · required

Name of the campaign

object

Target audience for the campaign

Default: {}

object

Tracking settings for the campaign

Default: {"opens":true,"clicks_html":true,"clicks_text":true}

object

Sender email and name for the campaign

reply_to_email

string · email

Specify a different reply-to email address than the sender

object

Email content of the campaign

Default: {"type":"html"}

CreateCampaignLogExportRequest

description

string

filter

string

Valid Terms:

additional_info
link_id
contact_id
email
uniques
group_by_contact
log_id
totals
type

Valid Operators:

==

Query separator:

CreateCampaignLogExportResponse

id

string · required

Export task id

object · required

Created export details

object

string

Object type

Default: task

created

boolean

Whether the export was created

Default: true

CreateCampaignReportExport

description

string

CreateCampaignResponse

id

integer · required

object · required

object

string

Default: campaign

created

boolean

Default: true

CreateCampaignsReportsExportResponse

object · required

Created export details

CreateContactResponse

id

integer · required

object

string

Default: contact

created

boolean

Default: true

object

CreateContactsExportResponse

id

string · required

ID of the created export task

object · required

Created export details

object

string

Object type

Default: task

created

boolean

Whether the export was created

Default: true

CreateCustomAttribute

name

string · pattern: ^[A-Za-z0-9\-_]+$ · required

Cannot be one of the reserved terms: id, email, status, registered, bounce_type, bounce_count, tags, _tags

type

string · enum · required

An enumeration.

Enum values:

text

mediumtext

integer

timestamp

datetime

CreateDkim

domain

string · required

selector

string

CreateDkimResponse

object · required

Created DKIM key details

object

string

Object type

Default: dkim

created

boolean

Whether the DKIM key was created

Default: true

CreateEnhancedForm

list_id

integer · required

List ID

name

string · required

Name of the form

description

string

tags

string[]

Tags of the form

post_redirect_url

string

Instead of the usual API reply, redirect to this URL when submitting the form.

double_opt_in_redirect_url

string

Redirect to this URL after the double opt in callback.

type

string

Default: enhanced

object

Recaptcha configuration

Default: {}

object

Content of the form

Default: {}

branding

string · enum

Branding type - either 'smart' or 'basic'

Enum values:

smart

basic

Default: basic

double_opt_in

boolean

Whether to use double opt in

Default: true

async_processing

boolean

Whether to process the form submission asynchronously.

Default: false

CreateForm

name

string · minLength: 1 · required

Name of the form

object · required

HTML content of the form

list_id

integer · min: 1 · required

ID of the contact list to subscribe to

language

string · enum · required

Language of the form

Enum values:

da_DK

de_DE

el_GR

en_US

status

string · enum

Publication status of the form

Enum values:

active

deleted

Default: active

object

Post-action redirect URLs

Default: {}

double_opt_in

boolean

Whether to use double opt-in

Default: true

type

string

Default: basic

CreateListLogsExportRequest

description

string

filter

string

Valid Terms:

additional_info
contact_id
email
uniques
group_by_contact
track_id
log_id
start_id
end_id
totals
type

Valid Operators:

==

Query separator:

CreateListLogsExportResponse

id

string · required

Export task id

object · required

Created export details

object

string

Object type

Default: task

created

boolean

Whether the export was created

Default: true

CreateListResponse

id

integer · required

object · required

created

boolean

Default: true

CreateMFARequest

type

string · enum · required

An enumeration.

Enum values:

totp

description

string

CreateMFAResponse

id

string · required

MFA method id

object · required

Created MFA method details

object

string

Object type

Default: mfa

created

boolean

Whether the MFA method was created

Default: true

CreatePatRequest

name

string · minLength: 1 · maxLength: 128 · pattern: ^[\w\s\-.,!@#%()+='\… · required

Human-readable token name

scopes

string[] · required

Requested scopes (broad or granular)

Enum values:

lists:read

lists:write

lists:delete

contacts:read

contacts:write

contacts:delete

contacts:import

contacts:export

allowed_account_ids

integer[]

Restrict this token to a specific set of account IDs. When set, the token will be rejected with 403 Forbidden on any request that operates on an account not in this list, even if the owning user has access to that account. Use this to apply the principle of least privilege in multi-account contexts — for example, grant an automation token access to only the accounts it actually needs to manage. Null (default) means the token is unrestricted and inherits all account access rights of the owning user.

expires_at

integer

Expiry as a Unix timestamp (seconds since epoch). Null = never expires.

CreatePatResponse

key_prefix

string · required

Public identifier (first 12 chars of token)

name

string · required

Human-readable token name

scopes

string[] · required

Granted granular scopes

status

string · required

Token status: active or revoked

created_at

integer · required

Creation timestamp (Unix)

plaintext

string · required

Full token plaintext (shown once; store securely)

allowed_account_ids

integer[]

Null = unrestricted. List = restricted to these account IDs.

expires_at

integer

Expiry timestamp (Unix) or null

revoked_at

integer

Revocation timestamp (Unix) or null

CreateSegmentResponse

id

integer · required

Segment id

object · required

Created segment details

object

string

Object type

Default: segment

created

boolean

Whether the segment was created

Default: true

CreateSender

name

string · minLength: 1 · required

Display name of the sender

email

string · email · required

Email address of the sender

language

string · enum

Language for sender-related communications

Enum values:

da_DK

de_DE

el_GR

en_US

Default: en_US

CreateSenderResponse

id

string · required

Unique identifier of the created sender

object · required

Created sender details

created

boolean

Whether the sender was created

Default: true

object

string

Object type

Default: sender

CreateSubscriptionFormEndpointRequest

domain

string · pattern: ^(?:[a-zA-Z0-9](?:[a…

domain name hosting the form

name

string

Name of the form

double_opt_in

boolean

Whether to use double opt in

Default: true

secret

string

Google reCaptcha secret key

post_redirect_url

string

Instead of the usual API reply, redirect to this URL when submitting the form.

double_opt_in_redirect_url

string

Redirect to this URL after the double opt in callback.

async_processing

boolean

Whether to process the form submission asynchronously.

Default: true

CreateSubscriptionFormEndpointResponse

object · required

object

string

Default: subscription_form_endpoint

created

boolean

Default: true

CreateSuppressedEmailResponse

email

string · required

Suppressed email address

created

boolean

Whether the suppression was created

Default: true

CreateSuppressedEmailsExportResponse

id

string · required

Export task id

object · required

Created export details

object

string

Object type

Default: task

created

boolean

Whether the export was created

Default: true

CreateTag

tag

string · minLength: 1 · maxLength: 64 · pattern: ^[A-Za-z0-9.\-+_]+$ · required

CreateTagResponse

tag

string · required

Tag value

object

string

Object type

Default: tag

created

boolean

Whether the tag was created

Default: true

object

Created tag details

CreateTransactionalEmailFromTemplate

subject

string · required

template_id

integer · required

CreateTransactionalEmailTemplate

name

string · required

object · required

required

reply_to

string · email

cc

string[] · maxItems: 1

object

CreateTransactionalEmailTemplateContent

type

string · enum · required

An enumeration.

Enum values:

custom

html

bee

subject

string · required

json

object

html

string

CreateTransactionalEmailTemplateResponse

id

integer · required

object · required

object

string

Default: transactional-email-template

created

boolean

Default: true

CreateUserResponse

id

string · required

object · required

object

string

Default: user

created

boolean

Default: true

CreateWebhook

event

string · enum · required

An enumeration.

Enum values:

Account.Created

Account.Updated

Account.Confirmed

Account.Deleted

ContactsExport.Created

ContactsExport.Deleted

Campaign.Canceled

Campaign.Created

url

string · uri · minLength: 1 · maxLength: 2083 · required

rate_limit

integer

Default: 50

rate_limit_period

string · enum

An enumeration.

Enum values:

second

minute

Default: second

CreateWebhookResponse

id

string · required

Unique identifier for the webhook

object · required

Created webhook details

CreateWorkflowResponse

object · required

id

string · required

object

string

Default: workflow

created

boolean

Default: true

Cursor

previous

string

Previous page cursor token

next

string

Next page cursor token

CustomAttribute

name

string · minLength: 1 · required

Attribute name

value

string

Attribute value

CustomAttributeFullResponse

One List

name

string

Name of the custom attribute

type

string · enum

Data type of the custom attribute

Enum values:

text

mediumtext

integer

timestamp

datetime

CustomAttributeResp

name

string · minLength: 1 · required

Attribute name

value

string

Attribute value

CustomAttributeResponse

object · required

Custom attribute details

CustomAttributeType

string · enum

Enum values:

text

mediumtext

integer

timestamp

datetime

An enumeration.

CustomAttributesDataResponse

name

string · minLength: 1 · required

Attribute name

value

string · required

CustomAttributesResponse

object · required

Pagination metadata

object[] · required

List of custom attributes

DeactivateWorkflowResponse

id

string · required

object

string

Default: workflow

deactivated

boolean

Default: true

DeleteAccountResponse

id

string · required

object

string

Default: account

deleted

boolean

Default: true

DeleteActionResponse

id

string · required

object · required

object

string

Default: action

deleted

boolean

Default: true

DeleteCampaignResponse

id

integer · required

object

string

Default: campaign

deleted

boolean

Default: true

DeleteCampaignsReportsExportResponse

object · required

Deleted export details

DeleteContactResponse

id

integer · required

object

string

Default: contact

deleted

boolean

Default: true

DeleteCustomAttributeResponse

name

string · required

Name of the deleted custom attribute

object

string

Object type

Default: attribute

deleted

boolean

Whether the attribute was deleted

Default: true

DeleteDkimKeyResponse

object · required

Deleted DKIM key details

object

string

Object type

Default: dkim

deleted

boolean

Whether the DKIM key was deleted

Default: true

DeleteFormResponse

id

string · required

ID of the deleted form

object

string

Object type

Default: form

deleted

boolean

Whether the form was deleted

Default: true

DeleteListResponse

id

integer · required

object

string

Default: list

deleted

boolean

Default: true

DeleteLogoResponse

object

string

Default: logo

deleted

boolean

Default: true

DeleteMFAResponse

id

string · required

MFA method id

object

string

Object type

Default: mfa

deleted

boolean

Whether the MFA method was deleted

Default: true

DeleteSegmentResponse

id

integer · required

Segment id

object

string

Object type

Default: segment

deleted

boolean

Whether the segment was deleted

Default: true

DeleteSenderResponse

id

string · required

Unique identifier of the deleted sender

deleted

boolean

Whether the sender was deleted

Default: true

object

string

Object type

Default: sender

DeleteSubscriptionFormEndpointResponse

object · required

object

string

Default: subscription_form_endpoint

deleted

boolean

Default: true

DeleteSuppressedEmailResponse

email

string · required

Suppressed email address

deleted

boolean

Whether the suppression was deleted

Default: true

DeleteSuppressedEmailsExportResponse

id

string · required

Export task id

object · required

Deleted export details

object

string

Object type

Default: task

deleted

boolean

Whether the export was deleted

Default: true

DeleteTagResponse

tag

string · required

Tag value

object

string

Object type

Default: tag

deleted

boolean

Whether the tag was deleted

Default: true

DeleteTemplateResponse

id

integer · required

ID of the deleted template

object

string

Object type

Default: template

deleted

boolean

Whether the template was deleted

Default: true

DeleteTransactionalEmailTemplateResponse

id

integer · required

object · required

object

string

Default: transactional-email-template

deleted

boolean

Default: true

DeleteUserResponse

id

string · required

object

string

Default: user

deleted

boolean

Default: true

DeleteWorkflowResponse

object · required

id

string · required

object

string

Default: workflow

deleted

boolean

Default: true

DeviceFamilyEnum

string · enum

Enum values:

mobile

tablet

An enumeration.

DeviceInfo

family

string · enum

Device type (pc, mobile, tablet)

Enum values:

mobile

tablet

brand

string

Device manufacturer

model

string

Device model name

DisableFormResponse

object · required

Disabled form details

object

string

Object type

Default: form

enabled

boolean

Whether the form is enabled

Default: false

DisableSubscriptionFormEndpointResponse

object · required

object

string

Default: subscription_form_endpoint

enabled

boolean

Default: false

DkimKeyFullResponse

id

integer · required

Unique identifier for the DKIM key

selector

string · required

DNS selector for the DKIM key

domain

string · required

Domain associated with the DKIM key

public_key

string · required

Public key value for DNS record

account_default

boolean · required

Whether this is the account default DKIM key

status

string · enum

Persisted status of the DKIM key: 'active' or 'inactive'. Omitted (null) when no information is available.

Enum values:

active

inactive

domain_default

boolean

Whether this is the default DKIM key for its domain

Default: false

live_dns_status

string · enum

Result of the live DNS lookup performed when fetching this record: 'valid' (TXT matches the key), 'invalid' (TXT exists but does not match), or 'unknown' (DNS error or no TXT). Null when no live lookup was performed.

Enum values:

valid

invalid

unknown

DkimKeyListItemResponse

id

integer · required

Unique identifier for the DKIM key

selector

string · required

DNS selector for the DKIM key

domain

string · required

Domain associated with the DKIM key

public_key

string · required

Public key value for DNS record

account_default

boolean · required

Whether this is the account default DKIM key

status

string · enum

Persisted status of the DKIM key: 'active' or 'inactive'. Omitted (null) when no information is available.

Enum values:

active

inactive

domain_default

boolean

Whether this is the default DKIM key for its domain

Default: false

DkimKeyResponse

object · required

DKIM key details

DkimKeySummaryResponse

id

integer · required

Unique identifier for the DKIM key

selector

string · required

DNS selector for the DKIM key

domain

string · required

Domain associated with the DKIM key

public_key

string · required

Public key value for DNS record

status

string · enum

Persisted status of the DKIM key: 'active' or 'inactive'. Omitted (null) when no information is available.

Enum values:

active

inactive

DkimKeysResponse

object[] · required

List of DKIM keys

DkimRecordActivateResponse

object · required

Activated DKIM key status

object

string

Object type

Default: dkim

activated

boolean

Whether the DKIM key was activated

Default: true

DkimRecordDeactivateResponse

object · required

Deactivated DKIM key status

object

string

Object type

Default: dkim

deactivated

boolean

Whether the DKIM key was deactivated

Default: true

DkimRecordStatusData

id

integer · required

Unique identifier for the DKIM key

status

string · enum · required

The persisted status, 'active' or 'inactive'

Enum values:

active

inactive

DomainInstructionResponse

entry

string · required

valid

boolean · required

Domains

bounce

string

Custom bounce domain for email delivery

tracking

string · uri · minLength: 1 · maxLength: 2083

Custom domain for tracking links

forward

string · uri · minLength: 1 · maxLength: 2083

Custom domain for forward-to-a-friend links

DomainsFullResponse

auth

string · required

Authentication domain

bounce

string · required

Bounce handling domain

dkim

string · required

DKIM signing domain

tracking

string · required

Link tracking domain

DomainsInstructionResponse

object[] · required

DomainsResponse

object · required

DoubleOptIn

string · enum

Enum values:

true

false

new

not_active

Default: 'false'

Send a double opt-in/confirmation email

new : send only if the email is new to the list
not_active : send only if the contact is not already active
true : send the email regardless of contact status
false : do not send the email

DownloadCampaignLogExportFullResponse

expires_on

integer · required

Download URL expiration date (Unix time)

url

string · uri · minLength: 1 · maxLength: 65536 · required

Download URL

DownloadCampaignLogExportResponse

object · required

Download details

DownloadCampaignsReportsExportFullResponse

expires_on

integer · required

Download URL expiration date (Unix time)

url

string · uri · minLength: 1 · maxLength: 65536 · required

Download URL

DownloadCampaignsReportsExportResponse

object · required

Download details

DownloadContactsExportFullResponse

expires_on

integer · required

When the download URL expires

url

string · uri · minLength: 1 · maxLength: 65536 · required

Temporary URL to download the export file

DownloadContactsExportResponse

object · required

Download details

DownloadListLogsExportFullResponse

expires_on

integer · required

Download URL expiration date (Unix time)

url

string · uri · minLength: 1 · maxLength: 65536 · required

Download URL

DownloadListLogsExportResponse

object · required

Download details

DownloadSuppressedEmailsExportFullResponse

expires_on

integer · required

Download URL expiration date (Unix time)

url

string · uri · minLength: 1 · maxLength: 65536 · required

Download URL

DownloadSuppressedEmailsExportResponse

object · required

Download details

Email

email

string · email · required

Recipient's email address

object · required

Sender name and email address

object · required

Email content (subject, HTML, text, or template)

group_id

integer · min: 1

Allows the grouping multiple transactional emails for analytics

object

Tracking options for opens and clicks

Default: {"opens":true,"clicks_html":true,"clicks_text":true}

object[]

Custom mail headers

One or more file attachments

queue

integer · min: 0 · max: 1

Queue ID

Default: 0

EmailAPIEventType

string · enum

Enum values:

submitted

processing

click

open

bounce

spam

unsubscribe

unsubscribe_reason

An enumeration.

EmailAPILogResponse

id

string · uuid · required

Log entry ID

type

string · enum · required

Type of event

Enum values:

submitted

processing

click

open

bounce

spam

unsubscribe

unsubscribe_reason

email_id

string · uuid · required

ID of the email

required

Time of the event

email

string

Recipient email address

subject

string

Email subject line

provider

string

Email delivery provider

tags

string[]

Tags associated with the email

sender_name

string

Sender display name

sender_email

string

Sender email address

metadata

object

Additional metadata for the event

EmailAPILogsResponse

object · required

Pagination details

object · required

Applied filter parameters

object[] · required

List of Email API log entries

EmailAPIMarketingEmailContent

subject

string · minLength: 1 · required

Email subject line

html

string · minLength: 1

HTML body of the email

text

string · minLength: 1

Plain text body of the email

object

Template to use for the email content

encoding

string · enum

Character encoding for HTML or text content

Enum values:

utf-8

armscii-8

ascii

big-5

cp51932

cp866

cp936

euc-cn

object[]

Values for the merge tags in the email content. Requires list management, as they are resolved against the recipient's contact record

markup

object

JSON-LD Email Markup Data

type

string · enum

Type of content.

marketing: A marketing email is one that encourages participation in a commercial activity. For example, emails promoting products, services, typically sent to a broad audience. (e.g.,newsletters, promotional offers).

Enum values:

marketing

Default: marketing

EmailAPIStatResponse

submitted

integer

Number of emails submitted via Email API

delivered

integer

Number of emails delivered via Email API

EmailAPIStatsIntervalResponse

required

Start of the interval

required

End of the interval

submitted

integer · required

Number of emails submitted

rejected

integer · required

Number of emails rejected

error

integer · required

Number of emails that errored

queued

integer · required

Number of emails queued for delivery

processed

integer · required

Number of emails processed

delivered

integer · required

Number of emails delivered

unique_open

integer · required

Number of unique email opens

unique_click

integer · required

Number of unique email clicks

open

integer · required

Total number of email opens

click

integer · required

Total number of link clicks

bounce

integer · required

Total number of bounced emails

hard_bounce

integer · required

Number of hard bounces

soft_bounce

integer · required

Number of soft bounces

spam

integer · required

Number of spam complaints

unsubscribe

integer · required

Number of unsubscribes

global_unsubscribe

integer · required

Number of global unsubscribes

unique_open_rate

number · required

Percentage of unique opens

unique_click_rate

number · required

Percentage of unique clicks

open_rate

number · required

Percentage of email opens

click_rate

number · required

Percentage of emails clicked

clickthru_rate

number · required

Percentage of opened emails clicked

delivery_rate

number · required

Percentage of emails delivered

error_rate

number · required

Percentage of emails that errored

reject_rate

number · required

Percentage of emails rejected

bounce_rate

number · required

Percentage of emails that bounced

global_unsubscribe_rate

number · required

Percentage of global unsubscribes

unsubscribe_rate

number · required

Percentage of unsubscribes

spam_rate

number · required

Percentage of spam complaints

EmailAPIStatsResponse

object · required

Applied filter parameters

object[] · required

Statistics per interval

EmailAPISummaryEngagementEnum

string · enum

Enum values:

click

open

none

open_not_click

An enumeration.

EmailAPISummaryItem

email_id

string · uuid · required

ID of the email

status

string · enum · required

Current status of the email

Enum values:

submitted

processing

click

open

bounce

spam

unsubscribe

unsubscribe_reason

email

string · required

Recipient email address

required

Time the email was submitted

subject

string

Email subject line

tags

string[]

Tags associated with the email

provider

string

Email delivery provider

Time the email was delivered

Time of the first open

Time of the first click

Time of the first engagement (open or click)

Time of the most recent engagement

unsubscribed

boolean

Whether the recipient unsubscribed

Default: false

global_unsubscribed

boolean

Whether the recipient globally unsubscribed

Default: false

soft_bounce

boolean

Whether the email soft bounced

Default: false

hard_bounce

boolean

Whether the email hard bounced

Default: false

reported_as_spam

boolean

Whether the email was reported as spam

Default: false

open

integer

Total number of opens

Default: 0

click

integer

Total number of clicks

Default: 0

EmailAPISummaryResponse

object · required

Pagination details

object · required

Applied filter parameters

object[] · required

List of email summaries

EmailAPISummaryStatus

string · enum

Enum values:

submitted

delivered

queued

rejected

error

bounced

spam

unsubscribed

An enumeration.

EmailAPITransactionalEmailContent

subject

string · minLength: 1 · required

Email subject line

html

string · minLength: 1

HTML body of the email

text

string · minLength: 1

Plain text body of the email

object

Template to use for the email content

encoding

string · enum

Character encoding for HTML or text content

Enum values:

utf-8

armscii-8

ascii

big-5

cp51932

cp866

cp936

euc-cn

object[]

Values for the merge tags in the email content. Requires list management, as they are resolved against the recipient's contact record

markup

object

JSON-LD Email Markup Data

type

string · enum

Type of content.

transactional: A transactional email does not encourage participation in a commercial activity. For example, emails containing essential information related to a user-initiated actionor account activity (e.g., password resets, order confirmations).

Enum values:

transactional

Default: transactional

EmailContent

subject

string · minLength: 1 · required

Email subject line

html

string · minLength: 1

HTML body of the email

text

string · minLength: 1

Plain text body of the email

object

Template to use for the email content

encoding

string · enum

Character encoding for HTML or text content

Enum values:

utf-8

armscii-8

ascii

big-5

cp51932

cp866

cp936

euc-cn

object[]

Values for the merge tags in the email content. Requires list management, as they are resolved against the recipient's contact record

EmailContentResponse

subject

string

Email subject line

template_id

integer

ID of the template used for the email

object[]

Custom attributes for merge tags

type

string · enum

Content type of the email

Enum values:

marketing

transactional

EmailGroupId

id

integer · required

Email group id

description

string · maxLength: 255

Email group description

EmailLogResponse

type

string · enum

Type of event

Enum values:

clickthru

click

open

bounce

bounce_ac

bounce_cr

bounce_df

bounce_fm

timestamp

integer

Timestamp of the event

email

string

Recipient email address

email_id

integer

ID of the email

group_id

integer

ID of the contact list

object

User agent details

clickthru_url

string

URL that was clicked

dsn_message

string

Delivery status notification message

sender_name

string

Sender display name

sender_email

string

Sender email address

source_ip

string

Source IP address

envelope_from

string

Envelope sender address

object[]

Additional email headers

EmailLogsResponse

object · required

Pagination details

object[] · required

List of email log entries

EmailSenderResponse

id

string

Sender identifier

name

string

Sender display name

email

string

Sender email address

EmailStatResponse

date

integer · required

Date

sent_emails

integer · required

Number of emails sent on this date

open_rate

number · required

Percentage of delivered emails opened

bounce_rate

number · required

Percentage of emails that bounced

click_rate

number · required

Percentage of delivered emails clicked

spam_rate

number · required

Percentage of spam complaints

EmailStatsResponse

object[] · required

Email statistics per date

EmailTagType

string · enum

Enum values:

emails

events

An enumeration.

EmailTracking

opens

boolean

Enable the tracking of opens (only available for the HTML version)

Default: true

clicks_html

boolean

Enable the tracking of link clicks in the HTML version

Default: true

clicks_text

boolean

Enable the tracking of link clicks in the text version

Default: true

EmailTrackingResponse

opens

boolean · required

Whether open tracking is enabled

clicks_html

boolean · required

Whether HTML click tracking is enabled

clicks_text

boolean · required

Whether text click tracking is enabled

EnableFormResponse

object · required

Enabled form details

object

string

Object type

Default: form

enabled

boolean

Whether the form is enabled

Default: true

EnableSubscriptionFormEndpointResponse

object · required

object

string

Default: subscription_form_endpoint

enabled

boolean

Default: true

Encoding

string · enum

Enum values:

utf-8

armscii-8

ascii

big-5

cp51932

cp866

cp936

euc-cn

An enumeration.

EncodingResponse

string · enum

Enum values:

utf-8

armscii-8

ascii

big-5

cp51932

cp866

cp936

euc-cn

An enumeration.

EnhancedFormContent

json

object

JSON content of the form

EnhancedFormResponse

id

string · required

Unique identifier for the subscription form endpoint

list_id

integer

List ID

enabled

boolean

Whether the subscription form is enabled

name

string

Name of the subscription form

post_redirect_url

string

URL to redirect to after form submission

double_opt_in

boolean

Whether to use double opt-in

double_opt_in_redirect_url

string

URL to redirect to after double opt-in

published_url

string

URL to render the public published content of the form

submission_url

string

URL to submit the form to

async_processing

boolean

Whether to process the form asynchronously

branding

string · enum

Branding type - either 'smart' or 'basic'

Enum values:

smart

basic

Default: basic

created_on

integer · min: 0

Date and time the form was created

Default: 0

updated_on

integer · min: 0

Date and time the form was last updated

Default: 0

published_on

integer · min: 0

Date and time the form was published

object

User who last edited the form

Default: {}

thumbnail_url

string

Thumbnail URL

object

reCaptcha

Default: {}

description

string

Description of the subscription form

tags

string[]

Tags of the subscription form

object

Content of the form

Default: {}

EventType

string · enum

Enum values:

Account.Created

Account.Updated

Account.Confirmed

Account.Deleted

Contact.Added

Contact.Updated

Contact.Removed

Contact.Tagged

An enumeration.

EventTypeResponse

string · enum

Enum values:

clickthru

click

open

bounce

bounce_ac

bounce_cr

bounce_df

bounce_fm

exposed_string = database_string

FilterParameters

Start of the reporting period

End of the reporting period

interval

string

Time interval for grouping results

resolution

string

Data resolution granularity

iso_time

boolean

Default: false

timezone

string

Timezone for date formatting

tags

object

Tag filters applied to the query

providers

object

Provider filters applied to the query

ForbiddenMessage

msg

string · required

code

integer

type

string

Default: forbidden

ForgotMyPassword

email

string · email · required

Email address of the user requesting a password reset

FormBranding

string · enum

Enum values:

smart

basic

An enumeration.

FormContent

embedded

string · minLength: 1

The HTML content representing the form that can be embedded on a website

linked

string · minLength: 1

The HTML content representing the hosted version of the form

FormContentResponse

linked

string

HTML content for linked form

embedded

string

HTML content for embedded form

FormFullResponse

id

string · required

Unique identifier for the form

name

string · required

Name of the form

status

string · enum · required

Current status of the form

Enum values:

active

deleted

object · required

HTML content of the form

language

string · enum · required

Language of the form

Enum values:

da_DK

de_DE

el_GR

en_US

object · required

URLs for the form

object · required

Redirect URLs after form actions

created_on

integer

When the form was created

last_updated_on

integer

When the form was last updated

thumbnail_url

string

URL of the form thumbnail image

list_id

integer

ID of the contact list linked to the form

double_opt_in

boolean

Whether double opt-in is enabled

thumbnail

string · deprecated · required

FormRedirections

after_opt_in

string · uri · minLength: 1 · maxLength: 2083

URL to redirect to after opt-in

after_double_opt_in

string · uri · minLength: 1 · maxLength: 2083

URL to redirect to after double opt-in confirmation

after_opt_out

string · uri · minLength: 1 · maxLength: 2083

URL to redirect to after opt-out

FormRedirectionsResponse

after_opt_in

string

Redirect URL after opt-in

after_double_opt_in

string

Redirect URL after double opt-in confirmation

after_opt_out

string

Redirect URL after opt-out

FormStatus

string · enum

Enum values:

active

deleted

An enumeration.

FormSubmissionStatus

string · enum

Enum values:

pending

processed

An enumeration.

FormUrlsResponse

linked

string

URL for the linked version of the form

embedded

string

URL for the embedded version of the form

FormUser

id

integer

User ID

email

string

User email

GetActionResponse

object · required

GetCampaignsReportsExportResponse

object · required

Export details

GetEmailResponse

email_id

string · uuid · required

Unique identifier of the email

status

string · enum · required

Current delivery status of the email

Enum values:

submitted

processing

click

open

bounce

spam

unsubscribe

unsubscribe_reason

email

string · required

Recipient email address

submitted_time

integer · required

Submission timestamp

object · required

Sender information

object · required

Email content details

object · required

Tracking configuration

provider

string

Email delivery provider

unsubscribed

boolean

Whether recipient unsubscribed

Default: false

global_unsubscribed

boolean

Whether recipient globally unsubscribed

Default: false

soft_bounced

boolean

Whether the email soft bounced

Default: false

hard_bounced

boolean

Whether the email hard bounced

Default: false

reported_as_spam

boolean

Whether the email was reported as spam

Default: false

open

integer

Number of times the email was opened

Default: 0

click

integer

Number of link clicks in the email

Default: 0

list_id

integer

ID of the contact list

tags

string[]

Tags associated with the email

object[]

Additional email headers

thumbnail_url

string

URL to the email thumbnail image

GetMFAPortalResponse

url

string · uri · minLength: 1 · maxLength: 2083 · required

MFA portal URL

GetSuppressedEmailsExportResponse

object · required

Export details

GetWorkflowResponse

object · required

HTTPBadRequestError

object[] · required

HTTPForbiddenError

object[] · required

HTTPInternalServerError

object[] · required

HTTPUnauthorizedError

object[] · required

HTTPValidationError

object[]

HasMorePagination

page

integer

Current page number

Default: 1

per_page

integer

Number of items per page

has_more

boolean

Whether more items are available

Default: false

ImportContactData

email

string · email · required

Contact's email address

object[] · minItems: 1

Custom attributes to set on the contact

tags

string[]

Tags to assign to the contact

interests

string[]

Interests to assign to the contact

ImportContactInvalidCustomAttributeErrorResponse

loc

string[] · required

msg

string

Default: Invalid custom attribute

code

integer

Default: 8014

ImportContactNotFoundErrorResponse

loc

string[] · required

msg

string

Default: Contact not found

code

integer

Default: 8001

ImportContactUnknownErrorResponse

loc

string[] · required

msg

string

Default: Unknown error

code

integer

Default: 8015

ImportContacts

object[] · minItems: 1 · required

List of contacts to import

import_to

string · enum

Status to assign to imported contacts

Enum values:

active

unsubscribed

deleted

contact_details

boolean

Include detailed contact information in the response. When false, returns only ID and email.

Default: true

resubscribe

boolean

Resubscribe previously unsubscribed contacts

Default: false

remove_tags

boolean

Tags are removed if omitted.

Default: true

remove_interests

boolean

Interests are removed if omitted.

Default: true

ImportContactsResponse

id

integer[] · required

IDs of successfully imported contacts

import_id

string · uuid4

Unique identifier for this import batch

object

string

Object type

Default: contact

imported

boolean

Whether the import succeeded

Default: true

array

Imported contact details

Default: []

array

Errors encountered during import

InterestCreate

name

string · minLength: 1 · maxLength: 255 · pattern: ^[+@\-_#a-zA-Z0-9]+$ · required

alias

string

InterestCreatedResponse

object · required

Created interest details

object

string

Object type

Default: interest

created

boolean

Whether the interest was created

Default: true

InterestDeletedResponse

object · required

Deleted interest details

object

string

Object type

Default: interest

deleted

boolean

Whether the interest was deleted

Default: true

InterestFullResponse

name

string · required

Name of the interest

alias

string

URL-friendly alias for the interest

usage

integer

Number of contacts with this interest

InterestPatch

name

string

alias

string

InterestPatchedResponse

object · required

Patched interest details

object

string

Object type

Default: interest

patched

boolean

Whether the interest was patched

Default: true

InterestResponse

object · required

Interest details

InterestsResponse

object · required

Pagination metadata

object[] · required

List of interests

InternalServerErrorMessage

msg

string · required

type

string

Default: fatal_error

IntervalEnum

string · enum

Enum values:

15m

30m

An enumeration.

Languages

string · enum

Enum values:

da_DK

de_DE

el_GR

en_US

Supported Locales

LinkFullResponse

id

integer · required

Unique identifier for the link

status

string · required

Current status of the link

link_to

string · required

URL the link points to

LinkInfoFullResponse

mailing_id

integer · required

Identifier of the mailing containing this link

LinkInfoResponse

object · required

Link info details

LinksResponse

object · required

Pagination metadata

object[] · required

List of links

List

name

string · minLength: 1 · required

List Name

object · required

language

string · enum

Supported Locales

Enum values:

da_DK

de_DE

el_GR

en_US

Default: en_US

object

Default: {}

object

Default: {}

ListCampaignsReportsExportsResponse

object · required

Pagination details

object[] · required

List of campaign report exports

ListEmailGroupIdsResponse

object · required

Pagination details

object[] · required

List of email group ids

ListEmailTagsResponse

object · required

Pagination details

data

string[] · required

List of email tags

ListFullResponse

id

integer · required

Unique list identifier

name

string · required

List name

status

string · required

List status: active, archived, or deleted

language

string · required

Default language for the list (e.g. en_US)

created_on

integer · required

Creation timestamp

object · required

Default sender identity for campaigns

object · required

Redirect URLs after subscription events

object · required

Hosted page URLs for subscription management

object · required

Webhook configuration for list events

policy_accepted

boolean

Whether the anti-spam policy has been accepted

Default: false

ListLogResponse

id

integer

Log entry ID

contact_id

integer

ID of the contact

email

string

Contact email address

type

string · enum

Type of event

Enum values:

clickthru

click

open

bounce

bounce_ac

bounce_cr

bounce_df

bounce_fm

timestamp

integer

Timestamp of the event

occurrences

integer

Number of times this event occurred

object

User agent details

campaign_id

integer

ID of the associated campaign

clickthru_url

string

URL that was clicked

dsn_message

string

Delivery status notification message

unsub_reason

string

Reason given for unsubscribing

subscription_type

string · enum

Type of subscription event

Enum values:

resubscribe

subscription_confirmation

ListLogsExportFullResponse

id

string · required

Export task id

list_id

integer · required

List id

status

string · enum · required

Export status

Enum values:

pending

ready

deleted

failed

object · required

User who requested the export

created_on

integer · required

Creation date (Unix time)

expires_on

integer · required

Expiration date (Unix time)

progress

number · required

Export progress percentage

description

string

Export description

ListLogsExportRequestedBy

id

integer · required

User id

email

string · required

User email

ListLogsExportStatus

string · enum

Enum values:

pending

ready

deleted

failed

An enumeration.

ListLogsExportsResponse

object · required

Pagination details

object[] · required

List of list log exports

ListLogsResponse

object · required

Pagination details

object[] · required

List of contact list log entries

ListMFAResponse

object · required

Pagination details

object[] · required

List of MFA methods

ListPagesResponse

opt_in

string

Hosted opt-in confirmation page URL

opt_out

string

Hosted opt-out confirmation page URL

subscribe

string

Hosted subscribe page URL

unsubscribe

string

Hosted unsubscribe page URL

ListRedirectionsResponse

after_opt_in

string

Redirect URL after single opt-in

after_double_opt_in

string

Redirect URL after double opt-in confirmation

after_opt_out

string

Redirect URL after opt-out

ListResponse

object · required

ListSenderResponse

name

string

Sender display name

email

string

Sender email address

ListStatResponse

active_contacts

integer · required

Number of active contacts

pending_contacts

integer · required

Number of contacts pending confirmation

invalid_contacts

integer · required

Number of invalid contacts

unsubscribed_contacts

integer · required

Number of unsubscribed contacts

flagged_contacts

integer · required

Number of flagged contacts

deleted_contacts

integer · required

Number of deleted contacts

sent_emails

integer · required

Total number of emails sent

open_rate

number · required

Percentage of delivered emails opened

bounce_rate

number · required

Percentage of emails that bounced

click_rate

number · required

Percentage of delivered emails clicked

clickthru_rate

number · required

Percentage of opened emails clicked

unsubscribe_rate

number · required

Percentage of unsubscribes

spam_rate

number · required

Percentage of spam complaints

ListStatsResponse

object · required

Contact list statistics

ListSubscriptionFormEndpointResponse

object · required

object[] · required

ListSummaryResponse

id

integer · required

Unique list identifier

name

string · required

List name

status

string · required

List status: active, archived, or deleted

language

string · required

Default language for the list (e.g. en_US)

object · required

Default sender identity for campaigns

created_on

integer

Creation timestamp

ListSuppressedEmailsExportsResponse

object · required

Pagination details

object[] · required

List of suppressed emails exports

ListTasksResponse

object · required

Pagination details

object[] · required

List of tasks

ListTransactionalEmailTemplateResponse

object · required

object[] · required

ListWebhookAction

string · enum

Enum values:

all

unsubscribe

update

delete

spam

bounce

bounce_ac

An enumeration.

ListWebhookResponse

url

string

Webhook endpoint URL

actions

string[]

Events that trigger the webhook

Enum values:

all

unsubscribe

update

delete

spam

bounce

bounce_ac

ListWebhooksResponse

object · required

Pagination metadata

object[] · required

List of webhooks

ListWorkflowsResponse

object · required

object[] · required

ListsResponse

object · required

object[] · required

LockWorkflow

key

string · pattern: ^[a-zA-Z0-9-_]{8,}$ · required

LockWorkflowResponse

locked

boolean · required

expires_in

integer · required

object

string

Default: workflow

LogType

string · enum

Enum values:

bounce

clickthru

sent

open

unsubscribe

resubscribe

spam

global_unsubscribe

An enumeration.

LogTypeV2

string · enum

Enum values:

all

submitted

rejected

error

queued

delivered

open

click

An enumeration.

MFAResponse

id

string · required

MFA method id

type

string · enum · required

MFA type

Enum values:

totp

description

string

MFA method description

MFAType

string · enum

Enum values:

totp

An enumeration.

NewTOTPMFAResponse

id

string · required

MFA method id

qr_code

string · required

QR code image for authenticator app setup

secret

string · required

A secret key

type

string · enum

MFA type

Enum values:

totp

Default: totp

description

string

MFA method description

OperatingSystemInfo

family

string

Operating system name

version

string

Operating system version

Pagination

page

integer

Current page number

Default: 1

per_page

integer

Number of items per page

count

integer

Total number of items

PaginationWithCursor

page

integer

Current page number

Default: 1

per_page

integer

Number of items per page

count

integer

Total number of items

object

Cursor for pagination

PasswordGrantType

string · enum

Enum values:

password

refresh_token

An enumeration.

PasswordStrengthRequirement

string · enum

Enum values:

VERY_WEAK

WEAK

MODERATE

STRONG

VERY_STRONG

An enumeration.

PatAuditLogEntry

id

integer · required

Log entry ID

actor_id

integer · required

User who performed the action

key_prefix

string · required

Token key prefix

action

string · required

Lifecycle event: create, update, or revoke

created_at

integer · required

Event timestamp (Unix)

delta

object

Change payload

PatAuditLogResponse

object[] · required

object · required

PatListResponse

object[] · required

object · required

PatPagination

total_records

integer · required

page

integer · required

per_page

integer · required

PatResponse

key_prefix

string · required

Public identifier (first 12 chars of token)

name

string · required

Human-readable token name

scopes

string[] · required

Granted granular scopes

status

string · required

Token status: active or revoked

created_at

integer · required

Creation timestamp (Unix)

allowed_account_ids

integer[]

Null = unrestricted. List = restricted to these account IDs.

expires_at

integer

Expiry timestamp (Unix) or null

revoked_at

integer

Revocation timestamp (Unix) or null

PatScopeInput

string · enum

Enum values:

lists:read

lists:write

lists:delete

contacts:read

contacts:write

contacts:delete

contacts:import

contacts:export

All valid PAT scope input values (granular + broad convenience aliases).

PatStatus

string · enum

Enum values:

active

revoked

expired

all

An enumeration.

PatchAccount

object

Mailing address of the account

name

string

Account display name

object

User to set as account owner

fax

string

phone

string

object

Custom domain configuration

Default: {}

website

string · uri · minLength: 1 · maxLength: 2083

Account website URL

object

Account usage limits and feature flags

Default: {}

trial

boolean

Whether this is a trial account

partner

boolean

Whether this is a partner account

metadata

object

Arbitrary metadata for the account

PatchAccountResponse

object · required

object[]

Default: []

PatchAction

name

string

parent_id

string

condition

string · enum

An enumeration.

Enum values:

opened

not_opened

clicked

not_clicked

none

delay

integer

type

string · enum

An enumeration.

Enum values:

object

PatchActionContent

subject

string · minLength: 1

Email subject line

html

string · minLength: 1

HTML content of the email

text

string · minLength: 1

Plain text content of the email

json

object

JSON content of the email (BEE editor format)

type

string · enum

An enumeration.

Enum values:

custom

html

bee

encoding

string · enum

An enumeration.

Enum values:

utf-8

armscii-8

ascii

big-5

cp51932

cp866

cp936

euc-cn

PatchActionEmailSettings

object

PatchActionResponse

id

string · required

object · required

object

string

Default: action

patched

boolean

Default: true

PatchActionTracking

opens

boolean

clicks_html

boolean

clicks_text

boolean

PatchCampaign

name

string · minLength: 1

Name of the campaign

object

Target audience for the campaign

Default: {}

object

Tracking settings for the campaign

object

Sender email and name for the campaign

reply_to_email

string · email

Specify a different reply-to email address than the sender

object

Email content of the campaign

Default: {}

PatchCampaignContent

subject

string · minLength: 1

Email subject line

html

string · minLength: 1

HTML content of the email

text

string · minLength: 1

Plain text content of the email

json

object

JSON content of the email (BEE editor format)

type

string · enum

Content type of the email

Enum values:

custom

html

bee

encoding

string · enum

Character encoding of the email content

Enum values:

utf-8

armscii-8

ascii

big-5

cp51932

cp866

cp936

euc-cn

default_unsubscribe_link

boolean

Include a default unsubscribe link in the email

PatchCampaignResponse

id

integer · required

object · required

object

string

Default: campaign

updated

boolean

Default: true

PatchContact

email

string · email

Contact's email address

object[]

Custom attributes to set on the contact

interests

string[]

Interests to assign to the contact

tags

string[]

Tags to assign to the contact

PatchContactResponse

id

integer · required

object · required

object

string

Default: contact

updated

boolean

Default: true

PatchDomains

object · required

Custom domain configuration

PatchDomainsResponse

object · required

object

string

Default: domains

patched

boolean

Default: true

PatchEmailGroupId

description

string · maxLength: 255 · pattern: ^[\w\s!@#$%^&*()_+\-… · required

PatchEmailGroupIdResponse

id

integer · required

Email group id

object · required

Updated email group id details

object

string

Object type

Default: email-group-id

updated

boolean

Whether the email group id was updated

Default: true

PatchEnhancedForm

description

string

tags

string[]

Tags of the form

post_redirect_url

string

Instead of the usual API reply, redirect to this URL when submitting the form.

double_opt_in_redirect_url

string

Redirect to this URL after the double opt in callback.

name

string

Name of the form

list_id

integer

List ID

object

Content of the form

object

Recaptcha configuration

branding

string · enum

Branding type - either 'smart' or 'basic'

Enum values:

smart

basic

double_opt_in

boolean

Whether to use double opt in

async_processing

boolean

Whether to process the form submission asynchronously.

PatchForm

name

string · minLength: 1

Name of the form

status

string · minLength: 1

Publication status of the form

object

HTML content of the form

Default: {}

object

Post-action redirect URLs

Default: {}

list_id

integer · min: 1

ID of the contact list to subscribe to

language

string · enum

Language of the form

Enum values:

da_DK

de_DE

el_GR

en_US

double_opt_in

boolean

Whether to use double opt-in

PatchListResponse

id

integer · required

object · required

updated

boolean

Default: true

PatchSegmentResponse

id

integer · required

Segment id

object · required

Updated segment details

object

string

Object type

Default: segment

updated

boolean

Whether the segment was updated

Default: true

PatchSelfAccount

object

Mailing address of the account

name

string

Account display name

object

User to set as account owner

fax

string

phone

string

object

Custom domain configuration

Default: {}

website

string · uri · minLength: 1 · maxLength: 2083

Account website URL

PatchSenderResponse

id

string · required

Unique identifier of the updated sender

object · required

Updated sender details

updated

boolean

Whether the sender was updated

Default: true

object

string

Object type

Default: sender

PatchSubscriptionFormEndpointRequest

domain

string · pattern: ^(?:[a-zA-Z0-9](?:[a…

domain name hosting the form

name

string

Name of the form

double_opt_in

boolean

Whether to use double opt in

secret

string

Google reCaptcha secret key

post_redirect_url

string

Instead of the usual API reply, redirect to this URL when submitting the form.

double_opt_in_redirect_url

string

Redirect to this URL after the double opt in callback.

async_processing

boolean

Whether to process the form submission asynchronously.

PatchSubscriptionFormEndpointResponse

object · required

object

string

Default: subscription_form_endpoint

updated

boolean

Default: true

PatchTag

tag

string · minLength: 1 · maxLength: 64 · pattern: ^[A-Za-z0-9.\-+_]+$ · required

PatchTagResponse

tag

string · required

Tag value

object · required

Updated tag details

object

string

Object type

Default: tag

updated

boolean

Whether the tag was updated

Default: true

PatchTemplate

name

string · minLength: 1

Name of the template

description

string

Description of the template

object

Content of the template

tags

string[]

Tags to categorize the template

PatchTemplateContent

type

string · enum

An enumeration.

Enum values:

html

text

bee

custom

subject

string

Default email subject line for the template

html

string · minLength: 1

HTML content of the template

text

string · minLength: 1

Plain text content of the template

json

object

JSON content of the template (BEE editor format)

PatchTemplateResponse

id

integer · required

ID of the updated template

object · required

Updated template details

object

string

Object type

Default: template

updated

boolean

Whether the template was updated

Default: true

PatchTracking

opens

boolean

Enable the tracking of opens (only available for the HTML version)

clicks_html

boolean

Enable the tracking of link clicks in the HTML version

clicks_text

boolean

Enable the tracking of link clicks in the text version

additional_params

string · minLength: 1

Append additional tracking parameters on all link (should be URL encoded)

PatchUser

first_name

string

last_name

string

title

string

Job title

office_phone

string

Office phone number

mobile_phone

string · pattern: [0-9]+

Mobile phone number (digits only)

language

string · enum

Preferred language (e.g. en_US, fr_FR)

Enum values:

da_DK

de_DE

el_GR

en_US

timezone

string

IANA timezone identifier (e.g. America/Montreal)

object

PatchUserResponse

id

string · required

object · required

object

string

Default: user

patched

boolean

Default: true

PatchWebhook

url

string · uri · minLength: 1 · maxLength: 2083

rate_limit

integer

rate_limit_period

string · enum

An enumeration.

Enum values:

second

minute

PatchWebhookResponse

id

string · required

Unique identifier for the webhook

object · required

Patched webhook details

object

string

Default: Webhook

patched

boolean

Default: true

PatchWorkflow

name

string

goal

string

description

string

trigger

string · enum

An enumeration.

Enum values:

subscribed

unsubscribed

manual

object

PatchWorkflowResponse

object · required

id

string · required

object

string

Default: workflow

patched

boolean

Default: true

PutSystemEmailsResponse

object · required

object

string

Default: systememails

updated

boolean

Default: true

RateLimitPeriod

string · enum

Enum values:

second

minute

An enumeration.

Recaptcha

secret

string

Google reCaptcha secret key

domain

string · pattern: ^(?:[a-zA-Z0-9](?:[a…

domain name hosting the form

site_key

string

Google reCaptcha site key

RecoveryCodesResponse

data

string[] · required

List of recovery codes

Redirections

after_opt_in

string · uri · minLength: 1 · maxLength: 2083

Redirection after Opt In

after_double_opt_in

string · uri · minLength: 1 · maxLength: 2083

Redirection after Double Opt In

after_opt_out

string · uri · minLength: 1 · maxLength: 2083

Redirection after Opt Out

RefreshGrantType

string · enum

Enum values:

refresh_token

An enumeration.

RelayGroupId

id

integer · required

description

string

RemoveInterestsFromContacts

interests

string[] · maxItems: 16 · required

contact_ids

integer[] · min: 1 · maxItems: 1024

query

string

fiql

string

json

object

RemoveInterestsFromMultipleContactsResponse

object

string

Object type

Default: interests

removed

boolean

Whether interests were removed

Default: true

RenderCampaignFullResponse

html

string

text

string

RenderCampaignResponse

object · required

RenderFormResponse

data

string

Rendered HTML content of the form

RenderTransactionalEmailTemplate

contact_id

integer · required

object[]

RequestedByUser

email

string · email · required

Email of the user who requested the task

id

integer · required

User id

ResendAccountVerificationEmailResponse

object

string

Default: account

verification_resent

boolean

Default: true

ResendConfirmationEmailResponse

id

string · required

Unique identifier of the sender

resent

boolean

Whether the confirmation email was resent

Default: true

object

string

Object type

Default: sender

ResendUserVerificationEmailResponse

object

string

Default: user

confirmation_resent

boolean

Default: true

ResendVerificationEmail

email

string · email · required

Email address to resend the verification to

ResetPasswordConfirm

token

string · required

Password reset token received via email

password

string · minLength: 8 · maxLength: 128 · required

New password to set

ResetPasswordConfirmResponse

object

string

Default: user

password_reset

boolean

Default: true

ResetPasswordResponse

email

string · required

object

string

Default: user

reset_link_sent

boolean

Default: true

ResetUserPassword

invalidate_current_password

boolean

If true, immediately invalidates the current password, forcing the user to reset

Default: false

ResumeCampaignResponse

id

integer · required

object

string

Default: campaign

resumed

boolean

Default: true

ScheduleCampaign

date

integer · min: 1 · max: 2147483647

Scheduled send time

html_empty

boolean

Required to be true if the html message is empty

Default: false

ScheduleCampaignResponse

id

integer · required

object

string

Default: campaign

scheduled

boolean

Default: true

Scope

string · enum

Enum values:

user

admin

internal

auth

email_api

An enumeration.

Segment

name

string · minLength: 1 · required

query

string · minLength: 1

SQL-like expression (use one of query, fiql and json)

fiql

string · minLength: 1

FIQL expression (use one of query, fiql and json)

json

object

JSON expression (use one of query, fiql and json)

SegmentFullResponse

id

integer · required

Segment id

name

string · required

Segment name

campaigns_count

integer · required

Number of campaigns using this Segment

last_used

integer · required

Last used date (Unix time)

created_on

integer · required

Creation date (Unix time)

query

string

SQL-like expression

fiql

string

FIQL expression

json

object

JSON expression

SegmentResponse

object · required

Segment details

SegmentsResponse

object · required

Pagination details

object[] · required

List of segments

SendEmailResponse

email

string · required

Recipient email address

object · required

Sent email details

object

string

Object type

Default: email

sent

boolean

Whether the email was sent

Default: true

SendTestAction

email

string · email · required

type

string · enum

An enumeration.

Enum values:

merged

separated

Default: merged

SendTestActionResponse

id

string · required

object

string

Default: action

sent

boolean

Default: true

SendTestEmail

email

string · email · required

type

string · enum

An enumeration.

Enum values:

merged

separated

Default: merged

SendTestEmailResponse

email

string · email · required

Recipient email address

type

string · enum · required

Type of test email sent

Enum values:

merged

separated

object

string

Object type

Default: test_email

sent

boolean

Whether the test email was sent

Default: true

SendTestTransactionalEmail

email

string · email · required

SendTestTransactionalEmailTemplateResponse

object

string

Default: transactional-email-test

sent

boolean

Default: true

SendTransactionalEmailResponse

email

string · required

object · required

object

string

Default: email

sent

boolean

Default: true

SendTransactionalEmailTemplateResponse

email

string · required

object · required

object

string

Default: transactional-email-template

sent

boolean

Default: true

SendTransactionalEmailToAddress

email

string · email · required

object

object[]

List of temporary custom attributes, overriding the contact's custom attributes. Note: the custom attributes will not be saved to the contact's profile.

object[]

resubscribe

boolean

Default: false

queue

integer · min: 0 · max: 1

Queue ID

Default: 0

SendTransactionalEmailToContactId

contact_id

integer · required

object

object[]

List of temporary custom attributes, overriding the contact's custom attributes. Note: the custom attributes will not be saved to the contact's profile.

object[]

resubscribe

boolean

Default: false

queue

integer · min: 0 · max: 1

Queue ID

Default: 0

Sender

id

string · minLength: 1 · required

Unique identifier of the sender

SenderAndName

id

string · minLength: 1 · required

Unique identifier of the sender

name

string · minLength: 1

Display name override for the sender

SenderFullResponse

id

string · required

Unique identifier for the sender

name

string · required

Display name of the sender

email

string · required

Email address of the sender

confirmed

boolean · required

Whether the sender email is confirmed

confirmed_on

integer

Timestamp when the sender was confirmed

language

string · enum

Language for confirmation emails

Enum values:

da_DK

de_DE

el_GR

en_US

Default: en_US

last_confirmation_sent_on

integer

Timestamp of the last confirmation email sent

SenderInfo

name

string

email

string

SenderResponse

object · required

Sender details

SendersResponse

object · required

Pagination metadata

object[] · required

List of senders

SentTransactionalEmailResponse

contact_id

integer · required

ShowSubscriptionFormEndpointResponse

object · required

ShowTransactionalEmailTemplateResponse

object · required

SignatureHashFunction

string · enum

Enum values:

sha256

An enumeration.

SignatureInfo

hash_function

string · enum · required

Hash function used for signing

Enum values:

sha256

key

string

Signing key for webhook verification

SubmitEmailAPIStatus

string · enum

Enum values:

queued

rejected

error

An enumeration.

SubmitEmailResponse

email

string · required

Recipient email address

object · required

Submitted email details

object

string

Object type

Default: email

submitted

boolean

Whether the email was submitted

Default: true

SubmitEmailType

string · enum

Enum values:

marketing

transactional

An enumeration.

SubmitFormResponse

status

string · enum · required

Status of the form submission

Enum values:

pending

processed

object

string

Object type

Default: form

SubmitMarketingEmail

object · required

Sender name and email address

object · required

Email content (subject, HTML, text, or template)

email

string · email · required

Recipient's email address

list_id

integer · min: 1 · required

List ID.

tags

string[] · minLength: 1 · maxLength: 255 · pattern: ^[a-zA-Z0-9-_]+$

List of tags to apply to the email

object

Tracking options for opens and clicks

object[]

Custom mail headers

One or more file attachments

SubmitMarketingEmailWithContactId

object · required

Sender name and email address

object · required

Email content (subject, HTML, text, or template)

list_id

integer · min: 1 · required

List ID.

contact_id

integer · min: 1 · required

Contact ID.

tags

string[] · minLength: 1 · maxLength: 255 · pattern: ^[a-zA-Z0-9-_]+$

List of tags to apply to the email

object

Tracking options for opens and clicks

object[]

Custom mail headers

One or more file attachments

SubmitTransactionalEmail

object · required

Sender name and email address

object · required

Email content (subject, HTML, text, or template)

email

string · email · required

Recipient's email address

tags

string[] · minLength: 1 · maxLength: 255 · pattern: ^[a-zA-Z0-9-_]+$

List of tags to apply to the email

object

Tracking options for opens and clicks

object[]

Custom mail headers

One or more file attachments

SubmitTransactionalEmailWithListManagement

object · required

Sender name and email address

object · required

Email content (subject, HTML, text, or template)

email

string · email · required

Recipient's email address

list_id

integer · min: 1 · required

List ID.

tags

string[] · minLength: 1 · maxLength: 255 · pattern: ^[a-zA-Z0-9-_]+$

List of tags to apply to the email

object

Tracking options for opens and clicks

object[]

Custom mail headers

One or more file attachments

SubmitTransactionalEmailWithListManagementUsingContactId

object · required

Sender name and email address

object · required

Email content (subject, HTML, text, or template)

list_id

integer · min: 1 · required

List ID.

contact_id

integer · min: 1 · required

Contact ID.

tags

string[] · minLength: 1 · maxLength: 255 · pattern: ^[a-zA-Z0-9-_]+$

List of tags to apply to the email

object

Tracking options for opens and clicks

object[]

Custom mail headers

One or more file attachments

SubmittedEmailResponse

id

string · uuid · required

Unique identifier of the submitted email

status

string · enum · required

Submission status of the email

Enum values:

queued

rejected

error

SubscriptionFormEndpointResponse

id

string · required

Unique identifier for the subscription form endpoint

enabled

boolean · required

Whether the subscription form is enabled

name

string

Name of the subscription form

domain

string

reCaptcha Domain

secret

string

reCaptcha Secret key

post_redirect_url

string

URL to redirect to after form submission

double_opt_in

boolean

Whether to use double opt-in

double_opt_in_redirect_url

string

URL to redirect to after double opt-in

submission_url

string

URL to submit the form to

async_processing

boolean

Whether to process the form asynchronously

SubscriptionTypeResponse

string · enum

Enum values:

resubscribe

subscription_confirmation

An enumeration.

SummaryEnhancedFormResponse

id

string · required

Unique identifier for the subscription form endpoint

list_id

integer

List ID

enabled

boolean

Whether the subscription form is enabled

name

string

Name of the subscription form

post_redirect_url

string

URL to redirect to after form submission

double_opt_in

boolean

Whether to use double opt-in

double_opt_in_redirect_url

string

URL to redirect to after double opt-in

published_url

string

URL to render the public published content of the form

submission_url

string

URL to submit the form to

async_processing

boolean

Whether to process the form asynchronously

branding

string · enum

Branding type - either 'smart' or 'basic'

Enum values:

smart

basic

Default: basic

created_on

integer · min: 0

Date and time the form was created

Default: 0

updated_on

integer · min: 0

Date and time the form was last updated

Default: 0

published_on

integer · min: 0

Date and time the form was published

object

User who last edited the form

Default: {}

thumbnail_url

string

Thumbnail URL

object

reCaptcha

Default: {}

description

string

Description of the subscription form

tags

string[]

Tags of the subscription form

SuppressedEmail

email

string · minLength: 1 · required

Full email, a local part wildcard or a domain wildcard. Examples: @hotmail.com, john@, john@hotmail.com

SuppressedEmailResponse

email

string · required

Suppressed email address

source

string

Source of the suppression

SuppressedEmailsExportResponse

id

string · required

Task id

status

string · enum · required

Task status

Enum values:

pending

ready

error

deleted

created_on

integer · required

Creation date (Unix time)

expires_on

integer · required

Expiration date (Unix time)

object · required

User who requested the task

payload

object · required

Task parameters

progress

integer · min: 0

Task progress percentage

Default: 0

type

string · enum

Task type

Enum values:

contactsexport

campaignlogexport

campaignsreportsexport

suppressedemailsexport

listlogsexport

unknown

Default: suppressedemailsexport

description

string

Task description

SuppressedEmailsResponse

object · required

Pagination metadata

object[] · required

List of suppressed emails

SuspendAccountResponse

id

string · required

object · required

object

string

Default: account

suspended

boolean

Default: true

SuspendCampaignResponse

id

integer · required

object

string

Default: campaign

suspended

boolean

Default: true

SuspendUserResponse

id

string · required

object · required

object

string

Default: user

suspended

boolean

Default: true

SystemEmailTemplate

language

string · enum · required

Supported Locales

Enum values:

da_DK

de_DE

el_GR

en_US

object

SystemEmailsResponse

object · required

SystemEmailsTemplates

object[]

TagContactResponse

tagged

boolean

Default: true

TagFullResponse

tag

string · required

Tag value

TagMultipleContacts

tags

string[] · minItems: 1 · maxItems: 1024 · required

contact_ids

integer[] · min: 1 · minItems: 1 · maxItems: 1024

query

string · minLength: 1

SQL-like expression

fiql

string

json

object

TagMultipleContactsResponse

tagged

boolean

Default: true

TagResponse

object · required

Tag details

TagsResponse

object · required

Pagination metadata

object[] · required

List of tags

TaskFullResponse

id

string · required

Task id

status

string · enum · required

Task status

Enum values:

pending

ready

error

deleted

created_on

integer · required

Creation date (Unix time)

expires_on

integer · required

Expiration date (Unix time)

object · required

User who requested the task

type

string · enum · required

Task type

Enum values:

contactsexport

campaignlogexport

campaignsreportsexport

suppressedemailsexport

listlogsexport

unknown

payload

object · required

Task parameters

progress

integer · min: 0

Task progress percentage

Default: 0

description

string

Task description

TaskResponse

object · required

Task details

TaskStatus

string · enum

Enum values:

pending

ready

error

deleted

An enumeration.

TaskType

string · enum

Enum values:

contactsexport

campaignlogexport

campaignsreportsexport

suppressedemailsexport

listlogsexport

unknown

An enumeration.

TemplateContent

type

string · enum · required

Template content type (html, text, or bee)

Enum values:

html

text

bee

custom

subject

string

Default email subject line for the template

html

string · minLength: 1

HTML content of the template

text

string · minLength: 1

Plain text content of the template

json

object

JSON content of the template (BEE editor format)

TemplateContentResponse

type

string · enum · required

Content type of the template

Enum values:

html

text

bee

custom

subject

string

Email subject line

html

string

HTML content of the template

text

string

Plain text content of the template

json

object

JSON representation of the template

TemplateCreate

name

string · minLength: 1 · required

Name of the template

object · required

Content of the template

description

string

Description of the template

tags

string[]

Tags to categorize the template

TemplateCreated

id

integer · required

ID of the created template

object

string

Object type

Default: template

created

boolean

Whether the template was created

Default: true

TemplateCustomAttributes

name

string · minLength: 1 · required

value

string · required

TemplateFullResponse

id

integer · required

Unique identifier of the template

name

string · required

Name of the template

created_on

integer · required

Creation timestamp

updated_on

integer · required

Last update timestamp

object · required

Template content

description

string

tags

string[]

Tags associated with the template

is_owner

boolean

Whether the current user owns the template

object

Sharing configuration for the template

thumbnail_url

string

URL to the template thumbnail image

thumbnail

string · deprecated · required

Thumbnail URL (deprecated)

TemplateId

id

integer · required

TemplateInfo

id

integer · required

object[] · minItems: 1

TemplateResponse

object · required

Template details

shared

boolean

object[]

automatic

boolean

shared

boolean

TemplateSummaryResponse

id

integer · required

Unique identifier of the template

name

string · required

Name of the template

created_on

integer · required

Creation timestamp

updated_on

integer · required

Last update timestamp

description

string

tags

string[]

Tags associated with the template

is_owner

boolean

Whether the current user owns the template

object

Sharing settings summary

thumbnail_url

string

URL to the template thumbnail image

thumbnail

string · deprecated · required

Thumbnail URL (deprecated)

TemplateTypeEnum

string · enum

Enum values:

html

text

bee

custom

An enumeration.

TemplateVisibilityResponse

account_id

integer · required

visible

boolean · required

company_name

string

TemplatesResponse

object · required

Pagination metadata

object[] · required

List of templates

TestEmailType

string · enum

Enum values:

merged

separated

An enumeration.

TokenResponse

access_token

string · required

Bearer token for authenticating API requests

token_type

string · required

Token type, always "bearer"

expires_in

integer · required

Token lifetime in seconds

refresh_token

string · required

Token used to obtain a new access token when the current one expires

accounts

integer[] · unique · required

Set of account IDs the authenticated user has access to

Tracking

opens

boolean

Enable the tracking of opens (only available for the HTML version)

Default: true

clicks_html

boolean

Enable the tracking of link clicks in the HTML version

Default: true

clicks_text

boolean

Enable the tracking of link clicks in the text version

Default: true

additional_params

string · minLength: 1

Append additional tracking parameters on all link (should be URL encoded)

TrackingResponse

opens

boolean

Whether open tracking is enabled

clicks_html

boolean

Whether HTML click tracking is enabled

clicks_text

boolean

Whether text click tracking is enabled

additional_params

string

Extra tracking query parameters

TransactionalEmailResponse

id

integer · required

ID of the sent transactional email

TransactionalEmailTemplateContent

type

string · enum · required

An enumeration.

Enum values:

custom

html

bee

subject

string · required

json

object

html

string

TransactionalEmailTemplateContentSummaryResponse

type

string · enum · required

An enumeration.

Enum values:

custom

html

bee

subject

string

TransactionalEmailTemplateFullResponse

id

integer · required

name

string · required

status

string · required

created_on

integer · required

object · required

thumbnail_url

string · required

updated_on

integer

cc

string[]

reply_to

string

TransactionalEmailTemplateSummaryResponse

id

integer · required

name

string · required

status

string · required

created_on

integer · required

object · required

thumbnail_url

string · required

TransactionalEmailTemplateTracking

additional_params

string · minLength: 1

Append additional tracking parameters on all links (should be URL encoded)

UnArchiveWebhookResponse

id

string · required

Unique identifier for the webhook

object · required

Unarchived webhook details

object

string

Default: Webhook

archived

boolean

Default: false

UnauthorizedMessage

msg

string · required

code

integer

type

string

Default: unauthorized

UnifiedCreateFormResponse

id

string · required

ID of the created form

required

Created form details

object

string

Object type

Default: form

created

boolean

Whether the form was created

Default: true

UnifiedFormResponse

required

Form details

UnifiedFormsResponse

object · required

Pagination metadata

array · required

List of forms

UnifiedPatchFormResponse

id

string · required

ID of the updated form

required

Updated form details

object

string

Object type

Default: form

updated

boolean

Whether the form was updated

Default: true

UnlockWorkflow

key

string · pattern: ^[a-zA-Z0-9-_]{8,}$ · required

UnlockWorkflowResponse

locked

boolean · required

expires_in

integer · required

object

string

Default: workflow

UnsubscribeContactResponse

object · required

Unsubscribed contact details

object

string

Object type

Default: contact

subscribed

boolean

Subscription status of the contact

Default: false

UnsuspendAccountResponse

id

string · required

object · required

object

string

Default: account

unsuspended

boolean

Default: true

UntagContactResponse

untagged

boolean

Default: true

UntagMultipleContacts

tags

string[] · minItems: 1 · maxItems: 1024 · required

contact_ids

integer[] · min: 1 · minItems: 1 · maxItems: 1024

query

string · minLength: 1

SQL-like expression

fiql

string

json

object

UntagMultipleContactsResponse

untagged

boolean

Default: true

UpdateList

name

string · minLength: 1

object

language

string · enum

Supported Locales

Enum values:

da_DK

de_DE

el_GR

en_US

object

Default: {}

object

Default: {}

UpdatePatRequest

name

string · minLength: 1 · maxLength: 128 · pattern: ^[\w\s\-.,!@#%()+='\…

scopes

string[]

New scope list (granular)

Enum values:

lists:read

lists:write

lists:delete

contacts:read

contacts:write

contacts:delete

contacts:import

contacts:export

allowed_account_ids

integer[]

UpdateSegment

query

string · minLength: 1

SQL-like expression (use one of query, fiql and json)

fiql

string · minLength: 1

FIQL expression (use one of query, fiql and json)

json

object

JSON expression (use one of query, fiql and json)

name

string

Segment Name

UpdateSender

name

string

Display name of the sender

language

string · enum

Language for sender-related communications

Enum values:

da_DK

de_DE

el_GR

en_US

UpdateTransactionalEmailFromTemplate

template_id

integer · required

subject

string

UpdateTransactionalEmailTemplate

name

string

object

reply_to

string · email

cc

string[] · maxItems: 1

object

UpdateTransactionalEmailTemplateResponse

id

integer · required

object · required

object

string

Default: transactional-email-template

updated

boolean

Default: true

UpdateTransactionalEmailTemplateTemplateContent

subject

string · required

type

string · enum

An enumeration.

Enum values:

custom

html

bee

json

object

html

string

UploadLogo

file

string · minLength: 1 · required

Logo image as a data URI

UploadLogoResponse

logo

string · required

object

string

Default: logo

uploaded

boolean

Default: true

UsageLimits

starts_on

integer · min: 0

Billing cycle start timestamp

per_campaign

integer · min: 0

Max emails per campaign

per_month

integer · min: 0

Max emails per month

maximum_contacts

integer · min: 0

Max number of contacts

lists

integer · min: -1

Max number of lists (-1 for unlimited)

users

integer · min: -1

Max number of users (-1 for unlimited)

campaign_blueprints

integer · min: -1

Max number of campaign blueprints (-1 for unlimited)

automation_conditions

integer · min: -1

Max number of automation conditions (-1 for unlimited)

use_campaign_blueprints

boolean

Enable campaign blueprints

use_automation_conditions

boolean

Enable automation conditions

use_automations

boolean

Enable automations

use_automation_customwebhooks

boolean

Enable custom webhooks in automations

use_html_editor

boolean

Enable HTML editor

use_contact_export

boolean

Enable contact export

use_custom_merge_tags

boolean

Enable custom merge tags

use_list_redirection

boolean

Enable list redirection

use_behavioral_segmentation

boolean

Enable behavioral segmentation

use_ab_split

boolean

Enable A/B split testing

use_smart_email_resource

boolean

Enable smart email resource

use_smart_blueprint

boolean

Enable smart blueprints

use_brand

boolean

Enable brand management

use_email_api

boolean

Enable transactional email API

insert_reseller_logo

boolean

Insert reseller logo in emails

use_tags_in_automation

boolean

Enable tags in automations

use_tags

boolean

Enable tags

use_forms

boolean

Enable forms

use_popups

boolean

Enable popups

use_pages

boolean

Enable pages

use_pages_redirection

boolean

Enable page redirection

use_ai_generation

boolean

Enable AI content generation

UsageLimitsResponse

starts_on

integer

Start date of the current billing period

per_campaign

integer

Maximum number of emails per campaign

per_month

integer

Maximum number of emails per month

remaining

integer

Remaining email sends for the current period

maximum_contacts

integer

Maximum number of contacts across all lists

lists

integer

Maximum number of lists (-1 = unlimited)

users

integer

Maximum number of users (-1 = unlimited)

campaign_blueprints

integer

Maximum number of campaign blueprints (-1 = unlimited)

automation_conditions

integer

Maximum number of automation conditions (-1 = unlimited)

use_ab_split

boolean

A/B split testing feature enabled

use_automation_conditions

boolean

Automation conditions feature enabled

use_automations

boolean

Automations feature enabled

use_automation_customwebhooks

boolean

Custom webhooks in automations enabled

use_behavioral_segmentation

boolean

Behavioral segmentation feature enabled

use_brand

boolean

Brand management feature enabled

use_campaign_blueprints

boolean

Campaign blueprints feature enabled

use_contact_export

boolean

Contact export feature enabled

use_custom_merge_tags

boolean

Custom merge tags feature enabled

use_email_api

boolean

Transactional Email API feature enabled

use_html_editor

boolean

HTML editor feature enabled

use_list_redirection

boolean

List redirection feature enabled

use_smart_email_resource

boolean

Smart email resource feature enabled

use_smart_blueprint

boolean

Smart blueprint feature enabled

use_tags_in_automation

boolean

Tags in automation feature enabled

use_tags

boolean

Tags feature enabled

insert_reseller_logo

boolean

Reseller logo insertion enabled

use_forms

boolean

Forms feature enabled

use_popups

boolean

Popups feature enabled

use_pages

boolean

Pages feature enabled

use_pages_redirection

boolean

Pages redirection feature enabled

use_ai_generation

boolean

AI content generation feature enabled

User

first_name

string · required

First name

last_name

string · required

Last name

email

string · email · required

Email address, used as the login username

title

string

Job title

office_phone

string

Office phone number

mobile_phone

string · pattern: [0-9]+

Mobile phone number (digits only)

language

string · enum

Preferred language (e.g. en_US, fr_FR)

Enum values:

da_DK

de_DE

el_GR

en_US

timezone

string

IANA timezone identifier (e.g. America/Montreal)

password

string · minLength: 8 · maxLength: 128

Password (only when creating confirmed users with skip_verification permission)

password_strength_requirement

string · enum

Minimum entropy requirement for the password

Enum values:

VERY_WEAK

WEAK

MODERATE

STRONG

VERY_STRONG

Default: VERY_WEAK

UserConfirmation

confirmation

string · required

Confirmation hash from the verification email

password

string · minLength: 8 · maxLength: 128 · required

Password to set for the new account

UserFullResponse

id

string · required

Unique user identifier

email

string · required

User email address, used as the login username

status

string · required

User status: active, suspended, or pending

created_on

integer

Account creation timestamp

last_activity_on

integer

Last login or activity timestamp

expires_on

integer

Expiration timestamp for pending users

first_name

string

First name

last_name

string

Last name

title

string

Job title

language

string · enum

Preferred language (e.g. en_US, fr_FR)

Enum values:

da_DK

de_DE

el_GR

en_US

timezone

string

IANA timezone (e.g. America/Montreal)

office_phone

string

Office phone number

mobile_phone

string

Mobile phone number

UserInfo

object · required

Operating system information

object · required

Browser information

object · required

Device information

ip

string

IP address of the user

is_bot

boolean

Whether the user agent is a bot

raw

string

Raw user agent string

UserResponse

object · required

UserSummaryResponse

id

string · required

Unique user identifier

email

string · required

User email address

status

string

User status: active, suspended, or pending

first_name

string

First name

last_name

string

Last name

last_activity_on

integer

Last login or activity timestamp

created_on

integer

Account creation timestamp

expires_on

integer

Expiration timestamp for pending users

UsersResponse

object · required

object[] · required

ValidateDomainsResponse

object · required

ValidationError

array · required

msg

string · required

type

string · required

WebhookEventType

string · enum

Enum values:

Account.Created

Account.Updated

Account.Confirmed

Account.Deleted

ContactsExport.Created

ContactsExport.Deleted

Campaign.Canceled

Campaign.Created

An enumeration.

WebhookResponse

id

string · required

Unique identifier for the webhook

object · required

Webhook signature configuration

object · required

Webhook details

WebhookStatus

string · enum

Enum values:

active

archived

An enumeration.

Workflow

object · required

name

string

goal

string

description

string

trigger

string · enum

An enumeration.

Enum values:

subscribed

unsubscribed

manual

Default: subscribed

object

WorkflowAudience

list_id

integer · required

segment_id

integer

WorkflowBlueprint

id

string · required

name

string · required

goal

string · required

description

string

trigger

string · enum

An enumeration.

Enum values:

subscribed

unsubscribed

manual

created_on

integer

updated_on

integer

WorkflowBlueprintActionResponse

object · required

WorkflowBlueprintResponse

object · required

WorkflowBlueprintsResponse

object · required

object[] · required

WorkflowFromBlueprint

id

string · required

object

WorkflowResponse

id

string · required

name

string

description

string

goal

string

status

string · enum

An enumeration.

Enum values:

active

inactive

trigger

string · enum

An enumeration.

Enum values:

subscribed

unsubscribed

manual

object

created_on

integer

updated_on

integer

activated_on

integer

WorkflowStatus

string · enum

Enum values:

active

inactive

An enumeration.

WorkflowTrigger

string · enum

Enum values:

subscribed

unsubscribed

manual

An enumeration.

apischemasrequestslistsWebhook

url

string · uri · minLength: 1 · maxLength: 2083

actions

string[] · minItems: 1

Enum values:

all

unsubscribe

update

delete

spam

bounce

bounce_ac

apiserviceswebhooksschemasWebhook

id

string

status

string · enum

An enumeration.

Enum values:

active

archived

event

string · enum

An enumeration.

Enum values:

Account.Created

Account.Updated

Account.Confirmed

Account.Deleted

Contact.Added

Contact.Updated

Contact.Removed

Contact.Tagged

url

string · uri · minLength: 1 · maxLength: 2083

archived_at

integer

rate_limit

integer

rate_limit_period

string · enum

An enumeration.

Enum values:

second

minute