Skip to main content
PATCH
/
entities
/
{entity_id}
/
settings
Deep-merge partial entity settings
curl --request PATCH \
  --url https://api.arcuserp.com/v1/entities/{entity_id}/settings \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "settings": {}
}'
{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "settings": {}
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.arcuserp.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

API key issued per entity via Settings > Developers > API Keys. Each key carries scopes (e.g. orders:read, products:write). Bearer token format: Authorization: Bearer ark_live_ent_ Test keys use ark_test_ent_. Both are issued per entity via Settings > Developers > API Keys.

Headers

​
Idempotency-Key
string

Idempotent request key; same key within 24h returns cached result

Path Parameters

​
entity_id
string<uuid>
required

Entity UUID (must match the API key's entity)

Body

application/json
​
settings
object
required

Partial settings object. Will be deep-merged into the entity's existing settings JSONB. Must be a non-null object (not an array).

Response

Settings merged successfully

​
data
object