Skip to main content
PATCH
Error

Authorizations

Authorization
string
header
required

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

Path Parameters

slug
string
required
noteId
string<uuid>
required

Body

application/json

Partial update payload for a package note (FBS-3321)

note
object
required

Package note text

active
object
required

Set to false to deactivate the note. Must be a boolean if present; null is invalid.

isNoteValidWhenPresent
boolean
required
isAtLeastOneModifiableField
boolean
required
isActiveValidWhenPresent
boolean
required

Response

Package note updated

id
string<uuid>
required
name
string
required
automaticOrder
boolean
required
approvalRequired
boolean
required
requireJustification
boolean
required
slug
string
required
active
boolean
required
notes
object[]
required
skuIds
string<uuid>[]
assignedTo
object