Notify the recipient now

Méthode POST https://<client-api-host>/api/v3.1/containers/{crid}/notify

Queue the e-mail that tells the recipient their message (single) or gallery (gallery) is ready. At least one listed message is required (409 MESSAGE_MISSING). The optional body updates the recipient first name and e-mail before sending. The e-mail is queued whatever notifications.recipient is; the setting is applied when the e-mail is sent. Two calls within the same minute send one e-mail.

Autorisation

Scope requis containers:notify

Use Authorization: Bearer liv_<prefix>_<secret>. The key must belong to a platform served by the V3 pipeline; otherwise every route answers 403 PLATFORM_NOT_V3.

Paramètres

Nom	Emplacement	Type	Requis	Contraintes	Description
`crid`	Chemin	`string`	Requis		Your business reference of the container.

Corps de la requête

Facultatif application/json Schéma V31NotifyRequest

Nom	Type	Requis	Description
`recipient`	`object`	Facultatif
`recipient.firstName`	`string`	Facultatif	Contraintes max length 50
`recipient.email`	`string`	Facultatif	Contraintes max length 254, format email

Réponses

200 application/json Schéma V31NotifyResponse

Recipient notification queued.

400 application/json Schéma V31ErrorEnvelope

Invalid payload, unknown field or invalid value.

json 400

{
  "error": {
    "code": "DATA_INVALID",
    "message": "Invalid field crid"
  }
}

401 application/json Schéma V31ErrorEnvelope

Authentication failed or missing bearer token.

json 401

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Missing API key"
  }
}

403 application/json Schéma V31ErrorEnvelope

Authenticated but not allowed: missing scope (FORBIDDEN), invalid platform constraints (INVALID_PLATFORM_CONSTRAINTS) or a platform not served by API v3.1 (PLATFORM_NOT_V3).

json 403

{
  "error": {
    "code": "PLATFORM_NOT_V3",
    "message": "Platform is not served by API v3.1"
  }
}

404 application/json Schéma V31ErrorEnvelope

Container not found for this crid on the platform of the key.

json 404

{
  "error": {
    "code": "NOT_FOUND",
    "message": "Container not found"
  }
}

409 application/json Schéma V31ErrorEnvelope

The request conflicts with the state of the container or message: CRID_IN_USE, MODE_MISMATCH, GALLERY_CLOSED, GALLERY_NOT_EMPTY, MESSAGE_REJECTED, MESSAGE_MISSING.

json 409

{
  "error": {
    "code": "GALLERY_CLOSED",
    "message": "Gallery is closed"
  }
}

429 application/json Schéma V31ErrorEnvelope

Rate limit exceeded.

json 429

{
  "error": {
    "code": "RATE_LIMITED",
    "message": "Too many requests"
  }
}

500 application/json Schéma V31ErrorEnvelope

Unexpected server error.

json 500

{
  "error": {
    "code": "INTERNAL_ERROR",
    "message": "Internal error"
  }
}