Skip to main content

Send an email

POST 
/v1/email/send

This endpoint sends an email using the connected ESP

Request​

Body

required

Email Payload

    attachments

    object[]

    Attachments are optional

  • Array [

    • content stringrequired

    Base64 content is required

    contentId string
    contentLocation string
    disposition string
    filename stringrequired
    type stringrequired

    Possible values: [audio/aac, audio/aiff, audio/flac, audio/mpeg, audio/ogg, audio/opus, audio/wav, audio/mp4, audio/x-ms-wma, application/json, application/sql, application/toml, application/x-php, application/x-ndjson, application/x-sh, application/xml, text/xml, application/yaml, text/css, text/javascript, text/markdown, text/plain, text/tab-separated-values, application/x-c, application/x-c++, application/x-csharp, application/x-go, application/x-java, application/x-python, application/x-ruby, application/x-rust, application/x-scala, application/x-swift, application/typescript, application/gzip, application/vnd.ms-cab-compressed, application/vnd.rar, application/x-7z-compressed, application/x-bzip2, application/x-tar, application/x-xz, application/zip, application/epub+zip, application/msword, application/pdf, application/rtf, application/vnd.apple.pages, application/vnd.ms-excel, application/vnd.ms-outlook, application/vnd.ms-powerpoint, application/wps-office.doc, application/vnd.ms-xpsdocument, application/vnd.oasis.opendocument.graphics, application/vnd.oasis.opendocument.presentation, application/vnd.oasis.opendocument.spreadsheet, application/vnd.oasis.opendocument.text, application/vnd.openxmlformats-officedocument.presentationml.presentation, application/vnd.openxmlformats-officedocument.spreadsheetml.sheet, application/vnd.openxmlformats-officedocument.wordprocessingml.document, application/x-latex, message/rfc822, application/mhtml+xml, text/csv, text/html, image/bmp, image/gif, image/heic, image/heif, image/jpeg, image/png, image/svg+xml, image/tiff, image/vnd.adobe.photoshop, image/x-icon, image/webp, video/3gpp, video/mp4, video/mpeg, video/ogg, video/quicktime, video/webm, video/x-flv, video/x-m4v, video/x-matroska, video/x-ms-wmv, video/x-msvideo, application/pkcs10, application/x-pkcs12, application/pkcs7-mime, application/x-pkcs7-certificates, application/x-x509-ca-cert, application/x-pem-file, application/pkix-cert, application/x-mdb, application/vnd.sqlite3, application/x-fiddler-session, text/calendar, text/vcard, application/font-woff, application/font-woff2, application/vnd.ms-fontobject, font/otf, font/ttf, application/octet-stream]

  • ]

    • bcc

    object[]

    BCC recipients are optional

  • Array [

    • email stringrequired

    Email is required and must be a valid email format

    name string

    Name is optional

  • ]

    • campaign_id string

    Default value: NIL

    Campaign ID is optional

    cc

    object[]

    CC recipients are optional

  • Array [

    • email stringrequired

    Email is required and must be a valid email format

    name string

    Name is optional

  • ]

    • content

    object[]

    Email content is required when template_id is not provided

  • Array [

    • type stringrequired

    Possible values: [text/html, text/plain]

    MIME type required

    value stringrequired

    Email content is required

  • ]

    • custom_args

    object

    property name* any

    from

    object

    required

    email stringrequired

    Email is required and must be a valid email format

    name string

    Name is optional

    headers

    object

    Headers are optional

    property name* string
    mailer_id stringrequired

    Mailer ID is required // Custom arguments are optional

    priority integer

    Possible values: [1, 0]

    Default value: 0

    process_email_inbulk boolean

    Process email in bulk is optional

    replyTo string

    Reply-to email is optional but must be valid if provided

    settings

    object

    required

    click_tracking

    object

    Click tracking settings

    enable boolean

    Optional boolean value

    ip_pool

    object

    IP pool to use for sending emails

    fallback_to_default_ip_pool boolean

    Whether to fallback to default IP pool on failure

    id string

    IP pool ID

    open_tracking

    object

    Open tracking settings

    enable boolean

    Optional boolean value

    phishing_protection

    object

    Phishing protection settings

    enable boolean

    Optional boolean value

    unsubscribe

    object

    Unsubscribe settings

    enable boolean

    Optional boolean value

    validate

    object

    Email validation settings

    enable boolean

    Optional boolean value

    subject string

    Subject is required when template_id is not provided

    substitutions

    object

    property name*

    object

    property name* string
    template_id string

    Template ID is optional

    to

    object[]

    required

    At least one "to" recipient is required

  • Array [

    • email stringrequired

    Email is required and must be a valid email format

    name string

    Name is optional

  • ]

Responses​

Email sent

Schema

    ref_id string
    success boolean
Loading...