Skip to main content
PATCH
/
api
/
client
/
v2
/
context
/
{id}
Update Context
curl --request PATCH \
  --url https://prod-nginx-v2.goextrovert.com/webgateway/api/client/v2/context/{id} \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "contextAboutCompany": "<string>",
  "contextAboutUser": "<string>"
}
'
{
  "status": "success",
  "data": null,
  "message": "Operation completed successfully"
}

Authorizations

​
X-API-Key
string
header
required

API Key for authentication

Path Parameters

​
id
string
required

Body

application/json
​
id
string<uuid>
required

ID of the Context to update.

​
name
string
required

New short label for the Context.

Minimum string length: 1
​
contextAboutCompany
string
required

New plain text for the company description (fully replaces the previous value).

​
contextAboutUser
string
required

New plain text for the description of the user (fully replaces the previous value).

Response

​
status
enum<string>
required

Response status

Available options:
success
​
data
any | null
required

No response payload

Available options:
null
Example:

null

​
message
string
required

Success message

Example:

"Operation completed successfully"