Email

All the endpoints that can be called on the Email controller.

All these endpoints require the SETTINGS_CRUD permission, except for GET itemDownloadMail, which requires TICKET_READ

newInboundMessage

post

Creates a new inbound email message and decides if a new ticket is needed.

If you want to add multiple items to a request, just copy the keys and add indices to the empty square brackets.

Authorizations

apiKey

apiKeystringRequired

Body

multipart/form-data

messageIDstringOptional

The ID for the message to be created.

Only used to check if the message exists already with this brand ID.

Default: ""

externalIDstringOptional

External ID of the ticket.

Default: ""

subjectstringOptionalDefault: ""

htmlBodystringOptional

The HTML body of this message. This can just be a regular text as well.

Default: ""

referencesstring[]Optional

Use this if you want to reply to a thread as to make sure the application does not create a new ticket.

Default: []

attachmentsBase64arrayOptionalDefault: []

Responses

200Success

No content

post

/api/v2/email/newInboundMessage

HTTPcURLJavaScriptPython

POST /api/v2/email/newInboundMessage HTTP/1.1
Host: {{base_url}}
apiKey: YOUR_API_KEY
Content-Type: multipart/form-data
Accept: */*
Content-Length: 291

{
  "messageID": "",
  "externalID": "",
  "fromAddress": {
    "name": "",
    "address": ""
  },
  "replyToAddress": {
    "name": "",
    "address": ""
  },
  "toAddresses": [
    {
      "address": "text"
    }
  ],
  "ccAddresses": [
    {
      "address": "text"
    }
  ],
  "bccAddresses": [
    {
      "address": "text"
    }
  ],
  "subject": "",
  "htmlBody": "",
  "references": [
    "text"
  ],
  "attachmentsBase64": []
}

200Success

No content

address

get

Returns all email addresses with optional filters such as search queries, grouping and result limits.

Authorizations

apiKey

apiKeystringRequired

Query parameters

querystring · min: 1OptionalDefault: ""Pattern: ^[0-9a-zA-Z ]+$

itemStartnumberOptionalDefault: 0

itemLimitnumber · max: 99OptionalDefault: 15

groupByTimenumber · max: 99OptionalDefault: 1

groupByTimeAmountnumber · min: 1 · max: 999999OptionalDefault: 604800

Responses

200Success

No content

get

/api/v2/email/address

HTTPcURLJavaScriptPython

GET /api/v2/email/address HTTP/1.1
Host: {{base_url}}
apiKey: YOUR_API_KEY
Accept: */*

200Success

No content

address

post

Creates a new email address.

Authorizations

apiKey

apiKeystringRequired

Body

multipart/form-data

brand_idnumberRequired

emailstring · email · min: 1Required

reply_emailstring · email · min: 1Required

reply_email_titlestring · ^[a-zA-ZÀ-ÖØ-Þß-öø-ÿŠš\.\-\'', ]+$ · min: 1Optional

is_primarynumber · max: 1Required

signaturestring · max: 65535OptionalDefault: ""

group_idnumberOptionalDefault: 0

Responses

200Success

No content

post

/api/v2/email/address

HTTPcURLJavaScriptPython

POST /api/v2/email/address HTTP/1.1
Host: {{base_url}}
apiKey: YOUR_API_KEY
Content-Type: multipart/form-data
Accept: */*
Content-Length: 140

{
  "brand_id": 1,
  "email": "[email protected]",
  "reply_email": "[email protected]",
  "reply_email_title": "text",
  "is_primary": 1,
  "signature": "",
  "group_id": 0
}

200Success

No content

itemAddress

get

Returns this specific email address.

Authorizations

apiKey

apiKeystringRequired

Path parameters

idnumberRequired

Responses

200Success

No content

get

/api/v2/email/address/{id}

HTTPcURLJavaScriptPython

GET /api/v2/email/address/{id} HTTP/1.1
Host: {{base_url}}
apiKey: YOUR_API_KEY
Accept: */*

200Success

No content

itemAddress

put

Updates this specific email address.

Authorizations

apiKey

apiKeystringRequired

Path parameters

idnumberRequired

Body

application/x-www-form-urlencoded

group_idnumberOptionalDefault: 0

brand_idnumberRequired

emailstring · email · min: 1Required

reply_emailstring · email · min: 1Required

reply_email_titlestring · min: 1OptionalPattern: ^[a-zA-ZÀ-ÖØ-Þß-öø-ÿŠš\.\-\', ]+$

is_primarynumber · max: 1Required

group_by_timenumber · max: 99OptionalDefault: 0

group_by_time_amountnumber · max: 999999OptionalDefault: 0

signaturestring · max: 65535OptionalDefault: ""

Responses

200Success

No content

put

/api/v2/email/address/{id}

HTTPcURLJavaScriptPython

PUT /api/v2/email/address/{id} HTTP/1.1
Host: {{base_url}}
apiKey: YOUR_API_KEY
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 170

"group_id=0&brand_id=''&email='[email protected]'&reply_email=''&reply_email_title='text'&is_primary=1&group_by_time=0&group_by_time_amount=0&signature=''"

200Success

No content

itemAddress

delete

Permanently deletes this specific email address.

Authorizations

apiKey

apiKeystringRequired

Path parameters

idnumberRequired

Responses

200Success

No content

delete

/api/v2/email/address/{id}

HTTPcURLJavaScriptPython

DELETE /api/v2/email/address/{id} HTTP/1.1
Host: {{base_url}}
apiKey: YOUR_API_KEY
Accept: */*

200Success

No content

itemDownloadMail

get

Downloads a specific email based on its message ID.

Authorizations

apiKey

apiKeystringRequired

Path parameters

idnumberRequired

ID of the message to download.

Responses

200Success

No content

get

/api/v2/email/downloadMail/{id}

HTTPcURLJavaScriptPython

GET /api/v2/email/downloadMail/{id} HTTP/1.1
Host: {{base_url}}
apiKey: YOUR_API_KEY
Accept: */*

200Success

No content