Skip to main content

Documentation Index

Fetch the complete documentation index at: https://ekso.dev/llms.txt

Use this file to discover all available pages before exploring further.

Sample shape for ConfigTicket.

​
Sample JSON

Copy, edit, paste. Server-set fields (id, created, tenantId, …) are omitted from the example — they’re populated by the server on response. 
{
  "name": "Example name",
  "mailboxId": "<mailbox_id>",
  "containerId": "<container_id>",
  "processId": "<process_id>",
  "ackTemplateSubject": "example",
  "ackTemplateBody": "example",
  "replyTemplateSubject": "example",
  "replyTemplateBody": "example",
  "startFrom": "2026-04-29T14:30:00Z",
  "startFromUid": 0,
  "domainList": [
    "example"
  ],
  "domainListType": "<ticket-domain-list-type>"
}

​
Fields

FieldTypeRequiredNotes
entitystring • nullableServer-setSet by the server. Read-only on writes.
namestringRequired
mailboxIdstringRequired
containerIdstringRequired
processIdstringRequired
ackTemplateSubjectstringRequired
ackTemplateBodystringRequired
replyTemplateSubjectstringRequired
replyTemplateBodystringRequired
startFromstring (date-time)Required
startFromUidintegerOptional
domainListarray<string>Optional
domainListTypeTicketDomainListTypeOptional
tenantIdstringServer-setSet by the server. Read-only on writes.
idstringServer-setSet by the server. Read-only on writes.
createdstring (date-time)Server-setSet by the server. Read-only on writes.
createdBystringServer-setSet by the server. Read-only on writes.
updatedstring (date-time)Server-setSet by the server. Read-only on writes.
updatedBystringServer-setSet by the server. Read-only on writes.
deletedbooleanServer-setSet by the server. Read-only on writes.

​
Used by

​
Request body

  • POST /api/mail/ticketing
  • PUT /api/mail/ticketing/{id}

​
Response body

  • GET /api/mail/ticketing/{id}
  • GET /api/mail/ticketing

​
CLI

ekso mail-ticketing — see the command branches page for available verbs. Body for create / update verbs typically passed via --data @file.json matching the sample JSON above.