Chat Message Follow Ups

get

Retrieves multiple chat message follow-ups.

Query parameters

chatIdsany ofOptionalDefault: []

string · uuid[]Optional

A UUID v4 string that identifies an entity.

or

string · uuidOptional

A UUID v4 string that identifies an entity.

chatMessageIdsany ofOptionalDefault: []

string · uuid[]Optional

A UUID v4 string that identifies an entity.

or

string · uuidOptional

A UUID v4 string that identifies an entity.

pageNumbernumber · min: 1Optional

The page number.

Default: 1

pageSizenumber · min: 1 · max: 100Optional

The page size.

Default: 10

statusesany ofOptionalDefault: []

or

string · enumOptional

The current status of the follow-up.

Possible values:

triggerChatMessageIdsany ofOptionalDefault: []

string · uuid[]Optional

A UUID v4 string that identifies an entity.

or

string · uuidOptional

A UUID v4 string that identifies an entity.

Header parameters

authorizationstringRequired

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

Responses

200

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

application/json

createdAtstring · date-timeRequired

idstring · uuidRequired

A UUID v4 string that identifies an entity.

updatedAtstring · date-timeRequired

chatIdstring · uuidRequired

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

chatMessageIdstring · uuid · nullableRequired

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

dueDatestring · date-timeRequired

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

finishedAtstring · date-time · nullableRequired

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

messagestring · min: 1Required

The follow-up message content.

reasonstring · nullableRequired

The reason why the follow-up failed.

statusstring · enumRequired

The current status of the follow-up.

Possible values:

triggerChatMessageIdstring · uuidRequired

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

401

Unauthorized.

application/json

get

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

HTTPcURLJavaScriptPython

GET /api/v1/chat-message-follow-ups HTTP/1.1
Host: api.endless.zaia.app
authorization: text
Accept: */*

[
  {
    "createdAt": "2026-06-11T20:41:14.722Z",
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "updatedAt": "2026-06-11T20:41:14.722Z",
    "chatId": "123e4567-e89b-12d3-a456-426614174000",
    "chatMessageId": "123e4567-e89b-12d3-a456-426614174000",
    "dueDate": "2026-06-11T20:41:14.722Z",
    "finishedAt": "2026-06-11T20:41:14.722Z",
    "message": "text",
    "reason": "text",
    "status": "pending",
    "triggerChatMessageId": "123e4567-e89b-12d3-a456-426614174000"
  }
]

post

Creates a chat message follow-up.

Header parameters

authorizationstringRequired

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

Body

application/json

chatIdstring · uuidRequired

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

dueDatestring · date-timeRequired

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

messagestring · min: 1Required

The follow-up message content.

Responses

201

The chat message follow-up was created.

application/json

401

Unauthorized.

application/json

404

The chat was not found.

application/json

412

The chat has no messages or the last message is from the user.

application/json

post

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

HTTPcURLJavaScriptPython

POST /api/v1/chat-message-follow-ups HTTP/1.1
Host: api.endless.zaia.app
authorization: text
Content-Type: application/json
Accept: */*
Content-Length: 103

{
  "chatId": "123e4567-e89b-12d3-a456-426614174000",
  "dueDate": "2026-06-11T20:41:14.722Z",
  "message": "text"
}

{
  "createdAt": "2026-06-11T20:41:14.722Z",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "updatedAt": "2026-06-11T20:41:14.722Z",
  "chatId": "123e4567-e89b-12d3-a456-426614174000",
  "chatMessageId": "123e4567-e89b-12d3-a456-426614174000",
  "dueDate": "2026-06-11T20:41:14.722Z",
  "finishedAt": "2026-06-11T20:41:14.722Z",
  "message": "text",
  "reason": "text",
  "status": "pending",
  "triggerChatMessageId": "123e4567-e89b-12d3-a456-426614174000"
}

patch

Updates a chat message follow-up.

Path parameters

idstring · uuidRequired

A UUID v4 string that identifies an entity.

Header parameters

authorizationstringRequired

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

Body

application/json

chatIdstring · uuidOptional

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

chatMessageIdstring · uuid · nullableOptional

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

dueDatestring · date-timeOptional

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

finishedAtstring · date-time · nullableOptional

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

messagestring · min: 1Optional

The follow-up message content.

reasonstring · nullableOptional

The reason why the follow-up failed.

statusstring · enumOptionalPossible values:

triggerChatMessageIdstring · uuidOptional

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

Responses

200

The chat message follow-up was updated.

application/json

createdAtstring · date-timeRequired

idstring · uuidRequired

A UUID v4 string that identifies an entity.

updatedAtstring · date-timeRequired

chatIdstring · uuidRequired

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

chatMessageIdstring · uuid · nullableRequired

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

dueDatestring · date-timeRequired

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

finishedAtstring · date-time · nullableRequired

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

messagestring · min: 1Required

The follow-up message content.

reasonstring · nullableRequired

The reason why the follow-up failed.

statusstring · enumRequired

The current status of the follow-up.

Possible values:

triggerChatMessageIdstring · uuidRequired

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

401

Unauthorized.

application/json

404

The chat message follow-up was not found.

application/json

412

Only pending follow-ups can be updated.

application/json

patch

/api/v1/chat-message-follow-ups/{id}

HTTPcURLJavaScriptPython

PATCH /api/v1/chat-message-follow-ups/{id} HTTP/1.1
Host: api.endless.zaia.app
authorization: text
Content-Type: application/json
Accept: */*
Content-Length: 297

{
  "chatId": "123e4567-e89b-12d3-a456-426614174000",
  "chatMessageId": "123e4567-e89b-12d3-a456-426614174000",
  "dueDate": "2026-06-11T20:41:14.722Z",
  "finishedAt": "2026-06-11T20:41:14.722Z",
  "message": "text",
  "reason": "text",
  "status": "cancelled",
  "triggerChatMessageId": "123e4567-e89b-12d3-a456-426614174000"
}

{
  "createdAt": "2026-06-11T20:41:14.722Z",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "updatedAt": "2026-06-11T20:41:14.722Z",
  "chatId": "123e4567-e89b-12d3-a456-426614174000",
  "chatMessageId": "123e4567-e89b-12d3-a456-426614174000",
  "dueDate": "2026-06-11T20:41:14.722Z",
  "finishedAt": "2026-06-11T20:41:14.722Z",
  "message": "text",
  "reason": "text",
  "status": "pending",
  "triggerChatMessageId": "123e4567-e89b-12d3-a456-426614174000"
}