\n\n3. Get authorization from Quip\n\nWhen prompted, use your\ \ admin email address and password to log into\nyour Quip site and get an authorization\ \ token. This is required only\nthe first time you get an access token.\n\n
\n\n4. Save\ \ the Token\n\nIn Postman, the token details are displayed. Click Use Token\ \ to\nsave the provided token in your request and use it in your next\nAPI call.\n\ \n
| Before the call | \nAfter the\ \ call | \n
|---|---|
\n
| \n \n | \n
Here's the account information for Acme Company:
\",\n \"section_id\"\ : \"HcDACAwByNQ\",\n \"location\": 3\n}\n```\n\nHere's how the paragraph looks\ \ before and after the API call:\n\n| Before the call | \n\ \After the call | \n
|---|---|
| \n This customer\ \ is on the west coast. \n | \n \n Here's the account\ \ information for Acme Company: \nThis customer is on the west coast. \n\ \ | \n
Customers like Acme want more options.
They like personalized service.
\"\ ,\n \"section_id\": \"HcDACAJZEQf\",\n \"location\": 2\n}\n```\n\nHere's\ \ how the content looks before and after the API call:\n\n| Before the call | \nAfter the call | \n
|---|---|
| \n Here's the account information for Acme Company: \n \ \This customer is on the west coast. \n | \n \n Here's\ \ the account information for Acme Company: \nThis customer is on\ \ the west coast. \nCustomers like Acme want more options. \n \ \They like personalized service. \n | \n
Customers like Acme want more choices. They want a buffet experience.
\"\ ,\n \"section_id\": \"HcDABAJZEQf\",\n \"location\": 4\n}\n```\n\nHere's\ \ how the paragraph looks before and after the API call:\n\n| Before the call | \nAfter the call | \n
|---|---|
| \n Customers like Acme want more options. \n | \n \
\ \n Customers like Acme want more choices. They want a buffet experience. \n\ \ | \n
| Before the call | \n \ \After the call | \n
|---|---|
\n Topic 1 - Introduction\n\ \Content under Topic 1. \nTopic 2 - Prerequisites\n\ \Content under Topic 2. \nSubtopic 2.1\nContent\ \ under Subtopic 2.1. \nSubtopic 2.1.1\nContent under\ \ Subtopic 2.1.1. \nTopic 3 - Acceptance Criteria\nContent\ \ under Topic 3. \n | \n \n Topic 1 - Introduction\n\ \Content under Topic 1. \nTopic 3 - Acceptance Criteria\n\ \Content under Topic 3. \n | \n
Topic 4 - Considerations
Our\ \ beta launch requires training users who speak multiple languages.
\",\n \ \ \"location\": 8,\n \"document_range\": \"Topic 4 - Important Notes\"\n\ }\n```\n\nHere's how the content looks before and after the API call:\n\n| Before the call | \nAfter the call | \n
|---|---|
\n Topic 4 - Important Notes\nOur beta\ \ launch requires user training. \n | \n \n Topic 4 -\ \ Considerations\nOur beta launch requires training users who speak\ \ multiple languages. \n | \n
| Before the call | \nAfter\ \ the call | \n|||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
\n
| \n \n
| \n
| Before the call | \nAfter the\ \ call | \n||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
\n
| \n \n \
\
| \n
\\\n
\",\n \"section_id\": \"HcDACAxeuYo\",\n \
\ \"location\": 2\n}\n```\n\nHere's how the content looks before and after the\
\ API call:\n\n| Before the call | \nAfter the\ \ call | \n
|---|---|
| \n Let's start a customer satisfaction\ \ project. \n | \n \n | \n
| Before the call | \nAfter\ \ the call | \n
|---|---|
| \n | \n \n | \n
| Live App Type | \nSummary of Use Case | \n\ \Sample HTML for Content Field | \n
|---|---|---|
| Salesforce\ \ Record | \nAdd a Salesforce record | \n\n\n \n \n\n |
| Salesforce List | \nAdd a Salesforce record list | \n \ \\n\n \n \n\n |
| Salesforce List | \nAdd a Salesforce related list | \n\ \\n\n \n \n\
\n |
| Kanban Board | \nAdd a Kanban board with\
\ three columns:\n
| \n \n\n \n \n\n |
| Project Tracker | \n\ \Add a project tracker with five columns::\n
| \n \n\n \n \n\n |
| ` tags as ` | ` tags. When more than one ` |
|---|
| ` tags.'
title:
type: string
description: The title of the new document. If not specified, we infer the
title from the first content of the document, for example, the first heading.
The title must not exceed 10 KB.
member_ids:
type: string
description: 'A comma-separated list of folder IDs or user IDs. The document
will be placed in the specified folders, and any individual users listed
will be granted individual access to the document. If this argument is
not given, the document is created in the authenticated user''s Private
folder.
'
type:
type: string
enum:
- document
- spreadsheet
default: document
description: The type of document to create.
required:
- content
copy_document_v1_request:
type: object
properties:
thread_id:
type: string
description: 'The ID or secret path of the document to be copied:
- ID: You can find this in the `id` response field of the
Get Thread API method.
- secret path: You can find this in the URL of a thread.
For example, in this URL:
"https://quip.com/3fs7B2leat8/TrackingDocument", the secret path
is 3fs7B2leat8.
'
values:
type: string
description: "If you want to make a copy of a template and fill it in with\
\ your specified content, pass a JSON dictionary into this field. In the\
\ JSON dictionary, the keys must be strings and the values must be either\
\ strings or dictionaries. Keys can contain only the characters A-Z, a-z,\
\ 0-9, .(period) and _(underscore). For example:\n1. You have a document\
\ you want to copy that's a template\n containing these fields:\n\n\
\ `Name = [[Customer.Name]]`\n\n `Age = [[Customer.Age]]`\n\n `\
\ [[Greeting]], [[Customer.Name]]!`\n\n2. You pass this JSON dictionary\
\ into the `values` field:\n\n `{\"Customer\": {\"Age\": 34, \"Name\"\
: \"Arnie\"}, \"Greeting\": \"Hello\"}`\n\n3. The copy of the document\
\ displays this content:\n\n `Name = Arnie`\n\n `Age = 34`\n\n `Hello,\
\ Arnie!`\n"
example:
name:
first: Jane
last: Smith
department: Sales
member_ids:
type: string
description: 'Comma-separated list of user IDs of people who can access
the new
thread. If you don''t pass in `member_ids`, only the user who
called this API method has access to the new thread.
There''s a maximum limit of 100 `member_ids` per request. The default
access level is Full Access, which means that added users can
edit, comment on, and share the thread.
'
folder_ids:
type: string
description: "Comma-separated list of identifiers of the folders you want\
\ to add\nthe new thread to. If you don't pass in `folder_ids`, the new\n\
thread is added to the private folder of the user who called this\nAPI\
\ method. There's a maximum limit of 100 `folder_ids` per request.\nYou\
\ can pass in either of these identifiers:\n- `folder_id`: Identifier\
\ returned in the `id` field when you call\nthe \n\
\ Get Folder API method.\n- secret path: 12-character identifier\
\ that you can find in\nthe URL of the folder. For example,\nin this URL:\
\ \"https://quip.com/N5aaOTih0VYy/TeamFolder\", the secret\npath is N5aaOTih0VYy.\n\
\nNote: For better performance, it\u2019s recommended that you\n\
add no more than 1,000 items to a folder. There\u2019s a maximum limit\n\
of 4,000 items per folder. Items include documents, spreadsheets,\nand\
\ subfolders. When your API call exceeds the suggested limit of\n1,000\
\ items, a warning message is returned in the API response.\nWhen your\
\ API call exceeds the maximum limit of 4,000 items,\nthe request isn\u2019\
t executed and the 400 error code is returned.\nFor more information,\
\ see\n Folder Limits.\n"
title:
type: string
description: 'The name of the new thread. The title is used as the first
line of a document.
We recommend that you pass in a `title` to clearly identify the new thread.
If you don''t pass in a `title`, the names of the original and new threads
are the same.
'
copy_annotations:
type: boolean
default: false
description: "Determines whether to copy comments in the original thread\
\ to the\nnew thread. Possible values are:\n- true: Comments in\
\ the original thread are copied to the\n new thread.\n- false:\
\ Comments in the original thread aren't copied to\n the new thread.\n"
required:
- thread_id
copy_document_v2_request:
type: object
properties:
title:
type: string
description: The name of the new thread. The title is used as the first
line of a document. We recommend that you pass in a title to clearly identify
the new thread. If you don't pass in a title, the names of the original
and new threads are the same.
folder_id:
type: string
description: "Identifier of the folder you want to add the new thread to.\
\ If you don't pass in a folder_id, the new thread is added to the private\
\ folder of the user who called this API method. You can pass in either\
\ of these identifiers:\n* `folder_id`: Identifier returned in the `id`\
\ field when you call\n the [Get Folder](#operation/getFolder) API method.\n\
* `secret path`: 12-character identifier that you can find in the\n URL\
\ of the folder. For example, in this URL:\n \"https://quip.com/N5aaOTih0VYy/TeamFolder\"\
, the secret path is\n N5aaOTih0VYy.\n\n**Note**: Copy a Document or\
\ Template V2 is faster and more lightweight, so you can pass in only\
\ one folder ID. Copy a Document or Template V1 allows you to pass in\
\ multiple folder IDs."
mail_merge_values:
type: object
description: "If you want to make a copy of a template and fill it in with\
\ your specified content, pass a JSON dictionary into this field. In the\
\ JSON dictionary, the keys must be strings and the values must be either\
\ strings or dictionaries. Keys can contain only the characters A-Z, a-z,\
\ 0-9, .(period) and _(underscore).\nFor example:\n* You have a document\
\ you want to copy that's a template\n containing these fields:\n\n \
\ `Name = [[Customer.Name]]`\n\n `Age = [[Customer.Age]]`\n\n ` [[Greeting]],\
\ [[Customer.Name]]!`\n* You pass this JSON dictionary into the `mail_merge_values`\
\ field:\n\n `{\"Customer\": {\"Age\": 34, \"Name\": \"Arnie\"}, \"Greeting\"\
: \"Hello\"}`\n* The copy of the document displays this content:\n\n \
\ `Name = Arnie`\n\n `Age = 34`\n\n `Hello, Arnie!`"
maxItems: 1000
copy_annotations:
type: boolean
default: false
description: 'Determines whether to copy comments in the original thread
to the new thread. Possible values are:
* `true`: Comments in the original thread are copied to the new thread.
* `false`: Comments in the original thread aren''t copied to the new thread.'
example:
title: "\u2757\uFE0F very important cat pics \u2757\uFE0F"
folder_id: N5aaOTih0VYy
mail_merge_values:
Customer:
Age: 34
Name: Arnie
Greeting: Hello
copy_annotations: false
edit_document_request:
type: object
properties:
thread_id:
type: string
description: 'The ID or secret path of the thread whose document you want
to edit:
- ID: You can find this in the `id` response field of the
Get Thread API method.
- secret path: You can find this in the URL of a thread.
For example, in this URL:
"https://quip.com/3fs7B2leat8/TrackingDocument", the secret path
is 3fs7B2leat8.
'
format:
type: string
description: 'Format of the `content` field. Required unless `location`
is 5 (DELETE_SECTION).
'
enum:
- html
- markdown
default: html
content:
type: string
description: "The HTML or [Markdown](https://daringfireball.net/projects/markdown/)\
\ for the content that you want to add. There's a maximum limit of 1 MB\
\ of content per request.\nYou can add a live app by using a ` ` tag\
\ containing these values in the content field:\n* `data-live-app-id`:\
\ ID of the type of live app you want to add.\n For your company, this\
\ ID is always the same for the same type\n of live app. For a live app\
\ currently in a document, you can\n find this ID in the `html` field\
\ returned by the\n [Get Thread](https://quip.com/dev/automation/documentation/current#get-thread)\n\
\ API method. For example, for a calendar, you can call the\n [Get\
\ Thread](https://quip.com/dev/automation/documentation/current#get-thread)\n\
\ API and the `html` field returns something similar to:\n **data-live-app-id='AbNBjAC13no'**.\
\ Pass **'AbNBjAC13no'**\n into the content field every time you want\
\ to add a calendar to\n a document.\n* `data-live-app-payload`: A JSON\
\ string containing the data\n that you want to include in the live app.\n\
\n**Note**: We support most of the Markdown tags. The exceptions are described\
\ in the [differences](https://python-markdown.github.io/#differences)\
\ in the Python-Markdown implementation."
section_id:
type: string
description: "The ID of the part of the thread where you want to add content.\
\ Each of these types of content has its `own section_id`: paragraph,\
\ list item, graphic, spreadsheet row, spreadsheet or live app cell, and\
\ live app. This field is required if the location is `AFTER_SECTION`,\
\ `BEFORE_SECTION`, `REPLACE_SECTION`, or `DELETE_SECTION`. Provide either\
\ a `section_id` or a `document_range`.\n* To find a section_id for all\
\ content except live app and\n spreadsheet data:\n * Select content\
\ in a thread and use this keyboard shortcut\n to copy a link to the\
\ content:\n * **Windows**: Ctrl + Shift + A\n * **Mac**: Command\
\ + Shift + A\n\n Paste the link into a text editor. The `section_id`\n\
\ is after the \"#\". For example, in this link:\n \"https://quip.com/vXYlZwL8Ul35/CustomerFeedback#temp:C:UHA3342fed2be3f401fb513dc0cf\"\
,\n the `section_id` is **temp:C:UHA3342fed2be3f401fb513dc0cf**.\n\n\
* To find a `section_id` for all content including live app and\n spreadsheet\
\ data (for embedded and standalone spreadsheets):\n * Call the [Get\
\ Thread](https://quip.com/dev/automation/documentation/current#get-thread)\n\
\ API method and locate the ID for each HTML element in the\n `html`\
\ response field. For example:\n * In this HTML data:\n ` Welcome to QuipQuip lets you do much more than just create and edit documents online. Try it out and see for yourself! response_metadata: allOf: - $ref: '#/components/schemas/response_metadata' required: - html thread_add_members_v1_request: allOf: - type: object properties: thread_id: type: string description: 'The ID or secret path of the thread to get information about. You can pass in either of these identifiers: * **ID**: You can find this in the "id" response field of the [Get Thread](#operation/getThread) API method. * **Secret path**: You can find this in the URL of a thread. For example, in this URL: "https://quip.com/3fs7B2leat8/TrackingDocument", the secret path is 3fs7B2leat8. You can find this in "secret_path" response field of the [Get Thread](#operation/getThread) API method. ' required: - thread_id - oneOf: - type: object properties: member_ids: type: string description: "A comma-separated list of folder IDs and user IDs. We\ \ add each user individually to the thread. We add the thread to each\ \ of the specified folder IDs.\nIf you pass in a folder ID, use either\ \ of these folder identifiers:\n* **Folder id**: Identifier returned\ \ in the `id` field when you call the [Get Folder](#operation/getFolder)\ \ API method.\n* **Secret path**: 12-character identifier that you\ \ can find in the URL of the folder. For example, in the URL \"https://quip.com/N5aaOTih0VYy/TeamFolder\"\ , the secret path is N5aaOTih0VYy.\n\nThe `member_ids` field is required\ \ if you didn't pass in a `member_ids_by_access_level` value. If you\ \ pass in a `member_ids value` instead of a `member_ids_by_access_level`,\ \ the access level defaults to Full Access.\n\n**Note:** For better\ \ performance, it\u2019s recommended that you add no more than 1,000\ \ items to a folder. There\u2019s a maximum limit of 4,000 items per\ \ folder. Items include documents, spreadsheets, and subfolders. When\ \ your API call exceeds the suggested limit of 1,000 items, a warning\ \ message is returned in the API response. When your API call exceeds\ \ the maximum limit of 4,000 items, the request isn\u2019t executed\ \ and the 400 error code is returned. For more information, see [Folder\ \ Limits]( https://help.salesforce.com/s/articleView?id=sf.quip_folder_limits.htm).\n" required: - member_ids - type: object properties: member_ids_by_access_level: type: string description: "Each user's access level on the specified thread\nas a\ \ JSON\narray. This field is required if you didn't pass in a\n`member_ids`\ \ value. Possible access levels are:\n\n* `0`: Full Access - The user\ \ can edit, comment on,\n and share the thread.\n* `1`: Edit - The\ \ user can edit and comment on the\n thread.\n* `2`: Comment - The\ \ user can read and comment on\n the thread.\n* `3`: View - The user\ \ can only read the thread.\n\nExample:\n`[{\"access_level\": 0, \"\ member_ids\": [\"user_id_1\"]},\n{\"access_level\": 3, \"member_ids\"\ : [\"user_id_2\"]}]\n`\n" required: - member_ids_by_access_level thread_remove_members_v1_request: type: object properties: thread_id: type: string description: 'The ID or secret path of the thread from which you want to remove folders and users. ' member_ids: type: string description: A comma-separated list of folder IDs and user IDs. We remove each user ID individually from the thread. We remove the thread from each of the specified folder IDs. required: - thread_id - member_ids thread_get_members_v2_response: type: object properties: members: type: array description: Array of user IDs of the thread members along with their access levels. maxItems: 100 items: type: object properties: access_level: allOf: - $ref: '#/components/schemas/access_level' user_id: type: string description: The user ID of each thread member. id: type: string description: The ID of each thread member. required: - access_level - user_id - id example: - access_level: EDIT user_id: LJa9EAtQi98 id: dAWAFAAarIo - access_level: OWN user_id: BfNAEA8gUaD id: dAWAFAiFVnw response_metadata: allOf: - $ref: '#/components/schemas/response_metadata' required: - members thread_get_invited_members_v2_response: type: object properties: invited_members: type: array items: type: object description: Information about an invited user. properties: email: type: string description: 'The email address of each invited member. Note: This API method doesn''t return the email addresses of users who are already direct members of a thread. ' access_level: $ref: '#/components/schemas/access_level' id: type: string description: The ID of each invited thread member. example: - email: abc@example.com access_level: OWN id: fONAVAw8BJX - email: def@example.com access_level: VIEW id: SWJAVAhaLJ6 maxItems: 100 response_metadata: allOf: - $ref: '#/components/schemas/response_metadata' thread_add_members_v2_request: type: object properties: updated_members: type: array description: 'JSON array of user IDs or email addresses of people who can access the thread along with their access levels. You can add a maximum of 100 users per request. The fields in this array are:' example: - access_level: edit email: joe@doe.com - access_level: own user_id: LJa9EAtQi98 - access_level: comment user_id: DEF4545$ maxItems: 100 items: allOf: - type: object properties: access_level: $ref: '#/components/schemas/access_level' required: - access_level - oneOf: - type: object properties: user_id: type: string description: 'The user ID of each person who can access the thread. This field is required if you didn''t pass in an email. ' required: - user_id - type: object properties: email: type: string description: 'The email address of each person who can access the thread. This field is required if you didn''t pass in a user_id. ' required: - email required: - updated_members thread_add_members_v2_response: description: Add member V2 endpoint response type: object properties: updated_members: type: array description: 'Array of user IDs or email addresses of people who can access the thread along with their access levels. The fields returned are:' maxItems: 100 items: allOf: - type: object properties: access_level: $ref: '#/components/schemas/access_level' accepted: type: boolean description: 'States whether your request to add members is accepted. Possible values are: * `true`: The request was successful. * `false`: The request was unsuccessful because a required field is missing or you passed in an invalid user_id or email.' error_message: type: string description: A message is returned if the accepted field returns false. It provides information about what went wrong. required: - access_level - accepted - oneOf: - type: object properties: user_id: type: string description: 'The user ID of each person who can access the thread. Either a user_id or email address is returned based on what you passed into the API call. ' required: - user_id - type: object properties: email: type: string description: 'The email address of each person who can access the thread. This field is required if you didn''t pass in a user_id. Either a user_id or email address is returned based on what you passed into the API call. ' required: - email required: - updated_members example: - access_level: edit email: joe@doe.com accepted: true - access_level: own user_id: LJa9EAtQi98 accepted: true - access_level: comment user_id: DEF4545$ accepted: false error_message: Invalid user_id. thread_get_folders_v2_response: type: object properties: folders: type: array items: type: object example: - folder_id: XaABCAlgycE type: SHARED - folder_id: EGFAOAZ64Jg type: PRIVATE properties: folder_id: type: string description: 'The ID of each folder that the thread is in. ' type: type: string description: 'The type of the folder. Possible values are * `PRIVATE`: The folder is private to a single user. * `SHARED`: The folder is shared among users. ' enum: - PRIVATE - SHARED maxItems: 100 response_metadata: allOf: - $ref: '#/components/schemas/response_metadata' thread_add_to_folders_v2_request: type: object properties: folders: type: array description: 'JSON array of IDs for the folders to add the thread to along with the thread''s access level in each folder. You can add a thread to a maximum of 100 folders per request and 2,500 folders across multiple requests. The fields in this array are:' example: - access_level: edit folder_id: XaABCAlgycE - access_level: own folder_id: LJa9EAtQi98 - access_level: comment folder_id: XaXYZAlgycE maxItems: 100 items: allOf: - type: object properties: access_level: $ref: '#/components/schemas/access_level' folder_id: type: string description: The ID of each folder to add the thread to. required: - access_level - folder_id required: - folders thread_add_to_folders_v2_response: description: Add thread to folders V2 endpoint response type: object properties: folders: type: array description: 'Array of IDs for the folders that the thread was added to along with the thread''s access level in each folder. The fields returned are:' example: - access_level: edit folder_id: XaABCAlgycE accepted: true - access_level: own user_id: LJa9EAtQi98 accepted: true - access_level: comment user_id: XaXYZAlgycE accepted: false error_message: Invalid folder_id. maxItems: 100 items: allOf: - type: object properties: access_level: $ref: '#/components/schemas/access_level' folder_id: type: string description: The ID of each folder that the thread was added to. accepted: type: boolean description: 'States whether your request to add a thread to folders is accepted. Possible values are: * `true`: Your request was scheduled successfully. `Note`: Depending on factors such as the volume of content in the same folders as the thread, it can take up to several minutes to complete a request. * `false`: The request was unsuccessful because a required field is missing or you passed in an invalid `folder_id`.' error_message: type: string description: A message is returned if the accepted field returns `false`. It provides information about what went wrong. required: - access_level - folder_id - accepted required: - folders thread_edit_share_link_request: type: object properties: thread_id: type: string description: 'The ID or secret path of the thread whose share link settings you want to edit. ' allow_external_access: type: boolean description: Determines whether users outside your company can access the Quip thread. If `true`, users outside your company can access the Quip thread. If `false`, users outside your company can't access the Quip thread. mode: type: string enum: - edit - view - none description: Indicates the access that users will have to the thread. enable_request_access: type: boolean description: Allow users to request access to the document. When a user tries to access a document that they don't have access to, they are presented with a dialog informing them they do not have access to this document. If `enable_request_access` is `true`, this dialog will contain a "Request Access" button. show_conversation: type: boolean description: Determines whether users can see the conversation pane in a Quip thread. If `true`, users can see the conversation pane. If `false`, users can't see the conversation pane. show_edit_history: type: boolean description: Determines whether users can see a Quip thread's edit history in the conversation pane. If `true`, users can see the edit history. If `false`, users can't see the edit history. allow_messages: type: boolean description: 'Determines whether users can add comments to an existing conversation in a Quip thread. If `true`, users can add comments to an existing conversation. If `false`, users can''t add comments to an existing conversation. ' allow_comments: type: boolean description: 'Determines whether users can add new comments to a Quip thread. If `true`, users can add new comments. If `false`, users can''t add new comments. ' required: - thread_id minProperties: 3 thread_delete_request: type: object properties: thread_id: type: string description: 'The ID or secret path of the thread to delete. ' wipeout: type: boolean default: false description: Whether to permanently delete the thread. required: - thread_id get_bulk_export_response: type: object properties: completed: type: boolean description: 'States whether the export process was completed. Possible values are: * `true`: Export processing was completed (successfully or otherwise) for all requests in this batch. * `false`: Export processing is in progress for at least one request in this batch. ' results: description: 'Array of exported their PDF URLs and statuses ' type: array items: type: object properties: thread_id: type: string description: 'The ID of the thread for the document or spreadsheet you want to export. ' status: type: string enum: - PROCESSING - EXPORTED - FAILURE - OMITTED_DUE_TO_TIMESTAMP - NO_ACCESS - INCOMPATIBLE_FORMAT - FILE_TOO_LARGE file_url: type: string description: "URL that can be used to retrieve the exported file.\ \ Access\nto this URL requires an `Authorization` header. When\n\ `file_size` is larger than 209,715,200 bytes (200MB), please\nfetch\ \ the data by sending multiple requests and sending a\n `Range`\ \ header along with each request, as documented\n[here](https://www.rfc-editor.org/rfc/rfc9110.html#name-range)\n\ . (Note that multiple ranges in a single request are not\nsupported.)\ \ Recommended size for each request is 100MB or\nless.\nThis field\ \ is present when status is `EXPORTED`.\n" file_size: type: integer description: 'The number of bytes in this exported file. This field is present when status is `EXPORTED`. ' required: - thread_id - status example: - thread_id: UcZ9AAhvqrc status: EXPORTED file_url: https://corp.quip.com/-/blob/UcZ9AAhvqrc/3aXoBEvHxahzUtBse0799g?name=UcZ9AAhvqrc.pdf&expiring=true - thread_id: AVN9AAeqq5w status: PROCESSING get_bulk_export_pdf_response: type: object properties: completed: type: boolean description: 'States whether the PDF export process was completed. Possible values are: * `true`: The PDF export process was completed successfully or unsuccessfully. * `false`: The PDF export process is in progress. ' overall_status: type: object description: The overall status of your request. properties: processing: type: integer description: The number of PDF exports are in progress. minimum: 0 example: 0 success: type: integer description: The number of PDF exports were completed. minimum: 0 example: 2 failure: type: integer description: The number of PDF exports couldn't be exported. minimum: 0 example: 0 total: type: integer description: Total number of Quip threads to export to PDF. minimum: 0 example: 2 outputs: description: 'Array of exported their PDF URLs and statuses: ' additionalProperties: x-additionalPropertiesName: thread_id type: object description: 'Identifier of the Quip thread for which you requested a PDF: ' properties: pdf_url: type: string description: 'URL where you can access your PDF of the exported Quip thread. The PDF is available for download at this URL for 3 days after the PDF is created. ' example: https://corp.quip.com/-/blob/RHE9AANz1Io/3aXoBEvHxahzUtBse0799g?name=RHE9AANz1lo.pdf&is_admin=true status: type: string enum: - PROCESSING - SUCCESS - FAILURE description: 'The status of your request. Possible statuses are: * `PROCESSING`: The PDF export is in progress. * `SUCCESS`: The PDF export was completed. * `FAILURE`: The PDF couldn''t be exported. Call the [Create Bulk Export PDF Request]( #operation/createBulkExportPdfsRequest) API method again to create the PDF. ' example: SUCCESS message: type: string description: 'A message is returned if the status is FAILURE. It provides information about what went wrong. ' required: - status get_export_pdf_response: type: object properties: pdf_url: type: string description: 'A URL where you can access your PDF of the exported Quip thread. It is returned if the status is `SUCCESS`. The PDF is available for download at this URL for 3 days after the PDF is created. ' example: https://corp.quip.com/-/blob/RHE9AANz1Io/3aXoBEvHxahzUtBse0799g?name=RHE9AANz1lo.pdf status: type: string enum: - PROCESSING - SUCCESS - PARTIAL_SUCCESS - FAILURE description: 'The status of your request. Possible statuses are: * `PROCESSING`: The PDF export is in progress. * `SUCCESS`: The PDF export was completed. If you made a request to attach the PDF to a Quip document or Salesforce record, the PDF is also available in your specified location. * `PARTIAL_SUCCESS`: The PDF URL is available. However, the file couldn''t be attached in your specified location. Call the [Create Export PDF Request](#operation/createExportThreadToPdfRequest) API method again to attach the PDF to your specified Quip document or Salesforce record. Confirm that you passed in the correct `destination_thread_id`, `salesforce_org_id`, or `salesforce_record_id`. * `FAILURE`: The PDF couldn''t be exported. Call the [Create Export PDF Request](#operation/createExportThreadToPdfRequest) API method again to create the PDF. ' example: SUCCESS message: type: string description: 'A message is returned if the status is `FAILURE` or `PARTIAL_SUCCESS`. It provides information about what went wrong. ' required: - status mark_as_moved_to_external_request: type: object properties: thread_id: type: string description: 'The ID or secret path of the thread whose document you want to edit: - ID: You can find this in the `id` response field of the Get Thread API method. - secret path: You can find this in the URL of a thread. For example, in this URL: "https://quip.com/3fs7B2leat8/TrackingDocument", the secret path is 3fs7B2leat8. ' status: description: Status of moving the thread to an external location. type: string enum: - unset - moving - moved url: type: string description: 'The url of the thread''s new off-Quip location. Should only be provided if the status is "moved", in which case it is required. ' required: - thread_id - status mark_as_moved_to_external_response: type: object properties: thread_id: type: string status: description: Status of moving the thread to an external location. type: string enum: - unset - moving - moved url: type: string description: The url of the thread's new off-Quip location. user_id: type: string description: The ID of the user who updated the movement data. updated_usec: description: 'The [Unix timestamp](https://www.epochconverter.com/) in microseconds for when the movement data was last changed. ' required: - thread_id - status - user_id - updated_usec user_info: allOf: - $ref: '#/components/schemas/user_info_without_folders' - $ref: '#/components/schemas/user_folders' user_info_without_folders: type: object properties: id: type: string description: ID of the user. example: UTUAEAiZl6B name: type: string description: Full name of the user. example: Jane Doe company_id: type: string description: ID of the user's company. example: IMbAcASGu56 emails: type: array description: List of the user's emails. items: type: string example: - jane@example1.com - jane@example2.com disabled: type: boolean description: If `true`, the user has been disabled. example: false created_usec: type: integer format: int64 description: 'Timestamp (in microseconds since UNIX epoch) the user was created. ' example: 1632022665732239 is_robot: type: boolean description: If `true`, the user is a bot user. example: false affinity: type: number format: double description: "A floating point number between 0 and 1 indicating the authenticated\n\ \ user's affinity to this user. Quip generally presents contacts in\n\ \ affinity order throughout the app.\n" example: 0.43 chat_thread_id: type: string description: 'The ID of the chat thread between the authenticated user and this user, if any. ' example: adHAAAKik9A profile_picture_url: type: string description: URL of the user's profile picture. example: https://acme.quip.com:443/vWMeAXtnYvRMJJH_A6OaMA required: - id - name - is_robot - affinity user_folders: type: object properties: desktop_folder_id: type: string description: The ID of the user's desktop folder. example: AGWAOAhT3qk archive_folder_id: type: string description: The ID of the user's archive folder. example: BGWAOAhT3qk starred_folder_id: type: string description: The ID of the user's starred folder. example: CGWAOAhT3qk private_folder_id: type: string description: The ID of the user's private folder. example: DGWAOAhT3qk trash_folder_id: type: string description: The ID of the user's trash folder. example: EGWAOAhT3qk shared_folder_ids: type: array description: The IDs of the user's shared folders. items: type: string minimum: 0 example: - FGWAOAhT3qk - GGWAOAhT3qk group_folder_ids: type: array description: The IDs of the user's group folders. items: type: string minimum: 0 example: - HGWAOAhT3qk - IGWAOAhT3qk user_not_found_err_property: type: object properties: error: type: string description: 'An error message describing why the user could not be found. ' user_contacts: type: array items: allOf: - $ref: '#/components/schemas/user_info_without_folders' - $ref: '#/components/schemas/user_not_found_err_property' user_info_v2: allOf: - $ref: '#/components/schemas/user_info_without_folders_v2' - $ref: '#/components/schemas/user_folders_v2' user_info_without_folders_v2: type: object properties: id: type: string description: ID of the user. example: UTUAEAiZl6B name: type: string description: Full name of the user. example: Jane Doe company_id: type: string description: ID of the company that the user works for. example: IMbAcASGu56 emails: type: array description: List of the user's emails. items: type: string example: - jane@example1.com - jane@example2.com disabled: type: boolean description: 'Returns `true` if the user has been deactivated. Returns `false` if the user is enabled. ' example: false created_usec: type: integer format: int64 description: 'The [Unix timestamp](https://www.epochconverter.com) in microseconds for when the user''s account was created. ' example: 1632022665732239 is_robot: type: boolean description: If `true`, the user is a bot user. example: false affinity: type: number format: double description: 'A number between 0 and 1 indicating the frequency and recency of messages exchanged between the user calling this API method and the specified user. ' example: 0.43 chat_thread_id: type: string description: 'The ID of the chat thread between the authenticated user and this user, if any. ' example: adHAAAKik9A profile_picture_url: type: string description: URL where the user's profile picture is located. example: https://acme.quip.com:443/vWMeAXtnYvRMJJH_A6OaMA required: - id - name - is_robot - affinity user_folders_v2: type: object properties: desktop_folder_id: type: string description: 'The ID of the user''s desktop folder. The desktop folder is a legacy folder that''s no longer visible in the UI. ' example: AGWAOAhT3qk archive_folder_id: type: string description: 'The ID of the user''s archive folder. The archive folder is a legacy folder that''s no longer visible in the UI. ' example: BGWAOAhT3qk starred_folder_id: type: string description: The ID of the user's starred folder. example: CGWAOAhT3qk private_folder_id: type: string description: The ID of the user's private folder. example: DGWAOAhT3qk trash_folder_id: type: string description: The ID of the user's trash folder. example: EGWAOAhT3qk shared_folder_ids: type: array description: 'The IDs of the folders that the user shared with other members. ' items: type: string minimum: 0 example: - FGWAOAhT3qk - GGWAOAhT3qk group_folder_ids: type: array description: 'The IDs of the group folders that the user is a member of. ' items: type: string minimum: 0 example: - HGWAOAhT3qk - IGWAOAhT3qk user_threads: type: object properties: threads: description: 'Information about a thread. The fields returned are: ' additionalProperties: x-additionalPropertiesName: thread_id type: object description: 'This is the `thread_id`, which is the unique identifier for a thread. ' response_metadata: allOf: - $ref: '#/components/schemas/response_metadata' required: - threads user_threads_meta: type: object properties: threads: description: 'Information about a thread. The fields returned are: ' additionalProperties: x-additionalPropertiesName: thread_id type: object description: 'This is the `thread_id`, which is the unique identifier for a thread. ' properties: updated_usec: type: integer format: int64 description: 'The [Unix timestamp](https://www.epochconverter.com) in microseconds for when the thread was last updated. ' example: 1631915313977048 is_deleted: type: boolean description: 'Returns `true` if the thread is deleted. Returns `false` if this thread isn''t deleted. ' example: false link: type: string description: Permalink for the thread. example: https://example.com/KbTAAAkz5h7 thread_type: type: string description: 'The type of the thread. ' enum: - TEXT_DOCUMENT - SPREADSHEET_DOCUMENT - SLIDES - CHAT - OTHER example: TEXT_DOCUMENT response_metadata: allOf: - $ref: '#/components/schemas/response_metadata' required: - threads base_error_response: description: General purpose error response type: object properties: error: description: General category of error. type: string error_code: type: integer error_description: description: 'Human-readable description of API error case, if available. ' type: string error_response: allOf: - $ref: '#/components/schemas/base_error_response' - properties: error_code: description: HTTP status code of this response. response_metadata: type: object properties: next_cursor: type: string description: 'If more data is available, this field returns a cursor value that points to the next page of data you can get. Pass this value into the `cursor` field in your next call to retrieve more data. If no additional data is available, this field is empty. Continue to call this API method with each new cursor value until this field returns empty. Note: Each `next_cursor` value returned by this API method expires 30 minutes after creation. After a cursor expires, you can call this API again to get a new cursor. ' example: Y3Vyc29yVG9OZXh0UGFnZQ== responses: thread_edit_share_link_response: description: 'An object with the thread''s ID as its only property and the string "success" as its value. ' content: application/json: schema: type: object additionalProperties: x-additionalPropertiesName: thread_id type: string enum: - success 200_docx: description: Successful Response content: application/vnd.openxmlformats-officedocument.wordprocessingml.document: schema: description: The DOCX content returned in the response body. type: string format: binary 400_add_thread_to_folders_v2: description: Bad Request content: application/json: schema: allOf: - properties: error_code: type: integer default: 400 error: description: Bad Request type: string error_description: description: 'A required input is missing or your request is over a specified limit. Check the reference documentation for the required inputs and any limits. ' type: string 403_add_thread_to_folders_v2: description: Forbidden content: application/json: schema: allOf: - properties: error_code: type: integer default: 403 error: description: Forbidden type: string error_description: description: 'The caller doesn''t have full access to the thread. Contact the thread owner to request full (own) access to it. ' type: string 404_add_thread_to_folders_v2: description: Not Found content: application/json: schema: allOf: - properties: error_code: type: integer default: 404 error: description: Not Found type: string error_description: description: 'The thread identifier wasn''t found. Confirm that you passed in the correct thread identifier and the associated thread exists and isn''t deleted. ' type: string 400_get_users_v2: description: Bad Request content: application/json: schema: allOf: - properties: error_code: type: integer default: 400 error: description: Bad Request type: string error_description: description: "We couldn't complete the request. Confirm that you:\n\ - Passed in the correct identifier for the data that you\n want\ \ to view, add, copy, edit, or delete and the\n associated data\ \ exists.\n- Provided all required inputs, only allowable values,\n\ \ and a supported combination of inputs as described\n in the\ \ reference documentation.\n- Made a request for a thread whose\ \ content isn't locked\n or on which editing is disabled.\n-\ \ Passed in data using valid syntax such as correct JSON,\n Markdown,\ \ or HTML syntax.\n" type: string 403_get_users_v2: description: Forbidden content: application/json: schema: allOf: - properties: error_code: type: integer default: 403 error: description: Forbidden type: string error_description: description: 'The user making the call doesn''t have the required access to the thread or user. Contact the Quip admin or thread owner to request access. ' type: string 404_get_users_v2: description: Not Found content: application/json: schema: allOf: - properties: error_code: type: integer default: 404 error: description: Not Found type: string error_description: description: 'Invalid `section_id`, `thread_id`, or `id`. Confirm that you passed in the correct ID and the associated item or user exists. ' type: string 304_not_modified: description: Not Modified content: application/json: schema: allOf: - $ref: '#/components/schemas/error_response' - properties: error_code: default: 304 400_bad_request: description: Bad Request content: application/json: schema: allOf: - $ref: '#/components/schemas/error_response' - properties: error_code: default: 400 401_authentication: description: Authentication Error content: application/json: schema: allOf: - $ref: '#/components/schemas/error_response' - properties: error_code: default: 401 403_forbidden: description: Forbidden content: application/json: schema: allOf: - $ref: '#/components/schemas/error_response' - properties: error_code: default: 403 404_not_found: description: Not Found content: application/json: schema: allOf: - $ref: '#/components/schemas/error_response' - properties: error_code: default: 404 413_payload_too_large: description: Payload Too Large content: application/json: schema: allOf: - $ref: '#/components/schemas/error_response' - properties: error_code: default: 413 429_too_many_requests: description: Too Many Requests content: application/json: schema: allOf: - $ref: '#/components/schemas/error_response' - properties: error_code: default: 429 500_server_error: description: Server Error content: application/json: schema: allOf: - $ref: '#/components/schemas/error_response' - properties: error_code: default: 500 503_service_unavailable: description: Service Unavailable content: application/json: schema: allOf: - $ref: '#/components/schemas/error_response' - properties: error_code: default: 503 503_rate_limit: description: Rate Limited content: application/json: schema: allOf: - $ref: '#/components/schemas/error_response' - properties: error_code: default: 503 504_gateway_timeout: description: Service Unavailable content: application/json: schema: allOf: - $ref: '#/components/schemas/error_response' - properties: error_code: default: 504 401_authentication_v2: description: Authentication Error content: application/json: schema: allOf: - properties: error_code: type: integer default: 401 error: description: Authentication Error type: string error_description: description: 'The access token is invalid or missing. Confirm that your request header contains a valid access token. Then call the API method again. ' type: string 500_server_error_v2: description: Server Error content: application/json: schema: allOf: - properties: error_code: type: integer default: 500 error: description: Server Error type: string error_description: description: 'We couldn''t complete the request. Try again later. If this error reoccurs, contact Quip Support. ' type: string paths: /1/oauth/access_token: post: tags: - Authentication summary: Token Endpoint operationId: accessToken description: 'After you have obtained a verification code or refresh token, you can exchange it for an access token via a POST request to this endpoint. ' parameters: - name: grant_type in: query schema: type: string enum: - refresh_token - authorization_code description: Either `refresh_token` or `authorization_code`. required: true - name: client_id in: query schema: type: string required: true description: The client ID you created for your application. - name: client_secret in: query schema: type: string required: true description: The client secret you created for your application. - name: refresh_token in: query schema: type: string description: Required if `grant_type` is `refresh_token`. - name: code in: query schema: type: string description: Required if `grant_type` is `authorization_code`. - name: redirect_uri in: query schema: type: string description: 'Required if `grant_type` is `authorization_code`. Must match the `redirect_uri` supplied when requesting that authorization code. ' responses: '200': description: Successful Response content: application/json: schema: type: object properties: access_token: description: Token that can be used to access Quip APIs type: string expires_in: description: Number of seconds until token expires. type: integer format: int32 refresh_token: description: 'Token that can be used to obtain another access token in the future. ' type: string scope: description: 'Space-separated list of authorization scopes that can be accessed via this token. ' type: string token_type: description: Type of this token. type: string enum: - Bearer required: - access_token - expires_in - refresh_token - scope - token_type '400': $ref: '#/components/responses/400_bad_request' '401': $ref: '#/components/responses/401_authentication' '500': $ref: '#/components/responses/500_server_error' /1/oauth/login: get: tags: - Authentication summary: Authorization Endpoint operationId: authorization description: 'Redirect end users to this URL to get an OAuth 2.0 verification code, which you can exchange for an access token. ' parameters: - name: client_id in: query schema: type: string required: true description: 'The client ID you [created](https://corp.quip.com/api/domain-tokens) for your application. ' - name: client_secret in: query schema: type: string required: true description: The client secret you created for your application. - name: redirect_uri in: query schema: type: string required: true description: 'The URL we should redirect back to with the verification code. ' example: https://app.postman.com/oauth2/callback - name: state in: query schema: type: integer description: 'If given, we include this argument in our redirect back to the redirect_uri. This is recommended to prevent a variety of security issues. ' example: 1234 responses: '302': description: Successful response headers: Location: schema: type: string description: 'The URL to redirect to. Same as the URL returned in the body. ' content: text/plain; charset=utf-8: schema: type: string description: 'The URL to redirect to. Same as the URL returned in the `Location` header. ' '400': $ref: '#/components/responses/400_bad_request' '401': $ref: '#/components/responses/401_authentication' '403': $ref: '#/components/responses/403_forbidden' '500': $ref: '#/components/responses/500_server_error' /1/oauth/revoke: post: tags: - Authentication summary: Revoke a Token operationId: revokeToken description: 'Revoke an `access_token` or a `refresh_token`. ' parameters: - name: client_id in: query schema: type: string required: true description: The client ID you created for your application. - name: client_secret in: query schema: type: string required: true description: The client secret you created for your application. - name: token in: query schema: type: string required: true description: The token to revoke. responses: '200': description: Successful response content: application/json: schema: description: Empty JSON object type: object '400': $ref: '#/components/responses/400_bad_request' '401': $ref: '#/components/responses/401_authentication' '500': $ref: '#/components/responses/500_server_error' /1/oauth/verify_token: get: tags: - Authentication summary: Verify Token operationId: verifyToken description: Verifies the validity of the `access_token` in your header. responses: '200': description: Successful response content: application/json: schema: type: object properties: expires_in: type: integer format: int32 description: Number of seconds until token expires. example: 2425690 scope: type: string description: 'Space-separated list of authorization scopes that can be accessed via this token. ' example: USER_MANAGE USER_WRITE USER_READ token_type: type: string enum: - Bearer description: Type of this token. Will always be "Bearer". client_id: type: string description: 'The `client_id` of the API key that was used to generate this access token if applicable. ' api_key_expires_in: type: integer format: int32 description: 'Number of seconds until the API key used to mint this access token expires. ' example: 2425690 required: - expires_in - scope - token_type '500': $ref: '#/components/responses/500_server_error' /1/threads/add-members: post: security: - OAuth2: - USER_MANAGE tags: - Threads summary: Add People to a Thread or Add a Thread to Folders operationId: addMembersToThreadOrAddThreadToFolders description: "Shares a Quip thread (document, spreadsheet, or chat) with specified\n\ people (members) at your company and adds the thread to folders.\nThis supports\ \ information-sharing and collaboration within and\nacross teams.\n\n**Note:**\n\ \n * You can add a maximum of 100 people to a thread per request\n and\ \ 2,500 people per thread across multiple requests.\n * You can add a thread\ \ to a maximum of 100 folders per request\n and 2,500 folders across multiple\ \ requests.\n\nSee also: [Share Documents and Folders](\n https://help.salesforce.com/s/articleView?id=000354975&type=1)\n\ \n### Sample Calls\nIn this example, four people are added to a thread with\ \ the ID\n**e3fs7B2leat8**. The users are added with these access levels:\n\ \n* **0**: Full access\n* **1**: Edit\n* **2**: Comment\n* **3**: View\n\n\ See the reference documentation for more information about the access\nlevels.\n\ \n```text\nPOST https://platform.quip.com/1/threads/add-members\nContent-Type:\ \ application/json\nAuthorization: Bearer {{ABCSampleAccessToken}}\n\n{\n\ \ \"thread_id\": \"e3fs7B2leat8\",\n \"member_ids_by_access_level\u201D\ :\n [\n {\"access_level\": 0, \"member_ids\": [\"ABC12341234\"\ ]},\n {\"access_level\": 1, \"member_ids\": [\"DEF45456789\"]},\n\ \ {\"access_level\": 2, \"member_ids\": [\"LMN74856789\"]},\n \ \ {\"access_level\": 3, \"member_ids\": [\"XYZEF454599\"]}\n \ \ ]\n }\n}\n```\n\nIn this example, two actions are taken on a thread\ \ with ID\n**e3fs7B2leat8**:\n\n1. Add it to a folder with ID **abCsOFj2Ny3a**.\n\ 2. Add a member with user ID **XYZJAEAck4vn** to the thread.\n\n```text\n\ POST https://platform.quip.com/1/threads/add-members\nContent-Type: application/json\n\ Authorization: Bearer {{ABCSampleAccessToken}}\n{\n \"thread_id\": \"e3fs7B2leat8\"\ ,\n \"member_ids\": {\"abCsOFj2Ny3a\",\"XYZJAEAck4vn\"}\n}\n```\n" requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/thread_add_members_v1_request' parameters: - name: Content-Type in: header schema: type: string example: application/x-www-form-urlencoded responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/thread_info_v1' '400': $ref: '#/components/responses/400_bad_request' '401': $ref: '#/components/responses/401_authentication' '403': $ref: '#/components/responses/403_forbidden' '404': $ref: '#/components/responses/404_not_found' '500': $ref: '#/components/responses/500_server_error' /1/threads/add-rows: {} /1/threads/copy-document: post: security: - OAuth2: - USER_READ - USER_WRITE tags: - Threads summary: Copy a Document or Template operationId: copyDocument description: "Makes a copy of a thread (Quip document, spreadsheet, or template).\n\ This API method allows you to easily reuse existing content,\nautomatically\ \ add members to the thread, and add the thread to a\nfolder. For example,\ \ after a predefined step is completed, you can\nmake a copy of a template\ \ and fill it in with your specified content.\n\n**Note:** Quip has introduced\ \ a faster, more scalable version of this\nAPI method: [Copy a Document or\ \ Template V2](\nhttps://quip.com/dev/automation/documentation/current#operation/copyDocumentV2\n\ ). You\u2019re encouraged to modify your integrations to point to the\nlatest\ \ versions of API methods. You can continue to access legacy\nversions of\ \ API methods until we announce when support for them ends.\n\nSee also: [Folders\ \ (Quip)](\n https://help.salesforce.com/s/articleView?id=000355165&type=1),\n\ \ [REST API Versioning FAQ](\n https://quip.com/dev/automation/documentation/current#section/FAQs/REST-API-Versioning-FAQ)\n\ \n### Sample Call\nIn this example, a template with ID e3fs7B2leat8\ \ is copied and\nthe new document is filled in based on the data in the values\ \ field.\nThe new thread is also added to a folder with ID N5aaOTih0VYy.\n\ \n```text\nPOST https://platform.quip.com/1/threads/copy-document\nContent-Type:\ \ application/json\nAuthorization: Bearer ABCSampleAccessToken\n\n{\n \"\ thread_id\": \"e3fs7B2leat8\",\n \"title\": \"Customer Welcome\",\n \ \ \"folder_ids\": \"N5aaOTih0VYy\",\n \"values\": \"{\n \"Customer\"\ : {\"Age\": 34, \"Name\": \"Arnie\"},\n \"Greeting\": \"Hello\"\n \ \ }\",\n \"copy_annotations\": \"false\"\n}\n```\n" requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/copy_document_v1_request' parameters: - name: Content-Type in: header schema: type: string example: application/x-www-form-urlencoded responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/thread_info_v1' '400': $ref: '#/components/responses/400_bad_request' '401': $ref: '#/components/responses/401_authentication' '403': $ref: '#/components/responses/403_forbidden' '404': $ref: '#/components/responses/404_not_found' '500': $ref: '#/components/responses/500_server_error' /2/threads/{threadIdOrSecretPath}/copy: post: security: - OAuth2: - USER_READ - USER_WRITE tags: - Threads summary: Copy a Document or Template V2 operationId: copyDocumentV2 description: Makes a copy of a Quip thread (document, spreadsheet, or template) and adds it to a folder. This API method allows you to easily reuse existing content. For example, after a predefined step is completed, copy a template and add your specified content. When you add the new thread to a folder, members can automatically access that thread. This supports information-sharing and collaboration within and across teams. requestBody: content: application/json: schema: $ref: '#/components/schemas/copy_document_v2_request' parameters: - $ref: '#/components/parameters/thread_id_or_secret_path' responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/thread_get_v2' '400': $ref: '#/components/responses/400_bad_request' '401': $ref: '#/components/responses/401_authentication' '403': $ref: '#/components/responses/403_forbidden' '404': $ref: '#/components/responses/404_not_found' '429': $ref: '#/components/responses/429_too_many_requests' '500': $ref: '#/components/responses/500_server_error' /1/threads/delete: post: security: - OAuth2: - USER_MANAGE tags: - Threads summary: Delete a Thread operationId: deleteThread description: 'Deletes the thread with the specified ID or secret. ' requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/thread_delete_request' responses: '200': description: Successful Response content: application/json: schema: description: Empty JSON object. type: object '400': $ref: '#/components/responses/400_bad_request' '401': $ref: '#/components/responses/401_authentication' '403': $ref: '#/components/responses/403_forbidden' '404': $ref: '#/components/responses/404_not_found' '500': $ref: '#/components/responses/500_server_error' /1/threads/edit-document: post: security: - OAuth2: - USER_READ - USER_WRITE tags: - Threads summary: Edit a Document operationId: editDocument description: "Modifies the content of a thread (Quip document or spreadsheet).\n\ This API method allows you to mix and match content from different\nsources\ \ and automatically add it to the same thread whenever new\ndata becomes available.\ \ Quip users can then collaborate on the\nthread or make any other changes\ \ to it. Sample content:\nproject status updates, meeting minutes, support\ \ cases, event\nregistrations, approvals, survey results, or payments.\n\n\ ### Note\n- Live apps:\n - You can add only these types of live apps\ \ to a document:\n calendar, Salesforce record, Salesforce list, Kanban\ \ board,\n and project tracker.\n- Spreadsheets:\n - You can add\ \ a row or edit a cell in a spreadsheet embedded in a\n Quip document or\ \ a standalone Quip spreadsheet.\n - The number of columns that you pass\ \ into your API call must be\n less than or equal to the number of columns\ \ in the spreadsheet.\n Any extra columns you pass in aren't added.\n \ \ - Quip allows you to add a maximum of 100,000 cells to a\n spreadsheet.\ \ This means that you can add a maximum of 100,000\n cells by calling this\ \ API method once or multiple times.\n - You can add a maximum of 1,000 rows\ \ with each API call.\n - For best performance, it's recommended that you\ \ limit the number\n of cells you add to a maximum of 30,000 for each spreadsheet.\n\ - Paragraphs:\n - You can't edit only a sentence in a paragraph. To\ \ edit a\n sentence, replace the paragraph it's in with new content.\n\ \ - Deleting a sentence in a paragraph deletes the whole paragraph.\n" requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/edit_document_request' parameters: - name: Content-Type in: header schema: type: string example: application/x-www-form-urlencoded responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/edit_document_response' '400': $ref: '#/components/responses/400_bad_request' '401': $ref: '#/components/responses/401_authentication' '403': $ref: '#/components/responses/403_forbidden' '404': $ref: '#/components/responses/404_not_found' '413': $ref: '#/components/responses/413_payload_too_large' '500': $ref: '#/components/responses/500_server_error' /1/threads/edit-share-link-settings: post: security: - OAuth2: - USER_MANAGE tags: - Threads summary: Edit Thread Link Share Settings operationId: editThreadLinkShareSettings description: "Changes share link settings on a thread.\n\n\nAt least one of\ \ the following must be included in the request:\n * `allow_external_access`\n\ \ * `mode`\n * `enable_request_access`\n * `show_conversation`\n * `show_edit_history`\n\ \ * `allow_messages`\n * `allow_comments`\n" requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/thread_edit_share_link_request' responses: '200': $ref: '#/components/responses/thread_edit_share_link_response' '400': $ref: '#/components/responses/400_bad_request' '401': $ref: '#/components/responses/401_authentication' '403': $ref: '#/components/responses/403_forbidden' '500': $ref: '#/components/responses/500_server_error' /1/threads/{thread_id}/export/docx: get: security: - OAuth2: - USER_READ tags: - Threads summary: Export Document to .docx operationId: exportThreadToDocx description: Exports your specified Quip document to a DOCX file. parameters: - name: thread_id in: path schema: type: string required: true description: 'The ID or secret path of the thread for the document you want to export. ' responses: '200': $ref: '#/components/responses/200_docx' '400': $ref: '#/components/responses/400_bad_request' '401': $ref: '#/components/responses/401_authentication' '403': $ref: '#/components/responses/403_forbidden' '404': $ref: '#/components/responses/404_not_found' '500': $ref: '#/components/responses/500_server_error' /1/threads/export/async: get: security: - OAuth2: - USER_READ tags: - Threads summary: Retrieve Bulk Export Response operationId: getBulkExportResponse description: 'Returns the statuses and doc URLs after a request you made to export multiple Quip documents using the [Create Bulk Export Request](#operation/createBulkExportRequest) API method. You can export multiple Quip documents to fulfill eDiscovery and other regulatory requirements and archive documents in other systems. You can also use one of your other systems to search all document data, including comments, and export the matching results. ' parameters: - name: request_id in: query schema: type: string required: true description: 'Identifier returned by the [Create Bulk Export Request]( #operation/createBulkExportRequest) API method. ' example: AMXAEA8lSEj:1644470492776 responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/get_bulk_export_response' '400': $ref: '#/components/responses/400_bad_request' '401': $ref: '#/components/responses/401_authentication' '403': $ref: '#/components/responses/403_forbidden' '404': $ref: '#/components/responses/404_not_found' '500': $ref: '#/components/responses/500_server_error' post: security: - OAuth2: - USER_READ tags: - Threads summary: Create Bulk Export Request operationId: createBulkExportRequest description: 'This endpoint is currently available only to select customers. Please contact Quip support for more information. Submits a request to asynchronously export multiple Quip documents. This call returns a `request_id`. Pass that `request_id` into the [Retrieve Bulk Export Response]( #operation/getBulkExportResponse) call to get the doc URL and request status for each doc. Sample use cases: You can export documents to fulfill eDiscovery and other regulatory requirements and archive documents in other systems. You can also use one of your other systems to search all document data, including comments, and export the matching results. Note: - The appearance of the format(docx/xlsx/pdf) created using this API method is typically the same as documents exported in the Quip application. Sometimes there are minor formatting variations when you export via API. Example: fonts sometimes look different in a PDF exported via API. - Charts in spreadsheets are excluded from the exported PDF. - This API is subject to rate limiting. See [Document Bulk Export Rate Limit](#section/Rate-Limits/Document-Bulk-Export-Rate-Limit) for details. ' parameters: - name: Content-Type in: header schema: type: string example: application/json requestBody: content: application/json: schema: type: object properties: threads: type: array items: type: object properties: thread_id: type: string description: 'The ID of the thread for the document or spreadsheet you want to export. ' format: type: string enum: - XLSX - DOCX - PDF description: 'The format you want to export this quip document to. ' example: PDF description: 'A list of objects with `thread_id` and `format`. Each document can have its own format you want to export to. ' example: - thread_id: UcZ9AAhvqrc format: XLSX - thread_id: AVN9AAeqq5w format: DOCX include_conversations: type: boolean default: false description: 'Determines whether to include the conversation history associated with each Quip document or spreadsheet that you want to export. The formats supporting conversation history are PDF, DOCX, XLSX. Allowable values for this field: * `true`: Include the conversation history. * `false`: Don''t include the conversation history. ' example: true omit_if_unchanged_since_usec: type: integer description: 'This is Unix timestamp in microseconds. It determines whether to omit a quip document or spreadsheet if it is unchanged since this timestamp. If this field is unprovided, all documents listed in the `threads` field will be exported. ' example: 1750375408000000 locale: type: string default: en-US description: 'The preferred locale (e.g., en-US, fr-CA) used in exporting documents. ' required: - threads responses: '200': description: Successful Response content: application/json: schema: type: object properties: request_id: type: string description: 'Identifier that you can pass into the Retrieve Bulk Export Response call to get the doc URL and request status for each doc. ' example: AMXAEA8lSEj:1644470492776 '400': $ref: '#/components/responses/400_bad_request' '401': $ref: '#/components/responses/401_authentication' '403': $ref: '#/components/responses/403_forbidden' '404': $ref: '#/components/responses/404_not_found' '429': $ref: '#/components/responses/429_too_many_requests' '500': $ref: '#/components/responses/500_server_error' /1/threads/{thread_id}/export/pdf: get: security: - OAuth2: - USER_READ tags: - Threads summary: Export Slides to .pdf operationId: exportThreadToPdf description: Exports your specified Quip slide deck to PDF. parameters: - name: thread_id in: path schema: type: string required: true description: 'The ID or secret path of the thread for the document you want to export. ' responses: '200': description: Successful Response content: application/pdf: schema: description: The PDF content returned in the response body. type: string format: binary '400': $ref: '#/components/responses/400_bad_request' '401': $ref: '#/components/responses/401_authentication' '403': $ref: '#/components/responses/403_forbidden' '404': $ref: '#/components/responses/404_not_found' '500': $ref: '#/components/responses/500_server_error' /1/threads/{thread_id}/export/pdf/async: get: security: - OAuth2: - USER_READ tags: - Threads summary: Retrieve Export PDF Response operationId: getExportPdfResponse description: 'Returns the status and PDF URL after a request you made to export a Quip document or Quip spreadsheet to PDF using the [Create Export PDF Request](#operation/createExportThreadToPdfRequest) API method. You can use the PDF to mark an approval cycle as complete, take a record-keeping snapshot, or share information with your leadership or with customers. Note: - Depending on the size of a thread, it can take up to 10 minutes to complete the PDF export. If you call the Retrieve Export PDF - Response API method and your PDF isn''t available, wait a few minutes then make the call again. ' parameters: - name: request_id in: query schema: type: string required: true description: 'ID returned by the [Create Export PDF Request]( #operation/createExportThreadToPdfRequest) API method. Use this value to get the status and PDF URL after calling the [Create Export PDF Request](#operation/createExportThreadToPdfRequest) API method.' - name: thread_id in: path schema: type: string required: true description: 'ID of the thread whose document you requested a PDF export for using the [Create Export PDF Request]( #operation/createExportThreadToPdfRequest) API method.' responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/get_export_pdf_response' '400': $ref: '#/components/responses/400_bad_request' '401': $ref: '#/components/responses/401_authentication' '403': $ref: '#/components/responses/403_forbidden' '404': $ref: '#/components/responses/404_not_found' '500': $ref: '#/components/responses/500_server_error' post: security: - OAuth2: - USER_READ tags: - Threads summary: Create Export PDF Request operationId: createExportThreadToPdfRequest description: "Submits a request to asynchronously export a Quip document or\ \ Quip\nspreadsheet to PDF. This call returns a `request_id`. Pass that\n\ `request_id` into the [Retrieve Export PDF Response](\n#operation/getExportPdfResponse)\ \ call to get the PDF URL and request\nstatus. Sample use cases: You can export\ \ a document or spreadsheet to\nPDF to mark an approval cycle as complete,\ \ take a record-keeping\nsnapshot, or share the PDF with your leadership or\ \ with customers.\n\nNote:\n - Depending on the size of a thread, it can\ \ take up to 10 minutes to\n complete the PDF export. If you call the [Retrieve\ \ Export PDF\n Response](#operation/getExportPdfResponse) API method and\ \ your PDF\n isn't available, wait a few minutes then make the call again.\n\ \n - You can use this API method to complete a PDF export of a\n standalone\ \ Quip spreadsheet, not a spreadsheet inserted into a Quip\n document. When\ \ you do a PDF export of a Quip document containing a\n spreadsheet, the\ \ spreadsheet appears in the PDF.\n\n - You can export a maximum of 40,000\ \ cells in a spreadsheet to PDF.\n\n - Charts in spreadsheets are excluded\ \ from the exported PDF.\n\n - The appearance of the PDF exported using this\ \ API method is\n typically the same as if you exported a document or spreadsheet\ \ to\n PDF in the Quip application. Sometimes there are differences when\n\ \ you export via API. For example, in the PDF:\n - Bullets look bigger.\n\ \ - Emojis aren't displayed. They're replaced with boxes in the PDF.\n\ \ - In large spreadsheets or spreadsheets that break across pages,\n \ \ some of the data is hidden.\n - Live apps and graphics are distorted.\n\ \ - Page breaks appear in the middle of content (such as a live\n app)\ \ that's supposed to be kept on the same page.\n - Some Salesforce data\ \ is hidden based on permissions set by the\n Salesforce admin.\n" parameters: - name: thread_id in: path schema: type: string required: true description: ID of the Quip document or spreadsheet that you want to export to PDF. - name: destination_thread_id in: query schema: type: string description: 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. - name: salesforce_org_id in: query schema: type: string description: 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`. - name: salesforce_record_id in: query schema: type: string description: 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`. - name: sheet_name in: query schema: type: string description: 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. - name: apply_print_options in: query schema: type: boolean default: false description: '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`: Don''t apply print options to the PDF.' responses: '200': description: Successful Response content: application/json: schema: type: object properties: request_id: type: string description: 'ID that you can pass into the [Retrieve Export PDF Response](#operation/getExportPdfResponse) call to get the PDF URL and request status. ' example: IAcAAAY7zCRAMXAEA8lSEj1644527357113 status: type: string enum: - PROCESSING description: 'The status of your request. Possible statuses are: * `PROCESSING`: The PDF export is in progress. ' '400': $ref: '#/components/responses/400_bad_request' '401': $ref: '#/components/responses/401_authentication' '403': $ref: '#/components/responses/403_forbidden' '404': $ref: '#/components/responses/404_not_found' '500': $ref: '#/components/responses/500_server_error' /1/threads/{thread_id}/export/xlsx: get: security: - OAuth2: - USER_READ tags: - Threads summary: Export Spreadsheet to .xlsx operationId: exportThreadToXlsx description: Exports your specified Quip spreadsheet to an XLSX file. parameters: - name: thread_id in: path schema: type: string required: true description: 'The ID or secret path of the thread for the document you want to export. ' responses: '200': description: Successful Response content: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: schema: description: The XLSX content returned in the response body. type: string format: binary '400': $ref: '#/components/responses/400_bad_request' '401': $ref: '#/components/responses/401_authentication' '403': $ref: '#/components/responses/403_forbidden' '404': $ref: '#/components/responses/404_not_found' '500': $ref: '#/components/responses/500_server_error' /2/threads/{threadIdOrSecretPath}/folders: get: security: - OAuth2: - USER_READ tags: - Threads summary: Get Thread Folders V2 operationId: getThreadFoldersV2 description: "Returns the list of folders that a Quip thread (document, spreadsheet,\n\ \ or chat) is in. Use this API method to monitor\n information-sharing and\ \ improve folder organization on your\n Quip site.\n" parameters: - $ref: '#/components/parameters/thread_id_or_secret_path_for_get' - $ref: '#/components/parameters/cursor' - $ref: '#/components/parameters/limit' responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/thread_get_folders_v2_response' '400': $ref: '#/components/responses/400_bad_request' '401': $ref: '#/components/responses/401_authentication' '403': $ref: '#/components/responses/403_forbidden' '404': $ref: '#/components/responses/404_not_found' '500': $ref: '#/components/responses/500_server_error' /1/threads/{id}: get: security: - OAuth2: - USER_READ tags: - Threads deprecated: true summary: Get Thread operationId: getThread description: "Get information about a thread. You may also pass in a 12 character\n\ URL suffix to get the permanent thread ID.\nIf Mirrored Salesforce Permissions\ \ is enabled, data included in a\ndocument by using a Salesforce Data Mention\ \ is returned only if the\ndata mention has been displayed to the requesting\ \ user.\n\n**Note:** Quip has introduced faster, more scalable versions of\ \ this\nAPI method:\n[Get Thread V2](#operation/getThreadV2),\n[Get Thread\ \ HTML V2](#operation/getThreadHtmlV2),\n[Get Thread Members V2](#operation/getThreadMembersV2),\n\ [Get Thread Invited Members V2](\n #operation/getThreadInvitedMembersV2),\n\ and\n[Get Thread Folders V2](#operation/getThreadFoldersV2).\nYou're encouraged\ \ to modify your integrations to point to the\nlatest versions of API methods.\ \ You can continue to access legacy\nversions of API methods until we announce\ \ when support for them ends.\n\nSee Also:\n\n* [REST API Versioning FAQ](#section/FAQs/REST-API-Versioning-FAQ)\n" parameters: - name: id in: path schema: type: string required: true description: The ID or secret path of the thread to inspect. responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/thread_info_v1' '400': $ref: '#/components/responses/400_bad_request' '401': $ref: '#/components/responses/401_authentication' '403': $ref: '#/components/responses/403_forbidden' '404': $ref: '#/components/responses/404_not_found' '500': $ref: '#/components/responses/500_server_error' /2/threads/{threadIdOrSecretPath}: get: security: - OAuth2: - USER_READ tags: - Threads summary: Get Thread V2 operationId: getThreadV2 description: 'Returns basic information about a Quip thread (document, spreadsheet, or chat). This information includes things such as the ID, title, last time the thread was edited and the thread''s link sharing settings. ' parameters: - $ref: '#/components/parameters/thread_id_or_secret_path_for_get' responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/thread_get_v2' '400': $ref: '#/components/responses/400_bad_request' '401': $ref: '#/components/responses/401_authentication' '403': $ref: '#/components/responses/403_forbidden' '404': $ref: '#/components/responses/404_not_found' '500': $ref: '#/components/responses/500_server_error' /2/threads/{threadIdOrSecretPath}/html: get: security: - OAuth2: - USER_READ tags: - Threads summary: Get Thread Html V2 operationId: getThreadHtmlV2 description: 'Get the body of the thread in html format. If Mirrored Salesforce Permissions is enabled, data included in a document by using a Salesforce Data Mention is returned only if the data mention has been displayed to the requesting user. ' parameters: - $ref: '#/components/parameters/thread_id_or_secret_path' - $ref: '#/components/parameters/cursor' - $ref: '#/components/parameters/limit' responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/thread_get_html_v2_response' '400': $ref: '#/components/responses/400_bad_request' '401': $ref: '#/components/responses/401_authentication' '403': $ref: '#/components/responses/403_forbidden' '404': $ref: '#/components/responses/404_not_found' '500': $ref: '#/components/responses/500_server_error' '504': $ref: '#/components/responses/504_gateway_timeout' /2/threads/{threadIdOrSecretPath}/invited-members: get: security: - OAuth2: - USER_READ tags: - Threads summary: Get Thread Invited Members V2 operationId: getThreadInvitedMembersV2 description: 'Returns the list of users who were invited via email to become direct members of a Quip thread (document, spreadsheet, or chat). Use this API method to monitor requests for collaboration with people outside of your Quip site. Note: This API method doesn''t return the list of users who are already direct members of a thread. ' parameters: - $ref: '#/components/parameters/thread_id_or_secret_path' - $ref: '#/components/parameters/cursor' - $ref: '#/components/parameters/limit' responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/thread_get_invited_members_v2_response' '400': $ref: '#/components/responses/400_bad_request' '401': $ref: '#/components/responses/401_authentication' '403': $ref: '#/components/responses/403_forbidden' '404': $ref: '#/components/responses/404_not_found' '500': $ref: '#/components/responses/500_server_error' /1/threads/lock-edits: post: security: - OAuth2: - USER_MANAGE tags: - Threads summary: Lock or Unlock a Thread operationId: lockThread description: 'Lock or unlock edits to a thread. ' requestBody: content: application/x-www-form-urlencoded: schema: type: object properties: thread_id: type: string description: 'The ID or secret path of the thread whose document you want to modify. ' edits_disabled: type: boolean description: If true this will disable edits on this thread. If false, it will enable edits on this thread. required: - thread_id - edits_disabled parameters: - name: Content-Type in: header schema: type: string example: application/x-www-form-urlencoded responses: '200': description: Successful Response content: application/json: schema: description: Empty JSON object type: object '400': $ref: '#/components/responses/400_bad_request' '401': $ref: '#/components/responses/401_authentication' '403': $ref: '#/components/responses/403_forbidden' '404': $ref: '#/components/responses/404_not_found' '500': $ref: '#/components/responses/500_server_error' /1/threads/lock-section-edits: post: security: - OAuth2: - USER_MANAGE tags: - Threads summary: Lock or Unlock a Section operationId: lockThreadSection description: 'Lock or unlock edits to a section. ' requestBody: content: application/x-www-form-urlencoded: schema: type: object properties: thread_id: type: string description: 'The ID or secret path of the thread you want to modify. ' section_id: type: string description: 'The ID for the section you want to lock or unlock. ' edits_disabled: type: string description: If true this will disable edits for this section. If false, it will enable edits for this thread. required: - thread_id - section_id - edits_disabled parameters: - name: Content-Type in: header schema: type: string example: application/x-www-form-urlencoded responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/thread_info_v1' '400': $ref: '#/components/responses/400_bad_request' '401': $ref: '#/components/responses/401_authentication' '403': $ref: '#/components/responses/403_forbidden' '404': $ref: '#/components/responses/404_not_found' '500': $ref: '#/components/responses/500_server_error' /1/threads/live-paste: post: security: - OAuth2: - USER_READ - USER_WRITE tags: - Threads summary: Create a Live Paste Section In a Document operationId: createLivePasteSection description: 'Add a section to a document that tracks another section and can automatically update when the source section is updated. We determine where to insert the new content based on the `location` argument. Some `location` values are relative to another section, which is specified by `destination_section_id`, enabling fine-grained editing. For example, to add a section to the end of an existing section, you would send the ID of the existing section in the list as the `destination_section_id` and send `2: AFTER_SECTION` as the `location`. To get the IDs of sections in an existing document, parse the HTML returned by the [Get Thread](#operation/getThread). Every paragraph, list item, and table cell will have an HTML `id` attribute you can use in this method. Live Paste does not support individual items in lists. Alternatively the content of both the source and the destination document can be referred to by document ranges. A document range is a heading plus all sections underneath it up to the next heading of same or larger size. The `location` values `6`, `7` and `8` support document ranges in combination with `destination_document_range` for the destination document. The `is_document_range_source` parameter supports document ranges for the source document when set to `True`, in combination with the `source_document_range` parameter. Document ranges are available for documents only, i.e. not for spreadsheets. ' requestBody: content: application/x-www-form-urlencoded: schema: type: object properties: source_thread_id: type: string description: 'The ID or secret path of the thread to copy from. ' is_document_range_source: type: boolean default: false description: 'If `true`, `source_document_range` is required and is where the content of the source thread is acquired. If `source_section_ids` is provided in this case, an error will be returned. If `false`, the content is referenced by `source_section_ids`. In this case, `source_section_ids` is required and an error is returned if `source_document_range` is provided. ' source_section_ids: type: string description: A comma-separated list of sequential sections of the source thread to copy. Required if `is_document_range_source` is set to `false`. source_document_range: type: string description: 'The string of the heading in the source document that defines the document range you want to copy. The document range includes the header and all sections below it until the next heading of the same size or larger. This parameter is required if `is_document_range_source` is set to `true`. ' destination_thread_id: type: string description: The ID of the thread you want to modify. location: type: string default: 0 enum: - 1 - 2 - 3 - 4 - 6 - 7 - 8 - 9 description: "Where we should insert the new content.\n- `0: APPEND`\ \ - Append to the end of the document.\n- `1: PREPEND` - Prepend\ \ to the beginning of the document.\n- `2: AFTER_SECTION` - Insert\ \ after the section specified\n by `section_id`.\n\n- `3: BEFORE_SECTION`\ \ - Insert before the section\n specified by `section_id`.\n\n\ - `4: REPLACE_SECTION` - Delete the section specified by\n `section_id`\ \ and insert the new content at that\n location.\n\n- `6: AFTER_DOCUMENT_RANGE`\ \ - Insert after the document\n range specified by `document_range`.\n\ \n- `7: BEFORE_DOCUMENT_RANGE` - Insert before the document\n\ \ range specified by `document_range`.\n\n- `8: REPLACE_DOCUMENT_RANGE`\ \ - Delete the document range\n specified by `document_range`\ \ and insert the new content\n at that location.\n\n(`5` is intentionally\ \ omitted to have same numbering scheme as the edit-document endpoint.)\n\ Options `6`, `7` and `8` work only on documents.\n" destination_section_id: type: string description: The ID or secret path of the thread to be modified. This cannot be the same as the `source_thread_id`. Required for `location` values `6` - `8`. destination_document_range: type: string description: 'The string of the header in the destination document that defines the document range you want to modify. Required for `location` values `1` - `4` ' update_automatic: type: string description: If set to true, the destination section will update automatically when the source section changes. Live Pastes will not be able to update automatically if the admin has disabled automatic updates for Live Paste in the Admin Console. default: true required: - source_thread_id - destination_thread_id parameters: - name: Content-Type in: header schema: type: string example: application/x-www-form-urlencoded responses: '200': description: Example Response content: application/json: schema: $ref: '#/components/schemas/thread_info_v1' examples: example1: summary: Example Response value: thread: author_id: HcLAEARatvR thread_class: document id: SIdAAANKtjW created_usec: 1588263820524431 updated_usec: 1588264045370339 title: Test destination document link: https://corp.quip.com/EJGEA1dknX2g type: document document_id: SIdABA4DG5G user_ids: - HcLAEARatvR shared_folder_ids: [] expanded_user_ids: - HcLAEARatvR invited_user_emails: [] html: "Test destination document\n\u200B \n" example2: summary: Live Paste with Document Ranges value: thread: author_id: HcLAEARatvR thread_class: document id: SIdAAANKtjW created_usec: 1588263820524431 updated_usec: 1603817042093259 title: Test destination document link: https://corp.quip.com/EJGEA1dknX2g type: document is_template: false owning_company_id: DYTAcAiIFUr document_id: SIdABA4DG5G is_deleted: false user_ids: - HcLAEARatvR - bZBAEARddtM shared_folder_ids: [] expanded_user_ids: - bZBAEARddtM - HcLAEARatvR invited_user_emails: [] html: 'Test destination documentThis is a test section id=''SIdACAxnStn''>Another H1 Header' '400': $ref: '#/components/responses/400_bad_request' '401': $ref: '#/components/responses/401_authentication' '403': $ref: '#/components/responses/403_forbidden' '404': $ref: '#/components/responses/404_not_found' '500': $ref: '#/components/responses/500_server_error' /1/threads/mark-as-moved-to-external: {} /2/threads/{threadIdOrSecretPath}/members: get: security: - OAuth2: - USER_READ tags: - Threads summary: Get Thread Members V2 operationId: getThreadMembersV2 description: 'Returns the list of users who are members of a Quip thread (document, spreadsheet, or chat) because they were added to it directly. Use this API method to monitor information-sharing on your Quip site. Note: This API method doesn''t return the list of users who were added via other means including: - Folder-sharing - Link-sharing - Salesforce Synced Sharing - Email invitation.' parameters: - $ref: '#/components/parameters/thread_id_or_secret_path_for_get' - $ref: '#/components/parameters/cursor' - $ref: '#/components/parameters/limit' responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/thread_get_members_v2_response' '401': $ref: '#/components/responses/401_authentication' '403': $ref: '#/components/responses/403_forbidden' '404': $ref: '#/components/responses/404_not_found' '500': $ref: '#/components/responses/500_server_error' /2/threads/: get: security: - OAuth2: - USER_READ tags: - Threads summary: Get Threads V2 operationId: getThreadsV2 description: 'Bulk variant of the [Get Thread](#operation/getThreadV2) endpoint. Returns basic information about multiple Quip threads (documents, spreadsheets, or chats). This information for each thread includes things such as the ID, title, last time the thread was edited and the thread''s link sharing settings. ' parameters: - name: ids in: query schema: type: string required: true description: 'The IDs or secret paths of the threads to get information about. You can pass in a maximum of 100 of either of these identifiers: * `ID`: You can find this in the "id" response field of the [Get Thread](#operation/getThread) API method. * `secret path`: You can find this in the URL of a thread. For example, in this URL: "https://quip.com/3fs7B2leat8/TrackingDocument", the secret path is 3fs7B2leat8. You can also find this ID in the "secret_path" response field of this API method. ' responses: '200': description: Successful response. content: application/json: schema: $ref: '#/components/schemas/thread_multi_get_v2' '400': $ref: '#/components/responses/400_bad_request' '401': $ref: '#/components/responses/401_authentication' '403': $ref: '#/components/responses/403_forbidden' '404': $ref: '#/components/responses/404_not_found' '413': $ref: '#/components/responses/413_payload_too_large' '500': $ref: '#/components/responses/500_server_error' /1/threads/: get: security: - OAuth2: - USER_READ tags: - Threads deprecated: true summary: Get Threads operationId: getThreads description: 'Bulk variant of the [Get Thread](#operation/getThread) endpoint. Returns basic information about multiple Quip threads (documents, spreadsheets, or chats). This information for each thread includes things such as the ID, title, last time the thread was edited and the thread''s link sharing settings. **Note:** Quip has introduced a faster, more scalable version of this API method: [Get Threads V2](#operation/getThreadsV2). You''re encouraged to modify your integrations to point to the latest versions of API methods. You can continue to access legacy versions of API methods until we announce when support for them ends. See Also: * [REST API Versioning FAQ](#section/FAQs/REST-API-Versioning-FAQ) ' parameters: - name: ids in: query schema: type: string required: true description: A list of thread IDs or secret paths. example: KSRAAAikr74,LSRAAAikr74 responses: '200': description: A map from thread IDs to thread information. content: application/json: schema: type: object additionalProperties: x-additionalPropertiesName: thread_id allOf: - $ref: '#/components/schemas/thread_info_v1' '400': $ref: '#/components/responses/400_bad_request' '401': $ref: '#/components/responses/401_authentication' '403': $ref: '#/components/responses/403_forbidden' '404': $ref: '#/components/responses/404_not_found' '413': $ref: '#/components/responses/413_payload_too_large' '500': $ref: '#/components/responses/500_server_error' /1/threads/new-chat: post: security: - OAuth2: - USER_WRITE tags: - Threads summary: Create a Chat Room operationId: createChatRoom description: 'Creates a chat room. ' requestBody: content: application/x-www-form-urlencoded: schema: type: object properties: message: type: string description: Plain text content of the new message that is posted by the author of the chat room. Content must not exceed 100KB. title: type: string description: 'The title of the new chat room. Title length must not exceed 10 KB. ' member_ids: type: string description: 'A comma-separated list of user IDs to add as members to the chat room. ' required: - title parameters: - name: Content-Type in: header schema: type: string example: application/x-www-form-urlencoded responses: '200': description: Successful Response content: application/json: schema: allOf: - $ref: '#/components/schemas/thread_info_v1' - example: thread: type: chat thread_class: channel '400': $ref: '#/components/responses/400_bad_request' '401': $ref: '#/components/responses/401_authentication' '403': $ref: '#/components/responses/403_forbidden' '500': $ref: '#/components/responses/500_server_error' /1/threads/new-document: post: security: - OAuth2: - USER_WRITE tags: - Threads summary: Create a Document or Spreadsheet operationId: createDocument description: 'Creates a document or spreadsheet, returning the new thread in the same format as [Get Thread](#operation/getThread). This endpoint doesn''t support slides anymore because they''re retired as described in [this article]( https://help.salesforce.com/s/articleView?id=000355252&type=1). ' requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/new_document_request' parameters: - name: Content-Type in: header schema: type: string example: application/x-www-form-urlencoded responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/thread_info_v1' '400': $ref: '#/components/responses/400_bad_request' '401': $ref: '#/components/responses/401_authentication' '403': $ref: '#/components/responses/403_forbidden' '500': $ref: '#/components/responses/500_server_error' /1/threads/recent: get: security: - OAuth2: - USER_READ tags: - Threads summary: Get Recent Threads operationId: getRecentThreads description: 'Returns the most recent threads to have received messages, similar to the updates view in the Quip app. Results are returned in the same format as [Get Thread](#operation/getThread). ' parameters: - name: count in: query schema: type: integer minimum: 1 maximum: 50 default: 10 description: The number of threads to return. - name: max_updated_usec in: query schema: type: integer format: int64 description: 'UNIX epoch timestamp. Searches only for threads that were last updates before or at this timestamp. ' - name: include_hidden in: query schema: type: boolean description: If true, response includes hidden threads. responses: '200': description: A map from thread IDs to thread information. content: application/json: schema: type: object additionalProperties: x-additionalPropertiesName: thread_id allOf: - $ref: '#/components/schemas/thread_info_v1' '401': $ref: '#/components/responses/401_authentication' '403': $ref: '#/components/responses/403_forbidden' '404': $ref: '#/components/responses/404_not_found' '500': $ref: '#/components/responses/500_server_error' /1/threads/remove-members: post: security: - OAuth2: - USER_MANAGE tags: - Threads summary: Remove People from a Thread or Remove a Thread from Folders operationId: removeMembersFromThreadOrThreadFromFolders description: 'Removes the given individuals from the given thread and/or removes the thread from the given folders. We return the updated thread in same format as [Get Thread](#operation/getThread). ' requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/thread_remove_members_v1_request' parameters: - name: Content-Type in: header schema: type: string example: application/x-www-form-urlencoded responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/thread_info_v1' '400': $ref: '#/components/responses/400_bad_request' '401': $ref: '#/components/responses/401_authentication' '403': $ref: '#/components/responses/403_forbidden' '404': $ref: '#/components/responses/404_not_found' '500': $ref: '#/components/responses/500_server_error' /1/threads/resolve-data-mentions/{thread_id}: {} /1/threads/search: get: security: - OAuth2: - USER_READ tags: - Threads summary: Search for Threads operationId: searchForThreads description: 'Returns a list of threads whose content matches words in the given query. Threads are sorted from most to least relevant. ' parameters: - name: query in: query schema: type: string required: true description: 'A text string containing words delimited by spaces used to match thread content or titles. ' example: |