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

Servers

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 above.

entity_id String Yes

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

entity_type String Yes

Entity type. The system validates if the type is supported. See the list for each CRM above.

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. 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.
  3. Click Test request to test run your request to the API and see the API's response.