v1

latestOpenAPI 3.0.3MIT2026-07-24122271451.2 KB

Document Link to CRM

Create Linked Object

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.

post/public/v1/documents/{id}/linked-objects

Path parameters

idstring required

Specify document ID.

Request body

providerstring required

CRM name (lowercase).

See the list of available providers: https://developers.pandadoc.com/reference/link-service#examples-of-the-most-popular-crms

entity_typestring required

Entity type.

See the available entity types: https://developers.pandadoc.com/reference/link-service#examples-of-the-most-popular-crms

entity_idstring required

Entity unique identifier. The system validates if the entity exists.

Example request

{
  "provider": "pipedrive",
  "entity_type": "deal",
  "entity_id": "9372"
}

Response

Created

idstring

Linked object identifier (link_id).

providerstring

CRM name (lowercase).

See the list of available providers: https://developers.pandadoc.com/reference/link-service#examples-of-the-most-popular-crms

entity_typestring

Entity type.

See the available entity types: https://developers.pandadoc.com/reference/link-service#examples-of-the-most-popular-crms

entity_idstring

Entity unique identifier. The system validates if the entity exists.

Example response

{
  "id": "abb4d3fc-919b-491e-9e08-775036660c0b",
  "provider": "pipedrive",
  "entity_type": "deal",
  "entity_id": "9372",
  "children": [
    {
      "id": "abb4d3fc-919b-491e-9e08-775036660c0b",
      "entity_type": "deal",
      "entity_id": "9372"
    }
  ]
}