Conversation

Conversation is used to show the messages on a MessageThread in the Inbox It houses info like the if the conversation is open or closed or how many unread messages are present. Conversation are automatically created when assigning a MessageThread to a Candidate

Endpoints

• GET /conversations - Retrieve a list of all Conversations.

• GET /conversations/{id} - Retrieve a specific Conversation by ID.

• PATCH /conversations/{id} - Update a specific Conversation by ID.

Attributes

Field	Type	Description
status	String	The status of the conversation. Can be open or closed
unreadMessages	Boolean	Indicates if there are unread messages in the conversation
unreadMessagesCount	Integer	The number of unread messages in the conversation.
messageThreadId	String	The MessageThread id that is associated with this conversation.
candidateId	String	The Candidate id that is associated with this conversation.
createdAt	DateTime	The date and time the conversation was created.
updatedAt	DateTime	The date and time the conversation was last updated.

HTTP Methods

Field	GET	PATCH
status	X	X
unreadMessages	X	X
unreadMessagesCount	X	X
messageThreadId	X
candidateId	X
createdAt	X
updatedAt	X

Patching a Conversation

unreadMessagesCount, status and unreadMessages will all automatically be updated by us (either due to inbox usage or messaging). We do allow you to update these fields but we will overwrite them with the correct values.

Example PATCH body

{
    "data": {
        "type": "conversations",
        "id": "uuid",
        "attributes": {
            "status": "closed"
        }
    }
}

OpenAPI