Collections

Update collection

Update collection changing only the given values

patch/api/v1/collections/{id4n}

Request

Base URL
https://backend.id4i.de
Auth
API key in header Authorization
TypeScript
https://skmtc.dev/id4i/apis/id4i-api/docs/api/v1/collections/:id4n/patch.ts
A function with typed inputs. Its response is checked against the schema.

id4nstring required

id4n

createdTimestampinteger

The UTC unix timestamp of when this collection has been created

holderOrganizationIdstring

Organization namespace of the holder of the collection

id4nstring

The ID

labelstring

ownerOrganizationIdstring

Organization namespace of the collection owner

physicalState'UNATTACHED' | 'ATTACHED' | 'DETACHED'

Physical attachment state of the collection

type'ROUTING_COLLECTION' | 'LOGISTIC_COLLECTION' | 'LABELLED_COLLECTION'

object required

No recorded changes to this operation across all 1 revision of this API.