Share via

BlueInk

  • Reference

The Blueink connector allows you to add Blueink's eSignature platform into automated workflows. The connector allows you to check bundle status, create new bundles, access signer information, and more.

This connector is available in the following products and regions:

Service Class Regions
Logic Apps Standard All Logic Apps regions except the following:
     -   Azure Government regions
     -   Azure China regions
     -   US Department of Defense (DoD)
Power Automate Premium All Power Automate regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
     -   US Department of Defense (DoD)
Power Apps Premium All Power Apps regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
     -   US Department of Defense (DoD)
Contact
Name Blueink Support
URL https://help.blueink.com/en/
Email [email protected]
Connector Metadata
Publisher Blueink
Website https://blueink.com
Privacy policy https://blueink.com/privacy-policy/
Categories Business Management;Productivity

With this versatile connector, users can seamlessly integrate Blueink's powerful eSignature solution into their workflow by leveraging the capabilities of various Power Automate connectors. This integration empowers users to automate the creation and distribution of document bundles effortlessly. By orchestrating the harmonious interaction of this connector with other connectors, you can streamline your document management processes, enhance efficiency, and ensure a seamless and efficient document signing experience for your clients and stakeholders. Whether it's automating contract approvals, processing legal documents, or managing paperwork in any other context, this connector provides a powerful tool to optimize your workflow and boost productivity.

Prerequisites

To use this connector you will need an API enabled account from blueink.com.

How to get credentials

After creating your account, click the API button on the left side of the page. Under Private API Keys, press the Add API Key button. Give the API key a label and press submit. Copy the API key and save it somewhere, because it won’t be shown again.

Get started with your connector

When first creating a Blueink connection you will be prompted to enter an API key. Your API key will always need to start with Token followed by a space and then the API key you created. Inputting your API key should look like this Token .

A popular action is to create a bundle. Creating a bundle does require a complex set of inputs. Take a look at our API documentation at https://blueink.com/esignature-api/api-docs/#tag/Bundles/operation/createBundle for what the body variable could look like. Picture below as an example of a bundle creation body.

Untitled

There are multiple ways to create a bundle and you can modify this JSON to suit the bundle you wish to create. Take a look at the API for more ways this JSON can be modified. This one uses a previously created template that the user setup in their account.

Listing all of the completed bundles is another popular endpoint. Add the List Bundles action and then change the status button to co for completed bundles. You can keep up to date with all of your latest completed bundles using this endpoint.

Untitled

Known issues and limitations

A body JSON is required for the bundle creation endpoint

Common errors and remedies

If you get an error about a request not succeeding with an invalid token error make sure you didn’t just paste the API key in and including the preceding Token string followed be a space and then your API key.

If you get an error about an invalid input when creating a Bundle make sure it is valid JSON that is being sent to Blueink.

FAQ

1. What is Blueink?

  • Blueink is an advanced eSignature solution that simplifies the document signing process, making it easy to send, sign, and manage electronic documents securely.

2. What is the Microsoft Connector for Blueink?

  • The Microsoft Connector for Blueink is a tool that allows users to integrate Blueink's eSignature solution seamlessly with Microsoft Power Automate, enabling automation and enhanced document management.

3. How does the Microsoft Connector for Blueink work?

  • The connector enables you to create automated workflows by combining Blueink with other Power Automate connectors. You can automate the creation and distribution of document bundles, enhancing your document management processes.

4. What are some use cases for the Microsoft Connector for Blueink?

  • Common use cases include automating contract approvals, managing legal documents, streamlining paperwork processes, and ensuring a smooth and efficient document signing experience for clients and stakeholders.

5. Can I use the Microsoft Connector for Blueink with other Microsoft products?

  • Yes, the connector is designed to work seamlessly with various Microsoft products and services, allowing you to integrate Blueink eSignatures into your Microsoft-centric workflows.

6. Is the Microsoft Connector for Blueink easy to set up and use?

  • Yes, it is user-friendly and designed to be straightforward. You can configure and customize your workflows to suit your specific document management needs.

7. Is there any cost associated with using the Microsoft Connector for Blueink?

  • Pricing may vary based on your usage and licensing agreements. It's best to check with Blueink or Microsoft for specific pricing details.

8. Can I get support for any technical issues with the Microsoft Connector for Blueink?

  • Yes, Blueink and Microsoft typically offer support resources and documentation to assist with any technical issues or questions you may have regarding the connector's usage.

9. Is the Microsoft Connector for Blueink compatible with both Windows and cloud-based Microsoft services?

  • Yes, the connector is designed to work with both on-premises and cloud-based Microsoft services, providing flexibility in your integration options.

10. Where can I find more information about the Microsoft Connector for Blueink?

  • For additional information, including setup guides and documentation, you can visit the Blueink website or explore the Microsoft Power Automate documentation related to this connector.

Creating a connection

The connector supports the following authentication types:
Default Parameters for creating connection. All regions Not shareable

Default

Applicable: All regions

Parameters for creating connection.

This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.

Name Type Description Required
Blueink API Key securestring Your Blueink API key. This can be created in Blueink under the API tab. Correct format is 'Token XXXXXX' where XXXXXX is your API key True

Throttling Limits

Name Calls Renewal Period
API calls per connection 100 60 seconds

Actions

Add Tags to a bundle

Add additional tags to a Bundle. No existing tags on the Bundle are removed. The result of this call is that Bundle.tags is the union of the set of previous tags with the set of new tags. Duplicate tags are ignored.
Cancel a Bundle

Cancel the Bundle specified by the Bundle Slug
Create a Bundle

Create and send a bundle out for signature
Create a Person

Create a new person. A person can be associated with a BlueInk User, or can be a standalone person. If you want to create a person that is associated with a BlueInk User, you must provide the user_id field. If you want to create a standalone person, you must provide the name field.
Create a Webhook

Create a new Webhook
Create a WebhookExtraHeader

Create a new Webhook Header
Create an Embedded Signing URL

Create a URL which can be used for embedded signing
Delete a Person

Delete a Person. This will also delete any associated BlueInk User.
Delete a Webhook

Delete a Webhook by ID
Delete a WebhookExtraHeader

Delete a WebhookExtraHeader
Get Webhook Shared Secret

Get the Webhook Shared Secret
List Bundle Events

Get a list of Events that are associated with the Bundle
List Bundles

Returns a paginated list of Bundles in your Account, ordered by created date (from most recent to least recent). Pagination can be controlled via Pagination paramaters (see Overview->Pagination). Querystring filters paramaters can be combined, e.g. /bundles/?search=Gibbons&status__in=se,co&tag=needs-attention. When combining filters, only Bundles matching ALL the filters are returned.
List Document Templates

List all Document Templates
List Persons

Get a list of the Persons in your account. You can optionally filter the list by providing a search query. For example, to search for all Persons with the name "John", you would use the query search=John.
List WebhookEvents

List all Webhook Events in your BlueInk account
List WebhookEvents

List all WebhookDeliveries in your BlueInk account
List WebhookExtraHeaders

List all WebhookExtraHeaders in your BlueInk account
List Webhooks

List all Webhooks in your BlueInk account
Partially update a Person

Partially update the Person with new data.

To add a new email or phone to the Person, include a ContactChannel in the 'channels' array without an 'id'.

To update an existing ContactChannel associated with the Person, include an 'id'. That existing ContactChannel will be updated with the new email or phone. This will update any live Bundles associated with the Person that are sending to that email (or phone).

If a ContactChannel does not include an 'id', but the email (or phone) matches an existing ContactChannel, then that ContactChannel will not be changed.
Partially update a Webhook

Partially update the Webhook with new data.
Partially update a WebhookExtraHeader

Partially update the WebhookExtraHeader with new data.
Regenerate Webhook Shared Secret

Regenerate the Webhook Shared Secret
Remove Tags from a bundle

Remove tags from a Bundle. If a tag in the request does not exist on the Bundle, it is ignored.
Retrieve a Bundle

Retrieve a Bundle by slug
Retrieve a Document Template

Retrieve a Document Template
Retrieve a Person

Get a Person by ID
Retrieve a Webhook

Get a Webhook by ID
Retrieve a WebhookExtraHeader

Retrieve the details of a WebhookExtraHeader
Retrieve Bundle Data

Get data entered into fields for a completed Bundle
Retrieve Bundle Files

Get downloadable files for a completed Bundle
Retrieve Packet Certificate of Evidence

Get a link and checksum of the Certificate of Evidence for this Packet
Send a Reminder

Send a Reminder email or SMS to a Signer. A reminder can only be sent once every hour. The reminder will be sent via the delivery method (email or SMS) and to the email address (or phone number) previously designated for this Packet.
Update a Packet

Update a Packet (aka signer) with a new email, phone number, name or authentication options

The updated packet must still be deliverable. For instance, if you specify a deliver_via value of 'phone', but there was no phone number set in the original PacketRequest, then this request must include a phone as well, or an error will be returned.

You can change a Packet that was originally configured for embedded signing (that is, deliver_via was 'embed') to be delivered via email or SMS. However, no signing notifications or reminders will be automatically sent. You must call /packet/{packetId}/remind/ to send a signing notification email (or SMS).

If this Signer is associated with a Person, the person will be updated as well - the Person name will be changed (if provided) and any new email or phone number will be added.
Update a Person

Update the Person with new data. NOTE that any contact channels that are omitted from this request will be DELETED. If you don't want to replace all data on the Person, you probably want to use PATCH instead.
Update a Webhook

Update the Webhook with new data. NOTE that any subscriptions that are omitted from this request will be DELETED. If you don't want to replace all data on the Webhook, you probably want to use PATCH instead.
Update a WebhookExtraHeader

Update the WebhookExtraHeader with new data

Add Tags to a bundle

Operation ID:
addBundleTags

Add additional tags to a Bundle. No existing tags on the Bundle are removed. The result of this call is that Bundle.tags is the union of the set of previous tags with the set of new tags. Duplicate tags are ignored.

Parameters

Name Key Required Type Description
Bundle Slug
 bundleSlug True string

The slug that uniquely identifies the Bundle
tags
 tags array of string

An array of tags

Returns

Cancel a Bundle

Operation ID:
cancelBundle

Cancel the Bundle specified by the Bundle Slug

Parameters

Name Key Required Type Description
Bundle Slug
 bundleSlug True string

The slug that uniquely identifies the Bundle

Returns

Create a Bundle

Operation ID:
createBundle

Create and send a bundle out for signature

Parameters

Name Key Required Type Description
body
 body

The JSON body that defines the Bundle to be created

Returns

Create a Person

Operation ID:
createPerson

Create a new person. A person can be associated with a BlueInk User, or can be a standalone person. If you want to create a person that is associated with a BlueInk User, you must provide the user_id field. If you want to create a standalone person, you must provide the name field.

Parameters

Name Key Required Type Description
email
 email email
id
 id uuid
kind
 kind string

em for email. mp for phone.
phone
 phone phone
id
 id uuid
is_user
 is_user boolean

True if this Person is associated with a BlueInk User
metadata
 metadata object

Metadata to associate with this person. Metadata can be used in SmartFill to automatically populate documents. See SmartFill documentation for details.
name
 name string

The name of the person

Returns

Name Path Type Description
channels
 channels array of object
email
 channels.email email
id
 channels.id uuid
kind
 channels.kind string

em for email. mp for phone.
phone
 channels.phone phone
id
 id uuid
is_user
 is_user boolean

True if this Person is associated with a BlueInk User
metadata
 metadata object

Metadata to associate with this person. Metadata can be used in SmartFill to automatically populate documents. See SmartFill documentation for details.
name
 name string

The name of the person

Create a Webhook

Operation ID:
createWebhook

Create a new Webhook

Parameters

Name Key Required Type Description
enabled
 enabled boolean
event_types
 event_types array of string

types of events that will fire the webhook
id
 id uuid
name
 name string

must adhere to RFC 7230
order
 order integer
value
 value string

must adhere to RFC 7230
webhook
 webhook uuid
id
 id uuid
json
 json boolean
url
 url url

should be the full URL, including http/https

Returns

Name Path Type Description
enabled
 enabled boolean
event_types
 event_types array of string

types of events that will fire the webhook
extra_headers
 extra_headers array of object
id
 extra_headers.id uuid
name
 extra_headers.name string

must adhere to RFC 7230
order
 extra_headers.order integer
value
 extra_headers.value string

must adhere to RFC 7230
webhook
 extra_headers.webhook uuid
id
 id uuid
json
 json boolean
url
 url url

should be the full URL, including http/https

Create a WebhookExtraHeader

Operation ID:
createWebhookExtraHeader

Create a new Webhook Header

Parameters

Name Key Required Type Description
id
 id uuid
name
 name string

must adhere to RFC 7230
order
 order integer
value
 value string

must adhere to RFC 7230
webhook
 webhook uuid

Returns

Name Path Type Description
id
 id uuid
name
 name string

must adhere to RFC 7230
order
 order integer
value
 value string

must adhere to RFC 7230
webhook
 webhook uuid

Create an Embedded Signing URL

Operation ID:
createPacketEmbedURL

Create a URL which can be used for embedded signing

Parameters

Name Key Required Type Description
Packet Slug
 packetId True string

The slug that uniquely identifies the Packet

Returns

Name Path Type Description
expires
 expires date-time

Timestamp indicating when url expires
url
 url string

The URL which can be used in for embedded signing

Delete a Person

Operation ID:
deletePerson

Delete a Person. This will also delete any associated BlueInk User.

Parameters

Name Key Required Type Description
Person ID
 personId True uuid

The ID that uniquely identifies the Person

Delete a Webhook

Operation ID:
deleteWebhook

Delete a Webhook by ID

Parameters

Name Key Required Type Description
Webhook ID
 webhookId True uuid

The ID that uniquely identifies the Webhook

Delete a WebhookExtraHeader

Operation ID:
deleteWebhookExtraHeader

Delete a WebhookExtraHeader

Parameters

Name Key Required Type Description
WebhookExtraHeader ID
 webhookExtraHeaderId True uuid

The ID that uniquely identifies the WebhookExtraHeader

Get Webhook Shared Secret

Operation ID:
getWebhookSecret

Get the Webhook Shared Secret

Returns

Name Path Type Description
create_date
 create_date date-time
secret
 secret b58

List Bundle Events

Operation ID:
listBundleEvents

Get a list of Events that are associated with the Bundle

Parameters

Name Key Required Type Description
Bundle Slug
 bundleSlug True string

The slug that uniquely identifies the Bundle

Returns

Name Path Type Description
array of object
description
 description string

A brief desription of the event
kind
 kind string

The kind of the event as a 2 character code
packet_id
 packet_id uuid

The UUID of a Packet. Only present if the event is associated with a particular packet.
timestamp
 timestamp date-time

The time at which the event occured

List Bundles

Operation ID:
listBundles

Returns a paginated list of Bundles in your Account, ordered by created date (from most recent to least recent). Pagination can be controlled via Pagination paramaters (see Overview->Pagination). Querystring filters paramaters can be combined, e.g. /bundles/?search=Gibbons&status__in=se,co&tag=needs-attention. When combining filters, only Bundles matching ALL the filters are returned.

Parameters

Name Key Required Type Description
Search Query
 search string

A search query. Only bundles matching the search will be returned. The following data in the the Bundle is searched:

  • bundle slug
  • bundle label
  • bundle custom_key
  • signer name
  • signer email
  • signer phones

E.g. /bundles/[email protected]
Bundle Status
 status string

Limit bundles to those with the specified status.

  • dr: Draft - the Bundle has not yet been sent
  • se: Sent - the Bundle has been sent, but not yet started by any Signers
  • st: Started - at least one Signer has started reviewing the document(s)
  • co: Complete - all Signers have completed reviewing / signing
  • ca: Cancelled - the Bundle was cancelled
  • ex: Expired - the Bundle expired before it was Complete
  • fa: Failed - an error occurred and the Bundle could not be created or completed

E.g. /bundles/?status=co
List of Bundle Status
 status__in string

Limit bundles to those with one of the specified statuses. Statuses should be comma separated. E.g. /bundles/?status=co,se,st
Bundle Tag
 tag string

Return Bundles that have the given tag. E.g. /bundles/?tag=some-tag
List of Bundle Tags
 tag__in string

Return Bundles that have at least one of the given tags. Tags should be comma separated. E.g. /bundles/?tag=some-tag,another-tag
Bundle Sort Order
 ordering string

Control the sort order of Bundles. Prefix with "-" to reverse the sort order. By default Bundles are sorted by "-created", ie the Bundle creation date from most to least recent.

Returns

Name Path Type Description
array of

List Document Templates

Operation ID:
listTemplates

List all Document Templates

Returns

Name Path Type Description
fields
 fields array of

An array of fields placed on the document. Note that DocumentTemplate fields are slightly different than DocumentRequest fields, having a default_value and editor_roles instead of initial_value and editors.
file_url
 file_url string

The URL of the original file that serves as the basis for this Template
is_shared
 is_shared boolean

True if the Document Template is shared. False otherwise
name
 name string

The name of the document. Defaults to the filename or the document when it was uploaded, but can be set to a human-friendly name.
roles
 roles array of object
key
 roles.key string

A string that is unique for this document which identifies this role
label
 roles.label string

A human-friendly label for this role

List Persons

Operation ID:
listPersons

Get a list of the Persons in your account. You can optionally filter the list by providing a search query. For example, to search for all Persons with the name "John", you would use the query search=John.

Parameters

Name Key Required Type Description
Search Query
 search string

A search query.

Returns

Name Path Type Description
array of object
channels
 channels array of object
email
 channels.email email
id
 channels.id uuid
kind
 channels.kind string

em for email. mp for phone.
phone
 channels.phone phone
id
 id uuid
is_user
 is_user boolean

True if this Person is associated with a BlueInk User
metadata
 metadata object

Metadata to associate with this person. Metadata can be used in SmartFill to automatically populate documents. See SmartFill documentation for details.
name
 name string

The name of the person

List WebhookEvents

Operation ID:
listWebhookEvents

List all Webhook Events in your BlueInk account

Parameters

Name Key Required Type Description
Webhook ID
 webhook uuid

Only WebhookEvents matching the selected webhook ID will be returned.

E.g. /webhooks/events/?webhook=a053644f-e371-4883-ac17-534445993346
Event Type
 event_type string

Only WebhookEvents with webhooks matching the selected event_type or event_types will be returned.

E.g. /webhooks/events/?event_type=bundle_sent E.g. /webhooks/events/?event_type__in=bundle_error,bundle_cancelled
Status
 status integer

Only WebhookEvents matching the selected status will be returned.

E.g. /webhooks/events/?status=1 E.g. /webhooks/events/?status__in=0,1,2
Success Result
 success boolean

Only WebhookEvents matching the selected success status will be returned.

E.g. /webhooks/events/?success=true
Date Range
 date date-time

Only WebhookEvents occurring between a date range will be returned. Note: Dates are expressed as YYYY-MM-DD format.

E.g. /webhooks/events/?date_after=2022-10-01&date_before=2022-10-31

Returns

Name Path Type Description
array of object
created
 created date-time
deliveries
 deliveries array of object
message
 deliveries.message string

a message describing any issues
pk
 deliveries.pk uuid
status
 deliveries.status integer

status message of the response, or 0 if no status
timestamp
 deliveries.timestamp date-time

when the delivery attempt occurred (the start of the attempt, not when it failed, e.g for a timeout)
event_type
 event_type string
payload
 payload string

the payload to send on delivery; json
pk
 pk uuid
status
 status integer

the status code of the last response from webhook endpoint. 0 indicates no response received
success
 success boolean
webhook
 webhook uuid

UUID identifying which webhook the Event belongs to

List WebhookEvents

Operation ID:
listWebhookDeliveries

List all WebhookDeliveries in your BlueInk account

Parameters

Name Key Required Type Description
Webhook ID
 webhook uuid

Only WebhookDeliveries matching the selected webhook ID will be returned.

E.g. /webhooks/deliveries/?webhook=a053644f-e371-4883-ac17-534445993346
Webhook Event ID
 webhook_event uuid

Only WebhookDeliveries matching the selected webhook_event ID will be returned.

E.g. /webhooks/deliveries/?webhook_event=a053644f-e371-4883-ac17-534445993346
Event Type
 event_type string

Only WebhookDeliveries with webhooks matching the selected event_type or event_types will be returned.

E.g. /webhooks/deliveries/?event_type=bundle_sent E.g. /webhooks/deliveries/?event_type__in=bundle_error,bundle_cancelled
Status
 status integer

Only WebhookDeliveries matching the selected status will be returned.

E.g. /webhooks/deliveries/?status=1 E.g. /webhooks/deliveries/?status__in=0,1,2
Date Range
 date date-time

Only WebhookDeliveries occurring between a date range will be returned. Note: Dates are expressed as YYYY-MM-DD format.

E.g. /webhooks/deliveries/?date_after=2022-10-01&date_before=2022-10-31

Returns

Name Path Type Description
array of object
created
 created date-time
deliveries
 deliveries array of object
message
 deliveries.message string

a message describing any issues
pk
 deliveries.pk uuid
status
 deliveries.status integer

status message of the response, or 0 if no status
timestamp
 deliveries.timestamp date-time

when the delivery attempt occurred (the start of the attempt, not when it failed, e.g for a timeout)
event_type
 event_type string
payload
 payload string

the payload to send on delivery; json
pk
 pk uuid
status
 status integer

the status code of the last response from webhook endpoint. 0 indicates no response received
success
 success boolean
webhook
 webhook uuid

UUID identifying which webhook the Event belongs to

List WebhookExtraHeaders

Operation ID:
listWebhookExtraHeaders

List all WebhookExtraHeaders in your BlueInk account

Parameters

Name Key Required Type Description
Webhook ID
 webhook uuid

Only WebhookExtraHeaders matching the selected webhook ID will be returned.

E.g. /webhooks/headers/?webhook=a053644f-e371-4883-ac17-534445993346
Event Type
 event_type string

Only WebhookExtraHeaders with webhooks matching the selected event_type or event_types will be returned.

E.g. /webhooks/headers/?event_type=bundle_sent E.g. /webhooks/headers/?event_type__in=bundle_error,bundle_cancelled

Returns

Name Path Type Description
array of object
id
 id uuid
name
 name string

must adhere to RFC 7230
order
 order integer
value
 value string

must adhere to RFC 7230
webhook
 webhook uuid

List Webhooks

Operation ID:
listWebhooks

List all Webhooks in your BlueInk account

Parameters

Name Key Required Type Description
Enabled
 enabled boolean

Only Webhooks matching the selected 'enabled' state will be returned.

E.g. /webhooks/?enabled=true
Event Type
 event_type string

Only Webhooks matching the selected event_type or event_types will be returned.

E.g. /webhooks/?event_type=bundle_sent E.g. /webhooks/?event_type__in=bundle_error,bundle_cancelled

Returns

Name Path Type Description
array of object
enabled
 enabled boolean
event_types
 event_types array of string

types of events that will fire the webhook
extra_headers
 extra_headers array of object
id
 extra_headers.id uuid
name
 extra_headers.name string

must adhere to RFC 7230
order
 extra_headers.order integer
value
 extra_headers.value string

must adhere to RFC 7230
webhook
 extra_headers.webhook uuid
id
 id uuid
json
 json boolean
url
 url url

should be the full URL, including http/https

Partially update a Person

Operation ID:
updatePersonPartial

Partially update the Person with new data.

To add a new email or phone to the Person, include a ContactChannel in the 'channels' array without an 'id'.

To update an existing ContactChannel associated with the Person, include an 'id'. That existing ContactChannel will be updated with the new email or phone. This will update any live Bundles associated with the Person that are sending to that email (or phone).

If a ContactChannel does not include an 'id', but the email (or phone) matches an existing ContactChannel, then that ContactChannel will not be changed.

Parameters

Name Key Required Type Description
Person ID
 personId True uuid

The ID that uniquely identifies the Person
email
 email email
id
 id uuid
kind
 kind string

em for email. mp for phone.
phone
 phone phone
id
 id uuid
is_user
 is_user boolean

True if this Person is associated with a BlueInk User
metadata
 metadata object

Metadata to associate with this person. Metadata can be used in SmartFill to automatically populate documents. See SmartFill documentation for details.
name
 name string

The name of the person

Returns

Name Path Type Description
channels
 channels array of object
email
 channels.email email
id
 channels.id uuid
kind
 channels.kind string

em for email. mp for phone.
phone
 channels.phone phone
id
 id uuid
is_user
 is_user boolean

True if this Person is associated with a BlueInk User
metadata
 metadata object

Metadata to associate with this person. Metadata can be used in SmartFill to automatically populate documents. See SmartFill documentation for details.
name
 name string

The name of the person

Partially update a Webhook

Operation ID:
updateWebhookartial

Partially update the Webhook with new data.

Parameters

Name Key Required Type Description
Webhook ID
 webhookId True uuid

The ID that uniquely identifies the Webhook
enabled
 enabled boolean
event_types
 event_types array of string

types of events that will fire the webhook
id
 id uuid
name
 name string

must adhere to RFC 7230
order
 order integer
value
 value string

must adhere to RFC 7230
webhook
 webhook uuid
id
 id uuid
json
 json boolean
url
 url url

should be the full URL, including http/https

Returns

Name Path Type Description
enabled
 enabled boolean
event_types
 event_types array of string

types of events that will fire the webhook
extra_headers
 extra_headers array of object
id
 extra_headers.id uuid
name
 extra_headers.name string

must adhere to RFC 7230
order
 extra_headers.order integer
value
 extra_headers.value string

must adhere to RFC 7230
webhook
 extra_headers.webhook uuid
id
 id uuid
json
 json boolean
url
 url url

should be the full URL, including http/https

Partially update a WebhookExtraHeader

Operation ID:
updateWebhookExtraHeaderPartial

Partially update the WebhookExtraHeader with new data.

Parameters

Name Key Required Type Description
WebhookExtraHeader ID
 webhookExtraHeaderId True uuid

The ID that uniquely identifies the WebhookExtraHeader
id
 id uuid
name
 name string

must adhere to RFC 7230
order
 order integer
value
 value string

must adhere to RFC 7230
webhook
 webhook uuid

Returns

Name Path Type Description
id
 id uuid
name
 name string

must adhere to RFC 7230
order
 order integer
value
 value string

must adhere to RFC 7230
webhook
 webhook uuid

Regenerate Webhook Shared Secret

Operation ID:
regenerateWebhookSecret

Regenerate the Webhook Shared Secret

Returns

Name Path Type Description
create_date
 create_date date-time
secret
 secret b58

Remove Tags from a bundle

Operation ID:
removeBundleTags

Remove tags from a Bundle. If a tag in the request does not exist on the Bundle, it is ignored.

Parameters

Name Key Required Type Description
Bundle Slug
 bundleSlug True string

The slug that uniquely identifies the Bundle
tags
 tags array of string

An array of tags

Returns

Retrieve a Bundle

Operation ID:
retrieveBundle

Retrieve a Bundle by slug

Parameters

Name Key Required Type Description
Bundle Slug
 bundleSlug True string

The slug that uniquely identifies the Bundle

Returns

Retrieve a Document Template

Operation ID:
retrieveTemplate

Retrieve a Document Template

Parameters

Name Key Required Type Description
Template ID
 templateId True uuid

The ID that uniquely identifies the Template

Returns

Name Path Type Description
fields
 fields array of

An array of fields placed on the document. Note that DocumentTemplate fields are slightly different than DocumentRequest fields, having a default_value and editor_roles instead of initial_value and editors.
file_url
 file_url string

The URL of the original file that serves as the basis for this Template
is_shared
 is_shared boolean

True if the Document Template is shared. False otherwise
name
 name string

The name of the document. Defaults to the filename or the document when it was uploaded, but can be set to a human-friendly name.
roles
 roles array of object
key
 roles.key string

A string that is unique for this document which identifies this role
label
 roles.label string

A human-friendly label for this role

Retrieve a Person

Operation ID:
getPerson

Get a Person by ID

Parameters

Name Key Required Type Description
Person ID
 personId True uuid

The ID that uniquely identifies the Person

Returns

Name Path Type Description
channels
 channels array of object
email
 channels.email email
id
 channels.id uuid
kind
 channels.kind string

em for email. mp for phone.
phone
 channels.phone phone
id
 id uuid
is_user
 is_user boolean

True if this Person is associated with a BlueInk User
metadata
 metadata object

Metadata to associate with this person. Metadata can be used in SmartFill to automatically populate documents. See SmartFill documentation for details.
name
 name string

The name of the person

Retrieve a Webhook

Operation ID:
getWebhook

Get a Webhook by ID

Parameters

Name Key Required Type Description
Webhook ID
 webhookId True uuid

The ID that uniquely identifies the Webhook

Returns

Name Path Type Description
enabled
 enabled boolean
event_types
 event_types array of string

types of events that will fire the webhook
extra_headers
 extra_headers array of object
id
 extra_headers.id uuid
name
 extra_headers.name string

must adhere to RFC 7230
order
 extra_headers.order integer
value
 extra_headers.value string

must adhere to RFC 7230
webhook
 extra_headers.webhook uuid
id
 id uuid
json
 json boolean
url
 url url

should be the full URL, including http/https

Retrieve a WebhookExtraHeader

Operation ID:
getWebhookExtraHeader

Retrieve the details of a WebhookExtraHeader

Parameters

Name Key Required Type Description
WebhookExtraHeader ID
 webhookExtraHeaderId True uuid

The ID that uniquely identifies the WebhookExtraHeader

Returns

Name Path Type Description
id
 id uuid
name
 name string

must adhere to RFC 7230
order
 order integer
value
 value string

must adhere to RFC 7230
webhook
 webhook uuid

Retrieve Bundle Data

Operation ID:
getBundleData

Get data entered into fields for a completed Bundle

Parameters

Name Key Required Type Description
Bundle Slug
 bundleSlug True string

The slug that uniquely identifies the Bundle

Returns

Name Path Type Description
array of object
attachments
 attachments array of object

An array of file attachments for an attachment field, or null
ext
 attachments.ext string

The file extension
is_image
 attachments.is_image boolean

true if this attachment file is an image
name
 attachments.name string

File name of the attachment
num
 attachments.num integer

The order in which the file was added, if there we're multiple uploads for a single attachment field (for instance, a photo for each page of a document taken with a webcam)
size
 attachments.size integer

Size of the file, in bytes
url
 attachments.url url

A URL that can be used temporarily to download the attachment file
doc_key
 doc_key string

The key uniquely identifying this document in the Bundle (from the original BundleRequest)
field_key
 field_key string

The key uniquely identifying the field in the Document (either as specified in the original DocumentRequestField in the DocumentRequest in BundleRequest, or as configured on the DocumentTemplate)
filled_by
 filled_by string

The Packet key of the signer that entered the value for this field. If the field value was an 'initial_value' not edited by a signer, the value is 'initial'. If the field value was the default value configured on a DocumentTemplate, the filler is 'default'.
kind
 kind string

The kind of field
label
 label string

The label of the field (possibly blank)
packet_id
 packet_id

The Packet id of the signer that entered the value for this field, or null if the field value was not filled in by a signer (ie, it was an initial_value or defaul value).
value
 value

The value of the field.

Retrieve Bundle Files

Operation ID:
getBundleFiles

Get downloadable files for a completed Bundle

Parameters

Name Key Required Type Description
Bundle Slug
 bundleSlug True string

The slug that uniquely identifies the Bundle

Returns

Name Path Type Description
array of object
expires
 expires string

The time at which the link expires, as an ISO 8601 formatted time
file_url
 file_url string

the URL from where the file can be downloaded

Retrieve Packet Certificate of Evidence

Operation ID:
getPacketCOE

Get a link and checksum of the Certificate of Evidence for this Packet

Parameters

Name Key Required Type Description
Packet Slug
 packetId True string

The slug that uniquely identifies the Packet

Returns

Send a Reminder

Operation ID:
sendPacketReminder

Send a Reminder email or SMS to a Signer. A reminder can only be sent once every hour. The reminder will be sent via the delivery method (email or SMS) and to the email address (or phone number) previously designated for this Packet.

Parameters

Name Key Required Type Description
Packet Slug
 packetId True string

The slug that uniquely identifies the Packet

Returns

Update a Packet

Operation ID:
updatePacket

Update a Packet (aka signer) with a new email, phone number, name or authentication options

The updated packet must still be deliverable. For instance, if you specify a deliver_via value of 'phone', but there was no phone number set in the original PacketRequest, then this request must include a phone as well, or an error will be returned.

You can change a Packet that was originally configured for embedded signing (that is, deliver_via was 'embed') to be delivered via email or SMS. However, no signing notifications or reminders will be automatically sent. You must call /packet/{packetId}/remind/ to send a signing notification email (or SMS).

If this Signer is associated with a Person, the person will be updated as well - the Person name will be changed (if provided) and any new email or phone number will be added.

Parameters

Name Key Required Type Description
Packet Slug
 packetId True string

The slug that uniquely identifies the Packet
body
 body

Returns

Update a Person

Operation ID:
updatePerson

Update the Person with new data. NOTE that any contact channels that are omitted from this request will be DELETED. If you don't want to replace all data on the Person, you probably want to use PATCH instead.

Parameters

Name Key Required Type Description
Person ID
 personId True uuid

The ID that uniquely identifies the Person
email
 email email
id
 id uuid
kind
 kind string

em for email. mp for phone.
phone
 phone phone
id
 id uuid
is_user
 is_user boolean

True if this Person is associated with a BlueInk User
metadata
 metadata object

Metadata to associate with this person. Metadata can be used in SmartFill to automatically populate documents. See SmartFill documentation for details.
name
 name string

The name of the person

Returns

Name Path Type Description
channels
 channels array of object
email
 channels.email email
id
 channels.id uuid
kind
 channels.kind string

em for email. mp for phone.
phone
 channels.phone phone
id
 id uuid
is_user
 is_user boolean

True if this Person is associated with a BlueInk User
metadata
 metadata object

Metadata to associate with this person. Metadata can be used in SmartFill to automatically populate documents. See SmartFill documentation for details.
name
 name string

The name of the person

Update a Webhook

Operation ID:
updateWebhook

Update the Webhook with new data. NOTE that any subscriptions that are omitted from this request will be DELETED. If you don't want to replace all data on the Webhook, you probably want to use PATCH instead.

Parameters

Name Key Required Type Description
Webhook ID
 webhookId True uuid

The ID that uniquely identifies the Webhook
enabled
 enabled boolean
event_types
 event_types array of string

types of events that will fire the webhook
id
 id uuid
name
 name string

must adhere to RFC 7230
order
 order integer
value
 value string

must adhere to RFC 7230
webhook
 webhook uuid
id
 id uuid
json
 json boolean
url
 url url

should be the full URL, including http/https

Returns

Name Path Type Description
enabled
 enabled boolean
event_types
 event_types array of string

types of events that will fire the webhook
extra_headers
 extra_headers array of object
id
 extra_headers.id uuid
name
 extra_headers.name string

must adhere to RFC 7230
order
 extra_headers.order integer
value
 extra_headers.value string

must adhere to RFC 7230
webhook
 extra_headers.webhook uuid
id
 id uuid
json
 json boolean
url
 url url

should be the full URL, including http/https

Update a WebhookExtraHeader

Operation ID:
updateWebhookExtraHeader

Update the WebhookExtraHeader with new data

Parameters

Name Key Required Type Description
WebhookExtraHeader ID
 webhookExtraHeaderId True uuid

The ID that uniquely identifies the WebhookExtraHeader
id
 id uuid
name
 name string

must adhere to RFC 7230
order
 order integer
value
 value string

must adhere to RFC 7230
webhook
 webhook uuid

Returns

Name Path Type Description
id
 id uuid
name
 name string

must adhere to RFC 7230
order
 order integer
value
 value string

must adhere to RFC 7230
webhook
 webhook uuid