sixxmail API documentation

/auth

/users

/users/{id} get patch delete

get

Returns the specific user

patch

Update an user.

delete

Delete an user

/roles

/lists

/lists/{id} get patch delete

get

fetch a list, if visible and not deleted.

patch

updates a list

delete

marks a list as deleted and restricts access to it. The list will be eventually deleted.

/lists/{id}/mailings get post

get

fetch a list of mailings.

post

create a mailing in this list. does provide shortcuts to create mailing parts.

Request
Response

URI Parameters

id: required (string)

Headers

Authorization: required (string)
X-AuthToken

Body

Media type: application/json

Type: object

Properties

name: required (string)
format: required (one of TEXT, HTML, MULTI_PART)
format of the mailing
type: required (one of ORDINARY, SPLIT_MASTER, SPLIT_SLAVE)
type of the mailing. currently, only ordinary mails supported.
subject: required (string)
sender: (integer)
replyTo: (integer)
parts: (array of mailing.MailingPartCreateRequest)
Items: MailingPartCreateRequest
- type: required (one of TEXT, HTML, AMP)
  type of the part. We support TEXT, HTML and AMP. AMP is a specific part type for dynamic mails (i.e. supported by gmail / gsuite)
- content: required (string)
project: (integer)

HTTP status code 201

mailing created

Body

Media type: application/json

Type: object

Properties

id: required (integer)
listId: required (integer)
name: required (string)
format: required (one of TEXT, HTML, MULTI_PART)
may be removed in the future.
type: required (one of ORDINARY, SPLIT_MASTER, SPLIT_SLAVE)
type of the mailing. currently, only ordinary mails supported.
status: required (one of DRAFT, LOCK, PLAN, SEND)
current status of the mailing. if not draft, then certain properties are locked and cannot be adjusted anymore.
subject: required (string)
recipients: (integer)
recipients of the mailing. only available if recipients were calculated already. otherwise, it is null.
successfulRecipients: (integer)
successful delivery to recipients. this only refers to the sending process itself.
created: required (datetime)
updated: required (datetime)
sending: required (datetime)
project: required (integer)
sender: (object)
registered address preset
- id: required (integer)
- name: required (string)
- mail: required (string)
  Email based with (Java-compatible) Regex, cp. http://emailregex.com/.
- listDefault: required (boolean)
replyTo: (object)
registered address preset
- id: required (integer)
- name: required (string)
- mail: required (string)
  Email based with (Java-compatible) Regex, cp. http://emailregex.com/.
- listDefault: required (boolean)
filter: required (array of integer)

HTTP status code 401

Authentication problem (JWT not set / expired)

Body

Media type: application/json

Type: object

Properties

id: required (number)
description: required (string)

HTTP status code 403

Authentication valid, but permissions not suitable to access resource.

HTTP status code 404

list not found

HTTP status code 424

address presets not found

/lists/{id}/attributes get post

get

get list of attributes

post

make attributes visible in list. hide every other attribute.

get list of attributes

Request
Response

URI Parameters

id: required (string)

HTTP status code 200

Body

Media type: application/json

Type: array of object

Items: ListAttribute

attribute: required (object)
- id: required (integer)
- name: required (string)
- columnName: required (string - pattern: A-Za-z)
  The internal representation. Is not changeable and can be defined at attribute creation. Is unique. Is used to access data in mailings or during selections. The server automatically generates a column name if null or empty.
  Example:
```
Essen & Trinken gets automatically mapped to essenAndTrinken;
```
- type: required (one of ID, MAIL, IP, GEO_STREET, GEO_STREET_NO, GEO_CITY, GEO_COUNTRY, GEO_ZIP, GEO_LAT, GEO_LONG, TEXT, BOOL, INTEGER, FLOAT, DATE, DATETIME, SUBSCRIPTION, UNSUBSCRIPTION)
  The type of an attribute. Each attribute gets validated. MAIL only accepts valid e-mail addresses according to RFC 822. IP only accepts IPv4 or IPv6 addresses types with the prefix GEO_ are treated to determine the geographical coordinates. GEO_STREET is a text value. GEO_STREET_NO is a text value. It may be included in GEO_STREET. GEO_CITY is a text value GEO_COUNTRY is a text value GEO_ZIP is a text value GEO_LAT is a float value GEO_LONG is a float value TEXT is simple text. BOOL is either true or false. INTEGER accepts integer based values. The behaviour is guaranteed for a value between -2147483648 and 2147483647 FLOAT accepts decimal numbers and interprets it internally as double. DATE is a date without time. The proposed format is yyyy-MM-dd. Other values may be accepted. DATETIME is a date with time. The proposed format is yyyy-MM-dd HH:mm:ss, other values may be accepted. SUBSCRIPTION is a date time, which represents the subscription date. It cannot be modified or deleted. UNSUBSCRIPTION is a checkbox. If the user unsubscribed or gets unsubscribed, this checkbox is set.
- length: (integer)
- hidden: required (boolean)
- system: required (boolean)
- status: required (one of PENDING, SUCCESS)
- edit: required (boolean)
- subscription: required (integer)
  refers to a list
visible: required (boolean)

/lists/{id}/access get post

get

get access limits

post

update current settings

/lists/{id}/access/{id} delete

delete

remove access right

Request
Response

URI Parameters

id: required (string)
id: required (string)

Headers

Authorization: required (string)
X-AuthToken

HTTP status code 200

removed authority of specific user / role to see this list.

Body

Media type: application/json

Type: object

Properties

listId: required (integer)
userAccess: required (array of list.ListUserAccess)
Items: ListUserAccess
- id: (string - pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$)
  optional, because implicit granting possible (role access)
- user: required (object)
  - id: required (string - pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$)
    Universally Unique Identifier.
  - email: required (string)
    Email based with (Java-compatible) Regex, cp. http://emailregex.com/.
  - firstname: required (string)
  - lastname: required (string)
  - username: required (string)
- implicit: required (boolean)
roleAccess: required (array of list.ListRoleAccess)
Items: ListRoleAccess
- id: required (integer)
- user: required (object)
  role representation without permissions
  - id: required (string - pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$)
    Universally Unique Identifier.
  - name: required (string)

HTTP status code 304

cannot delete non-existant entity.

Body

Media type: application/json

Type: object

Properties

listId: required (integer)
userAccess: required (array of list.ListUserAccess)
Items: ListUserAccess
- id: (string - pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$)
  optional, because implicit granting possible (role access)
- user: required (object)
  - id: required (string - pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$)
    Universally Unique Identifier.
  - email: required (string)
    Email based with (Java-compatible) Regex, cp. http://emailregex.com/.
  - firstname: required (string)
  - lastname: required (string)
  - username: required (string)
- implicit: required (boolean)
roleAccess: required (array of list.ListRoleAccess)
Items: ListRoleAccess
- id: required (integer)
- user: required (object)
  role representation without permissions
  - id: required (string - pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$)
    Universally Unique Identifier.
  - name: required (string)

HTTP status code 401

Authentication problem (JWT not set / expired)

Body

Media type: application/json

Type: object

Properties

id: required (number)
description: required (string)

HTTP status code 403

Authentication valid, but permissions not suitable to access resource.

HTTP status code 404

list does not exist.

HTTP status code 410

list is deleted.

/selection-lists

/selection-lists get post

get

fetch all visible and not deleted selection lists (black & whitelists)

post

Requires a valid JWT (JSON web token), which is granted by the server on login.

/imports

/imports/{id} get delete post

get

get specific import information

delete

remove specific import. only the protocol entry is deleted, the subscribers are not unsubscribed.

post

updates an import

/projects

/attributes

/attributes get post

get

get a list of available attributes

post

add a new attribute.

get a list of available attributes

Request
Response

Headers

Authorization: required (string)
X-AuthToken

Query Parameters

page: (integer - default: 0)
the requested page
size: (integer - default: 20)
size of a page
sort: (string)
sort parameter.
q: (string)
the query string. returned datasets have to contain this string.

HTTP status code 200

get a list of objects

Body

Media type: application/json

Type: object

Properties

pageMetadata: required (object)
meta information for paged resources
- size: required (integer)
- totalElements: required (integer)
- totalPages: required (integer)
- number: required (integer)
content: required (array of attribute.AttributeInfo)
Items: AttributeInfo
- id: required (integer)
- name: required (string)
- columnName: required (string - pattern: A-Za-z)
  The internal representation. Is not changeable and can be defined at attribute creation. Is unique. Is used to access data in mailings or during selections. The server automatically generates a column name if null or empty.
  Example:
```
Essen & Trinken gets automatically mapped to essenAndTrinken;
```
- type: required (one of ID, MAIL, IP, GEO_STREET, GEO_STREET_NO, GEO_CITY, GEO_COUNTRY, GEO_ZIP, GEO_LAT, GEO_LONG, TEXT, BOOL, INTEGER, FLOAT, DATE, DATETIME, SUBSCRIPTION, UNSUBSCRIPTION)
  The type of an attribute. Each attribute gets validated. MAIL only accepts valid e-mail addresses according to RFC 822. IP only accepts IPv4 or IPv6 addresses types with the prefix GEO_ are treated to determine the geographical coordinates. GEO_STREET is a text value. GEO_STREET_NO is a text value. It may be included in GEO_STREET. GEO_CITY is a text value GEO_COUNTRY is a text value GEO_ZIP is a text value GEO_LAT is a float value GEO_LONG is a float value TEXT is simple text. BOOL is either true or false. INTEGER accepts integer based values. The behaviour is guaranteed for a value between -2147483648 and 2147483647 FLOAT accepts decimal numbers and interprets it internally as double. DATE is a date without time. The proposed format is yyyy-MM-dd. Other values may be accepted. DATETIME is a date with time. The proposed format is yyyy-MM-dd HH:mm:ss, other values may be accepted. SUBSCRIPTION is a date time, which represents the subscription date. It cannot be modified or deleted. UNSUBSCRIPTION is a checkbox. If the user unsubscribed or gets unsubscribed, this checkbox is set.
- length: (integer)
- hidden: required (boolean)
- system: required (boolean)
- status: required (one of PENDING, SUCCESS)
- edit: required (boolean)
- subscription: required (integer)
  refers to a list

HTTP status code 401

Authentication problem (JWT not set / expired)

Body

Media type: application/json

Type: object

Properties

id: required (number)
description: required (string)

HTTP status code 403

Authentication valid, but permissions not suitable to access resource.

add a new attribute.

Request
Response

Headers

Authorization: required (string)
X-AuthToken

Query Parameters

page: (integer - default: 0)
the requested page
size: (integer - default: 20)
size of a page
sort: (string)
sort parameter.
q: (string)
the query string. returned datasets have to contain this string.

Body

Media type: application/json

Type: object

Properties

name: required (string)
column: (string - pattern: A-Za-z)
The internal representation. Is not changeable and can be defined at attribute creation. Is unique. Is used to access data in mailings or during selections. The server automatically generates a column name if null or empty based on the name.
type: required (one of ID, MAIL, IP, GEO_STREET, GEO_STREET_NO, GEO_CITY, GEO_COUNTRY, GEO_ZIP, GEO_LAT, GEO_LONG, TEXT, BOOL, INTEGER, FLOAT, DATE, DATETIME, SUBSCRIPTION, UNSUBSCRIPTION)
The type of an attribute. Each attribute gets validated. MAIL only accepts valid e-mail addresses according to RFC 822. IP only accepts IPv4 or IPv6 addresses types with the prefix GEO_ are treated to determine the geographical coordinates. GEO_STREET is a text value. GEO_STREET_NO is a text value. It may be included in GEO_STREET. GEO_CITY is a text value GEO_COUNTRY is a text value GEO_ZIP is a text value GEO_LAT is a float value GEO_LONG is a float value TEXT is simple text. BOOL is either true or false. INTEGER accepts integer based values. The behaviour is guaranteed for a value between -2147483648 and 2147483647 FLOAT accepts decimal numbers and interprets it internally as double. DATE is a date without time. The proposed format is yyyy-MM-dd. Other values may be accepted. DATETIME is a date with time. The proposed format is yyyy-MM-dd HH:mm:ss, other values may be accepted. SUBSCRIPTION is a date time, which represents the subscription date. It cannot be modified or deleted. UNSUBSCRIPTION is a checkbox. If the user unsubscribed or gets unsubscribed, this checkbox is set.
length: (integer)
hidden: required (boolean)
list: (array of common.UUID)
edit: (boolean)

HTTP status code 200

attribute added.

Body

Media type: application/json

Type: object

Properties

id: required (integer)
name: required (string)
columnName: required (string - pattern: A-Za-z)
The internal representation. Is not changeable and can be defined at attribute creation. Is unique. Is used to access data in mailings or during selections. The server automatically generates a column name if null or empty.
Example:
```
Essen & Trinken gets automatically mapped to essenAndTrinken;
```
type: required (one of ID, MAIL, IP, GEO_STREET, GEO_STREET_NO, GEO_CITY, GEO_COUNTRY, GEO_ZIP, GEO_LAT, GEO_LONG, TEXT, BOOL, INTEGER, FLOAT, DATE, DATETIME, SUBSCRIPTION, UNSUBSCRIPTION)
The type of an attribute. Each attribute gets validated. MAIL only accepts valid e-mail addresses according to RFC 822. IP only accepts IPv4 or IPv6 addresses types with the prefix GEO_ are treated to determine the geographical coordinates. GEO_STREET is a text value. GEO_STREET_NO is a text value. It may be included in GEO_STREET. GEO_CITY is a text value GEO_COUNTRY is a text value GEO_ZIP is a text value GEO_LAT is a float value GEO_LONG is a float value TEXT is simple text. BOOL is either true or false. INTEGER accepts integer based values. The behaviour is guaranteed for a value between -2147483648 and 2147483647 FLOAT accepts decimal numbers and interprets it internally as double. DATE is a date without time. The proposed format is yyyy-MM-dd. Other values may be accepted. DATETIME is a date with time. The proposed format is yyyy-MM-dd HH:mm:ss, other values may be accepted. SUBSCRIPTION is a date time, which represents the subscription date. It cannot be modified or deleted. UNSUBSCRIPTION is a checkbox. If the user unsubscribed or gets unsubscribed, this checkbox is set.
length: (integer)
hidden: required (boolean)
system: required (boolean)
status: required (one of PENDING, SUCCESS)
edit: required (boolean)
subscription: required (integer)
refers to a list

HTTP status code 202

attribute add request received, but could not be added yet.

Body

Media type: application/json

Type: object

Properties

id: required (integer)
name: required (string)
columnName: required (string - pattern: A-Za-z)
The internal representation. Is not changeable and can be defined at attribute creation. Is unique. Is used to access data in mailings or during selections. The server automatically generates a column name if null or empty.
Example:
```
Essen & Trinken gets automatically mapped to essenAndTrinken;
```
type: required (one of ID, MAIL, IP, GEO_STREET, GEO_STREET_NO, GEO_CITY, GEO_COUNTRY, GEO_ZIP, GEO_LAT, GEO_LONG, TEXT, BOOL, INTEGER, FLOAT, DATE, DATETIME, SUBSCRIPTION, UNSUBSCRIPTION)
The type of an attribute. Each attribute gets validated. MAIL only accepts valid e-mail addresses according to RFC 822. IP only accepts IPv4 or IPv6 addresses types with the prefix GEO_ are treated to determine the geographical coordinates. GEO_STREET is a text value. GEO_STREET_NO is a text value. It may be included in GEO_STREET. GEO_CITY is a text value GEO_COUNTRY is a text value GEO_ZIP is a text value GEO_LAT is a float value GEO_LONG is a float value TEXT is simple text. BOOL is either true or false. INTEGER accepts integer based values. The behaviour is guaranteed for a value between -2147483648 and 2147483647 FLOAT accepts decimal numbers and interprets it internally as double. DATE is a date without time. The proposed format is yyyy-MM-dd. Other values may be accepted. DATETIME is a date with time. The proposed format is yyyy-MM-dd HH:mm:ss, other values may be accepted. SUBSCRIPTION is a date time, which represents the subscription date. It cannot be modified or deleted. UNSUBSCRIPTION is a checkbox. If the user unsubscribed or gets unsubscribed, this checkbox is set.
length: (integer)
hidden: required (boolean)
system: required (boolean)
status: required (one of PENDING, SUCCESS)
edit: required (boolean)
subscription: required (integer)
refers to a list

HTTP status code 401

Authentication problem (JWT not set / expired)

Body

Media type: application/json

Type: object

Properties

id: required (number)
description: required (string)

HTTP status code 403

Authentication valid, but permissions not suitable to access resource.

/attributes/{id} get patch delete

get

get a single attribute

patch

mod a single attribute

delete

delete a single attribute

get a single attribute

Request
Response

URI Parameters

id: required (string)

Headers

Authorization: required (string)
X-AuthToken

HTTP status code 200

attribute

Body

Media type: application/json

Type: object

Properties

id: required (integer)
name: required (string)
columnName: required (string - pattern: A-Za-z)
The internal representation. Is not changeable and can be defined at attribute creation. Is unique. Is used to access data in mailings or during selections. The server automatically generates a column name if null or empty.
Example:
```
Essen & Trinken gets automatically mapped to essenAndTrinken;
```
type: required (one of ID, MAIL, IP, GEO_STREET, GEO_STREET_NO, GEO_CITY, GEO_COUNTRY, GEO_ZIP, GEO_LAT, GEO_LONG, TEXT, BOOL, INTEGER, FLOAT, DATE, DATETIME, SUBSCRIPTION, UNSUBSCRIPTION)
The type of an attribute. Each attribute gets validated. MAIL only accepts valid e-mail addresses according to RFC 822. IP only accepts IPv4 or IPv6 addresses types with the prefix GEO_ are treated to determine the geographical coordinates. GEO_STREET is a text value. GEO_STREET_NO is a text value. It may be included in GEO_STREET. GEO_CITY is a text value GEO_COUNTRY is a text value GEO_ZIP is a text value GEO_LAT is a float value GEO_LONG is a float value TEXT is simple text. BOOL is either true or false. INTEGER accepts integer based values. The behaviour is guaranteed for a value between -2147483648 and 2147483647 FLOAT accepts decimal numbers and interprets it internally as double. DATE is a date without time. The proposed format is yyyy-MM-dd. Other values may be accepted. DATETIME is a date with time. The proposed format is yyyy-MM-dd HH:mm:ss, other values may be accepted. SUBSCRIPTION is a date time, which represents the subscription date. It cannot be modified or deleted. UNSUBSCRIPTION is a checkbox. If the user unsubscribed or gets unsubscribed, this checkbox is set.
length: (integer)
hidden: required (boolean)
system: required (boolean)
status: required (one of PENDING, SUCCESS)
edit: required (boolean)
subscription: required (integer)
refers to a list

HTTP status code 401

Authentication problem (JWT not set / expired)

Body

Media type: application/json

Type: object

Properties

id: required (number)
description: required (string)

HTTP status code 403

Authentication valid, but permissions not suitable to access resource.

mod a single attribute

Request
Response

URI Parameters

id: required (string)

Headers

Authorization: required (string)
X-AuthToken

Body

Media type: application/json

Type: object

Properties

name: required (string)
hidden: required (boolean)
edit: (boolean)

HTTP status code 200

attribute added.

Body

Media type: application/json

Type: object

Properties

id: required (integer)
name: required (string)
columnName: required (string - pattern: A-Za-z)
The internal representation. Is not changeable and can be defined at attribute creation. Is unique. Is used to access data in mailings or during selections. The server automatically generates a column name if null or empty.
Example:
```
Essen & Trinken gets automatically mapped to essenAndTrinken;
```
type: required (one of ID, MAIL, IP, GEO_STREET, GEO_STREET_NO, GEO_CITY, GEO_COUNTRY, GEO_ZIP, GEO_LAT, GEO_LONG, TEXT, BOOL, INTEGER, FLOAT, DATE, DATETIME, SUBSCRIPTION, UNSUBSCRIPTION)
The type of an attribute. Each attribute gets validated. MAIL only accepts valid e-mail addresses according to RFC 822. IP only accepts IPv4 or IPv6 addresses types with the prefix GEO_ are treated to determine the geographical coordinates. GEO_STREET is a text value. GEO_STREET_NO is a text value. It may be included in GEO_STREET. GEO_CITY is a text value GEO_COUNTRY is a text value GEO_ZIP is a text value GEO_LAT is a float value GEO_LONG is a float value TEXT is simple text. BOOL is either true or false. INTEGER accepts integer based values. The behaviour is guaranteed for a value between -2147483648 and 2147483647 FLOAT accepts decimal numbers and interprets it internally as double. DATE is a date without time. The proposed format is yyyy-MM-dd. Other values may be accepted. DATETIME is a date with time. The proposed format is yyyy-MM-dd HH:mm:ss, other values may be accepted. SUBSCRIPTION is a date time, which represents the subscription date. It cannot be modified or deleted. UNSUBSCRIPTION is a checkbox. If the user unsubscribed or gets unsubscribed, this checkbox is set.
length: (integer)
hidden: required (boolean)
system: required (boolean)
status: required (one of PENDING, SUCCESS)
edit: required (boolean)
subscription: required (integer)
refers to a list

HTTP status code 401

Authentication problem (JWT not set / expired)

Body

Media type: application/json

Type: object

Properties

id: required (number)
description: required (string)

HTTP status code 403

Authentication valid, but permissions not suitable to access resource.

HTTP status code 423

attribute is immutable (system attributes, i.e. mail address or subscription date)

/recipients

/mailings

/mailings/{id} get patch delete

get

fetch mailing information

patch

update an existing mailing.

delete

delete a mailing

/mailings/{id}/checks/{checkname} get post

get

fetch result of check, if available

post

start a check

/mailings/{id}/queue get post delete

get

fetch the queue for this mailing. Response includes related queue items of other mailings, if split test

post

queue mailing for sendout

delete

delete the queue for this mailing. if split test

/mailings/{id}/parts/{id}/preview get

get

render the preview

Request
Response

URI Parameters

id: required (string)
id: required (string)

Headers

Authorization: required (string)
X-AuthToken

Query Parameters

id: required (integer)
the id of the recipient (for personalization preview)

HTTP status code 200

created

Body

Media type: text/plain

Type: string

Example:

I am a text mail

Media type: text/html

Type: string

Example:

<b>I am a mail</b>

HTTP status code 401

Authentication problem (JWT not set / expired)

Body

Media type: application/json

Type: object

Properties

id: required (number)
description: required (string)

HTTP status code 403

Authentication valid, but permissions not suitable to access resource.

HTTP status code 406

cannot render part. usually, this does not happen.

/server/mail/out

/settings

/filters

Body

Media type: application/json

Type: object

Properties

name: required (string)
sql: (string)
listId: required (integer)
operator: (one of AND, OR)
combine single selection functions
operations: (array of selection.SelectionOperation)
Items: SelectionOperation
- function: required (one of COL_OP, FUNC_ALL_SEND, FUNC_ANY_SEND, FUNC_SUBSCRIBED, FUNC_UNSUBSCRIBED, FUNC_OPENED, FUNC_CLICKED, FUNC_REACTED, FUNC_NUM_SEND)
- attribute: (integer)
- operator: required (one of EQ, NEQ, IN, NIN, GTE, GT, LT, LTE, IS_NULL, IS_NOT_NULL, BETWEEN, NOT_BETWEEN)
- params: required (array of string)

Example:

{
    "name": "Filter",
    "operator": "AND",
    "operations": [
        {
            "function": "COL_OP",
            "attribute": 1,
            "operator": "BETWEEN",
            "params": [
                "23",
                "23",
                "34"
            ]
        },
        {
            "function": "COL_OP",
            "attribute": 33,
            "operator": "BETWEEN",
            "params": [
                "2017-02-02T12:12:12",
                "2017-02-04T12:12:12"
                ],
            "__comment": "yyyy-MM-dd'T'hh:mm:ss - sixmail should be able to detect many formats, but it will return this one"
        },
        {
            "function": "COL_OP",
            "attribute": 2,
            "operator": "EQ",
            "params": [
                "mail@mail.de"
            ]
        },
        {
            "function": "COL_OP",
            "attribute": 2,
            "operator": "EQ",
            "params": [
                "mail@mail.de"
            ]
        },
        {
            "function": "FUNC_ANY_SEND",
            "operator": "IN",
            "params": [
                "1234",
                "1234",
                "1234",
                "1234"
            ],
            "__comment": "2 supported operators: IN: any given mailings were send. NIN: none of the given mailings were send "
        },
        {
            "function": "FUNC_ALL_SEND",
            "operator": "IN",
            "params": [
                "1234",
                "1234",
                "1234",
                "1234"
            ],
            "__comment": "2 supported operators: IN: all given mailings were send. NIN: not all or none of the given mailings were send "
        },

        {
            "function": "FUNC_SUBSCRIBED",
            "operator": "EQ",
            "params": [
                "1234"
            ],
            "__comment": "2 supported operators: EQ: subscribed in given lists. NEQ: not subscribed in given list. "
        },

        {
            "function": "FUNC_UNSUBSCRIBED",
            "operator": "EQ",
            "params": [
                "1234"
            ],
            "__comment": "2 supported operators: EQ: unsubscribed in given list. NEQ: not unsubscribed in given list."
        },
        {
            "function": "FUNC_CLICKED",
            "operator": "IN",
            "params": [
                "1234",
                "1234"
            ],
            "__comment": "2 supported operators: IN: clicked any of the mailings. NIN: clicked none of the mailings"
        },
        {
            "function": "FUNC_OPENED",
            "operator": "IN",
            "params": [
                "1234",
                "1234"
            ],
            "__comment": "2 supported operators: IN: clicked any of the mailings. NIN: clicked none of the mailings"
        },
        {
            "function": "FUNC_CLICKED",
            "operator": "IN",
            "params": [
                "1234",
                "1234"
            ],
            "__comment": "2 supported operators: IN: clicked any of the mailings. NIN: clicked none of the mailings"
        }, 
        {
            "function": "FUNC_REACTED",
            "operator": "IN",
            "params": [
                "1234",
                "1234"
            ],
            "__comment": "2 supported operators: IN: clicked/opened any of the mailings. NIN: clicked/opened none of the mailings"
        },
        {
            "function": "FUNC_NUM_SEND",
            "attribute": null,
            "operator": "GTE",
            "params": [
                "2013-02-02T12:12:12",
                "2013-02-02T12:12:12",
                "4"
            ]
        },
        {
            "function": "FUNC_DISTANCE_TO",
            "attribute": null,
            "operator": "LT",
            "params": [
                "45.125",
                "55.21",
                "4.5"
            ]
        }
    ],
    "listId": null
}

HTTP status code 200

Body

Media type: application/json

Type: object

Properties

id: required (integer)
name: required (string)
listId: (integer)

/filters/{id} get patch delete

get

Requires a valid JWT (JSON web token), which is granted by the server on login.

patch

Requires a valid JWT (JSON web token), which is granted by the server on login.

delete

Requires a valid JWT (JSON web token), which is granted by the server on login.

Request
Response

URI Parameters

id: required (string)

Headers

Authorization: required (string)
X-AuthToken

Body

Media type: application/json

Type: object

Properties

name: required (string)
sql: (string)
listId: required (integer)
operator: (one of AND, OR)
combine single selection functions
operations: (array of selection.SelectionOperation)
Items: SelectionOperation
- function: required (one of COL_OP, FUNC_ALL_SEND, FUNC_ANY_SEND, FUNC_SUBSCRIBED, FUNC_UNSUBSCRIBED, FUNC_OPENED, FUNC_CLICKED, FUNC_REACTED, FUNC_NUM_SEND)
- attribute: (integer)
- operator: required (one of EQ, NEQ, IN, NIN, GTE, GT, LT, LTE, IS_NULL, IS_NOT_NULL, BETWEEN, NOT_BETWEEN)
- params: required (array of string)

Example:

{
    "name": "Filter",
    "operator": "AND",
    "operations": [
        {
            "function": "COL_OP",
            "attribute": 1,
            "operator": "BETWEEN",
            "params": [
                "23",
                "23",
                "34"
            ]
        },
        {
            "function": "COL_OP",
            "attribute": 33,
            "operator": "BETWEEN",
            "params": [
                "2017-02-02T12:12:12",
                "2017-02-04T12:12:12"
                ],
            "__comment": "yyyy-MM-dd'T'hh:mm:ss - sixmail should be able to detect many formats, but it will return this one"
        },
        {
            "function": "COL_OP",
            "attribute": 2,
            "operator": "EQ",
            "params": [
                "mail@mail.de"
            ]
        },
        {
            "function": "COL_OP",
            "attribute": 2,
            "operator": "EQ",
            "params": [
                "mail@mail.de"
            ]
        },
        {
            "function": "FUNC_ANY_SEND",
            "operator": "IN",
            "params": [
                "1234",
                "1234",
                "1234",
                "1234"
            ],
            "__comment": "2 supported operators: IN: any given mailings were send. NIN: none of the given mailings were send "
        },
        {
            "function": "FUNC_ALL_SEND",
            "operator": "IN",
            "params": [
                "1234",
                "1234",
                "1234",
                "1234"
            ],
            "__comment": "2 supported operators: IN: all given mailings were send. NIN: not all or none of the given mailings were send "
        },

        {
            "function": "FUNC_SUBSCRIBED",
            "operator": "EQ",
            "params": [
                "1234"
            ],
            "__comment": "2 supported operators: EQ: subscribed in given lists. NEQ: not subscribed in given list. "
        },

        {
            "function": "FUNC_UNSUBSCRIBED",
            "operator": "EQ",
            "params": [
                "1234"
            ],
            "__comment": "2 supported operators: EQ: unsubscribed in given list. NEQ: not unsubscribed in given list."
        },
        {
            "function": "FUNC_CLICKED",
            "operator": "IN",
            "params": [
                "1234",
                "1234"
            ],
            "__comment": "2 supported operators: IN: clicked any of the mailings. NIN: clicked none of the mailings"
        },
        {
            "function": "FUNC_OPENED",
            "operator": "IN",
            "params": [
                "1234",
                "1234"
            ],
            "__comment": "2 supported operators: IN: clicked any of the mailings. NIN: clicked none of the mailings"
        },
        {
            "function": "FUNC_CLICKED",
            "operator": "IN",
            "params": [
                "1234",
                "1234"
            ],
            "__comment": "2 supported operators: IN: clicked any of the mailings. NIN: clicked none of the mailings"
        }, 
        {
            "function": "FUNC_REACTED",
            "operator": "IN",
            "params": [
                "1234",
                "1234"
            ],
            "__comment": "2 supported operators: IN: clicked/opened any of the mailings. NIN: clicked/opened none of the mailings"
        },
        {
            "function": "FUNC_NUM_SEND",
            "attribute": null,
            "operator": "GTE",
            "params": [
                "2013-02-02T12:12:12",
                "2013-02-02T12:12:12",
                "4"
            ]
        },
        {
            "function": "FUNC_DISTANCE_TO",
            "attribute": null,
            "operator": "LT",
            "params": [
                "45.125",
                "55.21",
                "4.5"
            ]
        }
    ],
    "listId": null
}

HTTP status code 200

Body

Media type: application/json

Type: object

Properties

id: required (integer)
name: required (string)
description: required (string)
sql: required (string)
operator: required (one of AND, OR)
combine single selection functions
mode: required (one of SIMPLE, SQL)
if sql, then only sql is available (sql is too complex to parse in simple mode)
operations: required (array of selection.SelectionOperation)
Items: SelectionOperation
- function: required (one of COL_OP, FUNC_ALL_SEND, FUNC_ANY_SEND, FUNC_SUBSCRIBED, FUNC_UNSUBSCRIBED, FUNC_OPENED, FUNC_CLICKED, FUNC_REACTED, FUNC_NUM_SEND)
- attribute: (integer)
- operator: required (one of EQ, NEQ, IN, NIN, GTE, GT, LT, LTE, IS_NULL, IS_NOT_NULL, BETWEEN, NOT_BETWEEN)
- params: required (array of string)

HTTP status code 401

Authentication problem (JWT not set / expired)

Body

Media type: application/json

Type: object

Properties

id: required (number)
description: required (string)

HTTP status code 403

Authentication valid, but permissions not suitable to access resource.

/filters/{id}/scroll get

get

requests a ticket for obtaining recipients.

Request
Response

URI Parameters

id: required (string)

Headers

Authorization: required (string)
X-AuthToken

Query Parameters

timeout: (integer - default: 900)
selections of recipients requires to assign server resources. This request tells the server how long it should assign the resources.
Example:
```
900
```

HTTP status code 200

the request was accepted.

Body

Media type: application/json

Type: object

Properties

id: required (string - pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$)
Universally Unique Identifier.
hits: required (integer)
ttl: required (integer)

HTTP status code 401

Authentication problem (JWT not set / expired)

Body

Media type: application/json

Type: object

Properties

id: required (number)
description: required (string)

HTTP status code 403

Authentication valid, but permissions not suitable to access resource.

HTTP status code 429

the scroll results are limited. this status code indicates, that the limit is reached.

/domains

/domains/{id} get patch delete

get

Requires a valid JWT (JSON web token), which is granted by the server on login.

patch

Requires a valid JWT (JSON web token), which is granted by the server on login.

delete

delete domain & subdomains from system.

/domains/{id}/subdomain/{subdomainId} get patch delete

get

Requires a valid JWT (JSON web token), which is granted by the server on login.

patch

Requires a valid JWT (JSON web token), which is granted by the server on login.

delete

delete domain & subdomains from system.

/module

/maintenance

/mailbox

/mailbox-labels

a label defines, how a specific mail is treated, if the label can be applied according to the given rules

/checks

/pages

/pages/{pageName} get post patch delete

get

get page

post

create a new page

patch

update a page

delete

delete a page

sixxmail API documentation version v1

/auth

/users

/roles

/lists

/selection-lists

/imports

/projects

/attributes

/recipients

/mailings

/server/mail/out

/settings

/filters

/domains

/module

/maintenance

/mailbox

/mailbox-labels

/checks

/pages

/dynamic/{pageName}

sixxmail API documentation version v1

/auth

post /auth/login

Body

HTTP status code 200

Body

HTTP status code 401

post /auth/logout

Headers

HTTP status code 200

HTTP status code 401

Body

HTTP status code 403

get /auth/refresh

Headers

HTTP status code 200

Body

HTTP status code 401

Body

HTTP status code 403

/users

get /users

Headers

Query Parameters

HTTP status code 200

Body

HTTP status code 401

Body

HTTP status code 403

post /users

Headers

Body

HTTP status code 201

Body

HTTP status code 401

Body

HTTP status code 403

get /users/{id}

URI Parameters

Headers

HTTP status code 200

Body

HTTP status code 401

Body

HTTP status code 403

patch /users/{id}

URI Parameters

Headers

Body

HTTP status code 200

Body

HTTP status code 401

Body

HTTP status code 403

delete /users/{id}

URI Parameters

Headers

HTTP status code 200

HTTP status code 401

Body

HTTP status code 403

post /users/{id}/roles/{id}

URI Parameters

Headers

HTTP status code 200

Body

HTTP status code 401

Body

HTTP status code 403

delete /users/{id}/roles/{id}

URI Parameters

Headers

HTTP status code 200

Body

HTTP status code 401

Body

HTTP status code 403

get /users/me

Headers

HTTP status code 200