Sign in

v1

latestOpenAPI 3.1.02026-08-061,5107704.5 MB
Text

TextMessages.update

Modifies TextMessage or TextMessages with given id(s)

patch/entities/TextMessages/{id}

Path parameters

idstring uuid required

ID of TextMessage to update

Query parameters

validation-levelinteger

Specify validation level of TextMessage on update. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.

Request body

chat_conversation_idstring uuid

Id of the chat conversation.

contentstring

Body of the message. May be plain text or a JSON payload (e.g. AI assistant examples / suggestions).

datetime_sentstring date-time

Timestamp the message was sent.

direction1 | 2

Direction of the message (Incoming, Outgoing).

Integer enum value: 1 - OutgoingEmail, 2 - IncomingEmail

message_sidstring

External message identifier from the SMS provider (e.g. Twilio Message SID).

scoreinteger

Quality score given to the message by the user (e.g. for AI-suggested replies). Used to feed back into the suggestion engine.

status1 | 2 | 3 | 4 | 5

Delivery status of the message (e.g. Sent, Delivered, Failed).

Integer enum value: 1 - Sending, 2 - Sent, 3 - Failed, 4 - Received, 5 - Seen

text_message_conversation_idstring uuid

Id of the conversation.

revisioninteger

Revision when entity was lastly changed.

Example request

{
  "chat_conversation_id": "01234567-abcd-dcba-ffff-000000000000",
  "content": "string",
  "datetime_sent": "2019-01-01T00:00:00",
  "direction": 1,
  "message_sid": "string",
  "score": 1,
  "status": 1,
  "text_message_conversation_id": "01234567-abcd-dcba-ffff-000000000000",
  "revision": 1
}

Response

Modification confirmation. Returns resulting TextMessage

successboolean

True when response succeeded, false on error.

Example response

{
  "success": true,
  "data": {
    "id": "01234567-abcd-dcba-ffff-000000000000",
    "modified": "2019-01-01T00:00:00",
    "created": "2019-01-01T00:00:00",
    "chat_conversation_id": "01234567-abcd-dcba-ffff-000000000000",
    "content": "string",
    "datetime_sent": "2019-01-01T00:00:00",
    "direction": 1,
    "message_sid": "string",
    "score": 1,
    "status": 1,
    "text_message_conversation_id": "01234567-abcd-dcba-ffff-000000000000",
    "revision": 1,
    "content_as_html": "string",
    "data": "blob",
    "topic_prompts": "blob"
  }
}