Skip to main content
PATCH
/
interactions
/
{id}
cURL
curl --request PATCH \
  --url https://api.{environment}.corti.app/v2/interactions/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Tenant-Name: <tenant-name>' \
  --data '
{
  "assignedUserId": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
  "encounter": {
    "identifier": "<string>",
    "status": "planned",
    "type": "first_consultation",
    "title": "<string>"
  }
}
'
{
  "id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
  "assignedUserId": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
  "encounter": {
    "identifier": "<string>",
    "status": "planned",
    "type": "first_consultation",
    "period": {
      "startedAt": "2023-11-07T05:31:56Z",
      "endedAt": "2023-11-07T05:31:56Z"
    },
    "title": "<string>"
  },
  "patient": {
    "identifier": "<string>",
    "name": "<string>",
    "gender": "male",
    "birthDate": "2023-11-07T05:31:56Z",
    "pronouns": "<string>"
  },
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "websocketUrl": "<string>",
  "lastUpdated": "2023-11-07T05:31:56Z",
  "endedAt": "2023-11-07T05:31:56Z"
}

Documentation Index

Fetch the complete documentation index at: https://docs.corti.ai/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Input your token

Headers

​
Tenant-Name
string
required

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

Example:

"base"

Path Parameters

​
id
string<uuid>
required

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

Example:

"f47ac10b-58cc-4372-a567-0e02b2c3d479"

Body

application/json
​
assignedUserId
string<uuid>

The unique identifier of the medical professional responsible for this interaction. If nulled, automatically set to a uuid.

Example:

"f47ac10b-58cc-4372-a567-0e02b2c3d479"

​
encounter
object

Details of the encounter being updated.

​
patient
object

Patient-related updates.

Response

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

​
id
string<uuid>
required

Unique identifier for the interaction.

Example:

"f47ac10b-58cc-4372-a567-0e02b2c3d479"

​
assignedUserId
string<uuid>
required

A unique identifier for the medical professional responsible for this interaction. If nulled, automatically set to a uuid.

Example:

"f47ac10b-58cc-4372-a567-0e02b2c3d479"

​
encounter
object
required

Information about the encounter, including type, status, and timing.

​
patient
object
required

Details about the patient involved in the interaction, if applicable.

​
createdAt
string<date-time>
required

The timestamp when the interaction was started (UTC).

​
updatedAt
string<date-time>
required

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

​
websocketUrl
string
required

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

​
lastUpdated
string<date-time>
required

The timestamp indicating the last recorded update for this interaction.

​
endedAt
string<date-time> | null

The timestamp when the interaction concluded (UTC).