Skip to main content
PATCH
cURL

Authorizations

Authorization
string
header
required

Prefix the value with "ApiKey" to indicate the custom authorization type

Path Parameters

slug
string
required

Body

application/json

Partial update payload for a package (FBS-3321)

name
object
required

Package name

active
object
required

Set to false to soft-delete the package. Must be a boolean if present; null is invalid.

approvalRequired
object
required

Whether package orders require approval

requireJustification
object
required

Whether order items in this package require justification

automaticOrder
object
required

Whether orders for this package are placed automatically

defaultOfficeId
object
required

Default office UUID for OFFICE/FLEXIBLE delivery; cleared on PERSON delivery

deliverySetting
object
required

Package delivery setting (PERSON, OFFICE, FLEXIBLE)

skus
object[]

SKU changes for the package. null (omitted) means no change. When present, each entry adds (id only) or removes (id + delete: true) a SKU. Existing SKUs not mentioned are unchanged. At least one entry is required when present.

rules
object[]

Package rules. null (omitted) means no change. A present list replaces the package's rules (upsert/additive semantics, REQ-025).

usedEquipmentPreferences
object[]

Used-equipment preferences. null (omitted) means no change. A present list replaces the package's preferences (upsert/additive semantics, REQ-025).

Response

Package updated

Package details returned by get/list package endpoints

id
string<uuid>
required

Unique identifier of the package

name
string
required

Display name of the package.

automaticOrder
boolean
required

When true, assigning this package can trigger automatic equipment ordering

approvalRequired
boolean
required

When true, orders from this package require admin approval

requireJustification
boolean
required

When true, requesters must provide a justification when ordering

slug
string
required

URL-safe unique identifier for the package

active
boolean
required

Whether the package is active

notes
object[]
required

Notes associated with the package

skuIds
string<uuid>[]

SKU UUIDs included in this package

assignedTo
object

People currently assigned to this package