CloudPDF
DocsPricing
Start building

Pausing and ending

Every grant has a menu with what you can do to it:

A grant's menu: Settings, Visitors, Open as a visitor, Pause and End grant
What happensUndo
PauseNobody can open it again, through its link or on any website. A viewer already open stops within 10 minutesResume
End grantThe same, for good. One with visitors moves to the ended grants, with themNone
SettingsChange anything. Everyone who opens it next gets the new settingsChange it back

Pause#

Pause a grant while you fix something in the document, or when a page that embeds it should go quiet for a while. The list marks it Paused. Resume brings it back, with the same link and the same embed code.

End#

The End this grant dialog

Ending is for good: the link stops, and so does every website that embeds it. To share the document again, make a new grant, with a new link.

A grant with no visitors is deleted. One with visitors moves to Show ended grants, with its visitors and their copies, so you can still read their answers and erase them. Changes people made to a shared document stay in the document either way.

Deleting the document#

Deleting a document ends all its grants at once, along with every link and embed.

In code#

// Pause, and resume
await cloudpdf.grants.update({ tenantId, grantId, disabled: true });
await cloudpdf.grants.update({ tenantId, grantId, disabled: false });
 
// End: delete one with no visitors, or archive one with visitors
await cloudpdf.grants.delete({ tenantId, grantId });
await cloudpdf.grants.archive({ tenantId, grantId });