Composer defaults: requester (to) and people in copy, reply subject with [#N], mailbox and signature (desk:read, agent role)
GET /api/desk/v1/items/{ref}/mail/defaults
Module: Desk · operationId: getItemMailDefaults · Tag: Mail · Auth: access token (Authorization: Bearer <accessToken>)
Without parameters the defaults of an answer to the customers (public mails only). replyTo answers a mail of the ticket: an internal mail to or from third parties gives its sender (to) and its other recipients (cc) without own mailboxes and participants, the subject "Re: …" without token and visibility internal. visibility=internal starts a new internal mail to third parties (no recipients).
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
replyTo |
query | string | Entry id of the mail answered | |
visibility |
query | string | (one of public, internal) |
|
ref |
path | string | yes | Item id or number |
Responses
- 200 Defaults (
application/json) - 400 replyTo is no mail of the ticket, or an unknown visibility (code invalid)
- 422 public answer to an internal mail (internal_thread), internal answer to a customer mail (public_thread)
Fields of the 200 answer:
cc(array of Address): Recipients in copy (participants)address(string): E-mail addressname(string): Display name (may be empty)
inReplyToEntryId(string): The mail answered (replyTo)mailboxId(string): Default mailbox of the spacemailboxes(array of object): Mailboxes the mail can be sent frommailboxId(string): comms mailbox idname(string): Name of the mailbox
signature(AgentSignature)body(string): Markdownenabled(boolean): Whether the signature is added to new mailsupdatedAt(string (date-time), read-only): When the signature was last saveduserRef(string, read-only): Login (e-mail) of the agent
subject(string): Reply subject with the [#N] tokento(array of Address): Recipients (the requester)address(string): E-mail addressname(string): Display name (may be empty)
visibility(string): internal for a new internal mail to third parties or an answer to one (one ofpublic,internal)
Example 200 answer:
{
"cc": [],
"mailboxId": "3f0a1b2c-4d5e-4f6a-9b8c-0d1e2f3a4b01",
"mailboxes": [
{
"mailboxId": "3f0a1b2c-4d5e-4f6a-9b8c-0d1e2f3a4b01",
"name": "support@muster-it.example"
}
],
"signature": {
"body": "Viele Grüße\nSophie Huber",
"enabled": true,
"updatedAt": "2026-09-01T08:00:00Z",
"userRef": "sophie.huber@muster-it.example"
},
"subject": "[#1] WLAN in den Gästezimmern 2. OG fällt immer wieder aus",
"to": [
{
"address": "katrin.stadler@alpenhotel-seeblick.example",
"name": "Katrin Stadler"
}
],
"visibility": "public"
}
Example request
curl -X GET 'https://api.mbcom.cloud/api/desk/v1/items/string/mail/defaults' \
-H "Authorization: Bearer $ACCESS_TOKEN"