Skip to main content
POST
/
entities
/
{entity_id}
/
migration
/
cutover
/
freeze
Freeze entity for migration cutover
curl --request POST \
  --url https://api.arcuserp.com/v1/entities/{entity_id}/migration/cutover/freeze \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "reason": "WSS cutover Sat 7/12"
}
'
{
  "object": "entity_freeze_status",
  "entity_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "frozen": true,
  "freeze_token": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "frozen_at": "2023-11-07T05:31:56Z",
  "frozen_by": {
    "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "api_key_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  },
  "reason": "<string>",
  "idempotent": true,
  "unfrozen_at": "2023-11-07T05:31:56Z"
}

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.

Path Parameters

​
entity_id
string<uuid>
required

Body

application/json
​
reason
string

Human-readable reason for the freeze (shown in audit log).

Example:

"WSS cutover Sat 7/12"

Response

Entity frozen (or already frozen)

Current freeze state of an entity.

​
object
enum<string>
Available options:
entity_freeze_status
​
entity_id
string<uuid>
​
frozen
boolean
​
freeze_token
string<uuid> | null

Present when frozen=true. Supply as X-Freeze-Token for migration:write bypass.

​
frozen_at
string<date-time> | null
​
frozen_by
object
​
reason
string | null
​
idempotent
boolean

True if entity was already frozen (idempotent re-call).

​
unfrozen_at
string<date-time> | null

Present in unfreeze response only.