Skip to main content
PATCH
/
api
/
v1
/
appuid
/
{appUid}
/
contexts
/
externalId
/
{externalId}
Update a context by externalId
curl --request PATCH \
  --url https://a.api.mindset.ai/api/v1/appuid/{appUid}/contexts/externalId/{externalId} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "name": "<string>",
  "description": "<string>"
}'
{
  "uid": "<string>",
  "name": "<string>",
  "description": "<string>",
  "externalId": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "isSynced": true
}

Authorizations

x-api-key
string
header
required

Path Parameters

appUid
string
required

Your application's uid

Minimum length: 1
externalId
string
required

Unique externalId of the context

Body

application/json
name
string

Name of the context

Maximum length: 100
description
string

Description of the context

Maximum length: 100

Response

Successful update

uid
string

Unique ID of the context

name
string
description
string
externalId
string

Optional External ID of the context

createdAt
string<date-time>

Creation timestamp (ISO 8601)

isSynced
boolean

Is the context synced

I