Freeze entity for migration cutover
Sets the entity into read-only mode. All API mutations from non-migration callers are rejected with HTTP 423 Locked until POST …/unfreeze is called. Idempotent: if the entity is already frozen, returns the existing freeze_token. Requires migration:admin + migration:write scopes.
Authorizations
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
Body
Human-readable reason for the freeze (shown in audit log).
"WSS cutover Sat 7/12"
Response
Entity frozen (or already frozen)
Current freeze state of an entity.
entity_freeze_status Present when frozen=true. Supply as X-Freeze-Token for migration:write bypass.
True if entity was already frozen (idempotent re-call).
Present in unfreeze response only.

