LinkSquares Destination

Nexla's bi-directional connectors allow data to flow both to and from any location, making it simple to create a FlexFlow data flow that sends data to a LinkSquares location.

LinkSquares

Create a LinkSquares Destination

1. Click the + icon on the Nexset that will be sent to the LinkSquares destination, and select the Send to Destination option from the menu.

2. Select the LinkSquares connector from the list of available destination connectors. Then, select the credential that will be used to connect to the LinkSquares organization, and click Next; or, create a new LinkSquares credential for use in this flow.

3. In Nexla, LinkSquares destinations can be created using pre-built endpoint templates, which expedite destination setup for common LinkSquares API write operations. Each template is designed specifically for the corresponding LinkSquares endpoint, making destination configuration easy and efficient.
   • To configure this destination using a template, follow the instructions in Configure Using a Template.

   LinkSquares destinations can also be configured manually, allowing you to send data to LinkSquares endpoints not included in the pre-built templates or apply further customizations to exactly suit your needs.
   • To configure this destination manually, follow the instructions in Configure Manually.

Configure Using a Template

Nexla provides pre-built templates that can be used to rapidly configure destinations to send data to common LinkSquares endpoints. Each template is designed specifically for the corresponding LinkSquares endpoint, making destination setup easy and efficient.

• To configure this destination using a template, select the endpoint to which data will be sent from the Endpoint pulldown menu. Then, click on the template in the list below to expand it, and follow the instructions to configure additional endpoint settings.

  Link Agreements in Finalize

  This endpoint links related agreements together within the LinkSquares Finalize workflow. Use this endpoint when you need to associate agreements—for example, linking an amendment to its parent agreement or connecting related contracts in your Finalize workspace.

  • The request body should include the IDs of the agreements to be linked. Nexla sends the Nexset data as a JSON payload to the LinkSquares Finalize API. Ensure the Nexset contains the required fields for the link relationship as defined by the LinkSquares Finalize API schema.
  • This endpoint uses a POST method and sends data as a single record per API call (batch mode is disabled).

  For complete information about linking agreements in Finalize and the required request body structure, refer to the LinkSquares Finalize API Technical Overview.

  Set Finalize Agreement Owner

  This endpoint sets or updates the owner of a Finalize agreement. Use this endpoint when you need to assign agreement ownership programmatically—for example, as part of an onboarding workflow that routes new agreements to the appropriate account manager or legal reviewer.

  • This endpoint requires the following configuration:

    • Agreement ID: Enter the unique identifier of the Finalize agreement whose owner you want to set. This value is used in the API URL path. Agreement IDs can be obtained from the LinkSquares Finalize interface or by using the List Agreements (Finalize) source endpoint.
  • The request body should include the user ID of the new agreement owner. Nexla sends the Nexset data as a JSON payload using a PATCH method. Ensure the Nexset contains the required owner field as defined by the LinkSquares Finalize API.

  For complete information about setting agreement owners in Finalize, refer to the LinkSquares Finalize API Technical Overview.

  Rename Finalize Agreement

  This endpoint updates the name of a Finalize agreement. Use this endpoint when you need to rename agreements programmatically—for example, as part of a standardization workflow that applies consistent naming conventions across your contract portfolio.

  • This endpoint requires the following configuration:

    • Agreement ID: Enter the unique identifier of the Finalize agreement you want to rename. This value is used in the API URL path. Agreement IDs can be obtained from the LinkSquares Finalize interface or by using the List Agreements (Finalize) source endpoint.
  • The request body should include the new agreement name. Nexla sends the Nexset data as a JSON payload using a PATCH method. Ensure the Nexset contains the updated name field as defined by the LinkSquares Finalize API.

  For complete information about renaming Finalize agreements, refer to the LinkSquares Finalize API Technical Overview.

  Create Agreement Metadata

  This endpoint creates metadata for a new agreement in LinkSquares Analyze, including the agreement name, file name, type, tags, and terms. The API returns a presigned URL that can be used to upload the actual agreement file. Use this endpoint as the first step in a multi-step agreement ingestion workflow.

  • The request body should include the agreement metadata fields. The required and optional fields are defined by the LinkSquares Analyze API and typically include:

    • Name: The display name of the agreement as it will appear in LinkSquares Analyze.
    • File Name: The file name of the document to be uploaded (including the file extension, such as .pdf or .docx).
    • Type: The agreement type as configured in your LinkSquares account (e.g., Master Service Agreement, NDA, SOW).
    • Tags: Optional tags to apply to the agreement for categorization and filtering.
    • Terms: Optional pre-populated term values (Smart Values) to associate with the agreement.
  • The API response includes a presigned S3 URL that must be used to upload the agreement file within a limited time window. The upload status can be checked using the Get Upload Status source endpoint after the file has been uploaded.

  For complete information about the Analyze API agreement ingestion workflow and the required request body structure, refer to the LinkSquares Analyze API Sample Use Cases.

  Create Agreement Attachment

  This endpoint adds an attachment to an existing agreement in LinkSquares Analyze. The API returns a presigned URL that can be used to upload the attachment file. Use this endpoint to programmatically associate supplementary documents—such as exhibits, amendments, or supporting materials—with an existing contract.

  • This endpoint requires the following configuration:

    • Agreement ID: Enter the unique identifier of the Analyze agreement to which the attachment will be added. This value is used in the API URL path. Agreement IDs can be obtained from the LinkSquares Analyze interface or by using the Retrieve All Agreements source endpoint.
  • The request body should include the attachment metadata (such as file name and type) as defined by the LinkSquares Analyze API. The API response includes a presigned URL for uploading the attachment file.

  For complete information about adding attachments to Analyze agreements, refer to the LinkSquares Analyze API Sample Use Cases.

  Update Agreement

  This endpoint updates an existing agreement in LinkSquares Analyze with new metadata, tags, or status information. Use this endpoint to programmatically modify agreement properties—for example, updating term values, reassigning tags, or changing the agreement status as part of an automated contract management workflow.

  • This endpoint requires the following configuration:

    • Agreement ID: Enter the unique identifier of the Analyze agreement you want to update. This value is used in the API URL path. Agreement IDs can be obtained from the LinkSquares Analyze interface or by using the Retrieve All Agreements source endpoint.
  • The request body should include only the fields you want to update. Nexla sends the Nexset data as a JSON payload using a PATCH method, so only the fields present in the payload will be modified. Unspecified fields will retain their current values.

  The LinkSquares Analyze API supports updating terms (Smart Values), name, type, notes, tags, and parent-child hierarchies. For complete information about the update agreement endpoint and supported fields, refer to the LinkSquares Analyze API Sample Use Cases.

  Create Agreement (Finalize)

  This endpoint creates a new agreement in LinkSquares Finalize using a template or file upload. Use this endpoint when you need to initiate the contract drafting and negotiation workflow from an external system, such as submitting a new request for legal review from a CRM, ERP, or other business application.

  • The request body should include the agreement details required by the Finalize API, such as the template ID, agreement name, and any pre-populated field values. Nexla sends the Nexset data as a JSON payload using a POST method.
  • The API response includes the new agreement ID and initial status, which can be used to track the agreement's progress through the Finalize workflow using the Get Agreement (Finalize) source endpoint.

  For complete information about creating Finalize agreements and the required request body structure, refer to the LinkSquares Finalize API Technical Overview.

  Upload Agreement Attachment (Finalize)

  This endpoint uploads an attachment file to an existing agreement in LinkSquares Finalize. Use this endpoint to programmatically add supporting documents, exhibits, or reference files to a Finalize agreement during or after the drafting process.

  • This endpoint requires the following configuration:

    • Agreement ID: Enter the unique identifier of the Finalize agreement to which the attachment will be added. This value is used in the API URL path. Agreement IDs can be obtained from the LinkSquares Finalize interface or by using the List Agreements (Finalize) source endpoint.
  • The request body should include the attachment metadata as defined by the LinkSquares Finalize API. Nexla sends the Nexset data as a JSON payload using a POST method.

  For complete information about uploading attachments to Finalize agreements, refer to the LinkSquares Finalize API Technical Overview.

  Update Agreement (Finalize)

  This endpoint updates agreement details in LinkSquares Finalize, including status, completion flag, and question answers. Use this endpoint to programmatically advance an agreement through its workflow stages, mark it as complete, or update intake form responses from an external system.

  • This endpoint requires the following configuration:

    • Agreement ID: Enter the unique identifier of the Finalize agreement you want to update. This value is used in the API URL path. Agreement IDs can be obtained from the LinkSquares Finalize interface or by using the List Agreements (Finalize) source endpoint.
  • The request body should include only the fields you want to update. Nexla sends the Nexset data as a JSON payload using a PATCH method. Supported update fields include status, completion flag, and question (token) answer values.

  The Finalize API also supports updating token answers programmatically via PATCH, allowing you to modify specific intake form data fields directly through the API. For complete information, refer to the LinkSquares Finalize API Technical Overview.

  Upload Agreement Version

  This endpoint uploads a new version of a Finalize agreement with an updated status and version file reference. Use this endpoint when you need to submit a revised contract document as part of the negotiation workflow—for example, after incorporating redlines from a counterparty.

  • This endpoint requires the following configuration:

    • Agreement ID: Enter the unique identifier of the Finalize agreement for which a new version is being uploaded. This value is used in the API URL path. Agreement IDs can be obtained from the LinkSquares Finalize interface or by using the List Agreements (Finalize) source endpoint.
  • The request body should include the new version details, such as the status and version file reference, as defined by the LinkSquares Finalize API. Nexla sends the Nexset data as a JSON payload using a POST method.

  For complete information about uploading agreement versions in Finalize, refer to the LinkSquares Finalize API Technical Overview.

  Create Agreement Version (Finalize v2)

  This endpoint creates and finalizes a new version of a Finalize agreement using the v2 API, with a version file and status. Use this endpoint when you need to create agreement versions using the most current Finalize API capabilities, which offer additional fields and improved version management compared to the v1 endpoint.

  • This endpoint requires the following configuration:

    • Agreement ID: Enter the unique identifier of the Finalize agreement for which a new version is being created. This value is used in the API URL path. Agreement IDs can be obtained from the LinkSquares Finalize interface or by using the List Agreements (Finalize v2) source endpoint.
  • The request body should include the version details as defined by the LinkSquares Finalize v2 API. Nexla sends the Nexset data as a JSON payload using a POST method.

  For complete information about the Finalize v2 API and agreement version creation, refer to the LinkSquares Finalize API Technical Overview.

  Complete Version Upload

  This endpoint marks the upload of an agreement version as complete in LinkSquares Finalize v2. Use this endpoint as the final step in a multi-step version upload workflow after the version file has been successfully uploaded to the presigned URL provided by the Create Agreement Version (Finalize v2) endpoint.

  • This endpoint requires the following configuration:

    • Agreement ID: Enter the unique identifier of the Finalize agreement. This value is used in the API URL path.
    • Version ID: Enter the unique identifier of the specific agreement version to mark as complete. Version IDs are returned by the Create Agreement Version (Finalize v2) endpoint and can also be retrieved using the List Agreement Versions source endpoint.
  • The request body should include any completion metadata as defined by the LinkSquares Finalize v2 API. Nexla sends the Nexset data as a JSON payload using a PATCH method.

  For complete information about the version upload completion workflow in Finalize v2, refer to the LinkSquares Finalize API Technical Overview.

  Create Agreement (Finalize v2)

  This endpoint creates a new agreement in LinkSquares Finalize using the v2 API, with support for an optional file, template, tokens (field values), answers, and tables. Use this endpoint when you need to create agreements using the most current Finalize API capabilities, which provide a richer set of options for agreement initialization compared to the v1 endpoint.

  • The request body should include the agreement creation details as defined by the LinkSquares Finalize v2 API. Optional fields include a file reference, template ID, pre-populated token (field) values, question answers, and table data. Nexla sends the Nexset data as a JSON payload using a POST method.
  • The API response includes the new agreement ID and initial status, which can be used to track the agreement's progress through the Finalize workflow using the Get Agreement (Finalize) or List Agreements (Finalize v2) source endpoints.

  For complete information about creating Finalize v2 agreements and the supported request body fields, refer to the LinkSquares Finalize API Technical Overview.

Configure Manually

LinkSquares destinations can be manually configured to send data to any valid LinkSquares API endpoint. Manual configuration provides maximum flexibility when you need to use endpoints not covered by pre-built templates, add custom query parameters, or apply additional customizations to the API request.

Using manual configuration, you can also configure Nexla to automatically send the response received from the LinkSquares API after each call to a new Nexla webhook data source, enabling you to track the status of each API call and capture any data returned in the response.

API Method

1. To manually configure this destination, select the Advanced tab at the top of the configuration screen.

2. Select the API method that will be used for calls to the LinkSquares API from the Method pulldown menu. The most common methods for LinkSquares write operations are:

   • POST: For creating new agreements, versions, attachments, or other resources
   • PATCH: For partially updating existing agreements, statuses, or metadata fields

Data Format

3. Select the format in which the Nexset data will be sent to the LinkSquares API from the Content Format pulldown menu. Nexla will automatically convert the data to the selected format for each API call. The LinkSquares API accepts JSON (application/json) for all write operations.

API Endpoint URL

4. Enter the URL of the LinkSquares API endpoint to which you want to send the Nexset data in the URL field. This should be the complete URL including the protocol (https://) and any required path parameters.

   The base URL for the LinkSquares production API is https://api.linksquares.com. Append the appropriate path for the endpoint you want to call. For example:

   • Create an Analyze agreement: https://api.linksquares.com/analyze/v1/agreements
   • Update an Analyze agreement: https://api.linksquares.com/analyze/v2/agreements/{'{agreement_id}'}
   • Create a Finalize v2 agreement: https://api.linksquares.com/finalize/v2/agreements

Request Headers

Optional

• If Nexla should include any additional request headers in API calls to this destination, enter the headers & corresponding values as comma-separated pairs in the Request Headers field (e.g., header1:value1,header2:value2).

  You do not need to include the x-api-key authentication header. This header is automatically handled by Nexla based on your LinkSquares credential configuration.

Exclude Attributes from the Call

Optional

• If any record attributes in the Nexset should be omitted when sending data to this LinkSquares destination, select the attributes from the Exclude Attributes pulldown menu.

• Any number of attributes can be selected for exclusion, and all excluded attributes will be shown in the field. To remove an attribute from the list, click the X icon next to the attribute name.

Record Batching

Optional

1. If records should be sent to this destination in batched API calls, check the box next to Would you like to batch your records together? to enable record batching.

2. Enter the maximum number of records that should be batched together in a single API call in the Batch Size field. By default, this value is set to 100.

3. Select the algorithm that will be used to group records into batches from the Grouping Algorithm pulldown menu. The sample request shown in the panel on the right will be updated to reflect the current batching settings. Some algorithms require additional settings—click on an algorithm listed below to view instructions for configuring these settings.

Response Webhook

Optional

Nexla can automatically send the response received from the LinkSquares API after each call to a new Nexla webhook data source. This option allows you to keep track of the status of each API call and any additional information returned after each call, such as newly created agreement IDs or presigned upload URLs.

• To enable this option, check the box next to Would you like to process the API response as a Nexla Webhook source?.

Sample Request Payload

Sample request payloads containing a portion of the Nexset data that will be sent to the LinkSquares API endpoint based on the current settings are shown in the Sample Payload panel on the right. These samples can be referenced to ensure that the destination and request settings are correctly configured.

• Click on a sample request payload to expand it and view the complete payload content.
• Sample payloads are automatically updated with each setting change, making it easy to verify that changes achieve the desired effect.

Endpoint Testing (Manual Configuration)

After all endpoint settings have been configured, Nexla can send a test payload to the LinkSquares API to ensure that the destination is configured correctly.

1. To send a test payload, select the Test button at the top of the Sample Payload panel, and click on a listed sample payload to expand it.

2. If any modifications to the sample payload are needed, make the necessary changes directly within the sample window.

3. Click the Send Test Data button at the top of a sample payload to send the test payload to the LinkSquares API using the current settings.

Save & Activate the Destination

• Once all endpoint settings have been configured, click the Done button in the upper right corner of the screen to save and create the destination. To begin sending data to the configured LinkSquares endpoint, open the destination resource menu, and select Activate.

  The Nexset data will not be sent to the LinkSquares API until the destination is activated. Destinations can be activated immediately or at a later time, providing full control over data movement.