interactions
Update Interaction
interactions
documents
alignment
classification
explainability
swagger
interactions
Update Interaction
Modifies an existing interaction by updating specific fields without overwriting the entire record.
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
Identifies a distinct entity within Corti's multi-tenant system. Ensures correct routing and authentication of the request.
Example:
"copiloteu"
Path Parameters
The unique identifier of the interaction to update. Must be a valid UUID.
Body
application/json
Response
200
application/json
A request body containing the fields to update within the interaction.
The response is of type object
.
Was this page helpful?
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"
}