POST /public/v1/documents/{id}/linked-objects
Create a linked object in the document.
🚧
You can only link each document to each CRM once. This ensures the consistent functionality of the two-way CRM sync.
You can, however, link one document to several external systems.
Servers
- https://api.pandadoc.com
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
id |
String | Yes |
Specify document ID. |
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 |
|---|---|---|---|
provider |
String | Yes |
CRM name (lowercase). See the list of available providers: https://developers.pandadoc.com/reference/link-service#examples-of-the-most-popular-crms |
entity_id |
String | Yes |
Entity unique identifier. The system validates if the entity exists. |
entity_type |
String | Yes |
Entity type. See the available entity types: https://developers.pandadoc.com/reference/link-service#examples-of-the-most-popular-crms |
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.