PATCH /public/v1/documents/{id}/fields
Assign, reassign, or unassign document fields to recipients. Supports bulk operations by accepting multiple field assignment items in a single request.
🚧 Before you start
- The document must be in the 'Draft' (
document.draft) status.- You must have the 'Can Edit Document' permission.
Servers
- https://api.pandadoc.com
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
id |
String | Yes |
Document UUID. |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
fields[] |
Array | Yes |
An array of field assignment operations. Each item specifies a field and the recipient it should be assigned to. |
fields[].assigned_to |
String | Yes |
UUID of the recipient to assign the field to. Set to |
fields[].field_id |
String | Yes |
UUID of the field to assign or unassign. |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.