Cakemail Logo
Cakemail API

​Schemas(1.18.25)

​APIVersion

string · enum
Enum values:
v1
v2

​AcceptListPolicyResponse

  • idinteger · required
  • objectstring
    Default: list
  • policy_acceptedboolean
    Default: true

​AccountFullResponse

  • idstring · required
  • lineagestring · required
  • statusstring · enum · required
    Enum values:
    trial
    active
    suspended
    suspended_by_partner
    deleted
    incomplete
    pending
  • addressobject · required
  • account_ownerobject · required
  • logostring · required
  • usage_limitsobject · required
  • last_activity_oninteger · required
  • created_oninteger · required
  • partnerboolean · required
  • organizationboolean · required
  • overridesobject · required
  • namestring
  • faxstring
  • phonestring
  • websitestring
  • stripe_customer_idstring
  • metadataobject

​AccountOverrides

  • bypass_recaptchaboolean · required
  • inject_addressboolean · required
  • inject_unsubscribe_linkboolean · required

​AccountOwner

  • user_idinteger · min: 1 · required

​AccountOwnerResponse

  • user_idstring

​AccountOwnerUser

  • first_namestring · required
  • last_namestring · required
  • emailstring · email · required
  • titlestring
  • office_phonestring
  • mobile_phonestring · pattern: [0-9]+
  • languagestring · enum
    Enum values:
    da
    da_DK
    de
    de_DE
    el
    el_GR
    en
    en_US
  • timezonestring
  • passwordstring · minLength: 8
  • password_strength_requirementstring · enum
    Enum values:
    VERY_WEAK
    WEAK
    MODERATE
    STRONG
    VERY_STRONG
    Default: VERY_WEAK

​AccountResponse

  • dataobject · required

​AccountStatResponse

  • active_contactsinteger · required
  • sent_emailsinteger · required
  • sent_campaign_emailsinteger · required
  • sent_action_emailsinteger · required
  • sent_email_emailsinteger · required
  • open_ratenumber · required
  • bounce_ratenumber · required
  • click_ratenumber · required
  • spam_ratenumber · required
  • unsubscribe_ratenumber · required
  • emails_usagenumber · required
  • contacts_usagenumber · required
  • bounces_hardinteger · required
  • bounce_hard_ratenumber · required
  • spamsinteger · required
  • current_listsinteger · required
  • email_apiobject

​AccountStatsResponse

  • dataobject · required

​AccountStatus

string · enum
Enum values:
trial
active
suspended
suspended_by_partner
deleted
incomplete
pending

​AccountSummaryResponse

  • idstring · required
  • lineagestring · required
  • statusstring · enum · required
    Enum values:
    trial
    active
    suspended
    suspended_by_partner
    deleted
    incomplete
    pending
  • partnerboolean · required
  • account_ownerobject · required
  • usage_limitsobject · required
  • created_oninteger · required
  • namestring
  • stripe_customer_idstring
  • expires_oninteger

​AccountsResponse

  • paginationobject · required
  • dataobject[] · required

​Action

  • namestring · required
  • conditionstring · enum · required
    Enum values:
    opened
    not_opened
    clicked
    not_clicked
    none
  • delayinteger · required
  • typestring · enum · required
    Enum values:
    email
  • parent_idstring
  • email_settingsobject

​ActionBlueprint

  • idstring · required
  • namestring · required
  • conditionstring · enum · required
    Enum values:
    opened
    not_opened
    clicked
    not_clicked
    none
  • delayinteger · required
  • typestring · enum · required
    Enum values:
    email
  • created_oninteger
  • updated_oninteger
  • parent_idstring
  • email_settingsobject

​ActionCondition

string · enum
Enum values:
opened
not_opened
clicked
not_clicked
none

​ActionContent

  • subjectstring · minLength: 1
  • htmlstring · minLength: 1
  • textstring · minLength: 1
  • jsonobject
  • typestring · enum
    Enum values:
    custom
    html
    bee
    Default: html
  • encodingstring · enum
    Enum values:
    utf-8
    armscii-8
    ascii
    big-5
    cp51932
    cp866
    cp936
    euc-cn
  • templateobject

​ActionDefaultEmailSettings

  • senderobject · required

​ActionEmailBlueprintSettings

  • contentobject · required
  • trackingobject
    Default: {"opens":true,"clicks_html":true,"clicks_text":true}

​ActionEmailSettings

  • contentobject · required
  • senderobject · required
  • trackingobject
    Default: {"opens":true,"clicks_html":true,"clicks_text":true}

​ActionLogResponse

  • contact_idinteger · required
  • occurrencesinteger · required
  • idinteger
  • emailstring
  • typestring · enum
    Enum values:
    clickthru
    click
    open
    bounce
    bounce_ac
    bounce_cr
    bounce_df
    bounce_fm
  • timestampinteger
  • user_agentobject

​ActionLogsResponse

  • paginationobject · required
  • dataobject[] · required

​ActionResponse

  • idstring · required
  • namestring · required
  • conditionstring · enum · required
    Enum values:
    opened
    not_opened
    clicked
    not_clicked
    none
  • delayinteger · required
  • typestring · enum · required
    Enum values:
    email
  • thumbnail_urlstring · required
  • created_oninteger
  • updated_oninteger
  • parent_idstring
  • email_settingsobject

​ActionStatResponse

  • bouncesinteger · required
  • bounces_address_changedinteger · required
  • bounces_challenge_responseinteger · required
  • bounces_dns_failureinteger · required
  • bounces_full_mailboxinteger · required
  • bounces_hardinteger · required
  • bounces_mail_blockedinteger · required
  • bounces_softinteger · required
  • bounces_transientinteger · required
  • unique_clicksinteger · required
  • forwardsinteger · required
  • implied_opensinteger · required
  • unique_opensinteger · required
  • unopensinteger · required
  • clicksinteger · required
  • opensinteger · required
  • spamsinteger · required
  • spam_ratenumber · required
  • unsubscribesinteger · required
  • sent_emailsinteger · required

​ActionStatsResponse

  • dataobject · required

​ActionSummaryResponse

  • idstring · required
  • namestring · required
  • conditionstring · enum · required
    Enum values:
    opened
    not_opened
    clicked
    not_clicked
    none
  • delayinteger · required
  • typestring · enum · required
    Enum values:
    email
  • thumbnail_urlstring · required
  • parent_idstring
  • created_oninteger
  • updated_oninteger

​ActionTracking

  • opensboolean
    Default: true
  • clicks_htmlboolean
    Default: true
  • clicks_textboolean
    Default: true

​ActionType

string · enum
Enum values:
email

​ActionsResponse

  • paginationobject · required
  • dataobject[] · required

​ActivateMFARequest

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

​ActivateMFAResponse

  • idstring · required
  • objectstring
    Default: mfa
  • activatedboolean
    Default: true

​ActivateWorkflowResponse

  • idstring · required
  • objectstring
    Default: workflow
  • activatedboolean
    Default: true

​AddInterestsToContacts

  • interestsstring[] · maxItems: 16 · required
  • contact_idsinteger[] · min: 1 · maxItems: 1024
  • querystring
  • fiqlstring
  • jsonobject

​AddInterestsToMultipleContactsResponse

  • objectstring
    Default: interests
  • addedboolean
    Default: true

​AdditionalEmailHeader

  • namestring · required
  • valuestring · required

​Address

  • address1string · minLength: 1 · required
  • countrystring · minLength: 1 · required
  • address2string
  • citystring
  • provincestring
  • postal_codestring

​AddressResponse

  • address1string
  • address2string
  • citystring
  • countrystring
  • provincestring
  • postal_codestring

​ArchiveCampaignResponse

  • idinteger · required
  • objectstring
    Default: campaign
  • archivedboolean
    Default: true

​ArchiveListResponse

  • idinteger · required
  • objectstring
    Default: list
  • archivedboolean
    Default: true

​ArchiveWebhookResponse

  • idstring · required
  • dataobject · required
  • objectstring
    Default: Webhook
  • archivedboolean
    Default: true

​Attachment

  • filenamestring · pattern: ^[a-zA-Z0-9-_]+\.(cs… · required
  • typestring · enum · required
    Enum values:
    csv
    doc
    docx
    calendar
    jpeg
    pdf
    png
    xls
  • contentstring · pattern: ^(?:[A-Za-z0-9+/]{4}… · required

​AttachmentType

string · enum
Enum values:
csv
doc
docx
calendar
jpeg
pdf
png
xls

​Audience

  • list_idinteger · min: 1
  • segment_idinteger · min: 1

​AudienceResponse

  • list_idinteger
  • namestring
  • segment_idinteger

​AudienceSummaryResponse

  • list_idinteger
  • segment_idinteger

​BadRequestMessage

  • msgstring · required
  • locstring[]
  • typestring
    Default: bad_request

​Body_createToken

  • grant_typestring · enum
    Enum values:
    password
    refresh_token
    Default: password
  • usernamestring · email
  • passwordstring
  • account_idinteger
  • scopesstring · pattern: ^(user|admin|interna…
    Default: user
  • expiration_secondsinteger · min: 600
  • refresh_tokenstring

​Body_refreshToken

  • refresh_tokenstring · required
  • grant_typestring · enum
    Enum values:
    refresh_token
    Default: refresh_token

​BrowserInfo

  • familystring
  • versionstring

​CampaignBlueprintId

  • idinteger · required

​CampaignBlueprintResponse

  • dataobject · required

​CampaignBlueprintSummaryResponse

  • idinteger · required
  • namestring · required
  • created_oninteger · required
  • updated_oninteger · required
  • descriptionstring
  • tagsstring[]
  • thumbnail_urlstring
  • thumbnailstring · deprecated · required

​CampaignBlueprintsResponse

  • paginationobject · required
  • dataobject[] · required

​CampaignContent

  • subjectstring · minLength: 1
  • htmlstring · minLength: 1
  • textstring · minLength: 1
  • jsonobject
  • typestring · enum
    Enum values:
    custom
    html
    bee
    Default: html
  • encodingstring · enum
    Enum values:
    utf-8
    armscii-8
    ascii
    big-5
    cp51932
    cp866
    cp936
    euc-cn
  • templateobject
  • blueprintobject
  • default_unsubscribe_linkboolean

​CampaignContentResponse

  • subjectstring
  • htmlstring
  • textstring
  • jsonobject
  • typestring · enum
    Enum values:
    html
    bee
    custom
  • hashstring
  • last_updated_oninteger
  • encodingstring · enum
    Enum values:
    utf-8
    armscii-8
    ascii
    big-5
    cp51932
    cp866
    cp936
    euc-cn
  • default_unsubscribe_linkboolean
  • social_barboolean
  • footerstring

​CampaignFullResponse

  • idinteger · required
  • namestring
  • audienceobject
  • typestring · enum
    Enum values:
    standard
    recurring
    absplit
  • trackingobject
  • created_oninteger
  • scheduled_forinteger
  • scheduled_oninteger
  • delivery_finished_oninteger
  • senderobject
  • reply_to_emailstring
  • contentobject
  • next_building_stepstring
  • statusstring · enum
    Enum values:
    active
    delivering
    delivered
    archived
    deleted
    incomplete
    scheduled
  • suspendedboolean
  • over_limitboolean
  • under_reviewboolean
  • heatmap_linkstring
  • web_email_linkstring
  • thumbnail_urlstring
  • updated_oninteger

​CampaignLinkStatsResponse

  • idinteger · required
  • linkstring · required
  • uniqueinteger · required
  • totalinteger · required
  • unique_ratenumber · required
  • total_ratenumber · required

​CampaignLinksStatsResponse

  • paginationobject · required
  • dataobject[] · required

​CampaignLogExportFullResponse

  • idstring · required
  • campaign_idinteger · required
  • statusstring · enum · required
    Enum values:
    pending
    ready
    deleted
    failed
  • requested_byobject · required
  • created_oninteger · required
  • expires_oninteger · required
  • progressnumber · required
  • descriptionstring

​CampaignLogExportRequestedBy

  • idinteger · required
  • emailstring · required

​CampaignLogExportStatus

string · enum
Enum values:
pending
ready
deleted
failed

​CampaignLogExportsResponse

  • paginationobject · required
  • dataobject[] · required

​CampaignLogResponse

  • idinteger · required
  • contact_idinteger · required
  • emailstring
  • typestring · enum
    Enum values:
    clickthru
    click
    open
    bounce
    bounce_ac
    bounce_cr
    bounce_df
    bounce_fm
  • timestampinteger
  • occurrencesinteger
  • clickthru_urlstring
  • user_agentobject

​CampaignLogsResponse

  • paginationobject · required
  • dataobject[] · required

​CampaignResponse

  • dataobject · required

​CampaignRevision

  • idinteger · required
  • datestring · required

​CampaignRevisionsResponse

  • paginationobject · required
  • dataobject[] · required

​CampaignStatResponse

  • active_emailsinteger · required
  • bouncesinteger · required
  • bounce_ratenumber · required
  • bounces_address_changedinteger · required
  • bounces_challenge_responseinteger · required
  • bounces_dns_failureinteger · required
  • bounces_full_mailboxinteger · required
  • bounces_hardinteger · required
  • bounces_mail_blockedinteger · required
  • bounces_softinteger · required
  • bounces_transientinteger · required
  • clicksinteger · required
  • click_ratenumber · required
  • clickthru_ratenumber · required
  • forwardsinteger · required
  • implied_opensinteger · required
  • opensinteger · required
  • open_ratenumber · required
  • spamsinteger · required
  • unique_clicksinteger · required
  • unique_opensinteger · required
  • unopensinteger · required
  • unopen_ratenumber · required
  • unsubscribesinteger · required
  • unsubscribe_ratenumber · required
  • spam_ratenumber · required
  • sent_emailsinteger · required
  • sent_ratenumber · required

​CampaignStatsResponse

  • dataobject · required

​CampaignStatus

string · enum
Enum values:
active
delivering
delivered
archived
deleted
incomplete
scheduled

​CampaignSummaryResponse

  • idinteger · required
  • namestring
  • audienceobject
  • typestring · enum
    Enum values:
    standard
    recurring
    absplit
  • created_oninteger
  • scheduled_forinteger
  • scheduled_oninteger
  • senderobject
  • next_building_stepstring
  • statusstring · enum
    Enum values:
    active
    delivering
    delivered
    archived
    deleted
    incomplete
    scheduled
  • suspendedboolean
  • over_limitboolean
  • under_reviewboolean
  • web_email_linkstring
  • thumbnail_urlstring
  • updated_oninteger

​CampaignType

string · enum
Enum values:
standard
recurring
absplit

​CampaignsReportsExportResponse

  • idstring · required
  • statusstring · enum · required
    Enum values:
    pending
    ready
    error
    deleted
  • created_oninteger · required
  • expires_oninteger · required
  • requested_byobject · required
  • payloadobject · required
  • progressinteger
  • typestring · enum
    Enum values:
    contactsexport
    campaignlogexport
    campaignsreportsexport
    suppressedemailsexport
    listlogsexport
    unknown
    Default: campaignsreportsexport
  • descriptionstring

​CampaignsResponse

  • paginationobject · required
  • dataobject[] · required

​CancelCampaignResponse

  • idinteger · required
  • objectstring
    Default: campaign
  • cancelledboolean
    Default: true

​ChallengeResponse

  • challengestring · required

​ChallengeResponseRequest

  • challengestring · required
  • coderequired
  • scopesstring[] · unique
    Enum values:
    user
    admin
    internal
    auth
    Default: ["user"]

​ChangePassword

  • newstring · minLength: 8 · required
  • currentstring
  • password_strength_requirementstring · enum
    Enum values:
    VERY_WEAK
    WEAK
    MODERATE
    STRONG
    VERY_STRONG
    Default: VERY_WEAK

​ConfirmAccount

  • confirmationstring · required

​ConfirmAccountResponse

  • idstring · required
  • objectstring
    Default: account
  • emailstring · email
  • dataobject
  • metadatastring
  • confirmedboolean
    Default: true

​ConfirmSender

  • confirmation_idstring · minLength: 1 · required

​ConfirmSenderResponse

  • dataobject · required
  • confirmedboolean
    Default: true
  • objectstring
    Default: sender

​ConfirmUserResponse

  • idstring · required
  • dataobject · required
  • objectstring
    Default: user
  • confirmedboolean
    Default: true

​Contact

  • emailstring · email · required
  • custom_attributesobject[]

​ContactFullResponse

  • idinteger · required
  • emailstring · required
  • statusstring · required
  • subscribed_oninteger · required
  • last_bounce_typestring · required
  • bounces_countinteger · required
  • custom_attributesobject[] · required
  • tagsstring[]
    Default: []
  • interestsstring[]
    Default: []

​ContactResponse

  • dataobject · required

​ContactStatus

string · enum
Enum values:
active
unsubscribed
deleted

​ContactsExportDeleteResponse

  • idstring · required
  • dataobject · required
  • objectstring
    Default: contactsexport
  • deletedboolean
    Default: true

​ContactsExportFullResponse

  • idstring · required
  • statusstring · enum · required
    Enum values:
    pending
    ready
    deleted
    failed
  • created_oninteger · required
  • expires_oninteger · required
  • progressnumber · required
  • descriptionstring
  • segment_idinteger
  • filterstring
  • querystring
  • fiqlstring
  • jsonobject

​ContactsExportResponse

  • dataobject · required

​ContactsExportStatus

string · enum
Enum values:
pending
ready
deleted
failed

​ContactsExportsResponse

  • paginationobject · required
  • dataobject[] · required

​ContactsResponse

  • paginationobject · required
  • dataobject[] · required

​ContentType

string · enum
Enum values:
custom
html
bee

​ContentTypeResponse

string · enum
Enum values:
html
bee
custom

​ConvertAccount

  • migrate_ownerboolean
    Default: true

​CreateAccount

  • namestring · minLength: 1 · required
  • addressobject
  • account_ownerobject
  • faxstring · minLength: 1
  • phonestring · minLength: 1
  • websitestring · uri · minLength: 1 · maxLength: 2083
  • usage_limitsobject
    Default: {}
  • domainsobject
    Default: {}
  • trialboolean
  • partnerboolean

​CreateAccountResponse

  • idstring · required
  • objectstring
    Default: account
  • emailstring · email
  • dataobject
  • metadatastring
  • createdboolean
    Default: true
  • warningsobject[]
    Default: []

​CreateActionResponse

  • idstring · required
  • dataobject · required
  • objectstring
    Default: action
  • createdboolean
    Default: true

​CreateAttributeResponse

  • namestring · required
  • dataobject · required
  • objectstring
    Default: attribute
  • createdboolean
    Default: true

​CreateCampaign

  • namestring · minLength: 1 · required
  • audienceobject
    Default: {}
  • trackingobject
    Default: {"opens":true,"clicks_html":true,"clicks_text":true}
  • senderobject
  • reply_to_emailstring · email
  • contentobject
    Default: {"type":"html"}

​CreateCampaignLogExportRequest

  • descriptionstring
  • filterstring

​CreateCampaignLogExportResponse

  • idstring · required
  • dataobject · required
  • objectstring
    Default: task
  • createdboolean
    Default: true

​CreateCampaignReportExport

  • descriptionstring

​CreateCampaignResponse

  • idinteger · required
  • dataobject · required
  • objectstring
    Default: campaign
  • createdboolean
    Default: true

​CreateCampaignsReportsExportResponse

  • dataobject · required

​CreateContactResponse

  • idinteger · required
  • objectstring
    Default: contact
  • createdboolean
    Default: true
  • dataobject

​CreateContactsExportResponse

  • idstring · required
  • dataobject · required
  • objectstring
    Default: task
  • createdboolean
    Default: true

​CreateCustomAttribute

  • namestring · pattern: ^[A-Za-z0-9\-_]+$ · required
  • typestring · enum · required
    Enum values:
    text
    mediumtext
    integer
    timestamp
    datetime

​CreateDkim

  • domainstring · required
  • selectorstring

​CreateDkimResponse

  • dataobject · required
  • objectstring
    Default: dkim
  • createdboolean
    Default: true

​CreateForm

  • namestring · minLength: 1 · required
  • contentobject · required
  • list_idinteger · min: 1 · required
  • languagestring · enum · required
    Enum values:
    da
    da_DK
    de
    de_DE
    el
    el_GR
    en
    en_US
  • statusstring · enum
    Enum values:
    active
    deleted
    Default: active
  • redirectionsobject
    Default: {}
  • double_opt_inboolean
    Default: true

​CreateFormResponse

  • idstring · required
  • dataobject · required
  • objectstring
    Default: form
  • createdboolean
    Default: true

​CreateListLogsExportRequest

  • descriptionstring
  • filterstring

​CreateListLogsExportResponse

  • idstring · required
  • dataobject · required
  • objectstring
    Default: task
  • createdboolean
    Default: true

​CreateListResponse

  • idinteger · required
  • dataobject · required
  • createdboolean
    Default: true

​CreateMFARequest

  • typestring · enum · required
    Enum values:
    totp
  • descriptionstring

​CreateMFAResponse

  • idstring · required
  • dataobject · required
  • objectstring
    Default: mfa
  • createdboolean
    Default: true

​CreateSegmentResponse

  • idinteger · required
  • dataobject · required
  • objectstring
    Default: segment
  • createdboolean
    Default: true

​CreateSender

  • namestring · minLength: 1 · required
  • emailstring · email · required
  • languagestring · enum
    Enum values:
    da
    da_DK
    de
    de_DE
    el
    el_GR
    en
    en_US
    Default: en_US

​CreateSenderResponse

  • idstring · required
  • dataobject · required
  • createdboolean
    Default: true
  • objectstring
    Default: sender

​CreateSubscriptionFormEndpointRequest

  • domainstring · pattern: ^(?:[a-zA-Z0-9](?:[a…
  • namestring
  • double_opt_inboolean
    Default: true
  • secretstring
  • post_redirect_urlstring
  • double_opt_in_redirect_urlstring
  • async_processingboolean
    Default: true

​CreateSubscriptionFormEndpointResponse

  • dataobject · required
  • objectstring
    Default: subscription_form_endpoint
  • createdboolean
    Default: true

​CreateSuppressedEmailResponse

  • emailstring · required
  • createdboolean
    Default: true

​CreateSuppressedEmailsExportResponse

  • idstring · required
  • dataobject · required
  • objectstring
    Default: task
  • createdboolean
    Default: true

​CreateTag

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

​CreateTagResponse

  • tagstring · required
  • objectstring
    Default: tag
  • createdboolean
    Default: true
  • dataobject

​CreateTransactionalEmailFromTemplate

  • subjectstring · required
  • template_idinteger · required

​CreateTransactionalEmailTemplate

  • namestring · required
  • senderobject · required
  • contentrequired
  • reply_tostring · email
  • ccstring[] · maxItems: 1
  • trackingobject

​CreateTransactionalEmailTemplateContent

  • typestring · enum · required
    Enum values:
    custom
    html
    bee
  • subjectstring · required
  • jsonobject
  • htmlstring

​CreateTransactionalEmailTemplateResponse

  • idinteger · required
  • dataobject · required
  • objectstring
    Default: transactional-email-template
  • createdboolean
    Default: true

​CreateUserResponse

  • idstring · required
  • dataobject · required
  • objectstring
    Default: user
  • createdboolean
    Default: true

​CreateWebhook

  • eventstring · enum · required
    Enum values:
    Account.Created
    Account.Updated
    Account.Confirmed
    Account.Deleted
    Contact.Added
    Contact.Updated
    Contact.Removed
    Contact.Tagged
  • urlstring · uri · minLength: 1 · maxLength: 2083 · required
  • rate_limitinteger
    Default: 50
  • rate_limit_periodstring · enum
    Enum values:
    second
    minute
    Default: second

​CreateWebhookResponse

  • idstring · required
  • dataobject · required

​CreateWorkflowResponse

  • dataobject · required
  • idstring · required
  • objectstring
    Default: workflow
  • createdboolean
    Default: true

​Cursor

  • previousstring
  • nextstring

​CustomAttribute

  • namestring · minLength: 1 · required
  • valuestring

​CustomAttributeFullResponse

  • namestring
  • typestring · enum
    Enum values:
    text
    mediumtext
    integer
    timestamp
    datetime

​CustomAttributeResp

  • namestring · minLength: 1 · required
  • valuestring

​CustomAttributeResponse

  • dataobject · required

​CustomAttributeType

string · enum
Enum values:
text
mediumtext
integer
timestamp
datetime

​CustomAttributesDataResponse

  • namestring · minLength: 1 · required
  • valuestring · required

​CustomAttributesResponse

  • paginationobject · required
  • dataobject[] · required

​DeactivateWorkflowResponse

  • idstring · required
  • objectstring
    Default: workflow
  • deactivatedboolean
    Default: true

​DeleteAccountResponse

  • idstring · required
  • objectstring
    Default: account
  • deletedboolean
    Default: true

​DeleteActionResponse

  • idstring · required
  • dataobject · required
  • objectstring
    Default: action
  • deletedboolean
    Default: true

​DeleteCampaignResponse

  • idinteger · required
  • objectstring
    Default: campaign
  • deletedboolean
    Default: true

​DeleteCampaignsReportsExportResponse

  • dataobject · required

​DeleteContactResponse

  • idinteger · required
  • objectstring
    Default: contact
  • deletedboolean
    Default: true

​DeleteCustomAttributeResponse

  • namestring · required
  • objectstring
    Default: attribute
  • deletedboolean
    Default: true

​DeleteDkimKeyResponse

  • dataobject · required
  • objectstring
    Default: dkim
  • deletedboolean
    Default: true

​DeleteFormResponse

  • idstring · required
  • objectstring
    Default: form
  • deletedboolean
    Default: true

​DeleteListResponse

  • idinteger · required
  • objectstring
    Default: list
  • deletedboolean
    Default: true

​DeleteLogoResponse

  • objectstring
    Default: logo
  • deletedboolean
    Default: true

​DeleteMFAResponse

  • idstring · required
  • objectstring
    Default: mfa
  • deletedboolean
    Default: true

​DeleteSegmentResponse

  • idinteger · required
  • objectstring
    Default: segment
  • deletedboolean
    Default: true

​DeleteSenderResponse

  • idstring · required
  • deletedboolean
    Default: true
  • objectstring
    Default: sender

​DeleteSubscriptionFormEndpointResponse

  • dataobject · required
  • objectstring
    Default: subscription_form_endpoint
  • deletedboolean
    Default: true

​DeleteSuppressedEmailResponse

  • emailstring · required
  • deletedboolean
    Default: true

​DeleteSuppressedEmailsExportResponse

  • idstring · required
  • dataobject · required
  • objectstring
    Default: task
  • deletedboolean
    Default: true

​DeleteTagResponse

  • tagstring · required
  • objectstring
    Default: tag
  • deletedboolean
    Default: true

​DeleteTemplateResponse

  • idinteger · required
  • objectstring
    Default: template
  • deletedboolean
    Default: true

​DeleteTransactionalEmailTemplateResponse

  • idinteger · required
  • dataobject · required
  • objectstring
    Default: transactional-email-template
  • deletedboolean
    Default: true

​DeleteUserResponse

  • idstring · required
  • objectstring
    Default: user
  • deletedboolean
    Default: true

​DeleteWorkflowResponse

  • dataobject · required
  • idstring · required
  • objectstring
    Default: workflow
  • deletedboolean
    Default: true

​DeviceFamilyEnum

string · enum
Enum values:
pc
mobile
tablet

​DeviceInfo

  • familystring · enum
    Enum values:
    pc
    mobile
    tablet
  • brandstring
  • modelstring

​DisableSubscriptionFormEndpointResponse

  • dataobject · required
  • objectstring
    Default: subscription_form_endpoint
  • enabledboolean

​DkimKeyFullResponse

  • idinteger · required
  • selectorstring · required
  • domainstring · required
  • public_keystring · required
  • account_defaultboolean · required
  • statusstring

​DkimKeyResponse

  • dataobject · required

​DkimKeySummaryResponse

  • idinteger · required
  • selectorstring · required
  • domainstring · required
  • public_keystring · required
  • statusstring

​DkimKeysResponse

  • dataobject[] · required

​DomainInstructionResponse

  • entrystring · required
  • validboolean · required

​Domains

  • bouncestring
  • trackingstring · uri · minLength: 1 · maxLength: 2083
  • forwardstring · uri · minLength: 1 · maxLength: 2083

​DomainsFullResponse

  • authstring · required
  • bouncestring · required
  • dkimstring · required
  • trackingstring · required

​DomainsInstructionResponse

  • bounceobject[] · required
  • trackingobject[] · required

​DomainsResponse

  • dataobject · required

​DoubleOptIn

string · enum
Enum values:
true
false
new
not_active

​DownloadCampaignLogExportFullResponse

  • expires_oninteger · required
  • urlstring · uri · minLength: 1 · maxLength: 65536 · required

​DownloadCampaignLogExportResponse

  • dataobject · required

​DownloadCampaignsReportsExportFullResponse

  • expires_oninteger · required
  • urlstring · uri · minLength: 1 · maxLength: 65536 · required

​DownloadCampaignsReportsExportResponse

  • dataobject · required

​DownloadContactsExportFullResponse

  • expires_oninteger · required
  • urlstring · uri · minLength: 1 · maxLength: 65536 · required

​DownloadContactsExportResponse

  • dataobject · required

​DownloadListLogsExportFullResponse

  • expires_oninteger · required
  • urlstring · uri · minLength: 1 · maxLength: 65536 · required

​DownloadListLogsExportResponse

  • dataobject · required

​DownloadSuppressedEmailsExportFullResponse

  • expires_oninteger · required
  • urlstring · uri · minLength: 1 · maxLength: 65536 · required

​DownloadSuppressedEmailsExportResponse

  • dataobject · required

​Email

  • emailstring · email · required
  • senderobject · required
  • contentobject · required
  • group_idinteger · min: 1
  • trackingobject
    Default: {"opens":true,"clicks_html":true,"clicks_text":true}
  • additional_headersobject[]
  • attachment
  • queueinteger · max: 1

​EmailAPIEmailContent

  • subjectstring · minLength: 1 · required
  • typestring · enum · required
    Enum values:
    marketing
    transactional
  • htmlstring · minLength: 1
  • textstring · minLength: 1
  • templateobject
  • encodingstring · enum
    Enum values:
    utf-8
    armscii-8
    ascii
    big-5
    cp51932
    cp866
    cp936
    euc-cn
  • custom_attributesobject[]
  • markupobject

​EmailAPIEventType

string · enum
Enum values:
submitted
processing
click
open
bounce
spam
unsubscribe
unsubscribe_reason

​EmailAPILogResponse

  • idstring · uuid · required
  • typestring · enum · required
    Enum values:
    submitted
    processing
    click
    open
    bounce
    spam
    unsubscribe
    unsubscribe_reason
  • email_idstring · uuid · required
  • timerequired
  • emailstring
  • subjectstring
  • providerstring
  • tagsstring[]
  • sender_namestring
  • sender_emailstring
  • metadataobject

​EmailAPILogsResponse

  • paginationobject · required
  • parametersobject · required
  • dataobject[] · required

​EmailAPIStatResponse

  • submittedinteger
  • deliveredinteger

​EmailAPIStatsIntervalResponse

  • interval_startrequired
  • interval_endrequired
  • submittedinteger · required
  • rejectedinteger · required
  • errorinteger · required
  • queuedinteger · required
  • processedinteger · required
  • deliveredinteger · required
  • unique_openinteger · required
  • unique_clickinteger · required
  • openinteger · required
  • clickinteger · required
  • bounceinteger · required
  • hard_bounceinteger · required
  • soft_bounceinteger · required
  • spaminteger · required
  • unsubscribeinteger · required
  • global_unsubscribeinteger · required
  • unique_open_ratenumber · required
  • unique_click_ratenumber · required
  • open_ratenumber · required
  • click_ratenumber · required
  • clickthru_ratenumber · required
  • delivery_ratenumber · required
  • error_ratenumber · required
  • reject_ratenumber · required
  • bounce_ratenumber · required
  • global_unsubscribe_ratenumber · required
  • unsubscribe_ratenumber · required
  • spam_ratenumber · required

​EmailAPIStatsResponse

  • parametersobject · required
  • dataobject[] · required

​EmailAPISummaryEngagementEnum

string · enum
Enum values:
click
open
none
open_not_click

​EmailAPISummaryItem

  • email_idstring · uuid · required
  • statusstring · enum · required
    Enum values:
    submitted
    processing
    click
    open
    bounce
    spam
    unsubscribe
    unsubscribe_reason
  • emailstring · required
  • submitted_timerequired
  • subjectstring
  • tagsstring[]
  • providerstring
  • delivered_time
  • first_open_time
  • first_click_time
  • first_engagement_time
  • last_engagement_time
  • unsubscribedboolean
  • global_unsubscribedboolean
  • soft_bounceboolean
  • hard_bounceboolean
  • reported_as_spamboolean
  • openinteger
  • clickinteger

​EmailAPISummaryResponse

  • paginationobject · required
  • parametersobject · required
  • dataobject[] · required

​EmailAPISummaryStatus

string · enum
Enum values:
submitted
delivered
queued
rejected
error
bounced
spam
unsubscribed

​EmailContent

  • subjectstring · minLength: 1 · required
  • htmlstring · minLength: 1
  • textstring · minLength: 1
  • templateobject
  • encodingstring · enum
    Enum values:
    utf-8
    armscii-8
    ascii
    big-5
    cp51932
    cp866
    cp936
    euc-cn
  • custom_attributesobject[]

​EmailContentResponse

  • subjectstring
  • template_idinteger
  • custom_attributesobject[]
  • typestring · enum
    Enum values:
    marketing
    transactional

​EmailGroupId

  • idinteger · required
  • descriptionstring · maxLength: 255

​EmailLogResponse

  • typestring · enum
    Enum values:
    clickthru
    click
    open
    bounce
    bounce_ac
    bounce_cr
    bounce_df
    bounce_fm
  • timestampinteger
  • emailstring
  • email_idinteger
  • group_idinteger
  • user_agentobject
  • clickthru_urlstring
  • dsn_messagestring
  • sender_namestring
  • sender_emailstring
  • source_ipstring
  • envelope_fromstring
  • additional_headersobject[]

​EmailLogsResponse

  • paginationobject · required
  • dataobject[] · required

​EmailSenderResponse

  • idstring
  • namestring
  • emailstring

​EmailStatResponse

  • dateinteger · required
  • sent_emailsinteger · required
  • open_ratenumber · required
  • bounce_ratenumber · required
  • click_ratenumber · required
  • spam_ratenumber · required

​EmailStatsResponse

  • dataobject[] · required

​EmailTracking

  • opensboolean
    Default: true
  • clicks_htmlboolean
    Default: true
  • clicks_textboolean
    Default: true

​EmailTrackingResponse

  • opensboolean · required
  • clicks_htmlboolean · required
  • clicks_textboolean · required

​EnableSubscriptionFormEndpointResponse

  • dataobject · required
  • objectstring
    Default: subscription_form_endpoint
  • enabledboolean
    Default: true

​Encoding

string · enum
Enum values:
utf-8
armscii-8
ascii
big-5
cp51932
cp866
cp936
euc-cn

​EncodingResponse

string · enum
Enum values:
utf-8
armscii-8
ascii
big-5
cp51932
cp866
cp936
euc-cn

​EventType

string · enum
Enum values:
Account.Created
Account.Updated
Account.Confirmed
Account.Deleted
Contact.Added
Contact.Updated
Contact.Removed
Contact.Tagged

​EventTypeResponse

string · enum
Enum values:
clickthru
click
open
bounce
bounce_ac
bounce_cr
bounce_df
bounce_fm

​FilterParameters

  • start_time
  • end_time
  • intervalstring
  • resolutionstring
  • iso_timeboolean
  • timezonestring
  • tagsobject
  • providersobject

​ForbiddenMessage

  • msgstring · required
  • codeinteger
  • typestring
    Default: forbidden

​ForgotMyPassword

  • emailstring · email · required

​FormContent

  • embeddedstring · minLength: 1
  • linkedstring · minLength: 1

​FormContentResponse

  • linkedstring
  • embeddedstring

​FormFullResponse

  • idstring · required
  • namestring · required
  • statusstring · enum · required
    Enum values:
    active
    deleted
  • contentobject · required
  • languagestring · enum · required
    Enum values:
    da
    da_DK
    de
    de_DE
    el
    el_GR
    en
    en_US
  • urlobject · required
  • redirectionsobject · required
  • created_oninteger
  • last_updated_oninteger
  • thumbnail_urlstring
  • list_idinteger
  • double_opt_inboolean
  • thumbnailstring · deprecated · required

​FormRedirections

  • after_opt_instring · uri · minLength: 1 · maxLength: 2083
  • after_double_opt_instring · uri · minLength: 1 · maxLength: 2083
  • after_opt_outstring · uri · minLength: 1 · maxLength: 2083

​FormRedirectionsResponse

  • after_opt_instring
  • after_double_opt_instring
  • after_opt_outstring

​FormResponse

  • dataobject · required

​FormStatus

string · enum
Enum values:
active
deleted

​FormUrlsResponse

  • linkedstring
  • embeddedstring

​FormsResponse

  • paginationobject · required
  • dataobject[] · required

​GetActionResponse

  • dataobject · required

​GetCampaignsReportsExportResponse

  • dataobject · required

​GetEmailResponse

  • email_idstring · uuid · required
  • statusstring · enum · required
    Enum values:
    submitted
    processing
    click
    open
    bounce
    spam
    unsubscribe
    unsubscribe_reason
  • emailstring · required
  • submitted_timeinteger · required
  • senderobject · required
  • contentobject · required
  • trackingobject · required
  • providerstring
  • unsubscribedboolean
  • global_unsubscribedboolean
  • soft_bouncedboolean
  • hard_bouncedboolean
  • reported_as_spamboolean
  • openinteger
  • clickinteger
  • list_idinteger
  • tagsstring[]
  • additional_headersobject[]
  • thumbnail_urlstring

​GetMFAPortalResponse

  • urlstring · uri · minLength: 1 · maxLength: 2083 · required

​GetSuppressedEmailsExportResponse

  • dataobject · required

​GetWorkflowResponse

  • dataobject · required

​HTTPBadRequestError

  • detailobject[] · required

​HTTPForbiddenError

  • detailobject[] · required

​HTTPUnauthorizedError

  • detailobject[] · required

​HTTPValidationError

  • detailobject[]

​HasMorePagination

  • pageinteger
    Default: 1
  • per_pageinteger
  • has_moreboolean

​ImportContactData

  • emailstring · email · required
  • custom_attributesobject[] · minItems: 1
  • tagsstring[]
  • interestsstring[]

​ImportContactInvalidCustomAttributeErrorResponse

  • locstring[] · required
  • msgstring
    Default: Invalid custom attribute
  • codeinteger
    Default: 8014

​ImportContactNotFoundErrorResponse

  • locstring[] · required
  • msgstring
    Default: Contact not found
  • codeinteger
    Default: 8001

​ImportContactUnknownErrorResponse

  • locstring[] · required
  • msgstring
    Default: Unknown error
  • codeinteger
    Default: 8015

​ImportContacts

  • contactsobject[] · minItems: 1 · required
  • import_tostring · enum
    Enum values:
    active
    unsubscribed
    deleted
  • resubscribeboolean
  • remove_tagsboolean
    Default: true
  • remove_interestsboolean
    Default: true

​ImportContactsResponse

  • idinteger[] · required
  • import_idstring · uuid4
  • objectstring
    Default: contact
  • importedboolean
    Default: true
  • dataobject[]
    Default: []
  • errorsarray

​InterestCreate

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

​InterestCreatedResponse

  • dataobject · required
  • objectstring
    Default: interest
  • createdboolean
    Default: true

​InterestDeletedResponse

  • dataobject · required
  • objectstring
    Default: interest
  • deletedboolean
    Default: true

​InterestFullResponse

  • namestring · required
  • aliasstring
  • usageinteger

​InterestPatch

  • namestring
  • aliasstring

​InterestPatchedResponse

  • dataobject · required
  • objectstring
    Default: interest
  • patchedboolean
    Default: true

​InterestResponse

  • dataobject · required

​InterestsResponse

  • paginationobject · required
  • dataobject[] · required

​IntervalEnum

string · enum
Enum values:
5m
15m
30m
1h
1d

​Languages

string · enum
Enum values:
da
da_DK
de
de_DE
el
el_GR
en
en_US

​LinkFullResponse

  • idinteger · required
  • statusstring · required
  • link_tostring · required

​LinkInfoFullResponse

  • mailing_idinteger · required

​LinkInfoResponse

  • dataobject · required

​LinksResponse

  • paginationobject · required
  • dataobject[] · required

​List

  • namestring · minLength: 1 · required
  • default_senderobject · required
  • languagestring · enum
    Enum values:
    da
    da_DK
    de
    de_DE
    el
    el_GR
    en
    en_US
    Default: en_US
  • redirectionsobject
    Default: {}
  • webhookobject
    Default: {}

​ListCampaignsReportsExportsResponse

  • paginationobject · required
  • dataobject[] · required

​ListEmailGroupIdsResponse

  • paginationobject · required
  • dataobject[] · required

​ListEmailTagsResponse

  • paginationobject · required
  • datastring[] · required

​ListFullResponse

  • idinteger · required
  • namestring · required
  • statusstring · required
  • languagestring · required
  • created_oninteger · required
  • default_senderobject · required
  • redirectionsobject · required
  • pagesobject · required
  • webhookobject · required
  • policy_acceptedboolean

​ListLogResponse

  • idinteger
  • contact_idinteger
  • emailstring
  • typestring · enum
    Enum values:
    clickthru
    click
    open
    bounce
    bounce_ac
    bounce_cr
    bounce_df
    bounce_fm
  • timestampinteger
  • occurrencesinteger
  • user_agentobject
  • campaign_idinteger
  • clickthru_urlstring
  • dsn_messagestring
  • unsub_reasonstring
  • subscription_typestring · enum
    Enum values:
    resubscribe
    subscription_confirmation

​ListLogsExportFullResponse

  • idstring · required
  • list_idinteger · required
  • statusstring · enum · required
    Enum values:
    pending
    ready
    deleted
    failed
  • requested_byobject · required
  • created_oninteger · required
  • expires_oninteger · required
  • progressnumber · required
  • descriptionstring

​ListLogsExportRequestedBy

  • idinteger · required
  • emailstring · required

​ListLogsExportStatus

string · enum
Enum values:
pending
ready
deleted
failed

​ListLogsExportsResponse

  • paginationobject · required
  • dataobject[] · required

​ListLogsResponse

  • paginationobject · required
  • dataobject[] · required

​ListMFAResponse

  • paginationobject · required
  • dataobject[] · required

​ListPagesResponse

  • opt_instring
  • opt_outstring
  • subscribestring
  • unsubscribestring

​ListRedirectionsResponse

  • after_opt_instring
  • after_double_opt_instring
  • after_opt_outstring

​ListResponse

  • dataobject · required

​ListSenderResponse

  • namestring
  • emailstring

​ListStatResponse

  • active_contactsinteger · required
  • pending_contactsinteger · required
  • invalid_contactsinteger · required
  • unsubscribed_contactsinteger · required
  • flagged_contactsinteger · required
  • deleted_contactsinteger · required
  • sent_emailsinteger · required
  • open_ratenumber · required
  • bounce_ratenumber · required
  • click_ratenumber · required
  • clickthru_ratenumber · required
  • unsubscribe_ratenumber · required
  • spam_ratenumber · required

​ListStatsResponse

  • dataobject · required

​ListSubscriptionFormEndpointResponse

  • paginationobject · required
  • dataobject[] · required

​ListSummaryResponse

  • idinteger · required
  • namestring · required
  • statusstring · required
  • languagestring · required
  • default_senderobject · required
  • created_oninteger

​ListSuppressedEmailsExportsResponse

  • paginationobject · required
  • dataobject[] · required

​ListTasksResponse

  • paginationobject · required
  • dataobject[] · required

​ListTransactionalEmailTemplateResponse

  • paginationobject · required
  • dataobject[] · required

​ListWebhookAction

string · enum
Enum values:
all
subscribe
unsubscribe
update
delete
spam
bounce
bounce_ac

​ListWebhookResponse

  • urlstring
  • actionsstring[]
    Enum values:
    all
    subscribe
    unsubscribe
    update
    delete
    spam
    bounce
    bounce_ac

​ListWebhooksResponse

  • paginationobject · required
  • dataobject[] · required

​ListWorkflowsResponse

  • paginationobject · required
  • dataobject[] · required

​ListsResponse

  • paginationobject · required
  • dataobject[] · required

​LockWorkflow

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

​LockWorkflowResponse

  • lockedboolean · required
  • expires_ininteger · required
  • objectstring
    Default: workflow

​LogType

string · enum
Enum values:
bounce
clickthru
sent
open
unsubscribe
resubscribe
spam
global_unsubscribe

​LogTypeV2

string · enum
Enum values:
all
submitted
rejected
error
queued
delivered
open
click

​MFAResponse

  • idstring · required
  • typestring · enum · required
    Enum values:
    totp
  • descriptionstring

​MFAType

string · enum
Enum values:
totp

​NewTOTPMFAResponse

  • idstring · required
  • qr_codestring · required
  • secretstring · required
  • typestring · enum
    Enum values:
    totp
    Default: totp
  • descriptionstring

​OperatingSystemInfo

  • familystring
  • versionstring

​Pagination

  • pageinteger
    Default: 1
  • per_pageinteger
  • countinteger

​PaginationWithCursor

  • pageinteger
    Default: 1
  • per_pageinteger
  • countinteger
  • cursorobject

​PasswordGrantType

string · enum
Enum values:
password
refresh_token

​PasswordStrengthRequirement

string · enum
Enum values:
VERY_WEAK
WEAK
MODERATE
STRONG
VERY_STRONG

​PatchAccount

  • addressobject
  • namestring
  • account_ownerobject
  • faxstring
  • phonestring
  • domainsobject
    Default: {}
  • websitestring · uri · minLength: 1 · maxLength: 2083
  • usage_limitsobject
    Default: {}
  • trialboolean
  • partnerboolean
  • metadataobject

​PatchAccountResponse

  • dataobject · required
  • warningsobject[]
    Default: []

​PatchAction

  • namestring
  • parent_idstring
  • conditionstring · enum
    Enum values:
    opened
    not_opened
    clicked
    not_clicked
    none
  • delayinteger
  • typestring · enum
    Enum values:
    email
  • email_settingsobject

​PatchActionContent

  • subjectstring · minLength: 1
  • htmlstring · minLength: 1
  • textstring · minLength: 1
  • jsonobject
  • typestring · enum
    Enum values:
    custom
    html
    bee
  • encodingstring · enum
    Enum values:
    utf-8
    armscii-8
    ascii
    big-5
    cp51932
    cp866
    cp936
    euc-cn

​PatchActionEmailSettings

  • trackingobject
  • contentobject
  • senderobject

​PatchActionResponse

  • idstring · required
  • dataobject · required
  • objectstring
    Default: action
  • patchedboolean
    Default: true

​PatchActionTracking

  • opensboolean
  • clicks_htmlboolean
  • clicks_textboolean

​PatchCampaign

  • namestring · minLength: 1
  • audienceobject
    Default: {}
  • trackingobject
  • senderobject
  • reply_to_emailstring · email
  • contentobject
    Default: {}

​PatchCampaignContent

  • subjectstring · minLength: 1
  • htmlstring · minLength: 1
  • textstring · minLength: 1
  • jsonobject
  • typestring · enum
    Enum values:
    custom
    html
    bee
  • encodingstring · enum
    Enum values:
    utf-8
    armscii-8
    ascii
    big-5
    cp51932
    cp866
    cp936
    euc-cn
  • default_unsubscribe_linkboolean

​PatchCampaignResponse

  • idinteger · required
  • dataobject · required
  • objectstring
    Default: campaign
  • updatedboolean
    Default: true

​PatchContact

  • emailstring · email
  • custom_attributesobject[]
  • interestsstring[]
  • tagsstring[]

​PatchContactResponse

  • idinteger · required
  • dataobject · required
  • objectstring
    Default: contact
  • updatedboolean
    Default: true

​PatchDomains

  • domainsobject · required

​PatchDomainsResponse

  • dataobject · required
  • objectstring
    Default: domains
  • patchedboolean
    Default: true

​PatchEmailGroupId

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

​PatchEmailGroupIdResponse

  • idinteger · required
  • dataobject · required
  • objectstring
    Default: email-group-id
  • updatedboolean
    Default: true

​PatchForm

  • namestring · minLength: 1
  • statusstring · minLength: 1
  • contentobject
    Default: {}
  • redirectionsobject
    Default: {}
  • list_idinteger · min: 1
  • languagestring · enum
    Enum values:
    da
    da_DK
    de
    de_DE
    el
    el_GR
    en
    en_US
  • double_opt_inboolean

​PatchFormResponse

  • idstring · required
  • dataobject · required
  • objectstring
    Default: form
  • updatedboolean
    Default: true

​PatchListResponse

  • idinteger · required
  • dataobject · required
  • updatedboolean
    Default: true

​PatchSegmentResponse

  • idinteger · required
  • dataobject · required
  • objectstring
    Default: segment
  • updatedboolean
    Default: true

​PatchSelfAccount

  • addressobject
  • namestring
  • account_ownerobject
  • faxstring
  • phonestring
  • domainsobject
    Default: {}
  • websitestring · uri · minLength: 1 · maxLength: 2083

​PatchSenderResponse

  • idstring · required
  • dataobject · required
  • updatedboolean
    Default: true
  • objectstring
    Default: sender

​PatchSubscriptionFormEndpointRequest

  • domainstring · pattern: ^(?:[a-zA-Z0-9](?:[a…
  • namestring
  • double_opt_inboolean
  • secretstring
  • post_redirect_urlstring
  • double_opt_in_redirect_urlstring
  • async_processingboolean

​PatchSubscriptionFormEndpointResponse

  • dataobject · required
  • objectstring
    Default: subscription_form_endpoint
  • updatedboolean
    Default: true

​PatchTag

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

​PatchTagResponse

  • tagstring · required
  • dataobject · required
  • objectstring
    Default: tag
  • updatedboolean
    Default: true

​PatchTemplate

  • namestring · minLength: 1
  • descriptionstring
  • contentobject
  • tagsstring[]

​PatchTemplateContent

  • typestring · enum
    Enum values:
    html
    text
    bee
    custom
  • subjectstring
  • htmlstring · minLength: 1
  • textstring · minLength: 1
  • jsonobject

​PatchTemplateResponse

  • idinteger · required
  • dataobject · required
  • objectstring
    Default: template
  • updatedboolean
    Default: true

​PatchTracking

  • opensboolean
  • clicks_htmlboolean
  • clicks_textboolean
  • additional_paramsstring · minLength: 1

​PatchUser

  • first_namestring
  • last_namestring
  • titlestring
  • office_phonestring
  • mobile_phonestring · pattern: [0-9]+
  • languagestring · enum
    Enum values:
    da
    da_DK
    de
    de_DE
    el
    el_GR
    en
    en_US
  • timezonestring
  • passwordobject

​PatchUserResponse

  • idstring · required
  • dataobject · required
  • objectstring
    Default: user
  • patchedboolean
    Default: true

​PatchWebhook

  • urlstring · uri · minLength: 1 · maxLength: 2083
  • rate_limitinteger
  • rate_limit_periodstring · enum
    Enum values:
    second
    minute

​PatchWebhookResponse

  • idstring · required
  • dataobject · required
  • objectstring
    Default: Webhook
  • patchedboolean
    Default: true

​PatchWorkflow

  • namestring
  • goalstring
  • descriptionstring
  • triggerstring · enum
    Enum values:
    subscribed
    unsubscribed
    manual
  • audienceobject
  • blueprintobject

​PatchWorkflowResponse

  • dataobject · required
  • idstring · required
  • objectstring
    Default: workflow
  • patchedboolean
    Default: true

​PutSystemEmailsResponse

  • dataobject · required
  • objectstring
    Default: systememails
  • updatedboolean
    Default: true

​RateLimitPeriod

string · enum
Enum values:
second
minute

​RecoveryCodesResponse

  • datastring[] · required

​Redirections

  • after_opt_instring · uri · minLength: 1 · maxLength: 2083
  • after_double_opt_instring · uri · minLength: 1 · maxLength: 2083
  • after_opt_outstring · uri · minLength: 1 · maxLength: 2083

​RefreshGrantType

string · enum
Enum values:
refresh_token

​RelayGroupId

  • idinteger · required
  • descriptionstring

​RemoveInterestsFromContacts

  • interestsstring[] · maxItems: 16 · required
  • contact_idsinteger[] · min: 1 · maxItems: 1024
  • querystring
  • fiqlstring
  • jsonobject

​RemoveInterestsFromMultipleContactsResponse

  • objectstring
    Default: interests
  • removedboolean
    Default: true

​RenderCampaignFullResponse

  • htmlstring
  • textstring

​RenderCampaignResponse

  • dataobject · required

​RenderTransactionalEmailTemplate

  • contact_idinteger · required
  • custom_attributesobject[]

​RequestedByUser

  • emailstring · email · required
  • idinteger · required

​ResendAccountVerificationEmailResponse

  • objectstring
    Default: account
  • verification_resentboolean
    Default: true

​ResendConfirmationEmailResponse

  • idstring · required
  • resentboolean
    Default: true
  • objectstring
    Default: sender

​ResendUserVerificationEmailResponse

  • objectstring
    Default: user
  • confirmation_resentboolean
    Default: true

​ResendVerificationEmail

  • emailstring · email · required

​ResetPasswordConfirm

  • tokenstring · required
  • passwordstring · required

​ResetPasswordConfirmResponse

  • objectstring
    Default: user
  • password_resetboolean
    Default: true

​ResetPasswordResponse

  • emailstring · required
  • objectstring
    Default: user
  • reset_link_sentboolean
    Default: true

​ResetUserPassword

  • invalidate_current_passwordboolean

​ResumeCampaignResponse

  • idinteger · required
  • objectstring
    Default: campaign
  • resumedboolean
    Default: true

​ScheduleCampaign

  • dateinteger · min: 1 · max: 2147483647
  • html_emptyboolean

​ScheduleCampaignResponse

  • idinteger · required
  • objectstring
    Default: campaign
  • scheduledboolean
    Default: true

​Scope

string · enum
Enum values:
user
admin
internal
auth

​Segment

  • namestring · minLength: 1 · required
  • querystring · minLength: 1
  • fiqlstring · minLength: 1
  • jsonobject

​SegmentFullResponse

  • idinteger · required
  • namestring · required
  • campaigns_countinteger · required
  • last_usedinteger · required
  • created_oninteger · required
  • querystring
  • fiqlstring
  • jsonobject

​SegmentResponse

  • dataobject · required

​SegmentsResponse

  • paginationobject · required
  • dataobject[] · required

​SendEmailResponse

  • emailstring · required
  • dataobject · required
  • objectstring
    Default: email
  • sentboolean
    Default: true

​SendTestAction

  • emailstring · email · required
  • typestring · enum
    Enum values:
    merged
    separated
    Default: merged

​SendTestActionResponse

  • idstring · required
  • objectstring
    Default: action
  • sentboolean
    Default: true

​SendTestEmail

  • emailstring · email · required
  • typestring · enum
    Enum values:
    merged
    separated
    Default: merged

​SendTestEmailResponse

  • emailstring · email · required
  • typestring · enum · required
    Enum values:
    merged
    separated
  • objectstring
    Default: test_email
  • sentboolean
    Default: true

​SendTestTransactionalEmail

  • emailstring · email · required

​SendTestTransactionalEmailTemplateResponse

  • objectstring
    Default: transactional-email-test
  • sentboolean
    Default: true

​SendTransactionalEmailResponse

  • emailstring · required
  • dataobject · required
  • objectstring
    Default: email
  • sentboolean
    Default: true

​SendTransactionalEmailTemplateResponse

  • emailstring · required
  • dataobject · required
  • objectstring
    Default: transactional-email-template
  • sentboolean
    Default: true

​SendTransactionalEmailToAddress

  • emailstring · email · required
  • senderobject
  • custom_attributesobject[]
  • attachmentsobject[]
  • resubscribeboolean
  • queueinteger · max: 1

​SendTransactionalEmailToContactId

  • contact_idinteger · required
  • senderobject
  • custom_attributesobject[]
  • attachmentsobject[]
  • resubscribeboolean
  • queueinteger · max: 1

​Sender

  • idstring · minLength: 1 · required

​SenderAndName

  • idstring · minLength: 1 · required
  • namestring · minLength: 1

​SenderFullResponse

  • idstring · required
  • namestring · required
  • emailstring · required
  • confirmedboolean · required
  • confirmed_oninteger
  • languagestring · enum
    Enum values:
    da
    da_DK
    de
    de_DE
    el
    el_GR
    en
    en_US
    Default: en_US
  • last_confirmation_sent_oninteger

​SenderInfo

  • namestring
  • emailstring

​SenderResponse

  • dataobject · required

​SendersResponse

  • paginationobject · required
  • dataobject[] · required

​SentTransactionalEmailResponse

  • contact_idinteger · required

​ShowSubscriptionFormEndpointResponse

  • dataobject · required

​ShowTransactionalEmailTemplateResponse

  • dataobject · required

​SignatureHashFunction

string · enum
Enum values:
sha256

​SignatureInfo

  • hash_functionstring · enum · required
    Enum values:
    sha256
  • keystring

​SubmitEmail

  • senderobject · required
  • contentobject · required
  • emailstring · email
  • list_idinteger · min: 1
  • contact_idinteger · min: 1
  • tagsstring[] · minLength: 1 · maxLength: 255 · pattern: ^[a-zA-Z0-9-_]+$
  • trackingobject
  • additional_headersobject[]
  • attachment

​SubmitEmailAPIStatus

string · enum
Enum values:
queued
rejected
error

​SubmitEmailResponse

  • emailstring · required
  • dataobject · required
  • objectstring
    Default: email
  • submittedboolean
    Default: true

​SubmitEmailType

string · enum
Enum values:
marketing
transactional

​SubmittedEmailResponse

  • idstring · uuid · required
  • statusstring · enum · required
    Enum values:
    queued
    rejected
    error

​SubscriptionFormEndpointResponse

  • idstring · required
  • enabledboolean · required
  • namestring
  • domainstring
  • secretstring
  • post_redirect_urlstring
  • double_opt_inboolean
  • double_opt_in_redirect_urlstring
  • submission_urlstring
  • async_processingboolean

​SubscriptionTypeResponse

string · enum
Enum values:
resubscribe
subscription_confirmation

​SuppressedEmail

  • emailstring · minLength: 1 · required

​SuppressedEmailResponse

  • emailstring · required
  • sourcestring

​SuppressedEmailsExportResponse

  • idstring · required
  • statusstring · enum · required
    Enum values:
    pending
    ready
    error
    deleted
  • created_oninteger · required
  • expires_oninteger · required
  • requested_byobject · required
  • payloadobject · required
  • progressinteger
  • typestring · enum
    Enum values:
    contactsexport
    campaignlogexport
    campaignsreportsexport
    suppressedemailsexport
    listlogsexport
    unknown
    Default: suppressedemailsexport
  • descriptionstring

​SuppressedEmailsResponse

  • paginationobject · required
  • dataobject[] · required

​SuspendAccountResponse

  • idstring · required
  • dataobject · required
  • objectstring
    Default: account
  • suspendedboolean
    Default: true

​SuspendCampaignResponse

  • idinteger · required
  • objectstring
    Default: campaign
  • suspendedboolean
    Default: true

​SuspendUserResponse

  • idstring · required
  • dataobject · required
  • objectstring
    Default: user
  • suspendedboolean
    Default: true

​SystemEmailTemplate

  • languagestring · enum · required
    Enum values:
    da
    da_DK
    de
    de_DE
    el
    el_GR
    en
    en_US
  • templateobject
  • senderobject

​SystemEmailsResponse

  • dataobject · required

​SystemEmailsTemplates

  • account_confirmobject[]
  • user_confirmobject[]
  • sender_confirmobject[]
  • password_resetobject[]
  • contact_double_opt_inobject[]

​TagContactResponse

  • taggedboolean
    Default: true

​TagFullResponse

  • tagstring · required

​TagMultipleContacts

  • tagsstring[] · minItems: 1 · maxItems: 1024 · required
  • contact_idsinteger[] · min: 1 · minItems: 1 · maxItems: 1024
  • querystring · minLength: 1
  • fiqlstring
  • jsonobject

​TagMultipleContactsResponse

  • taggedboolean
    Default: true

​TagResponse

  • dataobject · required

​Tags

  • tagsstring[] · minItems: 1 · maxItems: 1024 · required

​TagsResponse

  • paginationobject · required
  • dataobject[] · required

​TaskFullResponse

  • idstring · required
  • statusstring · enum · required
    Enum values:
    pending
    ready
    error
    deleted
  • created_oninteger · required
  • expires_oninteger · required
  • requested_byobject · required
  • typestring · enum · required
    Enum values:
    contactsexport
    campaignlogexport
    campaignsreportsexport
    suppressedemailsexport
    listlogsexport
    unknown
  • payloadobject · required
  • progressinteger
  • descriptionstring

​TaskResponse

  • dataobject · required

​TaskStatus

string · enum
Enum values:
pending
ready
error
deleted

​TaskType

string · enum
Enum values:
contactsexport
campaignlogexport
campaignsreportsexport
suppressedemailsexport
listlogsexport
unknown

​TemplateContent

  • typestring · enum · required
    Enum values:
    html
    text
    bee
    custom
  • subjectstring
  • htmlstring · minLength: 1
  • textstring · minLength: 1
  • jsonobject

​TemplateContentResponse

  • typestring · enum · required
    Enum values:
    html
    text
    bee
    custom
  • subjectstring
  • htmlstring
  • textstring
  • jsonobject

​TemplateCreate

  • namestring · minLength: 1 · required
  • contentobject · required
  • descriptionstring
  • tagsstring[]

​TemplateCreated

  • idinteger · required
  • objectstring
    Default: template
  • createdboolean
    Default: true

​TemplateCustomAttributes

  • namestring · minLength: 1 · required
  • valuestring · required

​TemplateFullResponse

  • idinteger · required
  • namestring · required
  • created_oninteger · required
  • updated_oninteger · required
  • contentobject · required
  • descriptionstring
  • tagsstring[]
  • is_ownerboolean
  • sharingobject
  • thumbnail_urlstring
  • thumbnailstring · deprecated · required

​TemplateId

  • idinteger · required

​TemplateInfo

  • idinteger · required
  • custom_attributesobject[] · minItems: 1

​TemplateResponse

  • dataobject · required

​TemplateSharing

  • sharedboolean
  • accountsobject[]
  • automaticboolean

​TemplateSharingSummaryResponse

  • sharedboolean

​TemplateSummaryResponse

  • idinteger · required
  • namestring · required
  • created_oninteger · required
  • updated_oninteger · required
  • descriptionstring
  • tagsstring[]
  • is_ownerboolean
  • sharingobject
  • thumbnail_urlstring
  • thumbnailstring · deprecated · required

​TemplateTypeEnum

string · enum
Enum values:
html
text
bee
custom

​TemplateVisibilityResponse

  • account_idinteger · required
  • visibleboolean · required
  • company_namestring

​TemplatesResponse

  • paginationobject · required
  • dataobject[] · required

​TestEmailType

string · enum
Enum values:
merged
separated

​TokenResponse

  • access_tokenstring · required
  • token_typestring · required
  • expires_ininteger · required
  • refresh_tokenstring · required
  • accountsinteger[] · unique · required

​Tracking

  • opensboolean
    Default: true
  • clicks_htmlboolean
    Default: true
  • clicks_textboolean
    Default: true
  • additional_paramsstring · minLength: 1

​TrackingResponse

  • opensboolean
  • clicks_htmlboolean
  • clicks_textboolean
  • additional_paramsstring

​TransactionalEmailResponse

  • idinteger · required

​TransactionalEmailTemplateContent

  • typestring · enum · required
    Enum values:
    custom
    html
    bee
  • subjectstring · required
  • jsonobject
  • htmlstring

​TransactionalEmailTemplateContentSummaryResponse

  • typestring · enum · required
    Enum values:
    custom
    html
    bee
  • subjectstring

​TransactionalEmailTemplateFullResponse

  • idinteger · required
  • namestring · required
  • statusstring · required
  • created_oninteger · required
  • senderobject · required
  • contentobject · required
  • thumbnail_urlstring · required
  • updated_oninteger
  • ccstring[]
  • reply_tostring

​TransactionalEmailTemplateSummaryResponse

  • idinteger · required
  • namestring · required
  • statusstring · required
  • created_oninteger · required
  • senderobject · required
  • contentobject · required
  • thumbnail_urlstring · required

​TransactionalEmailTemplateTracking

  • additional_paramsstring · minLength: 1

​UnArchiveWebhookResponse

  • idstring · required
  • dataobject · required
  • objectstring
    Default: Webhook
  • archivedboolean

​UnauthorizedMessage

  • msgstring · required
  • codeinteger
  • typestring
    Default: unauthorized

​UnlockWorkflow

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

​UnlockWorkflowResponse

  • lockedboolean · required
  • expires_ininteger · required
  • objectstring
    Default: workflow

​UnsubscribeContactResponse

  • dataobject · required
  • objectstring
    Default: contact
  • subscribedboolean

​UnsuspendAccountResponse

  • idstring · required
  • dataobject · required
  • objectstring
    Default: account
  • unsuspendedboolean
    Default: true

​UntagContactResponse

  • untaggedboolean
    Default: true

​UntagMultipleContacts

  • tagsstring[] · minItems: 1 · maxItems: 1024 · required
  • contact_idsinteger[] · min: 1 · minItems: 1 · maxItems: 1024
  • querystring · minLength: 1
  • fiqlstring
  • jsonobject

​UntagMultipleContactsResponse

  • untaggedboolean
    Default: true

​UpdateList

  • namestring · minLength: 1
  • default_senderobject
  • languagestring · enum
    Enum values:
    da
    da_DK
    de
    de_DE
    el
    el_GR
    en
    en_US
  • redirectionsobject
    Default: {}
  • webhookobject
    Default: {}

​UpdateSegment

  • querystring · minLength: 1
  • fiqlstring · minLength: 1
  • jsonobject
  • namestring

​UpdateSender

  • namestring
  • languagestring · enum
    Enum values:
    da
    da_DK
    de
    de_DE
    el
    el_GR
    en
    en_US

​UpdateTransactionalEmailFromTemplate

  • template_idinteger · required
  • subjectstring

​UpdateTransactionalEmailTemplate

  • namestring
  • senderobject
  • reply_tostring · email
  • ccstring[] · maxItems: 1
  • content
  • trackingobject

​UpdateTransactionalEmailTemplateResponse

  • idinteger · required
  • dataobject · required
  • objectstring
    Default: transactional-email-template
  • updatedboolean
    Default: true

​UpdateTransactionalEmailTemplateTemplateContent

  • subjectstring · required
  • typestring · enum
    Enum values:
    custom
    html
    bee
  • jsonobject
  • htmlstring
  • filestring · minLength: 1 · required

​UploadLogoResponse

  • logostring · required
  • objectstring
    Default: logo
  • uploadedboolean
    Default: true

​UsageLimits

  • starts_oninteger
  • per_campaigninteger
  • per_monthinteger
  • maximum_contactsinteger
  • listsinteger · min: -1
  • usersinteger · min: -1
  • campaign_blueprintsinteger · min: -1
  • automation_conditionsinteger · min: -1
  • use_campaign_blueprintsboolean
  • use_automation_conditionsboolean
  • use_automationsboolean
  • use_automation_customwebhooksboolean
  • use_html_editorboolean
  • use_contact_exportboolean
  • use_custom_merge_tagsboolean
  • use_list_redirectionboolean
  • use_behavioral_segmentationboolean
  • use_ab_splitboolean
  • use_smart_email_resourceboolean
  • use_smart_blueprintboolean
  • use_brandboolean
  • use_email_apiboolean
  • insert_reseller_logoboolean
  • use_tags_in_automationboolean
  • use_tagsboolean

​UsageLimitsResponse

  • starts_oninteger
  • per_campaigninteger
  • per_monthinteger
  • remaininginteger
  • maximum_contactsinteger
  • listsinteger
  • usersinteger
  • campaign_blueprintsinteger
  • automation_conditionsinteger
  • use_ab_splitboolean
  • use_automation_conditionsboolean
  • use_automationsboolean
  • use_automation_customwebhooksboolean
  • use_behavioral_segmentationboolean
  • use_brandboolean
  • use_campaign_blueprintsboolean
  • use_contact_exportboolean
  • use_custom_merge_tagsboolean
  • use_email_apiboolean
  • use_html_editorboolean
  • use_list_redirectionboolean
  • use_smart_email_resourceboolean
  • use_smart_blueprintboolean
  • use_tags_in_automationboolean
  • use_tagsboolean
  • insert_reseller_logoboolean

​User

  • first_namestring · required
  • last_namestring · required
  • emailstring · email · required
  • titlestring
  • office_phonestring
  • mobile_phonestring · pattern: [0-9]+
  • languagestring · enum
    Enum values:
    da
    da_DK
    de
    de_DE
    el
    el_GR
    en
    en_US
  • timezonestring
  • passwordstring · minLength: 8
  • password_strength_requirementstring · enum
    Enum values:
    VERY_WEAK
    WEAK
    MODERATE
    STRONG
    VERY_STRONG
    Default: VERY_WEAK

​UserConfirmation

  • confirmationstring · required
  • passwordstring · minLength: 8 · required

​UserFullResponse

  • idstring · required
  • emailstring · required
  • statusstring · required
  • created_oninteger
  • last_activity_oninteger
  • expires_oninteger
  • first_namestring
  • last_namestring
  • titlestring
  • languagestring · enum
    Enum values:
    da
    da_DK
    de
    de_DE
    el
    el_GR
    en
    en_US
  • timezonestring
  • office_phonestring
  • mobile_phonestring

​UserInfo

  • osobject · required
  • browserobject · required
  • deviceobject · required
  • ipstring
  • is_botboolean
  • rawstring

​UserResponse

  • dataobject · required

​UserSummaryResponse

  • idstring · required
  • emailstring · required
  • statusstring
  • first_namestring
  • last_namestring
  • last_activity_oninteger
  • created_oninteger
  • expires_oninteger

​UsersResponse

  • paginationobject · required
  • dataobject[] · required

​ValidateDomainsResponse

  • dataobject · required

​ValidationError

  • locarray · required
  • msgstring · required
  • typestring · required

​WebhookResponse

  • idstring · required
  • signatureobject · required
  • dataobject · required

​WebhookStatus

string · enum
Enum values:
active
archived

​Workflow

  • audienceobject · required
  • namestring
  • goalstring
  • descriptionstring
  • triggerstring · enum
    Enum values:
    subscribed
    unsubscribed
    manual
    Default: subscribed
  • blueprintobject

​WorkflowAudience

  • list_idinteger · required
  • segment_idinteger

​WorkflowBlueprint

  • idstring · required
  • namestring · required
  • goalstring · required
  • descriptionstring
  • triggerstring · enum
    Enum values:
    subscribed
    unsubscribed
    manual
  • created_oninteger
  • updated_oninteger

​WorkflowBlueprintActionResponse

  • dataobject · required

​WorkflowBlueprintResponse

  • dataobject · required

​WorkflowBlueprintsResponse

  • paginationobject · required
  • dataobject[] · required

​WorkflowFromBlueprint

  • idstring · required
  • email_settingsobject

​WorkflowResponse

  • idstring · required
  • namestring
  • descriptionstring
  • goalstring
  • statusstring · enum
    Enum values:
    active
    inactive
  • triggerstring · enum
    Enum values:
    subscribed
    unsubscribed
    manual
  • audienceobject
  • created_oninteger
  • updated_oninteger
  • activated_oninteger

​WorkflowStatus

string · enum
Enum values:
active
inactive

​WorkflowTrigger

string · enum
Enum values:
subscribed
unsubscribed
manual

​api__schemas__requests__lists__Webhook

  • urlstring · uri · minLength: 1 · maxLength: 2083
  • actionsstring[] · minItems: 1
    Enum values:
    all
    subscribe
    unsubscribe
    update
    delete
    spam
    bounce
    bounce_ac

​api__services__webhooks__schemas__Webhook

  • idstring
  • statusstring · enum
    Enum values:
    active
    archived
  • eventstring · enum
    Enum values:
    Account.Created
    Account.Updated
    Account.Confirmed
    Account.Deleted
    Contact.Added
    Contact.Updated
    Contact.Removed
    Contact.Tagged
  • urlstring · uri · minLength: 1 · maxLength: 2083
  • archived_atinteger
  • rate_limitinteger
  • rate_limit_periodstring · enum
    Enum values:
    second
    minute