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
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.
type: string = ' '
The ID for the message to be created. Only used to check if the message exists already with this brand ID.
type: string = ' '
External ID of the ticket.
type: string = ' '
The name of where the email is being sent from.
type: string = ' '
The address where the email is being sent from.
type: string = ' '
Alternative to fromAddress[name] if it is a reply.
type: string = ' '
Alternative to fromAddress[address] if it is a reply.
type: string
The address where this message is being sent to.
type: string = null
The CC address where this message is being sent to.
type: string = null
The BCC address where this message is being sent to.
type: string = null
The subject of the message.
type: string = null
The HTML body of this message. If you use this one, do not use plainTextBody as well.
type: string = null
The plain text body of this message. If you use this one, do not use htmlBody as well.
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.
type: string = null
type: string = null
type: string = null
type: string = null
type: string = null
Successful response
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"
}Successful response
Returns all email addresses with optional filters such as search queries, grouping and result limits.
Successful response
GET /api/v2/email/address HTTP/1.1
Host: {{base_url}}
Authorization: apikey YOUR_SECRET_TOKEN
Accept: */*
Successful response
Creates a new email address.
type: number
type: string
Has to be a valid email address format.
type: string
Has to be a valid email address format.
type: ^[a-zA-ZÀ-ÖØ-Þß-öø-ÿŠš\.\-\', ]+$ = null
type: ^[0,1]$
type: string = ' '
type: number = 0
Successful response
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"
}Successful response
Returns this specific email address.
Successful response
GET /api/v2/email/address/{id} HTTP/1.1
Host: {{base_url}}
Authorization: apikey YOUR_SECRET_TOKEN
Accept: */*
Successful response
Updates this specific email address.
type: number = 0
type: number
type: string
Has to be a valid email address format.
type: string
Has to be a valid email address format.
type: ^[a-zA-ZÀ-ÖØ-Þß-öø-ÿŠš\.\-\', ]+$ = null
type: ^[0,1]$
type: number = 0
type: number = 0
type: string = ' '
Successful response
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'"Successful response
Permanently deletes this specific email address.
Successful response
DELETE /api/v2/email/address/{id} HTTP/1.1
Host: {{base_url}}
Authorization: apikey YOUR_SECRET_TOKEN
Accept: */*
Successful response
Downloads a specific email based on its message ID.
ID of the message to download.
Successful response
GET /api/v2/email/downloadMail/{id} HTTP/1.1
Host: {{base_url}}
Authorization: apikey YOUR_SECRET_TOKEN
Accept: */*
Successful response
Last updated