Release a recipient's digest
Send one recipient’s held digest now, instead of waiting for its schedule. Use it to preview what a digest will look like, or to let someone flush their own.
Keyed on the topic because that is how a held digest is stored: one per recipient per topic, with the schedule recorded on it rather than part of its identity. To flush every recipient on a schedule instead, use POST /digests/schedules/{schedule_id}/trigger.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
The preference section containing the topic.
The preference topic whose digest to release.
Body
Which recipient's held digest to release.
The recipient whose digest to release. Required: there is no "release everyone on this topic" form, because a whole-schedule flush already has its own endpoint and a body-shaped difference between one recipient and all of them is too easy to get wrong.
1The recipient's tenant, when they were sent to as part of one -- the same value returned as tenant_id on a digest instance and sent as message.context.tenant_id. It is part of the held digest's key, so a tenanted recipient cannot be found without it. Omit for an ordinary recipient.
1Response
The recipient's digest was released. A 204 is also returned when they had nothing collected, so the call is safe to repeat.