API docs by Redocly

Especial Email API (1.12.14)

Download OpenAPI specification:Download

The Especial Email API exposes multiple APIs including Authentication, Marketing, Contact, Transactional, Analytic, Content, Account and Partner.

Account

Show my account details

Authorizations:
OAuth2PasswordBearer

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Update my account

Authorizations:
OAuth2PasswordBearer
Request Body schema: application/json
object (address)
name
string (name)
object (account_owner)
fax
string (fax)
phone
string (phone)
object (domains)
Default: {}
website
string <uri> (website) [ 1 .. 2083 ] characters

Responses

Request samples

Content type
application/json
{
  • "address": {
    },
  • "name": "string",
  • "account_owner": {
    },
  • "fax": "string",
  • "phone": "string",
  • "domains": { },
  • "website": "http://example.com"
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "warnings": [ ]
}

Action

List actions

Authorizations:
OAuth2PasswordBearer
path Parameters
workflow_id
required
string (workflow_id)
query Parameters
page
integer (page)
Default: 1
per_page
integer (per_page)
Default: 50
with_count
boolean (with_count)
Default: false
account_id
integer (account_id)
sort
string (sort)

Sort term and direction, using syntax [-|+]term.

Valid terms:

  • name
  • created_on

Responses

Response samples

Content type
application/json
{
  • "pagination": {
    },
  • "data": [
    ]
}

Create an action

Authorizations:
OAuth2PasswordBearer
path Parameters
workflow_id
required
string (workflow_id)
query Parameters
account_id
integer (account_id)
lock_key
string (lock_key) ^[a-zA-Z0-9-_]{8,}$

Locking key, preventing other users from modifying this workflow for a short period.

Request Body schema: application/json
name
required
string (name)
parent_id
string (parent_id)
condition
required
string (condition)
Enum: "opened" "not_opened" "clicked" "not_clicked" "none"

An enumeration.

delay
required
integer (delay)
type
required
string (type)
Value: "email"

An enumeration.

object (ActionEmailSettings)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "parent_id": "string",
  • "condition": "opened",
  • "delay": 0,
  • "type": "email",
  • "email_settings": {
    }
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "object": "action",
  • "data": {
    },
  • "created": true
}

Get an action

Authorizations:
OAuth2PasswordBearer
path Parameters
workflow_id
required
string (workflow_id)
action_id
required
string (action_id)
query Parameters
account_id
integer (account_id)
lock_key
string (lock_key) ^[a-zA-Z0-9-_]{8,}$

Locking key, preventing other users from modifying this workflow for a short period.

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Delete an action

Authorizations:
OAuth2PasswordBearer
path Parameters
action_id
required
string (action_id)
workflow_id
required
string (workflow_id)
query Parameters
account_id
integer (account_id)
lock_key
string (lock_key) ^[a-zA-Z0-9-_]{8,}$

Locking key, preventing other users from modifying this workflow for a short period.

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "object": "action",
  • "deleted": true,
  • "data": {
    }
}

Update an action

Authorizations:
OAuth2PasswordBearer
path Parameters
action_id
required
string (action_id)
workflow_id
required
string (workflow_id)
query Parameters
account_id
integer (account_id)
lock_key
string (lock_key) ^[a-zA-Z0-9-_]{8,}$

Locking key, preventing other users from modifying this workflow for a short period.

Request Body schema: application/json
name
string (name)
parent_id
string (parent_id)
condition
string (condition)
Enum: "opened" "not_opened" "clicked" "not_clicked" "none"

An enumeration.

delay
integer (delay)
type
string (type)
Value: "email"

An enumeration.

object (PatchActionEmailSettings)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "parent_id": "string",
  • "condition": "opened",
  • "delay": 0,
  • "type": "email",
  • "email_settings": {
    }
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "object": "action",
  • "patched": true,
  • "data": {
    }
}

Render an action

Authorizations:
OAuth2PasswordBearer
path Parameters
workflow_id
required
string (workflow_id)
action_id
required
string (action_id)
query Parameters
account_id
integer (account_id)
lock_key
string (lock_key) ^[a-zA-Z0-9-_]{8,}$

Locking key, preventing other users from modifying this workflow for a short period.

Responses

Response samples

Content type
application/json
{
  • "detail": [
    ]
}

Send a test of an action

Authorizations:
OAuth2PasswordBearer
path Parameters
workflow_id
required
string (workflow_id)
action_id
required
string (action_id)
query Parameters
account_id
integer (account_id)
lock_key
string (lock_key) ^[a-zA-Z0-9-_]{8,}$

Locking key, preventing other users from modifying this workflow for a short period.

Request Body schema: application/json
email
required
string <email> (email)
type
string (type)
Default: "merged"
Enum: "merged" "separated"

An enumeration.

Responses

Request samples

Content type
application/json
{
  • "email": "user@example.com",
  • "type": "merged"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "object": "action",
  • "sent": true
}

Campaign

Show all campaigns

Authorizations:
OAuth2PasswordBearer
query Parameters
page
integer (page) >= 1
Default: 1
per_page
integer (per_page) >= 1
Default: 50
with_count
boolean (with_count)
Default: false
account_id
integer (account_id)
filter
string (filter)

Valid Terms:

  • status
  • name
  • type
  • list_id

Valid Operators:

  • ==

Query separator:

  • ;
sort
string (sort)

Sort term and direction, using syntax [-|+]term.

Valid terms:

  • name
  • created_on
  • scheduled_for
  • scheduled_on
  • updated_on
  • type

Responses

Response samples

Content type
application/json
{
  • "pagination": {
    },
  • "data": [
    ]
}

Create a campaign

Authorizations:
OAuth2PasswordBearer
query Parameters
account_id
integer (account_id)
Request Body schema: application/json
name
required
string (name) non-empty
object (audience)
Default: {}
object (tracking)
Default: {"opens":true,"clicks_html":true,"clicks_text":true}
object (sender)
reply_to_email
string <email> (reply_to_email)

Specify a different reply-to email address than the sender

object (content)
Default: {"type":"html"}

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "audience": { },
  • "tracking": {
    },
  • "sender": {
    },
  • "reply_to_email": "user@example.com",
  • "content": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "object": "campaign",
  • "created": true,
  • "data": {
    }
}

Show a campaign details

Authorizations:
OAuth2PasswordBearer
path Parameters
campaign_id
required
integer (campaign_id)
query Parameters
account_id
integer (account_id)
revision_id
integer (revision_id)

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Delete a campaign

Authorizations:
OAuth2PasswordBearer
path Parameters
campaign_id
required
integer (campaign_id)
query Parameters
account_id
integer (account_id)

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "object": "campaign",
  • "deleted": true
}

Update a campaign

Authorizations:
OAuth2PasswordBearer
path Parameters
campaign_id
required
integer (campaign_id) >= 1
query Parameters
account_id
integer (account_id)
Request Body schema: application/json
name
string (name) non-empty
object (audience)
Default: {}
object (tracking)
object (sender)
reply_to_email
string <email> (reply_to_email)

Specify a different reply-to email address than the sender

object (content)
Default: {}

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "audience": { },
  • "tracking": {
    },
  • "sender": {
    },
  • "reply_to_email": "user@example.com",
  • "content": { }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "object": "campaign",
  • "updated": true,
  • "data": {
    }
}

Render a campaign

Authorizations:
OAuth2PasswordBearer
path Parameters
campaign_id
required
integer (campaign_id)
query Parameters
contact_id
integer (contact_id) >= 1
account_id
integer (account_id)

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Send a test email

Authorizations:
OAuth2PasswordBearer
path Parameters
campaign_id
required
integer (campaign_id) >= 1
query Parameters
account_id
integer (account_id)
Request Body schema: application/json
email
required
string <email> (email)
type
string (type)
Default: "merged"
Enum: "merged" "separated"

An enumeration.

Responses

Request samples

Content type
application/json
{
  • "email": "user@example.com",
  • "type": "merged"
}

Response samples

Content type
application/json
{
  • "email": "user@example.com",
  • "type": "merged",
  • "object": "test_email",
  • "sent": true
}

Schedule a campaign

Authorizations:
OAuth2PasswordBearer
path Parameters
campaign_id
required
integer (campaign_id) >= 1
query Parameters
account_id
integer (account_id)
Request Body schema: application/json
date
integer (date) [ 1 .. 2147483647 ]

A UNIX timestamp in the future

html_empty
boolean (html_empty)
Default: false

Required to be true if the html message is empty

Responses

Request samples

Content type
application/json
{
  • "date": 1,
  • "html_empty": false
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "object": "campaign",
  • "scheduled": true
}

Unschedule a campaign

Authorizations:
OAuth2PasswordBearer
path Parameters
campaign_id
required
integer (campaign_id) >= 1
query Parameters
account_id
integer (account_id)

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "object": "campaign",
  • "scheduled": true
}

Reschedule a campaign

Authorizations:
OAuth2PasswordBearer
path Parameters
campaign_id
required
integer (campaign_id) >= 1
query Parameters
account_id
integer (account_id)
Request Body schema: application/json
date
integer (date) [ 1 .. 2147483647 ]

A UNIX timestamp in the future

html_empty
boolean (html_empty)
Default: false

Required to be true if the html message is empty

Responses

Request samples

Content type
application/json
{
  • "date": 1,
  • "html_empty": false
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "object": "campaign",
  • "scheduled": true
}

Suspend a campaign

Authorizations:
OAuth2PasswordBearer
path Parameters
campaign_id
required
integer (campaign_id) >= 1
query Parameters
account_id
integer (account_id)

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "object": "campaign",
  • "suspended": true
}

Resume a campaign

Authorizations:
OAuth2PasswordBearer
path Parameters
campaign_id
required
integer (campaign_id) >= 1
query Parameters
account_id
integer (account_id)

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "object": "campaign",
  • "resumed": true
}

Cancel a campaign

Authorizations:
OAuth2PasswordBearer
path Parameters
campaign_id
required
integer (campaign_id) >= 1
query Parameters
account_id
integer (account_id)

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "object": "campaign",
  • "cancelled": true
}

Archive a campaign

You can only delete a campaign when the status is draft. However, if you want to remove a campaign from your list of active campaigns, you can archive it.

Authorizations:
OAuth2PasswordBearer
path Parameters
campaign_id
required
integer (campaign_id) >= 1
query Parameters
account_id
integer (account_id)

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "object": "campaign",
  • "archived": true
}

Unarchive a campaign

Authorizations:
OAuth2PasswordBearer
path Parameters
campaign_id
required
integer (campaign_id) >= 1
query Parameters
account_id
integer (account_id)

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "object": "campaign",
  • "archived": true
}

Show all campaign revisions

Authorizations:
OAuth2PasswordBearer
path Parameters
campaign_id
required
integer (campaign_id)
query Parameters
account_id
integer (account_id)
page
integer (page)
Default: 1
per_page
integer (per_page)
Default: 50
with_count
boolean (with_count)
Default: false

Responses

Response samples

Content type
application/json
{
  • "pagination": {
    },
  • "data": [
    ]
}

Campaign Blueprint

Show all campaign blueprints

query Parameters
page
integer (page)
Default: 1
per_page
integer (per_page)
Default: 50
with_count
boolean (with_count)
Default: false
filter
string (filter)

Valid Terms:

  • tag
  • name
  • is_owner
  • is_not_owner

Valid Operators:

  • ==

Query separator:

  • ;
sort
string (sort)
Default: "id"

Sort term and direction, using syntax [-|+]term.

Valid terms:

  • id
  • created_on
  • updated_on
  • name

Responses

Response samples

Content type
application/json
{
  • "pagination": {
    },
  • "data": [
    ]
}

Get a campaign blueprint

path Parameters
blueprint_id
required
integer (blueprint_id)

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Render campaign blueprint

path Parameters
blueprint_id
required
integer (blueprint_id)

Responses

Response samples

Content type
application/json
{
  • "detail": [
    ]
}

Contact

Add interest(s) to contact(s)

Authorizations:
OAuth2PasswordBearer
path Parameters
list_id
required
integer (list_id) >= 1
query Parameters
account_id
integer (account_id)
Request Body schema: application/json
interests
required
Array of strings (interests) <= 16 items [ items [ 1 .. 255 ] characters ^[+@\-_#a-zA-Z0-9]+$ ]
contact_ids
Array of integers (contact_ids) <= 1024 items >= 1 [ items >= 1 ]
query
string (query)
fiql
string (fiql)
json
object (json)

Responses

Request samples

Content type
application/json
{
  • "interests": [
    ],
  • "contact_ids": [
    ],
  • "query": "string",
  • "fiql": "string",
  • "json": { }
}

Response samples

Content type
application/json
{
  • "object": "interests",
  • "added": true
}

Show contacts of a list

Authorizations:
OAuth2PasswordBearer
path Parameters
list_id
required
integer (list_id) >= 1
query Parameters
account_id
integer (account_id)
page
integer (page) >= 1
per_page
integer (per_page) >= 1
Default: 50
with_count
boolean (with_count)
Default: false
query
string (query)

SQL selection query (only use one of query, fiql and json)

fiql
string (fiql)

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

json
string <json-string> (json)

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

cursor
string (cursor)

Cursor pagination

sort
string (sort)

Sort term and direction, using syntax [-|+]term.

Valid terms:

  • id
  • email
  • status
  • subscribed_on
  • last_bounce_type
  • bounces_count
filter
string (filter)

Valid Terms:

  • status
  • email
  • tags
  • interests

Valid Operators:

  • ==

Query separator:

  • ;

Responses

Response samples

Content type
application/json
{
  • "pagination": {
    },
  • "data": [
    ]
}

Add a contact

Authorizations:
OAuth2PasswordBearer
path Parameters
list_id
required
integer (list_id) >= 1
query Parameters
account_id
integer (account_id)
send_double_opt_in
string (send_double_opt_in)
Default: "false"
Enum: "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
resubscribe
boolean (resubscribe)
Default: true
Request Body schema: application/json
email
required
string <email> (email)
Array of objects (custom_attributes)

Responses

Request samples

Content type
application/json
{
  • "email": "user@example.com",
  • "custom_attributes": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "object": "contact",
  • "created": true,
  • "data": {
    }
}

Show contacts of a segment

Authorizations:
OAuth2PasswordBearer
path Parameters
segment_id
required
integer (segment_id) >= 1
list_id
required
integer (list_id) >= 1
query Parameters
account_id
integer (account_id)
page
integer (page) >= 1
per_page
integer (per_page) >= 1
Default: 50
with_count
boolean (with_count)
Default: false
query
string (query)

SQL selection query (only use one of query, fiql and json)

fiql
string (fiql)

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

json
string <json-string> (json)

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

cursor
string (cursor)

Cursor pagination

sort
string (sort)

Sort term and direction, using syntax [-|+]term.

Valid terms:

  • id
  • email
  • status
  • subscribed_on
  • last_bounce_type
  • bounces_count
filter
string (filter)

Valid Terms:

  • status
  • email
  • tags
  • interests

Valid Operators:

  • ==

Query separator:

  • ;

Responses

Response samples

Content type
application/json
{
  • "pagination": {
    },
  • "data": [
    ]
}

Tags multiple contacts

Authorizations:
OAuth2PasswordBearer
path Parameters
list_id
required
integer (list_id) >= 1
query Parameters
account_id
integer (account_id)
Request Body schema: application/json
tags
required
Array of strings (tags) [ 1 .. 1024 ] items [ items [ 1 .. 64 ] characters ^[A-Za-z0-9.\-+_]+$ ]
contact_ids
Array of integers (contact_ids) [ 1 .. 1024 ] items >= 1 [ items >= 1 ]
query
string (query) non-empty

SQL-like expression

fiql
string (fiql)
json
object (json)

Responses

Request samples

Content type
application/json
{
  • "tags": [
    ],
  • "contact_ids": [
    ],
  • "query": "string",
  • "fiql": "string",
  • "json": { }
}

Response samples

Content type
application/json
{
  • "tagged": true
}

Untags multiple contacts

Authorizations:
OAuth2PasswordBearer
path Parameters
list_id
required
integer (list_id) >= 1
query Parameters
account_id
integer (account_id)
Request Body schema: application/json
tags
required
Array of strings (tags) [ 1 .. 1024 ] items [ items [ 1 .. 64 ] characters ^[A-Za-z0-9.\-+_]+$ ]
contact_ids
Array of integers (contact_ids) [ 1 .. 1024 ] items >= 1 [ items >= 1 ]
query
string (query) non-empty

SQL-like expression

fiql
string (fiql)
json
object (json)

Responses

Request samples

Content type
application/json
{
  • "tags": [
    ],
  • "contact_ids": [
    ],
  • "query": "string",
  • "fiql": "string",
  • "json": { }
}

Response samples

Content type
application/json
{
  • "untagged": true
}

Show a contact details

Authorizations:
OAuth2PasswordBearer
path Parameters
list_id
required
integer (list_id) >= 1
contact_id
required
integer (contact_id) >= 1
query Parameters
account_id
integer (account_id)

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Delete a contact

Authorizations:
OAuth2PasswordBearer
path Parameters
list_id
required
integer (list_id) >= 1
contact_id
required
integer (contact_id) >= 1
query Parameters
account_id
integer (account_id)

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "object": "contact",
  • "deleted": true
}

Update a contact

Authorizations:
OAuth2PasswordBearer
path Parameters
list_id
required
integer (list_id) >= 1
contact_id
required
integer (contact_id) >= 1
query Parameters
account_id
integer (account_id)
Request Body schema: application/json
email
string <email> (email)
Array of objects (custom_attributes)
interests
Array of strings (interests) [ items [ 1 .. 255 ] characters ^[+@\-_#a-zA-Z0-9]+$ ]
tags
Array of strings (tags) [ items [ 1 .. 64 ] characters ^[A-Za-z0-9.\-+_]+$ ]

Responses

Request samples

Content type
application/json
{
  • "email": "user@example.com",
  • "custom_attributes": [
    ],
  • "interests": [
    ],
  • "tags": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "object": "contact",
  • "updated": true,
  • "data": {
    }
}

Import contacts

Synchronize your own list with Especialmail by importing to your active, unsubscribed or delete contacts.

Authorizations:
OAuth2PasswordBearer
path Parameters
list_id
required
integer (list_id) >= 1
query Parameters
account_id
integer (account_id)
send_double_opt_in
string (send_double_opt_in)
Default: "false"
Enum: "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
Request Body schema: application/json
import_to
string (import_to)
Enum: "active" "unsubscribed" "deleted"

An enumeration.

required
Array of objects (contacts) non-empty

Responses

Request samples

Content type
application/json
{
  • "import_to": "active",
  • "contacts": [
    ]
}

Response samples

Content type
application/json
{
  • "import_id": "string",
  • "id": [
    ],
  • "object": "contact",
  • "imported": true,
  • "data": [ ]
}

Unsubscribe a contact from a list

Authorizations:
OAuth2PasswordBearer
path Parameters
list_id
required
integer (list_id) >= 1
contact_id
required
integer (contact_id) >= 1
query Parameters
account_id
integer (account_id)

Responses

Response samples

Content type
application/json
{
  • "object": "contact",
  • "subscribed": false,
  • "data": {
    }
}

Tags a contact Deprecated

Authorizations:
OAuth2PasswordBearer
path Parameters
list_id
required
integer (list_id) >= 1
contact_id
required
integer (contact_id) >= 1
query Parameters
account_id
integer (account_id)
Request Body schema: application/json
tags
required
Array of strings (tags) [ 1 .. 1024 ] items [ items [ 1 .. 64 ] characters ^[A-Za-z0-9.\-+_]+$ ]

Responses

Request samples

Content type
application/json
{
  • "tags": [
    ]
}

Response samples

Content type
application/json
{
  • "tagged": true
}

Untags a contact Deprecated

Authorizations:
OAuth2PasswordBearer
path Parameters
list_id
required
integer (list_id) >= 1
contact_id
required
integer (contact_id) >= 1
query Parameters
account_id
integer (account_id)
Request Body schema: application/json
tags
required
Array of strings (tags) [ 1 .. 1024 ] items [ items [ 1 .. 64 ] characters ^[A-Za-z0-9.\-+_]+$ ]

Responses

Request samples

Content type
application/json
{
  • "tags": [
    ]
}

Response samples

Content type
application/json
{
  • "untagged": true
}

Remove interest(s) from contact(s)

Authorizations:
OAuth2PasswordBearer
path Parameters
list_id
required
integer (list_id) >= 1
query Parameters
account_id
integer (account_id)
Request Body schema: application/json
interests
required
Array of strings (interests) <= 16 items [ items [ 1 .. 255 ] characters ^[+@\-_#a-zA-Z0-9]+$ ]
contact_ids
Array of integers (contact_ids) <= 1024 items >= 1 [ items >= 1 ]
query
string (query)
fiql
string (fiql)
json
object (json)

Responses

Request samples

Content type
application/json
{
  • "interests": [
    ],
  • "contact_ids": [
    ],
  • "query": "string",
  • "fiql": "string",
  • "json": { }
}

Response samples

Content type
application/json
{
  • "object": "interests",
  • "removed": true
}

Show all Contacts Exports

Show all Contacts Exports.

Authorizations:
OAuth2PasswordBearer
path Parameters
list_id
required
integer (list_id) >= 1
query Parameters
account_id
integer (account_id)
page
integer (page) >= 1
Default: 1
per_page
integer (per_page) >= 1
Default: 50
with_count
boolean (with_count)
Default: false
sort
string (sort)

Sort term and direction, using syntax [-|+]term.

Valid terms:

  • status
  • created_on
  • expires_on
filter
string (filter)

Valid Terms:

  • status
  • progress

Valid Operators:

  • ==

Query separator:

  • ;

Responses

Response samples

Content type
application/json
{
  • "pagination": {
    },
  • "data": [
    ]
}

Create a Contacts Export

Create a Contacts Export to a CSV file.

Authorizations:
OAuth2PasswordBearer
path Parameters
list_id
required
integer (list_id) >= 1
query Parameters
account_id
integer (account_id)
description
string (description)
query
string (query)
fiql
string (fiql)
json
string <json-string> (json)
segment_id
integer (segment_id) >= 1
filter
string (filter)

Valid Terms:

  • status
  • email
  • tags
  • interests

Valid Operators:

  • ==

Query separator:

  • ;

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "object": "task",
  • "created": true,
  • "data": {
    }
}

Show a Contacts Export

Show a Contacts Export.

Authorizations:
OAuth2PasswordBearer
path Parameters
export_id
required
string (export_id)
list_id
required
integer (list_id) >= 1
query Parameters
account_id
integer (account_id)

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Delete a Contacts Export

Delete a Contacts Export.

Authorizations:
OAuth2PasswordBearer
path Parameters
export_id
required
string (export_id)
list_id
required
integer (list_id) >= 1
query Parameters
account_id
integer (account_id)

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "object": "contactsexport",
  • "deleted": true,
  • "data": {
    }
}

Download a Contacts Export

Download a Contacts Export.

Authorizations:
OAuth2PasswordBearer
path Parameters
export_id
required
string (export_id)
list_id
required
integer (list_id) >= 1
query Parameters
account_id
integer (account_id)

Responses

Response samples

Content type
application/json
{}

Custom Attribute

Show all custom attributes

Authorizations:
OAuth2PasswordBearer
path Parameters
list_id
required
integer (list_id) >= 1
query Parameters
account_id
integer (account_id)
page
integer (page) >= 1
Default: 1
per_page
integer (per_page) >= 1
Default: 50
with_count
boolean (with_count)
Default: false

Responses

Response samples

Content type
application/json
{
  • "pagination": {
    },
  • "data": [
    ]
}

Create a custom attribute

Authorizations:
OAuth2PasswordBearer
path Parameters
list_id
required
integer (list_id) >= 1
query Parameters
account_id
integer (account_id)
Request Body schema: application/json
name
required
string (name) ^[A-Za-z0-9\-_]+$

name

type
required
string (type)
Enum: "text" "mediumtext" "integer" "timestamp" "datetime"

An enumeration.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "type": "text"
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "object": "attribute",
  • "created": true,
  • "data": {
    }
}

Show a custom attribute

Authorizations:
OAuth2PasswordBearer
path Parameters
list_id
required
integer (list_id) >= 1
name
required
string (name)
query Parameters
account_id
integer (account_id)

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Delete a custom attribute

Authorizations:
OAuth2PasswordBearer
path Parameters
list_id
required
integer (list_id) >= 1
name
required
string (name)
query Parameters
account_id
integer (account_id)

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "object": "attribute",
  • "deleted": true
}

DKIM

List Dkim Keys

Authorizations:
OAuth2PasswordBearer
query Parameters
account_id
integer (account_id)

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Create Dkim Key

Authorizations:
OAuth2PasswordBearer
query Parameters
account_id
integer (account_id)
Request Body schema: application/json
selector
string (selector)
domain
required
string (domain)

Responses

Request samples

Content type
application/json
{
  • "selector": "string",
  • "domain": "string"
}

Response samples

Content type
application/json
{
  • "object": "dkim",
  • "created": true,
  • "data": {
    }
}

Get Dkim Key

Authorizations:
OAuth2PasswordBearer
path Parameters
id
required
integer (id)
query Parameters
account_id
integer (account_id)

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Delete Dkim Key

Authorizations:
OAuth2PasswordBearer
path Parameters
id
required
integer (id)
query Parameters
account_id
integer (account_id)

Responses

Response samples

Content type
application/json
{
  • "object": "dkim",
  • "deleted": true,
  • "data": {
    }
}

Domain

Show domains

Show the Tracking and Bounce domains.

Authorizations:
OAuth2PasswordBearer
query Parameters
account_id
integer (account_id)

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Change domains

Change the Tracking and Bounce domains.

Authorizations:
OAuth2PasswordBearer
query Parameters
account_id
integer (account_id)
Request Body schema: application/json
required
object (domains)

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{
  • "object": "domains",
  • "patched": true,
  • "data": {
    }
}

Validate domains

Validate and return the DNS entries for the Tracking and the Bounce domains.

Authorizations:
OAuth2PasswordBearer
query Parameters
account_id
integer (account_id)

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Transactional Email

Send a transactional email

Authorizations:
OAuth2PasswordBearer
query Parameters
account_id
integer (account_id)
Request Body schema: application/json
email
required
string <email> (email)
group_id
integer (group_id) >= 1

Allows you to group multiple transaction emails together for analytics

object (tracking)
Default: {"opens":true,"clicks_html":true,"clicks_text":true}
required
object (sender)
Array of objects (additional_headers)
object (attachment)
required
object (content)

Responses

Request samples

Content type
application/json
{
  • "email": "user@example.com",
  • "group_id": 1,
  • "tracking": {
    },
  • "sender": {
    },
  • "additional_headers": [
    ],
  • "attachment": {
    },
  • "content": {
    }
}

Response samples

Content type
application/json
{
  • "email": "string",
  • "object": "email",
  • "sent": true,
  • "data": {
    }
}

Form

Show all forms

Authorizations:
OAuth2PasswordBearer
query Parameters
account_id
integer (account_id)
page
integer (page) >= 1
Default: 1
per_page
integer (per_page) >= 1
Default: 50
with_count
boolean (with_count)
Default: false
sort
string (sort) [-|+]?[a-zA-Z_]+

Sort term and direction, using syntax [-|+]term.

Valid terms:

  • name
  • language
  • created_on
  • last_updated_on
  • list_id
  • status

Responses

Response samples

Content type
application/json
{
  • "pagination": {
    },
  • "data": [
    ]
}

Create a form

Authorizations:
OAuth2PasswordBearer
query Parameters
account_id
integer (account_id)
Request Body schema: application/json
name
required
string (name) non-empty
status
string (status)
Default: "active"
Enum: "active" "deleted"

An enumeration.

required
object (content)
object (redirections)
Default: {}
list_id
required
integer (list_id) >= 1
language
required
string (language)
Enum: "da" "da_DK" "de" "de_DE" "el" "el_GR" "en" "en_US" "en_GB" "en_UK" "es" "es_US" "es_ES" "et" "et_EE" "fi" "fi_FI" "fr" "fr_CA" "fr_FR" "he" "he_IL" "id" "id_ID" "it" "it_IT" "ja" "ja_JP" "nl" "nl_NL" "no" "no_NO" "pt" "pt_BR" "ro" "ro_RO" "ru" "ru_RU" "sv" "sv_SE" "th" "th_TH" "tr" "tr_TR" "vi" "vi_VN" "zh" "zh_CN" "aa" "ab" "ae" "af" "ak" "am" "an" "ar" "av" "ay" "az" "ba" "be" "bg" "bh" "bi" "bm" "bn" "bo" "br" "bs" "ca" "ce" "ch" "co" "cr" "cs" "cu" "cv" "cy" "dv" "dz" "ee" "eo" "eu" "fa" "ff" "fj" "fo" "fy" "ga" "gd" "gl" "gn" "gu" "gv" "ha" "hi" "ho" "hr" "ht" "hu" "hy" "hz" "ia" "ie" "ig" "ii" "ik" "io" "is_IS" "iu" "jv" "ka" "kg" "ki" "kj" "kk" "kl" "km" "kn" "ko" "kr" "ks" "ku" "kv" "kw" "ky" "la" "lb" "lg" "li" "ln" "lo" "lt" "lu" "lv" "mg" "mh" "mi" "mk" "ml" "mn" "mr" "ms" "mt" "my" "na" "nb" "nd" "ne" "ng" "nn" "nr" "nv" "ny" "oc" "oj" "om" "os" "pa" "pi" "pl" "ps" "qu" "rm" "rn" "rw" "sa" "sc" "sd" "se" "sg" "si" "sk" "sl" "sm" "sn" "so" "sq" "sr" "ss" "st" "su" "sw" "ta" "te" "tg" "ti" "tk" "tl" "tn" "to" "ts" "tt" "tw" "ty" "ug" "uk" "ur" "uz" "ve" "vo" "wa" "wo" "xh" "yi" "yo" "za" "zu"

Supported Locales

double_opt_in
boolean (double_opt_in)
Default: true

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "status": "active",
  • "content": {
    },
  • "redirections": { },
  • "list_id": 1,
  • "language": "da",
  • "double_opt_in": true
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "object": "form",
  • "created": true,
  • "data": {
    }
}

Show a form details

Authorizations:
OAuth2PasswordBearer
path Parameters
form_id
required
string (form_id)
query Parameters
account_id
integer (account_id)

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Delete a form

Authorizations:
OAuth2PasswordBearer
path Parameters
form_id
required
string (form_id)
query Parameters
account_id
integer (account_id)

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "object": "form",
  • "deleted": true
}

Update a form

Authorizations:
OAuth2PasswordBearer
path Parameters
form_id
required
string (form_id)
query Parameters
account_id
integer (account_id)
Request Body schema: application/json
name
string (name) non-empty
status
string (status) non-empty
object (content)
Default: {}
object (redirections)
Default: {}
list_id
integer (list_id) >= 1
language
string (language)
Enum: "da" "da_DK" "de" "de_DE" "el" "el_GR" "en" "en_US" "en_GB" "en_UK" "es" "es_US" "es_ES" "et" "et_EE" "fi" "fi_FI" "fr" "fr_CA" "fr_FR" "he" "he_IL" "id" "id_ID" "it" "it_IT" "ja" "ja_JP" "nl" "nl_NL" "no" "no_NO" "pt" "pt_BR" "ro" "ro_RO" "ru" "ru_RU" "sv" "sv_SE" "th" "th_TH" "tr" "tr_TR" "vi" "vi_VN" "zh" "zh_CN" "aa" "ab" "ae" "af" "ak" "am" "an" "ar" "av" "ay" "az" "ba" "be" "bg" "bh" "bi" "bm" "bn" "bo" "br" "bs" "ca" "ce" "ch" "co" "cr" "cs" "cu" "cv" "cy" "dv" "dz" "ee" "eo" "eu" "fa" "ff" "fj" "fo" "fy" "ga" "gd" "gl" "gn" "gu" "gv" "ha" "hi" "ho" "hr" "ht" "hu" "hy" "hz" "ia" "ie" "ig" "ii" "ik" "io" "is_IS" "iu" "jv" "ka" "kg" "ki" "kj" "kk" "kl" "km" "kn" "ko" "kr" "ks" "ku" "kv" "kw" "ky" "la" "lb" "lg" "li" "ln" "lo" "lt" "lu" "lv" "mg" "mh" "mi" "mk" "ml" "mn" "mr" "ms" "mt" "my" "na" "nb" "nd" "ne" "ng" "nn" "nr" "nv" "ny" "oc" "oj" "om" "os" "pa" "pi" "pl" "ps" "qu" "rm" "rn" "rw" "sa" "sc" "sd" "se" "sg" "si" "sk" "sl" "sm" "sn" "so" "sq" "sr" "ss" "st" "su" "sw" "ta" "te" "tg" "ti" "tk" "tl" "tn" "to" "ts" "tt" "tw" "ty" "ug" "uk" "ur" "uz" "ve" "vo" "wa" "wo" "xh" "yi" "yo" "za" "zu"

Supported Locales

double_opt_in
boolean (double_opt_in)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "status": "string",
  • "content": { },
  • "redirections": { },
  • "list_id": 1,
  • "language": "da",
  • "double_opt_in": true
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "object": "form",
  • "updated": true,
  • "data": {
    }
}

List

Show all lists

Authorizations:
OAuth2PasswordBearer
query Parameters
account_id
integer (account_id)
page
integer (page) >= 1
Default: 1
per_page
integer (per_page) >= 1
Default: 50
with_count
boolean (with_count)
Default: false
filter
string (filter)

Valid Terms:

  • status
  • name

Valid Operators:

  • ==

Query separator:

  • ;
sort
string (sort)

Sort term and direction, using syntax [-|+]term.

Valid terms:

  • name
  • created_on

Responses

Response samples

Content type
application/json
{
  • "pagination": {
    },
  • "data": [
    ]
}

Create a List

Authorizations:
OAuth2PasswordBearer
query Parameters
account_id
integer (account_id)
Request Body schema: application/json
name
required
string (name) non-empty

List Name

required
object (default_sender)
language
string (language)
Default: "en_US"
Enum: "da" "da_DK" "de" "de_DE" "el" "el_GR" "en" "en_US" "en_GB" "en_UK" "es" "es_US" "es_ES" "et" "et_EE" "fi" "fi_FI" "fr" "fr_CA" "fr_FR" "he" "he_IL" "id" "id_ID" "it" "it_IT" "ja" "ja_JP" "nl" "nl_NL" "no" "no_NO" "pt" "pt_BR" "ro" "ro_RO" "ru" "ru_RU" "sv" "sv_SE" "th" "th_TH" "tr" "tr_TR" "vi" "vi_VN" "zh" "zh_CN" "aa" "ab" "ae" "af" "ak" "am" "an" "ar" "av" "ay" "az" "ba" "be" "bg" "bh" "bi" "bm" "bn" "bo" "br" "bs" "ca" "ce" "ch" "co" "cr" "cs" "cu" "cv" "cy" "dv" "dz" "ee" "eo" "eu" "fa" "ff" "fj" "fo" "fy" "ga" "gd" "gl" "gn" "gu" "gv" "ha" "hi" "ho" "hr" "ht" "hu" "hy" "hz" "ia" "ie" "ig" "ii" "ik" "io" "is_IS" "iu" "jv" "ka" "kg" "ki" "kj" "kk" "kl" "km" "kn" "ko" "kr" "ks" "ku" "kv" "kw" "ky" "la" "lb" "lg" "li" "ln" "lo" "lt" "lu" "lv" "mg" "mh" "mi" "mk" "ml" "mn" "mr" "ms" "mt" "my" "na" "nb" "nd" "ne" "ng" "nn" "nr" "nv" "ny" "oc" "oj" "om" "os" "pa" "pi" "pl" "ps" "qu" "rm" "rn" "rw" "sa" "sc" "sd" "se" "sg" "si" "sk" "sl" "sm" "sn" "so" "sq" "sr" "ss" "st" "su" "sw" "ta" "te" "tg" "ti" "tk" "tl" "tn" "to" "ts" "tt" "tw" "ty" "ug" "uk" "ur" "uz" "ve" "vo" "wa" "wo" "xh" "yi" "yo" "za" "zu"

Supported Locales

object (redirections)
Default: {}
object (webhook)
Default: {}

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "default_sender": {
    },
  • "language": "en_US",
  • "redirections": { },
  • "webhook": { }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "created": true,
  • "data": {
    }
}

Show a list parameters

Authorizations:
OAuth2PasswordBearer
path Parameters
list_id
required
integer (list_id) >= 1
query Parameters
account_id
integer (account_id)

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Delete a List

Authorizations:
OAuth2PasswordBearer
path Parameters
list_id
required
integer (list_id) >= 1
query Parameters
account_id
integer (account_id)

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "object": "list",
  • "deleted": true
}

Update a list parameters

Authorizations:
OAuth2PasswordBearer
path Parameters
list_id
required
integer (list_id) >= 1
query Parameters
account_id
integer (account_id)
Request Body schema: application/json
name
string (name) non-empty
object (default_sender)
language
string (language)
Enum: "da" "da_DK" "de" "de_DE" "el" "el_GR" "en" "en_US" "en_GB" "en_UK" "es" "es_US" "es_ES" "et" "et_EE" "fi" "fi_FI" "fr" "fr_CA" "fr_FR" "he" "he_IL" "id" "id_ID" "it" "it_IT" "ja" "ja_JP" "nl" "nl_NL" "no" "no_NO" "pt" "pt_BR" "ro" "ro_RO" "ru" "ru_RU" "sv" "sv_SE" "th" "th_TH" "tr" "tr_TR" "vi" "vi_VN" "zh" "zh_CN" "aa" "ab" "ae" "af" "ak" "am" "an" "ar" "av" "ay" "az" "ba" "be" "bg" "bh" "bi" "bm" "bn" "bo" "br" "bs" "ca" "ce" "ch" "co" "cr" "cs" "cu" "cv" "cy" "dv" "dz" "ee" "eo" "eu" "fa" "ff" "fj" "fo" "fy" "ga" "gd" "gl" "gn" "gu" "gv" "ha" "hi" "ho" "hr" "ht" "hu" "hy" "hz" "ia" "ie" "ig" "ii" "ik" "io" "is_IS" "iu" "jv" "ka" "kg" "ki" "kj" "kk" "kl" "km" "kn" "ko" "kr" "ks" "ku" "kv" "kw" "ky" "la" "lb" "lg" "li" "ln" "lo" "lt" "lu" "lv" "mg" "mh" "mi" "mk" "ml" "mn" "mr" "ms" "mt" "my" "na" "nb" "nd" "ne" "ng" "nn" "nr" "nv" "ny" "oc" "oj" "om" "os" "pa" "pi" "pl" "ps" "qu" "rm" "rn" "rw" "sa" "sc" "sd" "se" "sg" "si" "sk" "sl" "sm" "sn" "so" "sq" "sr" "ss" "st" "su" "sw" "ta" "te" "tg" "ti" "tk" "tl" "tn" "to" "ts" "tt" "tw" "ty" "ug" "uk" "ur" "uz" "ve" "vo" "wa" "wo" "xh" "yi" "yo" "za" "zu"

Supported Locales

object (redirections)
Default: {}
object (webhook)
Default: {}

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "default_sender": {
    },
  • "language": "da",
  • "redirections": { },
  • "webhook": { }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "updated": true,
  • "data": {
    }
}

Accept policy for a list

Authorizations:
OAuth2PasswordBearer
path Parameters
list_id
required
integer (list_id) >= 1
query Parameters
account_id
integer (account_id)

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "object": "list",
  • "policy_accepted": true
}

Archive a list

Authorizations:
OAuth2PasswordBearer
path Parameters
list_id
required
integer (list_id) >= 1
query Parameters
account_id
integer (account_id)

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "object": "list",
  • "archived": true
}

Unarchive a list

Authorizations:
OAuth2PasswordBearer
path Parameters
list_id
required
integer (list_id) >= 1
query Parameters
account_id
integer (account_id)

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "object": "list",
  • "archived": false
}

Log

Show list logs

Authorizations:
OAuth2PasswordBearer
path Parameters
list_id
required
integer (list_id) >= 1
query Parameters
account_id
integer (account_id)
start_time
integer (start_time) [ 1 .. 2147483647 ]
end_time
integer (end_time) [ 1 .. 2147483647 ]
page
integer (page) >= 1
Default: 1
per_page
integer (per_page) >= 1
Default: 50
with_count
boolean (with_count)
Default: false
filter
string (filter)

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:

  • ;

Responses

Response samples

Content type
application/json
{
  • "pagination": {
    },
  • "data": [
    ]
}

Show campaign logs

Authorizations:
OAuth2PasswordBearer
path Parameters
campaign_id
required
integer (campaign_id) >= 1
query Parameters
account_id
integer (account_id)
start_time
integer (start_time) [ 1 .. 2147483647 ]
end_time
integer (end_time) [ 1 .. 2147483647 ]
page
integer (page) >= 1
Default: 1
per_page
integer (per_page) >= 1
Default: 50
with_count
boolean (with_count)
Default: false
cursor
string (cursor)
filter
string (filter)

Valid Terms:

  • additional_info
  • link_id
  • contact_id
  • email
  • uniques
  • group_by_contact
  • log_id
  • totals
  • type

Valid Operators:

  • ==

Query separator:

  • ;
sort
string (sort) [-|+]?.*

Sort term and direction, using syntax [-|+]term.

Valid terms:

  • time
  • log_id

Responses

Response samples

Content type
application/json
{
  • "pagination": {
    },
  • "data": [
    ]
}

Show transactional email logs

Authorizations:
OAuth2PasswordBearer
query Parameters
log_type
required
string (log_type)
Enum: "bounce" "clickthru" "sent" "open" "unsubscribe" "resubscribe"

An enumeration.

account_id
integer (account_id)
start_time
integer (start_time) [ 1 .. 2147483647 ]
end_time
integer (end_time) [ 1 .. 2147483647 ]
page
integer (page) >= 1
Default: 1
per_page
integer (per_page) >= 1
Default: 50
with_count
boolean (with_count)
Default: false
filter
string (filter)

Valid Terms:

  • group_id
  • email
  • email_id

Valid Operators:

  • ==

Query separator:

  • ;

Responses

Response samples

Content type
application/json
{
  • "pagination": {
    },
  • "data": [
    ]
}

Show action logs

Authorizations:
OAuth2PasswordBearer
path Parameters
workflow_id
required
string (workflow_id)
action_id
required
string (action_id)
query Parameters
account_id
integer (account_id)
start_time
integer (start_time) [ 1 .. 2147483647 ]
end_time
integer (end_time) [ 1 .. 2147483647 ]
page
integer (page) >= 1
Default: 1
per_page
integer (per_page) >= 1
Default: 50
with_count
boolean (with_count)
Default: false
filter
string (filter)

Valid Terms:

  • additional_info
  • link_id
  • contact_id
  • email
  • log_id
  • track_id
  • type
  • group_by_contact

Valid Operators:

  • ==

Query separator:

  • ;
sort
string (sort) [-|+]?.*

Sort term and direction, using syntax [-|+]term.

Valid terms:

  • time
  • log_id

Responses

Response samples

Content type
application/json
{
  • "pagination": {
    },
  • "data": [
    ]
}

Show all campaign log exports

Show all campaign log exports

Authorizations:
OAuth2PasswordBearer
path Parameters
campaign_id
required
integer (campaign_id)
query Parameters
account_id
integer (account_id) >= 1
page
integer (page) >= 1
Default: 1
per_page
integer (per_page) >= 1
Default: 50
with_count
boolean (with_count)
Default: false

Responses

Response samples

Content type
application/json
{
  • "pagination": {
    },
  • "data": [
    ]
}

Create a campaign log export

Export to CSV a campaign log.

Authorizations:
OAuth2PasswordBearer
path Parameters
campaign_id
required
integer (campaign_id)
query Parameters
account_id
integer (account_id)
description
string (description)

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "object": "task",
  • "created": true,
  • "data": {
    }
}

Download a campaign log export

Returns the URL to download the exported CSV file.

Authorizations:
OAuth2PasswordBearer
path Parameters
campaign_log_export_id
required
string (campaign_log_export_id)
campaign_id
required
integer (campaign_id)
query Parameters
account_id
integer (account_id)

Responses

Response samples

Content type
application/json
{}

Segment

Show all segments

Authorizations:
OAuth2PasswordBearer
path Parameters
list_id
required
integer (list_id) >= 1
query Parameters
account_id
integer (account_id)
page
integer (page) >= 1
Default: 1
per_page
integer (per_page) >= 1
Default: 50
with_count
boolean (with_count)
Default: false
sort
string (sort)

Sort term and direction, using syntax [-|+]term.

Valid terms:

  • id
  • name
  • created_on

Responses

Response samples

Content type
application/json
{
  • "pagination": {
    },
  • "data": [
    ]
}

Create a segment

Authorizations:
OAuth2PasswordBearer
path Parameters
list_id
required
integer (list_id) >= 1
query Parameters
account_id
integer (account_id)
Request Body schema: application/json
query
string (query) non-empty

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

fiql
string (fiql) non-empty

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

json
object (json)

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

name
required
string (name) non-empty

Responses

Request samples

Content type
application/json
{
  • "query": "string",
  • "fiql": "string",
  • "json": { },
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "object": "segment",
  • "created": true,
  • "data": {
    }
}

Show a segment details

Authorizations:
OAuth2PasswordBearer
path Parameters
list_id
required
integer (list_id) >= 1
segment_id
required
integer (segment_id) >= 1
query Parameters
account_id
integer (account_id)

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Delete a segment

Authorizations:
OAuth2PasswordBearer
path Parameters
list_id
required
integer (list_id) >= 1
segment_id
required
integer (segment_id) >= 1
query Parameters
account_id
integer (account_id)

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "object": "segment",
  • "deleted": true
}

Update a segment

Authorizations:
OAuth2PasswordBearer
path Parameters
list_id
required
integer (list_id) >= 1
segment_id
required
integer (segment_id) >= 1
query Parameters
account_id
integer (account_id)
Request Body schema: application/json
query
string (query) non-empty

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

fiql
string (fiql) non-empty

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

json
object (json)

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

name
string (name)

Segment Name

Responses

Request samples

Content type
application/json
{
  • "query": "string",
  • "fiql": "string",
  • "json": { },
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "object": "segment",
  • "updated": true,
  • "data": {
    }
}

Sender

Show all senders

Authorizations:
OAuth2PasswordBearer
query Parameters
page
integer (page) >= 1
Default: 1
per_page
integer (per_page) >= 1
Default: 50
account_id
integer (account_id)
with_count
boolean (with_count)
Default: false
sort
string (sort)

Sort term and direction, using syntax [-|+]term.

Valid terms:

  • name
  • email
  • confirmed

Responses

Response samples

Content type
application/json
{
  • "pagination": {
    },
  • "data": [
    ]
}

Add a sender

Authorizations:
OAuth2PasswordBearer
query Parameters
account_id
integer (account_id)
Request Body schema: application/json
name
required
string (name) non-empty
email
required
string <email> (email)
language
string (language)
Default: "en_US"
Enum: "da" "da_DK" "de" "de_DE" "el" "el_GR" "en" "en_US" "en_GB" "en_UK" "es" "es_US" "es_ES" "et" "et_EE" "fi" "fi_FI" "fr" "fr_CA" "fr_FR" "he" "he_IL" "id" "id_ID" "it" "it_IT" "ja" "ja_JP" "nl" "nl_NL" "no" "no_NO" "pt" "pt_BR" "ro" "ro_RO" "ru" "ru_RU" "sv" "sv_SE" "th" "th_TH" "tr" "tr_TR" "vi" "vi_VN" "zh" "zh_CN" "aa" "ab" "ae" "af" "ak" "am" "an" "ar" "av" "ay" "az" "ba" "be" "bg" "bh" "bi" "bm" "bn" "bo" "br" "bs" "ca" "ce" "ch" "co" "cr" "cs" "cu" "cv" "cy" "dv" "dz" "ee" "eo" "eu" "fa" "ff" "fj" "fo" "fy" "ga" "gd" "gl" "gn" "gu" "gv" "ha" "hi" "ho" "hr" "ht" "hu" "hy" "hz" "ia" "ie" "ig" "ii" "ik" "io" "is_IS" "iu" "jv" "ka" "kg" "ki" "kj" "kk" "kl" "km" "kn" "ko" "kr" "ks" "ku" "kv" "kw" "ky" "la" "lb" "lg" "li" "ln" "lo" "lt" "lu" "lv" "mg" "mh" "mi" "mk" "ml" "mn" "mr" "ms" "mt" "my" "na" "nb" "nd" "ne" "ng" "nn" "nr" "nv" "ny" "oc" "oj" "om" "os" "pa" "pi" "pl" "ps" "qu" "rm" "rn" "rw" "sa" "sc" "sd" "se" "sg" "si" "sk" "sl" "sm" "sn" "so" "sq" "sr" "ss" "st" "su" "sw" "ta" "te" "tg" "ti" "tk" "tl" "tn" "to" "ts" "tt" "tw" "ty" "ug" "uk" "ur" "uz" "ve" "vo" "wa" "wo" "xh" "yi" "yo" "za" "zu"

Supported Locales

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "email": "user@example.com",
  • "language": "en_US"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "created": true,
  • "object": "sender",
  • "data": {
    }
}

Show a sender details

Authorizations:
OAuth2PasswordBearer
path Parameters
sender_id
required
string (sender_id)
query Parameters
account_id
integer (account_id)

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Delete a sender

Authorizations:
OAuth2PasswordBearer
path Parameters
sender_id
required
string (sender_id)
query Parameters
account_id
integer (account_id)

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "deleted": true,
  • "object": "sender"
}

Update a sender

Authorizations:
OAuth2PasswordBearer
path Parameters
sender_id
required
string (sender_id)
query Parameters
account_id
integer (account_id)
Request Body schema: application/json
name
string (name)
language
string (language)
Enum: "da" "da_DK" "de" "de_DE" "el" "el_GR" "en" "en_US" "en_GB" "en_UK" "es" "es_US" "es_ES" "et" "et_EE" "fi" "fi_FI" "fr" "fr_CA" "fr_FR" "he" "he_IL" "id" "id_ID" "it" "it_IT" "ja" "ja_JP" "nl" "nl_NL" "no" "no_NO" "pt" "pt_BR" "ro" "ro_RO" "ru" "ru_RU" "sv" "sv_SE" "th" "th_TH" "tr" "tr_TR" "vi" "vi_VN" "zh" "zh_CN" "aa" "ab" "ae" "af" "ak" "am" "an" "ar" "av" "ay" "az" "ba" "be" "bg" "bh" "bi" "bm" "bn" "bo" "br" "bs" "ca" "ce" "ch" "co" "cr" "cs" "cu" "cv" "cy" "dv" "dz" "ee" "eo" "eu" "fa" "ff" "fj" "fo" "fy" "ga" "gd" "gl" "gn" "gu" "gv" "ha" "hi" "ho" "hr" "ht" "hu" "hy" "hz" "ia" "ie" "ig" "ii" "ik" "io" "is_IS" "iu" "jv" "ka" "kg" "ki" "kj" "kk" "kl" "km" "kn" "ko" "kr" "ks" "ku" "kv" "kw" "ky" "la" "lb" "lg" "li" "ln" "lo" "lt" "lu" "lv" "mg" "mh" "mi" "mk" "ml" "mn" "mr" "ms" "mt" "my" "na" "nb" "nd" "ne" "ng" "nn" "nr" "nv" "ny" "oc" "oj" "om" "os" "pa" "pi" "pl" "ps" "qu" "rm" "rn" "rw" "sa" "sc" "sd" "se" "sg" "si" "sk" "sl" "sm" "sn" "so" "sq" "sr" "ss" "st" "su" "sw" "ta" "te" "tg" "ti" "tk" "tl" "tn" "to" "ts" "tt" "tw" "ty" "ug" "uk" "ur" "uz" "ve" "vo" "wa" "wo" "xh" "yi" "yo" "za" "zu"

Supported Locales

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "language": "da"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "updated": true,
  • "object": "sender",
  • "data": {
    }
}

Confirm a sender

Request Body schema: application/json
confirmation_id
required
string (confirmation_id) non-empty

Responses

Request samples

Content type
application/json
{
  • "confirmation_id": "string"
}

Response samples

Content type
application/json
{
  • "confirmed": true,
  • "object": "sender",
  • "data": {
    }
}

Resend confirmation email

Authorizations:
OAuth2PasswordBearer
path Parameters
sender_id
required
string (sender_id)
query Parameters
account_id
integer (account_id)

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "resent": true,
  • "object": "sender"
}

Interest

Show all Interests

Authorizations:
OAuth2PasswordBearer
path Parameters
list_id
required
integer (list_id)
query Parameters
account_id
integer (account_id)
with_count
boolean (with_count)
Default: false
page
integer (page)
Default: 1
per_page
integer (per_page)
Default: 50

Responses

Response samples

Content type
application/json
{
  • "pagination": {
    },
  • "data": [
    ]
}

Create an Interest

Authorizations:
OAuth2PasswordBearer
path Parameters
list_id
required
integer (list_id)
query Parameters
account_id
integer (account_id)
Request Body schema: application/json
name
required
string (name) [ 1 .. 255 ] characters ^[+@\-_#a-zA-Z0-9]+$
alias
string (alias)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "alias": "string"
}

Response samples

Content type
application/json
{
  • "object": "interest",
  • "data": {
    },
  • "created": true
}

Get an Interest

Authorizations:
OAuth2PasswordBearer
path Parameters
list_id
required
integer (list_id)
interest_name
required
string (interest_name) [ 1 .. 255 ] characters ^[+@\-_#a-zA-Z0-9]+$
query Parameters
account_id
integer (account_id)

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Delete an Interest

Authorizations:
OAuth2PasswordBearer
path Parameters
list_id
required
integer (list_id)
interest_name
required
string (interest_name) [ 1 .. 255 ] characters ^[+@\-_#a-zA-Z0-9]+$
query Parameters
account_id
integer (account_id)

Responses

Response samples

Content type
application/json
{
  • "object": "interest",
  • "data": {
    },
  • "deleted": true
}

Update an Interest

Authorizations:
OAuth2PasswordBearer
path Parameters
list_id
required
integer (list_id)
interest_name
required
string (interest_name) [ 1 .. 255 ] characters ^[+@\-_#a-zA-Z0-9]+$
query Parameters
account_id
integer (account_id)
Request Body schema: application/json
name
string (name)
alias
string (alias)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "alias": "string"
}

Response samples

Content type
application/json
{
  • "object": "interest",
  • "data": {
    },
  • "patched": true
}

Task

Show all asynchronous Tasks

Show all asynchronous Task.

Authorizations:
OAuth2PasswordBearer
query Parameters
account_id
integer (account_id)
page
integer (page) >= 1
Default: 1
per_page
integer (per_page) >= 1
Default: 50
with_count
boolean (with_count)
Default: false
sort
string (sort)

Sort term and direction, using syntax [-|+]term.

Valid terms:

  • status
  • created_on
  • expires_on
filter
string (filter)

Valid Terms:

  • type
  • status
  • list_id
  • progress

Valid Operators:

  • ==

Query separator:

  • ;

Responses

Response samples

Content type
application/json
{
  • "pagination": {
    },
  • "data": [
    ]
}

Show an asynchronous Task

Show an asynchronous Task.

Authorizations:
OAuth2PasswordBearer
path Parameters
task_id
required
string (task_id)
query Parameters
account_id
integer (account_id)

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Delete an asynchronous Task

Delete an asynchronous Task.

Authorizations:
OAuth2PasswordBearer
path Parameters
task_id
required
string (task_id)
query Parameters
account_id
integer (account_id)

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Template

Show all templates

Authorizations:
OAuth2PasswordBearer
query Parameters
page
integer (page) >= 1
Default: 1
per_page
integer (per_page) >= 1
Default: 50
account_id
integer (account_id)
with_count
boolean (with_count)
Default: false
filter
string (filter)

Valid Terms:

  • tag
  • name
  • is_owner
  • is_not_owner

Valid Operators:

  • ==

Query separator:

  • ;
sort
string (sort)
Default: "id"

Sort term and direction, using syntax [-|+]term.

Valid terms:

  • id
  • created_on
  • updated_on
  • name

Responses

Response samples

Content type
application/json
{
  • "pagination": {
    },
  • "data": [
    ]
}

Create a template

Authorizations:
OAuth2PasswordBearer
query Parameters
account_id
integer (account_id)
Request Body schema: application/json
name
required
string (name) non-empty
required
object (content)
tags
Array of strings (tags)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "content": {
    },
  • "tags": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "object": "template",
  • "created": true
}

Get a template

Authorizations:
OAuth2PasswordBearer
path Parameters
template_id
required
integer (template_id)
query Parameters
account_id
integer (account_id)

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Delete a template

Authorizations:
OAuth2PasswordBearer
path Parameters
template_id
required
integer (template_id)
query Parameters
account_id
integer (account_id)

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "object": "template",
  • "deleted": true
}

Update a template

Authorizations:
OAuth2PasswordBearer
path Parameters
template_id
required
integer (template_id)
query Parameters
account_id
integer (account_id)
Request Body schema: application/json
name
string (name) non-empty
object (content)
tags
Array of strings (tags)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "content": {
    },
  • "tags": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "object": "template",
  • "updated": true,
  • "data": {
    }
}

Render a template

Authorizations:
OAuth2PasswordBearer
path Parameters
template_id
required
integer (template_id)
query Parameters
account_id
integer (account_id)

Responses

Response samples

Content type
application/json
{
  • "detail": [
    ]
}

Report

Show list report

Authorizations:
OAuth2PasswordBearer
path Parameters
list_id
required
integer (list_id) >= 1
query Parameters
account_id
integer (account_id)

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Show campaign report

Authorizations:
OAuth2PasswordBearer
path Parameters
campaign_id
required
integer (campaign_id) >= 1
query Parameters
account_id
integer (account_id)

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Show campaign links report

Authorizations:
OAuth2PasswordBearer
path Parameters
campaign_id
required
integer (campaign_id) >= 1
query Parameters
account_id
integer (account_id)
start_time
integer (start_time)
end_time
integer (end_time)
page
integer (page) >= 1
Default: 1
per_page
integer (per_page) >= 1
Default: 50
with_count
boolean (with_count)
Default: false
sort
string (sort)

Sort term and direction, using syntax [-|+]term.

Valid terms:

  • unique
  • total
  • link

Responses

Response samples

Content type
application/json
{
  • "pagination": {
    },
  • "data": [
    ]
}

Show transactional email report

Authorizations:
OAuth2PasswordBearer
query Parameters
start_time
required
integer (start_time) [ 1 .. 2147483647 ]
end_time
required
integer (end_time) [ 1 .. 2147483647 ]
account_id
integer (account_id)

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Show my account report

Authorizations:
OAuth2PasswordBearer
query Parameters
start_time
integer (start_time) [ 1 .. 2147483647 ]
end_time
integer (end_time) [ 1 .. 2147483647 ]

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Show account report

Authorizations:
OAuth2PasswordBearer
path Parameters
account_id
required
integer (account_id) >= 1
query Parameters
start_time
integer (start_time) [ 1 .. 2147483647 ]
end_time
integer (end_time) [ 1 .. 2147483647 ]

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Show action report

Authorizations:
OAuth2PasswordBearer
path Parameters
workflow_id
required
string (workflow_id)
action_id
required
string (action_id)
query Parameters
account_id
integer (account_id)

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Suppressed Email

Show all suppressed emails

Authorizations:
OAuth2PasswordBearer
query Parameters
account_id
integer (account_id)
page
integer (page)
Default: 1
per_page
integer (per_page)
Default: 50
with_count
boolean (with_count)
Default: false
filter
string (filter)

Valid Terms:

  • email

Valid Operators:

  • ==

Query separator:

  • ;

Responses

Response samples

Content type
application/json
{
  • "pagination": {
    },
  • "data": [
    ]
}

Add a suppressed email

Authorizations:
OAuth2PasswordBearer
query Parameters
account_id
integer (account_id)
Request Body schema: application/json
email
required
string (email) non-empty

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

Responses

Request samples

Content type
application/json
{
  • "email": "string"
}

Response samples

Content type
application/json
{
  • "email": "string",
  • "created": true
}

Delete a suppressed email

Authorizations:
OAuth2PasswordBearer
path Parameters
email
required
string (email) (^\*@[^@*]+\.[^@*]+$|^[^@*]+@\*$|^[^@*]+@[^@*...

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

query Parameters
account_id
integer (account_id)

Responses

Response samples

Content type
application/json
{
  • "email": "string",
  • "deleted": true
}

Token

Refresh a token

query Parameters
version
string (version)
Default: "v1"
Request Body schema: application/x-www-form-urlencoded
grant_type
string (grant_type)
Default: "refresh_token"
Value: "refresh_token"

An enumeration.

refresh_token
required
string (refresh_token)

Responses

Response samples

Content type
application/json
{
  • "access_token": "string",
  • "token_type": "string",
  • "expires_in": 0,
  • "refresh_token": "string"
}

Create a token

Authorizations:
OAuth2PasswordBearer
query Parameters
version
string (version)
Default: "v1"
Request Body schema: application/x-www-form-urlencoded
grant_type
string (grant_type)
Default: "password"
Value: "password"

An enumeration.

username
required
string <email> (username)
password
string (password)
account_id
integer (account_id)
scopes
string (scopes)
Default: "user"
expiration_seconds
integer (expiration_seconds) >= 600

Responses

Response samples

Content type
application/json
{
  • "access_token": "string",
  • "token_type": "string",
  • "expires_in": 0,
  • "refresh_token": "string"
}

User

Show my user details

Authorizations:
OAuth2PasswordBearer

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Forgot my password

Sends an email containing a reset password token.

query Parameters
account_id
integer (account_id)
language
string (language)
Default: "en_US"
Enum: "da" "da_DK" "de" "de_DE" "el" "el_GR" "en" "en_US" "en_GB" "en_UK" "es" "es_US" "es_ES" "et" "et_EE" "fi" "fi_FI" "fr" "fr_CA" "fr_FR" "he" "he_IL" "id" "id_ID" "it" "it_IT" "ja" "ja_JP" "nl" "nl_NL" "no" "no_NO" "pt" "pt_BR" "ro" "ro_RO" "ru" "ru_RU" "sv" "sv_SE" "th" "th_TH" "tr" "tr_TR" "vi" "vi_VN" "zh" "zh_CN" "aa" "ab" "ae" "af" "ak" "am" "an" "ar" "av" "ay" "az" "ba" "be" "bg" "bh" "bi" "bm" "bn" "bo" "br" "bs" "ca" "ce" "ch" "co" "cr" "cs" "cu" "cv" "cy" "dv" "dz" "ee" "eo" "eu" "fa" "ff" "fj" "fo" "fy" "ga" "gd" "gl" "gn" "gu" "gv" "ha" "hi" "ho" "hr" "ht" "hu" "hy" "hz" "ia" "ie" "ig" "ii" "ik" "io" "is_IS" "iu" "jv" "ka" "kg" "ki" "kj" "kk" "kl" "km" "kn" "ko" "kr" "ks" "ku" "kv" "kw" "ky" "la" "lb" "lg" "li" "ln" "lo" "lt" "lu" "lv" "mg" "mh" "mi" "mk" "ml" "mn" "mr" "ms" "mt" "my" "na" "nb" "nd" "ne" "ng" "nn" "nr" "nv" "ny" "oc" "oj" "om" "os" "pa" "pi" "pl" "ps" "qu" "rm" "rn" "rw" "sa" "sc" "sd" "se" "sg" "si" "sk" "sl" "sm" "sn" "so" "sq" "sr" "ss" "st" "su" "sw" "ta" "te" "tg" "ti" "tk" "tl" "tn" "to" "ts" "tt" "tw" "ty" "ug" "uk" "ur" "uz" "ve" "vo" "wa" "wo" "xh" "yi" "yo" "za" "zu"

Supported Locales

Request Body schema: application/json
email
required
string <email> (email)

Responses

Request samples

Content type
application/json
{
  • "email": "user@example.com"
}

Response samples

Content type
application/json
{
  • "email": "string",
  • "object": "user",
  • "reset_link_sent": true
}

Reset my password

Sends an email containing a reset password token.

Authorizations:
OAuth2PasswordBearer

Responses

Response samples

Content type
application/json
{
  • "email": "string",
  • "object": "user",
  • "reset_link_sent": true
}

Reset a user password

Sends an email containing a reset password token.

Authorizations:
OAuth2PasswordBearer
path Parameters
user_id
required
integer (user_id)
query Parameters
account_id
integer (account_id)
Request Body schema: application/json
invalidate_current_password
boolean (invalidate_current_password)
Default: false

Responses

Request samples

Content type
application/json
{
  • "invalidate_current_password": false
}

Response samples

Content type
application/json
{
  • "email": "string",
  • "object": "user",
  • "reset_link_sent": true
}

Reset password confirmation

Change a user password if the reset password token is valid for that user.

Request Body schema: application/json
token
required
string (token)
password
required
string (password)

Responses

Request samples

Content type
application/json
{
  • "token": "string",
  • "password": "string"
}

Response samples

Content type
application/json
{
  • "object": "user",
  • "password_reset": true
}

Show all users in my account

Authorizations:
OAuth2PasswordBearer
query Parameters
account_id
integer (account_id)
page
integer (page) >= 1
Default: 1
per_page
integer (per_page) >= 1
Default: 50
with_count
boolean (with_count)
Default: false
filter
string (filter)

Valid Terms:

  • email
  • status

Valid Operators:

  • ==

Query separator:

  • ;

Responses

Response samples

Content type
application/json
{
  • "pagination": {
    },
  • "data": [
    ]
}

Create a user

Authorizations:
OAuth2PasswordBearerOAuth2PasswordBearer
query Parameters
account_id
integer (account_id)
skip_verification
boolean (skip_verification)
Default: false
Request Body schema: application/json
first_name
required
string (first_name)
last_name
required
string (last_name)
title
string (title)
office_phone
string (office_phone)
mobile_phone
string (mobile_phone) [0-9]+
language
string (language)
Enum: "da" "da_DK" "de" "de_DE" "el" "el_GR" "en" "en_US" "en_GB" "en_UK" "es" "es_US" "es_ES" "et" "et_EE" "fi" "fi_FI" "fr" "fr_CA" "fr_FR" "he" "he_IL" "id" "id_ID" "it" "it_IT" "ja" "ja_JP" "nl" "nl_NL" "no" "no_NO" "pt" "pt_BR" "ro" "ro_RO" "ru" "ru_RU" "sv" "sv_SE" "th" "th_TH" "tr" "tr_TR" "vi" "vi_VN" "zh" "zh_CN" "aa" "ab" "ae" "af" "ak" "am" "an" "ar" "av" "ay" "az" "ba" "be" "bg" "bh" "bi" "bm" "bn" "bo" "br" "bs" "ca" "ce" "ch" "co" "cr" "cs" "cu" "cv" "cy" "dv" "dz" "ee" "eo" "eu" "fa" "ff" "fj" "fo" "fy" "ga" "gd" "gl" "gn" "gu" "gv" "ha" "hi" "ho" "hr" "ht" "hu" "hy" "hz" "ia" "ie" "ig" "ii" "ik" "io" "is_IS" "iu" "jv" "ka" "kg" "ki" "kj" "kk" "kl" "km" "kn" "ko" "kr" "ks" "ku" "kv" "kw" "ky" "la" "lb" "lg" "li" "ln" "lo" "lt" "lu" "lv" "mg" "mh" "mi" "mk" "ml" "mn" "mr" "ms" "mt" "my" "na" "nb" "nd" "ne" "ng" "nn" "nr" "nv" "ny" "oc" "oj" "om" "os" "pa" "pi" "pl" "ps" "qu" "rm" "rn" "rw" "sa" "sc" "sd" "se" "sg" "si" "sk" "sl" "sm" "sn" "so" "sq" "sr" "ss" "st" "su" "sw" "ta" "te" "tg" "ti" "tk" "tl" "tn" "to" "ts" "tt" "tw" "ty" "ug" "uk" "ur" "uz" "ve" "vo" "wa" "wo" "xh" "yi" "yo" "za" "zu"

Supported Locales

timezone
string (timezone)

Based on tz database

password
string (password)

New password (admin only)

email
required
string <email> (email)

Responses

Request samples

Content type
application/json
{
  • "first_name": "string",
  • "last_name": "string",
  • "title": "string",
  • "office_phone": "string",
  • "mobile_phone": "string",
  • "language": "da",
  • "timezone": "string",
  • "password": "string",
  • "email": "user@example.com"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "object": "user",
  • "created": true,
  • "data": {
    }
}

Show a user details

Authorizations:
OAuth2PasswordBearer
path Parameters
user_id
required
string (user_id) [ 1 .. 20 ] characters ^[a-zA-Z0-9]+$
query Parameters
account_id
integer (account_id)

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Delete a user

Authorizations:
OAuth2PasswordBearer
path Parameters
user_id
required
string (user_id) [ 1 .. 20 ] characters ^[a-zA-Z0-9]+$
query Parameters
account_id
integer (account_id)

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "object": "user",
  • "deleted": true
}

Update a user

Authorizations:
OAuth2PasswordBearerOAuth2PasswordBearer
path Parameters
user_id
required
string (user_id) [ 1 .. 20 ] characters ^[a-zA-Z0-9]+$
query Parameters
account_id
integer (account_id)
Request Body schema: application/json
first_name
string (first_name)
last_name
string (last_name)
title
string (title)
office_phone
string (office_phone)
mobile_phone
string (mobile_phone) [0-9]+
language
string (language)
Enum: "da" "da_DK" "de" "de_DE" "el" "el_GR" "en" "en_US" "en_GB" "en_UK" "es" "es_US" "es_ES" "et" "et_EE" "fi" "fi_FI" "fr" "fr_CA" "fr_FR" "he" "he_IL" "id" "id_ID" "it" "it_IT" "ja" "ja_JP" "nl" "nl_NL" "no" "no_NO" "pt" "pt_BR" "ro" "ro_RO" "ru" "ru_RU" "sv" "sv_SE" "th" "th_TH" "tr" "tr_TR" "vi" "vi_VN" "zh" "zh_CN" "aa" "ab" "ae" "af" "ak" "am" "an" "ar" "av" "ay" "az" "ba" "be" "bg" "bh" "bi" "bm" "bn" "bo" "br" "bs" "ca" "ce" "ch" "co" "cr" "cs" "cu" "cv" "cy" "dv" "dz" "ee" "eo" "eu" "fa" "ff" "fj" "fo" "fy" "ga" "gd" "gl" "gn" "gu" "gv" "ha" "hi" "ho" "hr" "ht" "hu" "hy" "hz" "ia" "ie" "ig" "ii" "ik" "io" "is_IS" "iu" "jv" "ka" "kg" "ki" "kj" "kk" "kl" "km" "kn" "ko" "kr" "ks" "ku" "kv" "kw" "ky" "la" "lb" "lg" "li" "ln" "lo" "lt" "lu" "lv" "mg" "mh" "mi" "mk" "ml" "mn" "mr" "ms" "mt" "my" "na" "nb" "nd" "ne" "ng" "nn" "nr" "nv" "ny" "oc" "oj" "om" "os" "pa" "pi" "pl" "ps" "qu" "rm" "rn" "rw" "sa" "sc" "sd" "se" "sg" "si" "sk" "sl" "sm" "sn" "so" "sq" "sr" "ss" "st" "su" "sw" "ta" "te" "tg" "ti" "tk" "tl" "tn" "to" "ts" "tt" "tw" "ty" "ug" "uk" "ur" "uz" "ve" "vo" "wa" "wo" "xh" "yi" "yo" "za" "zu"

Supported Locales

timezone
string (timezone)

Based on tz database

object (ChangePassword)

Responses

Request samples

Content type
application/json
{
  • "first_name": "string",
  • "last_name": "string",
  • "title": "string",
  • "office_phone": "string",
  • "mobile_phone": "string",
  • "language": "da",
  • "timezone": "string",
  • "password": {
    }
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "object": "user",
  • "patched": true,
  • "data": {
    }
}

Suspend a user

Authorizations:
OAuth2PasswordBearer
path Parameters
user_id
required
integer (user_id)
query Parameters
account_id
integer (account_id)

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "object": "user",
  • "suspended": true,
  • "data": {
    }
}

Unsuspend a user

Authorizations:
OAuth2PasswordBearer
path Parameters
user_id
required
integer (user_id)
query Parameters
account_id
integer (account_id)

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "object": "user",
  • "suspended": true,
  • "data": {
    }
}

Confirm a user

path Parameters
user_id
required
string (user_id) [ 1 .. 20 ] characters ^[a-zA-Z0-9]+$
Request Body schema: application/json
confirmation
required
string (confirmation)
password
required
string (password) >= 8 characters

Responses

Request samples

Content type
application/json
{
  • "confirmation": "string",
  • "password": "stringst"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "object": "user",
  • "confirmed": true,
  • "data": {
    }
}

Resend the user verification email

Authorizations:
OAuth2PasswordBearer
path Parameters
user_id
required
string (user_id) [ 1 .. 20 ] characters ^[a-zA-Z0-9]+$
query Parameters
account_id
integer (account_id)

Responses

Response samples

Content type
application/json
{
  • "object": "user",
  • "confirmation_resent": true
}

Sub-Account

Show all sub-accounts

Authorizations:
OAuth2PasswordBearer
query Parameters
partner_account_id
integer (partner_account_id)
page
integer (page) >= 1
Default: 1
per_page
integer (per_page) >= 1
Default: 50
with_count
boolean (with_count)
Default: false
recursive
boolean (recursive)
Default: false
sort
string (sort)

Sort term and direction, using syntax [-|+]term.

Valid terms:

  • name
  • created_on
filter
string (filter)

Valid Terms:

  • name
  • status

Valid Operators:

  • ==

Query separator:

  • ;

Responses

Response samples

Content type
application/json
{
  • "pagination": {
    },
  • "data": [
    ]
}

Create a sub-account

Authorizations:
OAuth2PasswordBearer
query Parameters
partner_account_id
integer (partner_account_id)
skip_verification
boolean (skip_verification)
Default: false
Request Body schema: application/json
name
required
string (name) non-empty
object (address)
required
object (account_owner)
fax
string (fax) non-empty
phone
string (phone) non-empty
website
string <uri> (website) [ 1 .. 2083 ] characters
object (usage_limits)
Default: {}
object (domains)
Default: {}
trial
boolean (trial)
Default: false
partner
boolean (partner)
Default: false

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "address": {
    },
  • "account_owner": {
    },
  • "fax": "string",
  • "phone": "string",
  • "website": "http://example.com",
  • "usage_limits": { },
  • "domains": { },
  • "trial": false,
  • "partner": false
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "object": "account",
  • "email": "user@example.com",
  • "data": {
    },
  • "metadata": "string",
  • "created": true,
  • "warnings": [ ]
}

Show sub-account details

Authorizations:
OAuth2PasswordBearer
path Parameters
account_id
required
string (account_id) [ 1 .. 20 ] characters ^[a-zA-Z0-9]+$

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Delete a sub-account

Authorizations:
OAuth2PasswordBearer
path Parameters
account_id
required
string (account_id) [ 1 .. 20 ] characters ^[a-zA-Z0-9]+$

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "object": "account",
  • "deleted": true
}

Update a sub-account

Authorizations:
OAuth2PasswordBearer
path Parameters
account_id
required
integer (account_id)
Request Body schema: application/json
object (address)
name
string (name)
object (account_owner)
fax
string (fax)
phone
string (phone)
object (domains)
Default: {}
website
string <uri> (website) [ 1 .. 2083 ] characters
object (usage_limits)
Default: {}
trial
boolean (trial)
partner
boolean (partner)

Responses

Request samples

Content type
application/json
{
  • "address": {
    },
  • "name": "string",
  • "account_owner": {
    },
  • "fax": "string",
  • "phone": "string",
  • "domains": { },
  • "website": "http://example.com",
  • "usage_limits": { },
  • "trial": true,
  • "partner": true
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "warnings": [ ]
}

Suspend a sub-account

Authorizations:
OAuth2PasswordBearer
path Parameters
account_id
required
integer (account_id)

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "object": "account",
  • "suspended": true,
  • "data": {
    }
}

Unsuspend a sub-account

Authorizations:
OAuth2PasswordBearer
path Parameters
account_id
required
integer (account_id)

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "object": "account",
  • "unsuspended": true,
  • "data": {
    }
}

Confirm sub-account creation

path Parameters
account_id
required
string (account_id) [ 1 .. 20 ] characters ^[a-zA-Z0-9]+$
Request Body schema: application/json
confirmation
required
string (confirmation)

Responses

Request samples

Content type
application/json
{
  • "confirmation": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "object": "account",
  • "email": "user@example.com",
  • "data": {
    },
  • "metadata": "string",
  • "confirmed": true
}

Resend the account verification email

Request Body schema: application/json
email
required
string <email> (email)

Responses

Request samples

Content type
application/json
{
  • "email": "user@example.com"
}

Response samples

Content type
application/json
{
  • "object": "account",
  • "verification_resent": true
}

Workflow

Show all workflows

Authorizations:
OAuth2PasswordBearer
query Parameters
page
integer (page) >= 1
Default: 1
per_page
integer (per_page) >= 1
Default: 50
account_id
integer (account_id)
with_count
boolean (with_count)
Default: false
sort
string (sort)

Sort term and direction, using syntax [-|+]term.

Valid terms:

  • name
  • description
  • goal
  • status
  • created_on
  • updated_on
  • activated_on

Responses

Response samples

Content type
application/json
{
  • "pagination": {
    },
  • "data": [
    ]
}

Create a workflow

Authorizations:
OAuth2PasswordBearer
query Parameters
account_id
integer (account_id)
lock_key
string (lock_key) ^[a-zA-Z0-9-_]{8,}$

Locking key, preventing other users from modifying this workflow for a short period.

Request Body schema: application/json
name
string (name)
goal
string (goal)
description
string (description)
trigger
string (trigger)
Default: "subscribed"
Enum: "subscribed" "unsubscribed" "manual"

An enumeration.

required
object (WorkflowAudience)
object (WorkflowFromBlueprint)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "goal": "string",
  • "description": "string",
  • "trigger": "subscribed",
  • "audience": {
    },
  • "blueprint": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "id": "string",
  • "object": "workflow",
  • "created": true
}

Show a workflow

Authorizations:
OAuth2PasswordBearer
path Parameters
workflow_id
required
string (workflow_id)
query Parameters
account_id
integer (account_id)
lock_key
string (lock_key) ^[a-zA-Z0-9-_]{8,}$

Locking key, preventing other users from modifying this workflow for a short period.

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Delete a workflow

Authorizations:
OAuth2PasswordBearer
path Parameters
workflow_id
required
string (workflow_id)
query Parameters
account_id
integer (account_id)
lock_key
string (lock_key) ^[a-zA-Z0-9-_]{8,}$

Locking key, preventing other users from modifying this workflow for a short period.

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "id": "string",
  • "object": "workflow",
  • "deleted": true
}

Update a workflow

Authorizations:
OAuth2PasswordBearer
path Parameters
workflow_id
required
string (workflow_id)
query Parameters
account_id
integer (account_id)
lock_key
string (lock_key) ^[a-zA-Z0-9-_]{8,}$

Locking key, preventing other users from modifying this workflow for a short period.

Request Body schema: application/json
name
string (name)
goal
string (goal)
description
string (description)
trigger
string (trigger)
Enum: "subscribed" "unsubscribed" "manual"

An enumeration.

object (WorkflowAudience)
object (WorkflowFromBlueprint)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "goal": "string",
  • "description": "string",
  • "trigger": "subscribed",
  • "audience": {
    },
  • "blueprint": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "id": "string",
  • "object": "workflow",
  • "patched": true
}

Activate a workflow

Authorizations:
OAuth2PasswordBearer
path Parameters
workflow_id
required
string (workflow_id)
query Parameters
account_id
integer (account_id)
lock_key
string (lock_key) ^[a-zA-Z0-9-_]{8,}$

Locking key, preventing other users from modifying this workflow for a short period.

sender_email
string (sender_email)

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "object": "workflow",
  • "activated": true
}

Deactivate a workflow

Authorizations:
OAuth2PasswordBearer
path Parameters
workflow_id
required
string (workflow_id)
query Parameters
account_id
integer (account_id)
lock_key
string (lock_key) ^[a-zA-Z0-9-_]{8,}$

Locking key, preventing other users from modifying this workflow for a short period.

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "object": "workflow",
  • "deactivated": true
}

Lock a workflow

Authorizations:
OAuth2PasswordBearer
path Parameters
workflow_id
required
string (workflow_id)
query Parameters
account_id
integer (account_id)
Request Body schema: application/json
key
required
string (key) ^[a-zA-Z0-9-_]{8,}$

Responses

Request samples

Content type
application/json
{
  • "key": "string"
}

Response samples

Content type
application/json
{
  • "object": "workflow",
  • "locked": true,
  • "expires_in": 0
}

Unlock a workflow

Authorizations:
OAuth2PasswordBearer
path Parameters
workflow_id
required
string (workflow_id)
query Parameters
account_id
integer (account_id)
Request Body schema: application/json
key
required
string (key) ^[a-zA-Z0-9-_]{8,}$

Responses

Request samples

Content type
application/json
{
  • "key": "string"
}

Response samples

Content type
application/json
{
  • "object": "workflow",
  • "locked": true,
  • "expires_in": 0
}

Workflow Blueprint

Show all workflow blueprints

query Parameters
page
integer (page)
Default: 1
per_page
integer (per_page)
Default: 50
with_count
boolean (with_count)
Default: false
sort
string (sort)

Sort term and direction, using syntax [-|+]term.

Valid terms:

  • name
  • description
  • goal
  • created_on
  • updated_on

Responses

Response samples

Content type
application/json
{
  • "pagination": {
    },
  • "data": [
    ]
}

Show workflow blueprint actions

path Parameters
blueprint_id
required
string (blueprint_id)
query Parameters
page
integer (page)
Default: 1
per_page
integer (per_page)
Default: 50
with_count
boolean (with_count)
Default: false
sort
string (sort)

Sort term and direction, using syntax [-|+]term.

Valid terms:

  • name
  • created_on

Responses

Response samples

Content type
application/json
{
  • "pagination": {
    },
  • "data": [
    ]
}

Show a workflow blueprint action

path Parameters
blueprint_id
required
string (blueprint_id)
action_id
required
string (action_id)

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Show a workflow blueprint

path Parameters
blueprint_id
required
string (blueprint_id)

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

System Email

Show system emails configuration

Show system emails configuration

Authorizations:
OAuth2PasswordBearer
query Parameters
account_id
integer (account_id)

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Set system emails configuration

Set system emails configuration

Authorizations:
OAuth2PasswordBearer
query Parameters
account_id
integer (account_id)
Request Body schema: application/json
Array of objects (account_confirm)
Array of objects (user_confirm)
Array of objects (sender_confirm)
Array of objects (password_reset)

Responses

Request samples

Content type
application/json
{
  • "account_confirm": [
    ],
  • "user_confirm": [
    ],
  • "sender_confirm": [
    ],
  • "password_reset": [
    ]
}

Response samples

Content type
application/json
{
  • "object": "systememails",
  • "updated": true,
  • "data": {
    }
}

Update system emails configuration

Partially update system emails configuration

Authorizations:
OAuth2PasswordBearer
query Parameters
account_id
integer (account_id)
Request Body schema: application/json
Array of objects (account_confirm)
Array of objects (user_confirm)
Array of objects (sender_confirm)
Array of objects (password_reset)

Responses

Request samples

Content type
application/json
{
  • "account_confirm": [
    ],
  • "user_confirm": [
    ],
  • "sender_confirm": [
    ],
  • "password_reset": [
    ]
}

Response samples

Content type
application/json
{
  • "object": "systememails",
  • "updated": true,
  • "data": {
    }
}

Webhook

List all webhooks

Authorizations:
OAuth2PasswordBearer
query Parameters
page
integer (page) >= 1
Default: 1
per_page
integer (per_page) >= 1
Default: 50
with_archived
boolean (with_archived)
Default: false
account_id
integer (account_id)

Responses

Response samples

Content type
application/json
{
  • "pagination": {
    },
  • "data": [
    ]
}

Create a webhook

Authorizations:
OAuth2PasswordBearer
query Parameters
account_id
integer (account_id)
Request Body schema: application/json
event
required
string (EventType)
Enum: "Account.Created" "Account.Updated" "Account.Confirmed" "Account.Deleted" "Contact.Added" "Contact.Updated" "Contact.Removed" "Contact.Tagged" "Contact.Untagged" "ContactsExport.Created" "ContactsExport.Deleted" "Campaign.Canceled" "Campaign.Created" "Campaign.Unscheduled" "Campaign.Updated" "Campaign.Resumed" "Campaign.Scheduled" "Campaign.Suspended" "CampaignLogExport.Created" "Email.Sent" "Email.Opened" "Email.Clicked" "Email.Bounced" "Email.ReportedAsSpam" "User.Created" "User.Deleted" "User.LoggedIn" "User.Updated" "List.Created" "List.Updated" "List.Deleted" "Segment.Created" "Segment.Updated" "Segment.Deleted" "Sender.Created" "Sender.Updated" "Sender.Deleted" "Sender.Confirmed" "Sender.ConfirmationEmailSent" "SuppressedEmail.Added" "SuppressedEmail.Removed"

An enumeration.

url
required
string <uri> (url) [ 1 .. 2083 ] characters
rate_limit
integer (rate_limit)
Default: 80
rate_limit_period
string (rate_limit_period)
Default: "second"
Enum: "second" "minute"

An enumeration.

Responses

Request samples

Content type
application/json
{
  • "event": "Account.Created",
  • "url": "http://example.com",
  • "rate_limit": 80,
  • "rate_limit_period": "second"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "data": {
    }
}

Archive a webhook

Authorizations:
OAuth2PasswordBearer
path Parameters
webhook_id
required
string (webhook_id)
query Parameters
account_id
integer (account_id)

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "data": {
    },
  • "object": "Webhook",
  • "archived": true
}

Unarchive a webhook

Authorizations:
OAuth2PasswordBearer
path Parameters
webhook_id
required
string (webhook_id)
query Parameters
account_id
integer (account_id)

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "data": {
    },
  • "object": "Webhook",
  • "archived": false
}

Show a webhook

Authorizations:
OAuth2PasswordBearer
path Parameters
webhook_id
required
string (webhook_id)
query Parameters
account_id
integer (account_id)

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "signature": {
    },
  • "data": {
    }
}

Patch a webhook

Authorizations:
OAuth2PasswordBearer
path Parameters
webhook_id
required
string (webhook_id)
query Parameters
account_id
integer (account_id)
Request Body schema: application/json
url
string <uri> (url) [ 1 .. 2083 ] characters
rate_limit
integer (rate_limit)
rate_limit_period
string (RateLimitPeriod)
Enum: "second" "minute"

An enumeration.

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{
  • "id": "string",
  • "data": {
    },
  • "object": "Webhook",
  • "patched": true
}

Tags

Show a tag

Authorizations:
OAuth2PasswordBearer
path Parameters
tag
required
string (tag) [ 1 .. 64 ] characters ^[A-Za-z0-9.\-+_]+$
query Parameters
account_id
integer (account_id)

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Delete a tag

Authorizations:
OAuth2PasswordBearer
path Parameters
tag
required
string (tag) [ 1 .. 64 ] characters ^[A-Za-z0-9.\-+_]+$
query Parameters
account_id
integer (account_id)

Responses

Response samples

Content type
application/json
{
  • "tag": "string",
  • "object": "tag",
  • "deleted": true
}

Edit tag

Authorizations:
OAuth2PasswordBearer
path Parameters
tag
required
string (tag) [ 1 .. 64 ] characters ^[A-Za-z0-9.\-+_]+$
query Parameters
account_id
integer (account_id)
Request Body schema: application/json
tag
required
string (tag) [ 1 .. 64 ] characters ^[A-Za-z0-9.\-+_]+$

Responses

Request samples

Content type
application/json
{
  • "tag": "string"
}

Response samples

Content type
application/json
{
  • "tag": "string",
  • "object": "tag",
  • "updated": true,
  • "data": {
    }
}

Show all tags

Authorizations:
OAuth2PasswordBearer
query Parameters
account_id
integer (account_id)
page
integer (page) >= 1
Default: 1
per_page
integer (per_page) >= 1
Default: 50
with_count
boolean (with_count)
Default: false

Responses

Response samples

Content type
application/json
{
  • "pagination": {
    },
  • "data": [
    ]
}

Create a tag

Authorizations:
OAuth2PasswordBearer
query Parameters
account_id
integer (account_id)
Request Body schema: application/json
tag
required
string (tag) [ 1 .. 64 ] characters ^[A-Za-z0-9.\-+_]+$

Responses

Request samples

Content type
application/json
{
  • "tag": "string"
}

Response samples

Content type
application/json
{
  • "tag": "string",
  • "object": "tag",
  • "created": true,
  • "data": {
    }
}