Modify order with optimistic concurrency (V4)

PUT

/v4/orders/{id}

curl --request PUT \
  --url https://api-crm-staging.divinea.com/api/v4/orders/1 \
  --header 'APIKey: <APIKey>' \
  --header 'Content-Type: application/json' \
  --data '{ "expectedUpdatedAt": "2026-04-15T12:00:00Z", "extraMetadata": {}, "marketingManual": true, "notes": "example", "paymentMethod": "example", "sourceExternalId": "example", "sourceExternalType": "example", "sourceSyncedAt": "2026-04-15T12:00:00Z", "status": "example", "userMetadata": {} }'

Set expectedUpdatedAt to enforce optimistic lock; returns STALE_UPDATE on concurrent modifications. When userMetadata is non-null it replaces the entire orders.user_metadata JSON (COALESCE semantics — not a deep merge); to update secondaryContacts only, GET order-details first, merge fields into userMetadata, then PUT. WS-2594: optional userMetadata.secondaryContacts — array of { contactId, amountCents }; validated when present. When extraMetadata is non-null it likewise replaces orders.extra_metadata entirely.

Authorizations

• ApiKey

Parameters

Path Parameters

id

required

integer format: int64

Id

Header Parameters

APIKey

string

APIKey

Request Body

RequestParam

Media typeapplication/json

UpdateParam

object

expectedUpdatedAt

string format: date-time

extraMetadata

object

marketingManual

boolean

notes

string

paymentMethod

string

sourceExternalId

string

sourceExternalType

string

sourceSyncedAt

string format: date-time

status

string

userMetadata

object

Example^generated

{
  "expectedUpdatedAt": "2026-04-15T12:00:00Z",
  "extraMetadata": {},
  "marketingManual": true,
  "notes": "example",
  "paymentMethod": "example",
  "sourceExternalId": "example",
  "sourceExternalType": "example",
  "sourceSyncedAt": "2026-04-15T12:00:00Z",
  "status": "example",
  "userMetadata": {}
}

Responses

200

OK

Media type*/*

object