# Chat

The `chat` object contains the following attributes:

<table><thead><tr><th width="177">Field Name</th><th width="174">Data Type</th><th>Description</th></tr></thead><tbody><tr><td><code>id</code></td><td>string</td><td><p>A unique identifier for the chat. </p><p>Example: CHT-1111-2222-3333</p></td></tr><tr><td><code>revision</code></td><td>uint</td><td>The revision number of the chat. </td></tr><tr><td><code>icon</code></td><td>string</td><td>The icon for the group and channel.</td></tr><tr><td><code>name</code></td><td>string</td><td><p>The chat name. </p><p>Required for <code>channel</code> chats, optional for <code>group</code> chats. For  <code>case</code> chats, the name is automatically generated from a truncated version of the first message in the support conversation.<br>This field is invalid for <code>direct</code> chats. </p><p>Example: “SoftwareOne news!”</p></td></tr><tr><td><code>description</code></td><td>string</td><td><p>The chat description. </p><p>Required for <code>channel</code> chats and optional for <code>group</code> chats. This field is invalid for any other chat type.</p></td></tr><tr><td><code>type</code></td><td>string</td><td> The type of chat. Allowed values are <code>direct</code>, <code>group</code>, <code>case</code>, or <code>channel</code>.</td></tr><tr><td><code>participants</code></td><td>object</td><td><p>The chat <a href="#participant"><code>participant</code></a>. This field can be used to set the participants when creating a chat. </p><p>Example:</p><pre class="language-json" data-overflow="wrap" data-line-numbers><code class="lang-json">[
  {
    "id": "CPT-1234-5678-9999",
    "role": "Admin",
    "status": "Active",
    "audit": {
      "created": {
        "at": "timestamp",
        "by": "{ IdentityQueryModel }"
     }
  }
]
</code></pre></td></tr><tr><td><code>lastMessage</code></td><td>object</td><td><p>The latest <a href="#message-object"><code>message</code></a> in the chat sent by any participant. This field can be used to create an opening message when creating a chat. </p><p>Example:</p><pre class="language-json" data-overflow="wrap" data-line-numbers><code class="lang-json">{
  "id": "CMG-1234-5678-9999-XXXXX",
  "content": "string",
  "audit": {
    "created": {
      "at": "timestamp",
      "by": "{ IdentityQueryModel }"
  }
}
</code></pre></td></tr><tr><td><code>links</code></td><td>object</td><td>The <a href="#link-object"><code>link</code></a> for this chat.</td></tr><tr><td><code>attachments</code></td><td>object</td><td>The <a href="#attachment-object"><code>attachment</code></a> for this chat</td></tr><tr><td><code>audit</code></td><td>object</td><td>A reference to the <a href="../common-api-objects/audit"><code>audit</code></a> object.</td></tr></tbody></table>

### Participant object <a href="#participant-object" id="participant-object"></a>

This object contains the following attributes:

<table><thead><tr><th width="204">Field Name</th><th width="192">Data Type</th><th>Description</th></tr></thead><tbody><tr><td><code>id</code></td><td>string</td><td><p>The ID of the participant. </p><p>Example: CPT-1111-2222-3333</p></td></tr><tr><td><code>chat</code></td><td>chat</td><td><p>Chat parent object. </p><p>Example:</p><pre class="language-json" data-overflow="wrap" data-line-numbers><code class="lang-json">{
  "id": "CHT-1111-2222-3333",
  "status": "Active|Archived",
  "type": "Private|Group|Case|Channel"
},
</code></pre></td></tr><tr><td><code>status</code></td><td>string</td><td>Can only be set  <code>exited</code> in chats that are not <code>direct</code>. <code>deactivated</code> is a special state for exited participants where the user is no longer active on the platform, to ensure their participant state is never transitioned back to <code>active</code>. </td></tr><tr><td><code>contact</code></td><td>object</td><td>The <a href="../notifications-api/contacts"><code>contact</code></a> entity from the notifications API forms the primary mechanism for identifying chat participants. </td></tr><tr><td><code>identity</code></td><td>identity</td><td><p>Platform identity model. The property exists on the <code>participant</code> object only as a convenience and is calculated from the identity property of the referenced <code>contact</code> object. </p><p>Example:</p><pre class="language-json" data-overflow="wrap" data-line-numbers><code class="lang-json">{
  "id": "USR-0000-0001",
  "name": "string",
  "icon": "optional string",
  "type": "User|ApiToken|Extension|Service"
}
</code></pre></td></tr><tr><td><code>account</code></td><td>object</td><td><p>Platform <a href="../accounts-api/account"><code>account</code></a> model. It is only provided during participant creation when a provided contact has multiple account contexts. In most circumstances, it is derived automatically from <code>contact</code>. </p><p>Example:</p><pre class="language-json" data-overflow="wrap" data-line-numbers><code class="lang-json">{
  "id": "ACC-0000-0000-0001",
  "status": "Active|Enabled|Disabled",
  "type": "Client|Vendor|Operations"
}
</code></pre></td></tr><tr><td><code>lastReadMessage</code></td><td><a href="#message-object">message</a></td><td><p>If set, this field represents the last message seen by this user. It can be the same as latest message if user is up to date with chat. </p><p>Example:</p><pre class="language-json" data-overflow="wrap" data-line-numbers><code class="lang-json">{
  "id": "CMG-1234-5678-9999-XXXXX",
  "content": "string",
  "audit": {
    "created": {
      "at": "timestamp",
      "by": "{ IdentityQueryModel }"
  }
}
</code></pre></td></tr><tr><td><code>unread</code></td><td>integer</td><td><p>Calculated field. It represents the count of messages appended to the chat since the <code>lastReadMessage</code>. When a participant performs an action that changes any chat state, this will be reset to zero for that participant. It can also be reset by a put operation that changes the <code>lastReadMessage</code> reference. </p><p>Example: 27</p></td></tr><tr><td><code>audit</code></td><td>object</td><td>A reference to the <a href="../common-api-objects/audit"><code>audit</code></a> object.</td></tr><tr><td><code>muted</code></td><td>boolean</td><td>Flag indicating whether participant should be notified of new messages in the chat. Example: true</td></tr></tbody></table>

### Message object

This object contains the following attributes:

<table><thead><tr><th width="203">Field Name</th><th width="205">Data Type</th><th>Description</th></tr></thead><tbody><tr><td><code>id</code></td><td>string</td><td><p>The ID of the chat message. The first three sections are derived from the chat ID. The last section (length 5) supports up to 100,000 messages. For additional performance, this field could be separated from the clustered index in the database. </p><p>Example: CMG-1111-2222-3333-99999</p></td></tr><tr><td><code>chat</code></td><td>object</td><td><p>A reference to the <code>chat</code> object. </p><p>Example:</p><pre class="language-json" data-overflow="wrap" data-line-numbers><code class="lang-json">{
  "id": "CHT-1111-2222-3333",
  "status": "Active|Archived",
  "type": "Private|Group|Case|Channel"
}
</code></pre></td></tr><tr><td><code>sender</code></td><td>object</td><td><p>The <a href="#participant-object"><code>participant</code></a> that sent this message. </p><p>Example:</p><pre class="language-json" data-overflow="wrap" data-line-numbers><code class="lang-json">{
  "id": "CPT-345-678",
  "status": "Active",
  "role": "Contributor"
}
</code></pre></td></tr><tr><td><code>content</code></td><td>string</td><td><p>The body of the message. Can contain any Markdown supported by the UI, as well as special markup for links to platform objects. </p><p>Example: <code>Please find attached &#x3C;form id=”FRm-1234-5678 display=”Order details”/></code></p></td></tr><tr><td><code>visibility</code></td><td>string</td><td>Allowed values:  <code>public</code> or <code>private</code>. <code>private</code> means that it's visible only to users within the same account. In the context of a <code>channel</code>, these statuses can be interpreted as <code>draft</code> (<code>private</code>) and <code>published</code> (<code>public</code>).</td></tr><tr><td><code>isDeleted</code></td><td>bool</td><td>Soft delete state. The message is hidden going forward but may have already been seen by users. Deleting a message does not delete associated attachments or links. Soft-deleted messages are still returned by the API but contain no content.</td></tr><tr><td><code>links</code></td><td><a href="#link-object">link</a></td><td><p>Gets the links for this message. </p><p>Example:</p><pre class="language-json" data-overflow="wrap" data-line-numbers><code class="lang-json">[
  {
    "id": "LNK-0011-1233",
    "objectId": "HAT-345-678",
    "name": "certificate.pdf",
    "icon": "",
    "url": "/v1/helpdesk/chats/CHT-2601-7865-9618/attachments/HAT-1234-4567"
  },
  {
    "id": "LNK-1111-1233",
    "objectId": "AGR-345-678",
    "name": "E2E Seeded For Commerce",
    "type": "Agreement",
    "icon": "",
    "url": "/v1/commerce/agreements/AGR-345-678"
  },
  {
    "id": "LNK-2222-1233",
    "objectId": "HAN-345-678",
    "name": "",
    "icon": "",
  },
  {
    "id": "LNK-0123-1233",
    "objectId": "",
    "name": "Google",
    "icon": "", // we could get with favicon?
    "url": "www.google.com"
  }
]
</code></pre></td></tr><tr><td><code>audit</code></td><td>object</td><td>A reference to the <a href="../common-api-objects/audit"><code>audit</code></a> object. For system messages, <code>created.by</code> is <code>null</code> whereas <code>created.at</code> contains a value.</td></tr></tbody></table>

### Link object

This object contains the following attributes:

<table><thead><tr><th width="203">Field</th><th width="216">Type</th><th>Description</th></tr></thead><tbody><tr><td><code>id</code></td><td>string</td><td><p>The ID of the link. </p><p>Example: LNK-1111-2222-3333</p></td></tr><tr><td><code>chat</code></td><td>object</td><td><p>The linked <a href="chat"><code>chat</code></a> object. </p><p>Example:</p><pre class="language-json" data-overflow="wrap" data-line-numbers><code class="lang-json">{
  "id": "CHT-1111-2222-3333",
  "status": "Active|Archived",
  "type": "Private|Group|Case|Channel"
}
</code></pre></td></tr><tr><td><code>message</code></td><td>object </td><td>The <a href="#message-object"><code>message</code></a> object that this <code>link</code> object links to.</td></tr><tr><td><code>url</code></td><td>string</td><td>The URL provided by the user.</td></tr><tr><td><code>objectId</code></td><td>string</td><td><p>When <code>objectId</code> is provided, the FE attempts to extract the corresponding <code>platformEntity</code> and create a proper link.<br>To do this, it calls the <a href="../audit-api">Audit API</a> to locate the entity:</p><p><code>https://portal.s1.today/public/v1/audit/records?eq(object.id,PRD-2245-6484)</code><br>(ordered by latest record and limited to 1 result).</p><p>If found, the returned object should include <code>{ id, name, icon }</code>, where applicable.</p></td></tr><tr><td><code>icon</code></td><td>string</td><td>Calculated by the FE when adding a link.</td></tr><tr><td><code>name</code></td><td>string</td><td>Calculated by the FE when not provided by the user.</td></tr><tr><td><code>isDeleted</code></td><td>boolean</td><td>Soft delete property.</td></tr><tr><td><code>audit</code></td><td>object</td><td>A reference to the <a href="../common-api-objects/audit"><code>audit</code></a> object.</td></tr></tbody></table>

### Attachment object <a href="#attachment-object" id="attachment-object"></a>

This object contains the following attributes:

<table><thead><tr><th width="198"></th><th width="218"></th><th></th></tr></thead><tbody><tr><td><code>id</code></td><td>string</td><td>The ID of the <code>attachment</code> object. Example: ATC-1111-2222-3333</td></tr><tr><td><code>chat</code></td><td>object</td><td><p>The ID of the <a href="chat"><code>chat</code></a> object. </p><p>Example:</p><pre class="language-json" data-overflow="wrap" data-line-numbers><code class="lang-json">{
  "id": "CHT-1111-2222-3333",
  "status": "Active|Archived",
  "type": "Private|Group|Case|Channel"
}
</code></pre></td></tr><tr><td><code>message</code></td><td>object </td><td>The <a href="#message-object"><code>message</code></a> object that this attachment links to.</td></tr><tr><td><code>isDeleted</code></td><td>bool</td><td>Soft delete state. It does not prevent users from having seen the message in the past; it only affects visibility going forward.</td></tr><tr><td><code>fileId</code></td><td>string</td><td><p>The ID of file metadata. </p><p>Example: FIL-1111-2222-3333</p></td></tr><tr><td><code>filename</code></td><td>string</td><td><p>The name of the file. Not Read-only because it doesn’t affect the stored file, only the content-disposition if the file is downloaded. </p><p>Example: prod-passwords-lol.txt</p></td></tr><tr><td><code>contentType</code></td><td>string</td><td><p>Attachment MIME type. Read-only; set automatically when the attachment is uploaded. </p><p>Example: application/vnd.ms-excel</p></td></tr><tr><td><code>size</code></td><td>integer</td><td><p>Size of attachment in bytes. Read-only; set automatically when the attachment is uploaded. </p><p>Example: 123,456</p></td></tr><tr><td><code>audit</code></td><td>object</td><td>A reference to the <a href="../common-api-objects/audit"><code>audit</code></a> object. The <code>created</code> audit property is used to find the message sender and timestamp. For system messages,  <code>null</code> is used.</td></tr></tbody></table>


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.platform.softwareone.com/developer-resources/rest-api/helpdesk-api/chat.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.