Skip to main content

BoldSign 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 BoldSign location.
bold_sign_api.png

BoldSign

Create a BoldSign Destination​

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

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

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

    BoldSign destinations can also be configured manually, allowing you to send data to BoldSign 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 BoldSign endpoints. Each template is designed specifically for the corresponding BoldSign 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.

    Send Document

    This endpoint sends a document for signature to one or more signers and CC recipients. Use it to programmatically launch signature requests as records flow in from an upstream system — for example, turning a row in a CRM or contract management system into an out-for-signature document.

    • Each upstream record is sent as the JSON body of the POST call. Use the Nexla transform layer to shape upstream attributes into the field names expected by the BoldSign send-document API, such as title, signers, files, and message.

    For the full set of supported attributes and a request schema, see the BoldSign send document API reference.

    Send Template

    This endpoint sends a document built from a reusable template to signers for signature. Use this endpoint when the document structure (fields, signer roles, content) is predefined in a BoldSign template and only signer-specific values need to be supplied per call.

    • Enter the BoldSign template ID in the Template ID field. This field is required and identifies the template that will be used to generate the signature request. Template IDs can be obtained from the Template List data source endpoint.
    • Each upstream record is sent as the JSON body of the POST call. Map upstream attributes to the role-specific signer fields expected by the template (for example, signer name, email, and any pre-fill values).

    Remind Document

    This endpoint sends a signing reminder to the pending signers on an in-flight document. Use it to automate nudge cadences for documents that have been out for signature beyond a threshold.

    • Enter the BoldSign document ID in the Document ID field. This field is required and identifies the document to send a reminder for. Map the upstream record's document ID into this field.

    Change Access Code

    This endpoint updates the access code (one-time passcode) required for a signer to open a document. Use it when the access code needs to be rotated or shared through a separate channel partway through the signing workflow.

    • Enter the BoldSign document ID in the Document ID field. This field is required and identifies the document whose signer access code is being updated.
    • Each upstream record is sent as the JSON body of the POST call and should include the signer's email and the new access code value.

    Revoke Document

    This endpoint revokes (cancels) an in-flight document that has not yet been signed by all parties. Use it to recall documents when upstream systems indicate the underlying agreement is no longer valid.

    • Enter the BoldSign document ID in the Document ID field. This field is required and identifies the document to revoke.
    • Each upstream record is sent as the JSON body of the POST call and should include the revocation reason (and any other supported revocation parameters).

    Revocation is permanent for the document instance. Filter upstream records to only those documents that should genuinely be cancelled before activating this destination.

    Delete Document

    This endpoint permanently deletes a completed or declined document from the account. Use it to enforce retention policies or to remove test documents from a production account.

    • Enter the BoldSign document ID in the Document ID field. This field is required and identifies the document to delete.

    Because deletion is irreversible and may have compliance implications, route upstream data through a Nexla transform that filters to only documents eligible for deletion before activating this destination.

    Create Template

    This endpoint creates a new reusable template with the specified roles, CC recipients, fields, and other configuration. Use it to programmatically provision templates from a system of record.

    • Each upstream record is sent as the JSON body of the POST call. Map upstream attributes to the template fields expected by BoldSign, such as title, roles, and the document content/files.

    Delete Template

    This endpoint deletes a template that is no longer needed. Use it to retire templates as part of a template lifecycle process.

    • Enter the BoldSign template ID in the Template ID field. This field is required and identifies the template to delete.

    Create Brand

    This endpoint creates a new brand with custom branding settings and a redirect URL. Use it to provision per-business-unit or per-product branding from a central configuration source.

    • Each upstream record is sent as the JSON body of the POST call. Map upstream attributes to the brand fields expected by BoldSign, such as brandName, logo, color, and redirect URL values.

    Edit Brand

    This endpoint updates an existing brand's settings and customization properties. Use it to keep BoldSign brand configurations aligned with an upstream branding source of truth.

    • Enter the BoldSign brand ID in the Brand ID field. This field identifies the brand to edit.
    • Each upstream record is sent as the JSON body of the POST call. Include only the fields that should be changed.

    Create Sender Identity

    This endpoint creates a new sender identity with a specified name and email address. Sender identities let an account send signature requests on behalf of multiple verified addresses.

    • Each upstream record is sent as the JSON body of the POST call. Map upstream attributes to name and email at a minimum.

    The email address used for a new sender identity must be verified through BoldSign before it can be used to send documents.

    Update Sender Identity

    This endpoint updates an existing sender identity with a new name for the specified email address. Use it to keep display names aligned with HR or identity changes.

    • Enter the email address of the sender identity to update in the Email Address field. The email address acts as the key used to locate the identity.
    • Each upstream record is sent as the JSON body of the PUT call and should include the new name value.

    Create Team

    This endpoint creates a new team in the BoldSign account. Use it to provision teams from an upstream HR or identity system.

    • Each upstream record is sent as the JSON body of the POST call. Map upstream attributes to the team field names expected by BoldSign, such as name and team member assignments.

    Update Team

    This endpoint updates an existing team identified by team ID. Use it to keep BoldSign team membership in sync with an upstream system of record.

    • Enter the BoldSign team ID in the Team ID field. This field is required and identifies the team to update.
    • The body of each PUT call is the upstream record (as JSON). Include only the fields that should be changed; omitted fields are left untouched.

    Create Contact

    This endpoint creates a new contact in the BoldSign contacts list. Use it to provision frequently used signer and recipient contacts from a CRM or address book system.

    • Each upstream record is sent as the JSON body of the POST call. Map upstream attributes to name, email, and any other supported contact attributes.

    Invite User

    This endpoint invites a new user to the BoldSign account or team. Use it to automate user onboarding from an upstream HR or identity system.

    • Each upstream record is sent as the JSON body of the POST call. Map upstream attributes to the invite field names expected by BoldSign, such as emailId, userRole, and any team assignment values.

Configure Manually​

BoldSign destinations can be manually configured to send data to any valid BoldSign API endpoint.

Using manual configuration, you can also configure Nexla to automatically send the response received from the BoldSign API after each call to a new Nexla webhook data source — useful for capturing IDs returned by BoldSign for newly created documents, templates, or brands.

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 BoldSign API from the Method pulldown menu. Use POST to create or trigger actions (send documents, send reminders), PUT to update existing resources, and DELETE to remove resources.

Data Format​

  1. Select the format in which the Nexset data will be sent to the BoldSign API from the Content Format pulldown menu. The BoldSign API expects application/json, so JSON is the appropriate format for most operations. Nexla will automatically convert the data to the selected format for each API call.

API Endpoint URL​

  1. Enter the URL of the BoldSign API endpoint to which you want to send the Nexset data in the URL field. BoldSign API endpoints follow the format https://api.boldsign.com/v1/<resource> — for example, https://api.boldsign.com/v1/document/send or https://api.boldsign.com/v1/template/send?templateId=<template-id>. For update operations, include the ID of the object to be updated in the URL as required by the endpoint.

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 any headers already present in the credentials. The BoldSign X-API-KEY header is handled automatically by Nexla based on your credential configuration.

Exclude Attributes from the Call​

Optional

  • If any record attributes in the Nexset should be omitted when sending data to this BoldSign 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.

    Property Inside JSON Object

    1. Enter the name of the JSON property that should contain the batched records in the Property Name field.
    2. If any additional properties should be included in the request, enter the properties in the Other Props field in JSON format.

    Code

    1. Enter the code that will be used to create the batched request in the code editor below the Grouping Algorithm field.

Most BoldSign write endpoints operate on a single document, template, or account resource per call. Record batching is best suited to custom endpoints that accept multiple records in a single request — confirm the target endpoint supports batched payloads before enabling this option.

Response Webhook​

Optional

Nexla can automatically send the response received from the BoldSign 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 — for example, the document ID and signing URL returned when a new document is sent for signature.

  • 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 BoldSign 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 BoldSign 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 BoldSign 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 BoldSign, open the destination resource menu, and select Activate.

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