Skip to content
Livstick Developers

Trigger message delivery workflow

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

Trigger downstream delivery for the recorded message. The request body is optional: without it, contacts already stored on the message are reused; when provided, typed contact values override the stored values before delivery is triggered.

Authorization

Required scope containers:notify

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

Parameters

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

Request body

Optional application/json Schema NotifyContainerInput

Name Type Required Description
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

Delivery workflow triggered.

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