capsule

Get the review receipt for a full read answered from a local copy, when the copy matches the capsule exactly

Changed on
post/api/preview/capsules/{id}/dependency-review/receipt

Request

Path parameters

idstring required

UUID v4 string

Request body

content_digeststring required

dependencyReviewContentDigest of the local copy's title, body, field values and token bindings.

dependency_vector_digeststring required

dependencyVectorDigest of the dependency revisions the local copy showed; a dependency change it has not synced refuses the receipt.

revisionstring required

The local copy's dependency_review.revision.

Response

Successful response

can_confirmboolean

You may confirm this capsule still valid (you can edit it, an edit share included). When false, receipt and receipt_expires_at are null. Absent from an older server.

enabledboolean required

Dependency review is on for your account.

pending_countinteger required
receiptstring nullable required

Pass as receipt to confirm the capsule still valid, after reading it in full. Valid 24 hours, once, for this account and connection.

receipt_expires_atstring nullable required
revisionstring required

The capsule's revision token (content.template.field) this read delivered. Compare for equality only.

Changes