PATCH
/
interactions
/
{id}
curl --request PATCH \
  --url https://api.{environment}.corti.app/v2/interactions/{id} \
  --header 'Content-Type: application/json' \
  --data '{
  "assignedUserId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "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>"
  }
}'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "assignedUserId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "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>"
  },
  "endedAt": "2023-11-07T05:31:56Z",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "websocketUrl": "<string>",
  "lastUpdated": "2023-11-07T05:31:56Z"
}

Headers

​
Tenant-Name
string

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

Example:

"copiloteu"

Path Parameters

​
id
string
required

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

Body

application/json
​
assignedUserId
string

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

​
encounter
object

Details of the encounter being updated.

​
patient
object

Patient-related updates.

Response

200
application/json
A request body containing the fields to update within the interaction.
​
id
string

Unique identifier for the interaction.

​
assignedUserId
string

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

​
encounter
object

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

​
patient
object

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

​
endedAt
string

The timestamp when the interaction concluded (UTC).

​
createdAt
string

The timestamp when the interaction was started (UTC).

​
updatedAt
string

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

​
websocketUrl
string

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

​
lastUpdated
string

The timestamp indicating the last recorded update for this interaction.

Was this page helpful?