Sign in

v1

latestOpenAPI 3.1.02026-07-2676188241.3 KB
Interactions

Update Interaction

Modifies an existing interaction by updating specific fields without overwriting the entire record.

patch/interactions/{id}

Path parameters

idstring uuid required
Example:f47ac10b-58cc-4372-a567-0e02b2c3d479

The unique identifier of the interaction. Must be a valid UUID.

Headers

Tenant-Namestring required

Identifies a distinct entity within Corti's multi-tenant system. Ensures correct routing and authentication of the request.

Example:base

Identifies a distinct entity within Corti's multi-tenant system. Ensures correct routing and authentication of the request.

Request body

assignedUserIdstring uuid

Example request

{
  "assignedUserId": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}

Response

A request body containing the fields to update within the interaction.

idstring uuid required
assignedUserIdstring uuid required
endedAtstring date-time nullable

The timestamp when the interaction concluded (UTC).

createdAtstring date-time required

The timestamp when the interaction was started (UTC).

updatedAtstring date-time required

The timestamp when the interaction was last modified (UTC).

websocketUrlstring required

WebSocket URL for streaming real-time interactions. Append a token in the format: /interactions/{interactionID}/streams?token=Bearer token-value-here

lastUpdatedstring date-time required

The timestamp indicating the last recorded update for this interaction.

Example response

{
  "id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
  "assignedUserId": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}