Skip to content
Livstick Developers

Update message data and privateData

Method 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.

Authorization

Required scope messages:write

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

Parameters

Name In Type Required Constraints Description
messageId Path string Required Unique identifier of the message.

Request body

Required application/json Schema UpdateMessageDataInput

Name Type Required Description
data object Optional Merge into message.data (keys overwrite, others preserved).
privateData object Optional Merge into message.privateData (validated against schema if defined).

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