omnidesk
  • Ticket
    • Message
    • Using forms
    • Contact forms
  • Customers
    • General
    • API sync on contact
    • CSV import
    • API sync before contact
    • Customer lookup
  • Telephone
    • Callflow
    • Numbers
  • E-mail
  • Users
  • Live chat
    • Livechat chatbot and app integration (backend)
  • Facebook
  • Twitter
  • Survey
    • Push data
  • Statistics
    • Statistics API
  • Raw data - BI
  • Security policy
  • Hosting
  • API docs
    • General
    • Authentication
    • REST
  • API specification
    • Documentation for the Omnidesk API endpoints
    • Chat
    • Customer
    • Email
    • Form
    • Formfield
    • Message
    • Notification
    • Raw
    • Statisticsv2
    • Ticket
    • User
    • View
Powered by GitBook
On this page
  1. API specification

Email

PreviousCustomerNextForm

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

itemAddress

get

Returns this specific email address.

Authorizations
Path parameters
idnumberRequired
Responses
get
GET /api/v2/email/address/{id} HTTP/1.1
Host: {{base_url}}
apiKey: YOUR_API_KEY
Accept: */*
200Success
No content

itemAddress

delete

Permanently deletes this specific email address.

Authorizations
Path parameters
idnumberRequired
Responses
delete
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
Path parameters
idnumberRequired

ID of the message to download.

Responses
get
GET /api/v2/email/downloadMail/{id} HTTP/1.1
Host: {{base_url}}
apiKey: YOUR_API_KEY
Accept: */*
200Success
No content
  • POSTnewInboundMessage
  • GETaddress
  • POSTaddress
  • GETitemAddress
  • PUTitemAddress
  • DELETEitemAddress
  • GETitemDownloadMail

address

get

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

Authorizations
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
get
GET /api/v2/email/address HTTP/1.1
Host: {{base_url}}
apiKey: YOUR_API_KEY
Accept: */*
200Success
No content

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
Body
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
post
POST /api/v2/email/newInboundMessage HTTP/1.1
Host: {{base_url}}
apiKey: YOUR_API_KEY
Content-Type: multipart/form-data
Accept: */*
Content-Length: 323

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

address

post

Creates a new email address.

Authorizations
Body
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
post
POST /api/v2/email/address HTTP/1.1
Host: {{base_url}}
apiKey: YOUR_API_KEY
Content-Type: multipart/form-data
Accept: */*
Content-Length: 144

{
  "brand_id": 1,
  "email": "name@gmail.com",
  "reply_email": "name@gmail.com",
  "reply_email_title": "text",
  "is_primary": 1,
  "signature": "text",
  "group_id": 1
}
200Success
No content

itemAddress

put

Updates this specific email address.

Authorizations
Path parameters
idnumberRequired
Body
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
put
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: 174

"group_id=1&brand_id=''&email='name@gmail.com'&reply_email=''&reply_email_title='text'&is_primary=1&group_by_time=1&group_by_time_amount=1&signature='text'"
200Success
No content