Aller au contenu
Livstick Développeurs

Trigger message delivery workflow

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

Autorisation

Scope requis containers:notify

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

Facultatif application/json Schéma NotifyContainerInput

Nom Type Requis Description
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

Delivery workflow triggered.

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