Skip to main content
POST
JavaScript

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

section_id
string
required

The preference section containing the topic.

topic_id
string
required

The preference topic whose digest to release.

Body

application/json

Which recipient's held digest to release.

user_id
string
required

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.

Minimum string length: 1
tenant_id
string

The 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.

Minimum string length: 1

Response

The recipient's digest was released. A 204 is also returned when they had nothing collected, so the call is safe to repeat.