Skip to main content
POST
/
orders
/
{id}
/
release-hold
Release a hold on an order
curl --request POST \
  --url https://api.arcuserp.com/v1/orders/{id}/release-hold \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "user_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "notes": "Credit limit increased; releasing hold per credit manager approval."
}
'
{
  "data": {
    "success": true,
    "order_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  }
}

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

Client-generated unique key for idempotent POST/PATCH/DELETE operations. Alias for the Idempotency parameter. Max 255 chars. On retry with the same key, the original response is returned without re-executing the operation. Keys expire after 24 hours.

Maximum string length: 255

Path Parameters

​
id
string<uuid>
required

UUID of the order to release from hold.

Body

application/json
​
user_id
string<uuid>

UUID of the user releasing the hold. Required for audit trail; defaults to API key owner if omitted.

​
notes
string

Optional notes to attach to the release event.

Response

Hold released successfully.

​
data
object