Skip to content
Livstick Developers

Update container metadata

Method PATCH https://client-api.v5.livstick.com/api/v3/containers/{crid}

Update supported fields such as shipping metadata, language, contacts, or replacement CRID. Before recording, contacts update the container defaults. After recording, they update Message.data without triggering delivery.

Authorization

Required scope containers:write

Use Authorization: Bearer liv_<prefix>_<secret>.

Parameters

Name In Type Required Constraints Description
crid Path string Required Business reference of the container.

Request body

Required application/json Schema UpdateContainerInput

Name Type Required Description
shipmentCarrier string Optional Values chronopost ups coursier dhl other
shipmentCode string Optional
newcrid string Optional
language string Optional
emailDeprecated string Optional Deprecated alias of sender.email. Constraints format email
sender SenderInput Optional Optional sender identity and contact values.
recipient RecipientInput Optional Optional recipient identity and contact values. With no channel, email is selected when present. A phone-only recipient must set channel to sms.

Responses

200 application/json Schema OperationResult

Update applied.

400 application/json Schema ApiErrorEnvelope

Request rejected due to invalid payload or business precondition.

json 400
{
  "error": {
    "code": "DATA_INVALID",
    "message": "Invalid request data"
  }
}

401 application/json Schema ApiErrorEnvelope

Authentication failed or missing bearer token.

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

403 application/json Schema ApiErrorEnvelope

Authenticated but not allowed by scope or key constraints.

json 403
{
  "error": {
    "code": "FORBIDDEN",
    "message": "Insufficient permissions"
  }
}

404 application/json Schema ApiErrorEnvelope

Target container could not be found.

json 404
{
  "error": {
    "code": "NOT_FOUND",
    "message": "Container not found for this CRID"
  }
}