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

apikeyAuth

HTTPRequired

Body

multipart/form-data

messageIDstringOptional

type: string = ' '

The ID for the message to be created. Only used to check if the message exists already with this brand ID.

externalIDstringOptional

type: string = ' '

External ID of the ticket.

fromAddress[name]stringOptional

type: string = ' '

The name of where the email is being sent from.

fromAddress[address]stringOptional

type: string = ' '

The address where the email is being sent from.

replyToAddress[name]stringOptional

type: string = ' '

Alternative to fromAddress[name] if it is a reply.

replyToAddress[address]stringOptional

type: string = ' '

Alternative to fromAddress[address] if it is a reply.

toAddresses[][address]stringOptional

type: string

The address where this message is being sent to.

ccAddresses[][address]stringOptional

type: string = null

The CC address where this message is being sent to.

bccAddresses[][address]stringOptional

type: string = null

The BCC address where this message is being sent to.

subjectstringOptional

type: string = null

The subject of the message.

htmlBodystringOptional

type: string = null

The HTML body of this message. If you use this one, do not use plainTextBody as well.

plainTextBodystringOptional

type: string = null

The plain text body of this message. If you use this one, do not use htmlBody as well.

references[]stringOptional

type: string = null

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

attachmentsBase64[0][fileCID]stringOptional

type: string = null

attachmentsBase64[0][fileName]stringOptional

type: string = null

attachmentsBase64[0][fileType]stringOptional

type: string = null

attachmentsBase64[0][fileExtension]stringOptional

type: string = null

attachmentsBase64[0][fileBase64Content]stringOptional

type: string = null

Responses

200

Successful response

application/json

post/api/v2/email/newInboundMessage

HTTPcURLJavaScriptPython

POST /api/v2/email/newInboundMessage HTTP/1.1
Host: {{base_url}}
Authorization: apikey YOUR_SECRET_TOKEN
Content-Type: multipart/form-data
Accept: */*
Content-Length: 550

{
  "messageID": "text",
  "externalID": "text",
  "fromAddress[name]": "text",
  "fromAddress[address]": "text",
  "replyToAddress[name]": "text",
  "replyToAddress[address]": "text",
  "toAddresses[][address]": "text",
  "ccAddresses[][address]": "text",
  "bccAddresses[][address]": "text",
  "subject": "text",
  "htmlBody": "text",
  "plainTextBody": "text",
  "references[]": "text",
  "attachmentsBase64[0][fileCID]": "text",
  "attachmentsBase64[0][fileName]": "text",
  "attachmentsBase64[0][fileType]": "text",
  "attachmentsBase64[0][fileExtension]": "text",
  "attachmentsBase64[0][fileBase64Content]": "text"
}

200

Successful response

address

get

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

Authorizations

apikeyAuth

HTTPRequired

Responses

200

Successful response

application/json

get/api/v2/email/address

HTTPcURLJavaScriptPython

GET /api/v2/email/address HTTP/1.1
Host: {{base_url}}
Authorization: apikey YOUR_SECRET_TOKEN
Accept: */*

200

Successful response

address

post

Creates a new email address.

Authorizations

apikeyAuth

HTTPRequired

Body

multipart/form-data

brand_idstringOptional

type: number

emailstringOptional

type: string

Has to be a valid email address format.

reply_emailstringOptional

type: string

Has to be a valid email address format.

reply_email_titlestringOptional

type: ^[a-zA-ZÀ-ÖØ-Þß-öø-ÿŠš\.\-\', ]+$ = null

is_primarystringOptional

type: ^[0,1]$

signaturestringOptional

type: string = ' '

group_idstringOptional

type: number = 0

Responses

200

Successful response

application/json

post/api/v2/email/address

HTTPcURLJavaScriptPython

POST /api/v2/email/address HTTP/1.1
Host: {{base_url}}
Authorization: apikey YOUR_SECRET_TOKEN
Content-Type: multipart/form-data
Accept: */*
Content-Length: 139

{
  "brand_id": "text",
  "email": "text",
  "reply_email": "text",
  "reply_email_title": "text",
  "is_primary": "text",
  "signature": "text",
  "group_id": "text"
}

200

Successful response

itemAddress

get

Returns this specific email address.

Authorizations

apikeyAuth

HTTPRequired

Path parameters

idstringRequired

Responses

200

Successful response

application/json

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

HTTPcURLJavaScriptPython

GET /api/v2/email/address/{id} HTTP/1.1
Host: {{base_url}}
Authorization: apikey YOUR_SECRET_TOKEN
Accept: */*

200

Successful response

itemAddress

put

Updates this specific email address.

Authorizations

apikeyAuth

HTTPRequired

Path parameters

idstringRequired

Body

application/x-www-form-urlencoded

group_idstringOptional

type: number = 0

brand_idstringOptional

type: number

emailstringOptional

type: string

Has to be a valid email address format.

reply_emailstringOptional

type: string

Has to be a valid email address format.

reply_email_titlestringOptional

type: ^[a-zA-ZÀ-ÖØ-Þß-öø-ÿŠš\.\-\', ]+$ = null

is_primarystringOptional

type: ^[0,1]$

group_by_timestringOptional

type: number = 0

group_by_time_amountstringOptional

type: number = 0

signaturestringOptional

type: string = ' '

Responses

200

Successful response

application/json

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

HTTPcURLJavaScriptPython

PUT /api/v2/email/address/{id} HTTP/1.1
Host: {{base_url}}
Authorization: apikey YOUR_SECRET_TOKEN
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 192

"group_id='text'&brand_id='text'&email='text'&reply_email='text'&reply_email_title='text'&is_primary='text'&group_by_time='text'&group_by_time_amount='text'&signature='text'"

200

Successful response

itemAddress

delete

Permanently deletes this specific email address.

Authorizations

apikeyAuth

HTTPRequired

Path parameters

idstringRequired

Responses

200

Successful response

application/json

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

HTTPcURLJavaScriptPython

DELETE /api/v2/email/address/{id} HTTP/1.1
Host: {{base_url}}
Authorization: apikey YOUR_SECRET_TOKEN
Accept: */*

200

Successful response

itemDownloadMail

get

Downloads a specific email based on its message ID.

Authorizations

apikeyAuth

HTTPRequired

Path parameters

idstringRequired

ID of the message to download.

Responses

200

Successful response

application/json

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

HTTPcURLJavaScriptPython

GET /api/v2/email/downloadMail/{id} HTTP/1.1
Host: {{base_url}}
Authorization: apikey YOUR_SECRET_TOKEN
Accept: */*

200

Successful response