Aller au contenu
Livstick Développeurs

Update container metadata

Méthode 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.

Autorisation

Scope requis containers:write

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

Paramètres

Nom Emplacement Type Requis Contraintes Description
crid Chemin string Requis Business reference of the container.

Corps de la requête

Requis application/json Schéma UpdateContainerInput

Nom Type Requis Description
shipmentCarrier string Facultatif Valeurs chronopost ups coursier dhl other
shipmentCode string Facultatif
newcrid string Facultatif
language string Facultatif
emailObsolète string Facultatif Deprecated alias of sender.email. Contraintes format email
sender SenderInput Facultatif Optional sender identity and contact values.
recipient RecipientInput Facultatif Optional recipient identity and contact values. With no channel, email is selected when present. A phone-only recipient must set channel to sms.

Réponses

200 application/json Schéma OperationResult

Update applied.

400 application/json Schéma ApiErrorEnvelope

Request rejected due to invalid payload or business precondition.

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

401 application/json Schéma ApiErrorEnvelope

Authentication failed or missing bearer token.

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

403 application/json Schéma ApiErrorEnvelope

Authenticated but not allowed by scope or key constraints.

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

404 application/json Schéma ApiErrorEnvelope

Target container could not be found.

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