OpenAiChatMessages
Update OpenAiChatMessage
Update an existing OpenAiChatMessage record.
PUT
Update OpenAiChatMessage
Updates an existing OpenAiChatMessage record. You must include the
Id of the record to update along with all required fields.
Authentication
This endpoint requires OAuth2 authentication. Include a valid bearer token in the
Authorization header.
The authenticated user must be a full unrestricted administrator or have the OpenAiChatMessage-Edit role.Enums
eOpenAiChatMessageType — Action values
eOpenAiChatMessageType — Action values
| Value | Name |
|---|---|
| 1 | Operator |
Request Body
Required Fields
The Id of the OpenAiChatMessage record to update.
ID of the business linked to this record.
The action value for this open ai chat message.
The content value for this open ai chat message.
Optional Fields
ID of the user linked to this record.
ID of the AI channel session linked to this message. Sessions group all messages in a conversation and link it to a specific user and AI channel (e.g. email, chat, WhatsApp).
Code Examples
Response
200
HTTP status code.
200 on success.A human-readable message confirming the update.
Contains the
Id of the updated record.true if the openaichatmessage was updated successfully.null on success.Example Response
400
A summary of the validation error(s), in the format
PropertyName: error message.null on validation failure.Array of validation errors.
false when the request fails validation.Example Response
Update OpenAiChatMessage