Refresh Document from Linked Object

Pull the latest data from a CRM object linked to the document. This is the same as clicking Refresh in the document editor.

The refresh updates the document's variables and merge fields with data from the linked CRM object. For HubSpot, Pipedrive, and Salesforce, it also pulls the object's line items into quote blocks and pricing tables, and applies the template's Merge Rules to them.

Use List Linked Objects to get the linked_object_id, or Create Linked Object to link one first.

🚧

Requirements

  • The document must be in the document.draft status. Otherwise, the endpoint returns 403.
  • The API user must be able to edit the document's content.
  • Only one refresh can run on a document at a time. A second request returns 409 until the first one finishes.
šŸ“˜

If the refresh can't fetch line items from a CRM that supports them, the endpoint returns 502 with the products_fetch_error code. Variables and merge fields may already be updated. Retry the request.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Specify document ID.

string
required

Specify linked object ID.

Responses
204

The document was refreshed with data from the linked CRM object.

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json