Sign in

v1

latestOpenAPI 3.1.02026-07-23310383.1 KB
Chat Message Follow-Ups

Retrieves multiple chat message follow-ups.

get/api/v1/chat-message-follow-ups

Query parameters

string[]
OR
string uuid

A UUID v4 string that identifies an entity.

string[]
OR
string uuid

A UUID v4 string that identifies an entity.

pageNumbernumber

The page number.

The page number.

pageSizenumber

The page size.

The page size.

string[]
OR
'pending' | 'sent' | 'failed' | 'cancelled'

The current status of the follow-up.

string[]
OR
string uuid

A UUID v4 string that identifies an entity.

Headers

authorizationstring required

The API key to use for authentication. Can be created in the api keys section on the workspace settings page.

The API key to use for authentication. Can be created in the api keys section on the workspace settings page.

Response

Retrieves all chat message follow-ups for the specified filters.

createdAtstring date-time required
idstring uuid required

A UUID v4 string that identifies an entity.

updatedAtstring date-time required
chatIdstring uuid required

The id of the chat this follow-up belongs to.

chatMessageIdstring uuid nullable required

The id of the chat message this follow-up belongs to.

dueDatestring date-time required

The date and time when the follow-up message should be sent.

finishedAtstring date-time nullable required

The date and time when the follow-up went from pending to any other status.

messagestring required

The follow-up message content.

reasonstring nullable required

The reason why the follow-up failed.

status'pending' | 'sent' | 'failed' | 'cancelled' required

The current status of the follow-up.

triggerChatMessageIdstring uuid required

The id of the chat message that triggered the follow-up.