Skip to main content
PATCH
/
entities
curl --request PATCH \
  --url https://api.geogen.io/v1/entities \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "entityId": "abc123def456",
  "description": "Updated description for the entity"
}
'
{
  "success": true,
  "data": {
    "id": "<string>",
    "name": "<string>",
    "target": "<string>",
    "description": "<string>",
    "language": "<string>",
    "geolocation": "<string>",
    "models": [
      "<string>"
    ],
    "isActive": true,
    "createdAt": 123,
    "updatedAt": 123
  },
  "message": "<string>"
}
{
  "error": "<string>"
}
{
  "error": "<string>"
}
{
  "error": "<string>"
}
{
  "error": "<string>"
}
{
  "error": "<string>",
  "retryAfter": 123
}

Authorizations

​
Authorization
string
header
required

API key authentication. Format: Bearer wsk_your_api_key

Body

application/json
​
entityId
string
required

The ID of the entity to update

​
target
string

New website domain (e.g., example.com)

​
description
string

New entity description

​
language
string

New language code (e.g., 'en', 'fr', 'de')

​
geolocation
string

New geolocation code (e.g., 'global', 'us', 'gb')

​
models
string[]

New array of model UUIDs from /v1/models. Must contain at least 1 model.

Response

Entity updated successfully

​
success
boolean
​
data
object
​
message
string