Aller au contenu
Livstick Développeurs

Update message data and privateData

Méthode PATCH https://client-api.v5.livstick.com/api/v3/messages/{messageId}

Merge provided fields into the message's data and/or privateData objects. Keys provided overwrite existing keys; keys not provided are preserved. If a privateDataSchema is defined on the code group or platform, privateData is validated against it.

Autorisation

Scope requis messages:write

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

Paramètres

Nom Emplacement Type Requis Contraintes Description
messageId Chemin string Requis Unique identifier of the message.

Corps de la requête

Requis application/json Schéma UpdateMessageDataInput

Nom Type Requis Description
data object Facultatif Merge into message.data (keys overwrite, others preserved).
privateData object Facultatif Merge into message.privateData (validated against schema if defined).

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"
  }
}