Skip to main content
PATCH
Spree Admin SDK

Authorizations

x-spree-api-key
string
header
required

Secret API key for admin access

Authorization
string
header
required

JWT token for admin user authentication

Headers

x-spree-api-key
string
required
Authorization
string
required

Path Parameters

id
string
required

Body

application/json
external_references
object

Identities the record has in external systems, keyed by system: the same { system: external_id } map the Admin API renders, so what you read can be sent straight back. Systems you do not name keep the reference they have. A list of { system, external_id } entries is accepted too.

name
string
Example:

"Globex Corporation"

kind
enum<string>

company is a legal entity (may hold tax registrations), division an organizational unit. Roots must be company.

Available options:
company,
division
Example:

"company"

parent_id
string | null

The parent node. Omit or null for a root.

Example:

"comp_86Rf07xd4z"

po_number_required
boolean

Whether this buyer's own procurement process demands a PO reference on every order: checkout asks for one and refuses to complete without it.

metadata
object

Response

200 - application/json

company updated