Mindset v3 / Deploy in your app / Contexts

Update a context by externalId

Mindset v3 REST API reference: Contexts.

PATCH /api/v1/appuid/{appUid}/contexts/externalId/{externalId}

Base URL

Requests go to your region's API host, for example https://a.api.mindset.ai. Hosts: https://a.api.mindset.ai, https://b.api.mindset.ai, https://c.api.mindset.ai, https://d.api.mindset.ai.

Authorization

x-api-keystringheaderrequired

Your API key.

Path parameters

appUidstringpathrequired

Your application's uid

externalIdstringpathrequired

Unique externalId of the context

Request body

Content type: application/json.

namestringbody

Name of the context

descriptionstringbody

Description of the context

json

{
  "name": "string",
  "description": "string"
}

Responses

200

Successful update

json

{
  "uid": "string",
  "name": "string",
  "description": "string",
  "externalId": "string",
  "createdAt": "string",
  "isSynced": true,
  "externalTenantId": "string"
}

404

Context not found

422

Unprocessable Entity

Example request

bash

curl -X PATCH "https://a.api.mindset.ai/api/v1/appuid/{appUid}/contexts/externalId/{externalId}" \
  -H "x-api-key: <your-api-key>" \
  -H "Content-Type: application/json" \
  -d '{"name":"string","description":"string"}'