Update a container

Method PATCH https://<client-api-host>/api/v3.1/containers/{crid}

Correct shipment data, contacts, language, notification settings or the gallery title, or rename the container with newcrid. mode and gallery.mode cannot be changed (400 IMMUTABLE_FIELD). notifications is merged key by key. Tokens already issued stay valid after a newcrid.

Authorization

Required scope containers:write

Use Authorization: Bearer liv_<prefix>_<secret>. The key must belong to a platform served by the V3 pipeline; otherwise every route answers 403 PLATFORM_NOT_V3.

Parameters

Name	In	Type	Required	Constraints	Description
`crid`	Path	`string`	Required		Your business reference of the container.

Request body

Required application/json Schema V31UpdateContainerRequest

Name	Type	Required	Description
`shipmentCarrier`	`string`	Optional
`shipmentCode`	`string`	Optional	Constraints max length 100
`newcrid`	`string`	Optional	Constraints pattern ^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$
`language`	`string`	Optional
`sender`	`V31Sender`	Optional
`recipient`	`V31Recipient`	Optional
`notifications`	`V31Notifications`	Optional
`gallery`	`V31GalleryInput`	Optional

Responses

200 application/json Schema V31Container

Container updated.

400 application/json Schema V31ErrorEnvelope

Invalid payload, unknown field or invalid value.

401 application/json Schema V31ErrorEnvelope

Authentication failed or missing bearer token.

json 401

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Missing API key"
  }
}

403 application/json Schema V31ErrorEnvelope

Authenticated but not allowed: missing scope (FORBIDDEN), invalid platform constraints (INVALID_PLATFORM_CONSTRAINTS) or a platform not served by API v3.1 (PLATFORM_NOT_V3).

json 403

{
  "error": {
    "code": "PLATFORM_NOT_V3",
    "message": "Platform is not served by API v3.1"
  }
}

404 application/json Schema V31ErrorEnvelope

Container not found for this crid on the platform of the key.

json 404

{
  "error": {
    "code": "NOT_FOUND",
    "message": "Container not found"
  }
}

409 application/json Schema V31ErrorEnvelope

The request conflicts with the state of the container or message: CRID_IN_USE, MODE_MISMATCH, GALLERY_CLOSED, GALLERY_NOT_EMPTY, MESSAGE_REJECTED, MESSAGE_MISSING.

json 409

{
  "error": {
    "code": "GALLERY_CLOSED",
    "message": "Gallery is closed"
  }
}

429 application/json Schema V31ErrorEnvelope

Rate limit exceeded.

json 429

{
  "error": {
    "code": "RATE_LIMITED",
    "message": "Too many requests"
  }
}

500 application/json Schema V31ErrorEnvelope

Unexpected server error.

json 500

{
  "error": {
    "code": "INTERNAL_ERROR",
    "message": "Internal error"
  }
}