Skip to main content
POST
Freeze entity for migration cutover

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 | null
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.