InteractionAddMessageRequest
A person’s message to an interaction run, such as a reply in a chat.
Kind: an object, used in requests.
Fields
Section titled “Fields”| Field | Type | Required | Description |
|---|---|---|---|
messageAuthorName | string | null | The name to record as the author. Used only when you call with an API key, so an integration can post for the people it serves; with a signed-in session the message is always recorded as you. Left out, an API-key call is recorded as the key’s user. Constraints: maxLength: 250. | |
messageAuthorId | uuid | The author’s id, used with messageAuthorName under the same rule. | |
message | string | yes | The message text. Constraints: required (empty or whitespace-only strings are rejected). |
Example
Section titled “Example”{ "messageAuthorName": "...", "messageAuthorId": "3f2b8c1e-5d4a-4e6b-9c7d-2a1b0c9d8e7f", "message": "..."}Where it’s used
Section titled “Where it’s used”interactionRuns.addMessage(POST /interactions/processes/by-id/{id}/add-message)