Skip to content
Livstick Developers

Before this page

This page assumes you can already read a message’s pending_release, released, delivery_triggered and unknown states. Container and message states

notify or unlock: who is carrying delivery?

Call notify when Livstick should send the email or SMS that tells the recipient their message is ready. Call unlock when your own channel — your email template, your printed card, your QR code — already carries the delivery, and you only need Livstick to make the message viewable the moment that channel reaches the recipient.

notify

POST /containers/{crid}/notify requires the containers:notify scope. Its body is optional and lets you override the sender or recipient contacts used for this delivery, using the same sender / recipient shape as container creation.

POST /containers/{crid}/notify
curl -X POST https://client-api.v5.livstick.com/api/v3/containers/{crid}/notify \
  -H "Authorization: Bearer {ACCESS_TOKEN}" \
  -H "Content-Type: application/json" \
  -d '{ "recipient": { "email": "recipient@example.com" } }'

unlock

POST /containers/{crid}/unlock requires the containers:unlock scope. It carries no body — call it once your own channel has reached the recipient, and Livstick makes the message accessible to them.

POST /containers/{crid}/unlock
curl -X POST https://client-api.v5.livstick.com/api/v3/containers/{crid}/unlock \
  -H "Authorization: Bearer {ACCESS_TOKEN}"

Your situation → the call to make

Read the row that matches how the recipient actually learns their message is ready.

Your situation The call to make
Livstick should send the email or SMS that reaches the recipient. notify
Your own email, QR code, or printed card already carries delivery. unlock
You need to send to a different contact than the one on the container. notify, with a recipient override in the body

Where this shows up

Two scenarios in this portal are built directly around this choice.