botruntime
API ReferenceChat API

Update Conversation

Update a [Conversation](#schema_conversation) object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

PUT
/v1/chat/conversations/{id}

Path Parameters

id*string

Conversation id

Header Parameters

x-bot-id*string

Bot id

x-integration-id?string

Integration id

x-integration-alias?string

Integration alias

Request Body

application/json

Conversation data

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

curl -X PUT "https://example.com/v1/chat/conversations/string" \  -H "x-bot-id: string" \  -H "Content-Type: application/json" \  -d '{}'
{  "conversation": {    "id": "stringstringstringstringstri",    "currentTaskId": "stringstringstringstringstri",    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z",    "channel": "string",    "integration": "string",    "tags": {      "property1": "string",      "property2": "string"    },    "messageCount": 0,    "properties": {      "property1": "string",      "property2": "string"    }  }}
{  "conversation": {    "id": "stringstringstringstringstri",    "currentTaskId": "stringstringstringstringstri",    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z",    "channel": "string",    "integration": "string",    "tags": {      "property1": "string",      "property2": "string"    },    "messageCount": 0,    "properties": {      "property1": "string",      "property2": "string"    }  }}

Start Integration Operation POST

Creates a durable operation record and queues an integration action. Support is action- and adapter-specific. The generic fallback invokes one ordinary action, remains limited by its maxExecutionTime (at most 119 seconds), and has no provider Start/Poll/Cancel adapter. The endpoint rejects fields named contentBase64. When input has a top-level fileRef, the server accepts its id, resolves it in the authenticated bot scope, and persists the complete immutable generation metadata; other input remains opaque JSON. File bytes are not part of this request.

Update Message PUT

Updates a message tags and payload. The message type cannot be changed. Calling this operation from an integration, to update an incoming message, will not invoke the bot. The other way around it also true; Calling this operation from the bot, to update an outgoing message, will not invoke the integration.