latestOpenAPI 3.0.02026-08-232861531.0 MB

d3c75c2a2f1d

chatActivities

Assign or Close

put/chatActivities/{chatActivityId}

Path parameters

chatActivityIdstring required

Request body

statusstring[] required

status

assigneestring

ID of a Staff user or provider to whom the chat will be assigned. If status is "assigned", there must be either an "assignee" or a "groupAssignee"

groupAssigneestring

ID of a Group to whom the chat will be assigned. If status is "assigned", there must be either an "assignee" or a "groupAssignee"

statusReasonstring

ID of a ChatActivityStatusReason to specify why a chat was closed. When status is closed, this field is mandatory, and sometimes the "description" is also mandatory.

descriptionstring

Description associated with a ChatActivityStatusReason to specify why a chat was closed. Some ChatActivitiesStatusReasons require a description.

Response

ChatActivity updated

_idstring

Luma's internal ID of an object.

userstring

The ID of the root account user.

deleted0 | 1

Flag for logical deletion where 1 means deleted.

createdBystring

The ID of the user who created this object.

updatedBystring

The ID of the user who updated this object.

createdAtstring date-time

The date/time when this object was created.

updatedAtstring date-time

The date/time when this object was updated.

lastMessagestring

ID of Message

status'closed' | 'assigned' | 'unassigned'

status

groupAssigneestring

ID of Group

previousAssigneestring

ID of User

previousGroupAssigneestring

ID of Group

statusReasonstring

ID of a ChatActivityStatusReason, only used when status is "closed"

descriptionstring

Additional description of the statusReason. Some ChatActivityStatusReasons require a description.

facilitiesstring[]

List of facilities where the patient linked to this chatActivity has appointments.

priorityUpdatedAtstring date-time

This date/time changes only when the chat is assigned or the patient gets a messsage. It can be used to sort the chatActivities on screen.

lastIrregularAtstring date-time

Indicates the last time an unexpected message was sent in the chat. An example is when patient gets an automated appointment reminder requesting to answer YES to confirm or NO to cancel, and patient replies with a completely different message.

automatedboolean

Indicates if this chatActivity was created as a consequence of an automated message being sent out, such as an appointment reminder.