Aller au contenu
Livstick Développeurs
v3 Demander un accès

Modify container metadata

Méthode POST {API_BASE}/v2.1/client/{key}/{crid}/modify

Update supported legacy metadata for a CRID.

Autorisation

Scope requis client_v2

The API key is intentionally kept in the path for V2 compatibility: /v2.1/client/{key}/{crid}/... or /v2.1/user/{key}/{crid}/.... Client routes require the client_v2 scope. User routes require the user_v2 scope. Unknown, expired, revoked, malformed, or wrong-scope keys return the legacy JSON error envelope.

Paramètres

Nom Emplacement Type Requis Contraintes Description
key Chemin string Requis API key kept in the URL for V2 compatibility. Requires client_v2 or user_v2 depending on the route.
crid Chemin string Requis Client reference ID, usually an order or campaign reference.

Corps de la requête

Facultatif application/json Schéma ModifyRequest

Nom Type Requis Description
shipmentCarrier string Facultatif Valeurs chronopost ups coursier dhl other
shipmentCode string Facultatif
newcrid string Facultatif Replacement client reference ID.
language string Facultatif
email string Facultatif Contraintes format email

Réponses

200 application/json Schéma OperationStatus

Update applied.

400 application/json Schéma LegacyError

Invalid key, CRID, payload, message state or business precondition.

json 400 
{
  "status": 1,
  "error": "key_invalid"
}

keyInvalid

json 400 
{
  "status": 1,
  "error": "key_invalid"
}

cridUnknown

json 400 
{
  "status": 1,
  "error": "crid_unknown"
}

dataInvalid

json 400 
{
  "status": 1,
  "error": "data_invalid"
}

noMessage

json 400 
{
  "status": 1,
  "error": "no_message_for_this_crid"
}

messageMissing

json 400 
{
  "status": 1,
  "error": "message_missing"
}

noLanguage

json 400 
{
  "status": 1,
  "error": "no_language_found"
}

noPdfTemplate

json 400 
{
  "status": 1,
  "error": "no_pdf_template"
}

webhookNotFound

json 400 
{
  "status": 1,
  "error": "webhook_not_found"
}

403 application/json Schéma LegacyError

Key is authenticated but scope or platform constraints are invalid.

json 403 
{
  "status": 1,
  "error": "forbidden"
}

forbidden

json 403 
{
  "status": 1,
  "error": "forbidden"
}

invalidPlatformConstraint

json 403 
{
  "status": 1,
  "error": "key_invalid"
}