Create Export PDF request
POST {{baseUrl}}/1/threads/:thread_id/export/pdf/async?destination_thread_id=nostrud cillum sed in&salesforce_org_id=nostrud cillum sed in&salesforce_record_id=nostrud cillum sed in&sheet_name=nostrud cillum sed in&apply_print_options=false
Submits a request to asynchronously export a Quip document or Quip spreadsheet to PDF. This call returns a request_id
. Pass that request_id
into the Retrieve Export PDF Response call to get the PDF URL and request status. Sample use cases: You can export a document or spreadsheet to PDF to mark an approval cycle as complete, take a record-keeping snapshot, or share the PDF with your leadership or with customers.
- The appearance of the PDF exported using this method is
typically the same as if you exported a document or spreadsheet to
PDF in the Quip application. Sometimes there are minor formatting
differences when you export via API. Example: bullets sometimes
look bigger in a PDF exported via API.
You can use this method to complete a PDF export of a standalone Quip spreadsheet, not a spreadsheet inserted into a Quip document. When you do a PDF export of a Quip document containing a spreadsheet, the spreadsheet appears in the PDF.
You can export a maximum of 40,000 cells in a spreadsheet to PDF.
Charts in spreadsheets are excluded from the exported PDF.
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
destination_thread_id | string | ID of the Quip document to which you want to attach the exported PDF. The PDF gets attached to the end of your specified document. | |
salesforce_org_id | string | ID of the Salesforce organization in which you want to attach the exported PDF. If you pass in a salesforce_org_id , you must also pass in a salesforce_record_id . | |
salesforce_record_id | string | ID of the Salesforce record to which you want to attach the exported PDF. If you pass in a salesforce_record_id , you must also pass in a salesforce_org_id . | |
sheet_name | string | If you’re exporting a spreadsheet with multiple tabs, this field identifies the tab that you want to export to PDF. If you don’t identify the tab, the first tab is exported. | |
apply_print_options | boolean | Determines whether to apply print options to the exported PDF. Allowable values are: True - Apply these print options to the PDF: Include all headers and footers Show collapsed content Remove web formatting False (default) - Don’t apply print options to the PDF. |
RESPONSES
status: OK
{"request_id":"esse","status":"SUCCESS"}