boxBundle

A bundle is a collection of messages, settings, recipients, documents and optionally placeholders.

Gets the details of a bundle.

get

Gets the detailed information of a bundle

Authorizations
OAuth2authorizationCodeRequired

FuseSign OAuth 2. Use this for most implementations.

Authorization URL: Token URL: Refresh URL:
Available scopes:
  • : Manage FuseSign Bundles and corresponding data.
  • : Ability to send bundles and extract bundles created by this user only. Special purpose scope, contact support@fuse.work.
Query parameters
TenantIdstring · guidRequired

FuseSign Tenant Id

Example: d0881e59-79f4-4816-8d99-5dfc7ae56241
BundleIdstring · guidRequired

Bundle Id

Example: 3fa5b7c8-8465-4dd6-a56a-15ab104d3010
Responses
chevron-right
200

Success

application/json
get
/api/Bundle/Get
circle-info

see Bundle Createfor a deep dive with more explanation

Creates a new bundle.

post

Submit a bundle to request to Sign with other options. FuseSign offers two different methods for document signing: Sign Entire Document and Signature Placeholders. Sign Entire Document is default. Whereas placeholder mode requires values in Documents > CustomerInputElements. We recommend uploading your documents to /Document/Upload to use DocumentId.

Authorizations
OAuth2authorizationCodeRequired

FuseSign OAuth 2. Use this for most implementations.

Authorization URL: Token URL: Refresh URL:
Available scopes:
  • : Manage FuseSign Bundles and corresponding data.
  • : Ability to send bundles and extract bundles created by this user only. Special purpose scope, contact support@fuse.work.
Query parameters
TenantIdstring · guidRequired

FuseSign Tenant Id

Body
Subjectstring · max: 200Optional

Bundle subject

Example: test
BodystringOptional

Bundle Body message

Example: body
CreateModeone ofOptional

Create and send or create as draft

Example: CreateAndSend
string · enumOptionalPossible values:
CreatedBystring · emailOptional

Sets the created by user email. If the user exists and the requestor has permissions, then the bundle will be "created" by the specified user. Will cause an error to throw if the user does not have permissions to do this.

Pattern: ^[^@]+@[^@]+$
DueDatestring · date-time | nullableOptional

The bundle due date (optional)

DueReminderModeone of | nullableOptional

Bundle reminder mode (optional)

string · enumOptionalPossible values:
OverdueReminderModeone of | nullableOptional

Bundle overdue reminder mode (optional)

string · enumOptionalPossible values:
ViewModeone of | nullableOptional

The bundle view mode setting. If this is blank the business default is selected and the system falls back to the highest available authentication

string · enumOptionalPossible values:
RecipientReceiveModeone of | nullableOptional

How the recipients receive signed documents

string · enumOptionalPossible values:
SigningModeone of | nullableOptional

Describe how the document(s) will be processed. I.e. if signature placements are used [I.e. if SENDING SignPlacements then all Documents must have CustomerSignerLocations set. Otherwise CustomerSigners.].

Example: SignPlacements
string · enumOptionalPossible values:
Settingsone ofOptional

Bundle settings object - API related options.

Metastring · max: 1000Optional

Bundle lookup metadata

TeamIdstring · guid | nullableOptional

If assigned - apply this team to the bundle. Verify that the user sending the bundle can send on behalf of this team.

SenderIPstring | nullableOptional

IP Address applied to the bundle Audit. Automatic Field - no need to set.

Responses
chevron-right
200

Success

application/json
post
/api/Bundle/Create

Get bundle audit history.

get

Get a bundles history, including things like Finalisation, Errors and other actions. We recommend using Webhooks instead where appropriate.

Authorizations
OAuth2authorizationCodeRequired

FuseSign OAuth 2. Use this for most implementations.

Authorization URL: Token URL: Refresh URL:
Available scopes:
  • : Manage FuseSign Bundles and corresponding data.
  • : Ability to send bundles and extract bundles created by this user only. Special purpose scope, contact support@fuse.work.
Query parameters
TenantIdstring · guidRequired

FuseSign Tenant Id

Example: 201e0838-77b7-4eba-84cb-9cab6dd76de9
BundleIdstring · guidRequired

Bundle Id

Example: 01eaea5a-d585-4461-8aa8-d2927141b77f
Responses
chevron-right
200

Success

application/json
get
/api/Bundle/GetHistory

Retract a bundle.

post

Request bundle retraction. This will cancel the outstanding sign request

Authorizations
OAuth2authorizationCodeRequired

FuseSign OAuth 2. Use this for most implementations.

Authorization URL: Token URL: Refresh URL:
Available scopes:
  • : Manage FuseSign Bundles and corresponding data.
  • : Ability to send bundles and extract bundles created by this user only. Special purpose scope, contact support@fuse.work.
Query parameters
TenantIdstring · guidRequired

FuseSign Tenant Id

Example: 9aa84c5b-3e3a-459b-bb9e-a7cecc6ed82f
Body
BundleIdstring · guid · min: 1Required

Bundle Id

Example: 40b18b9f-56f0-44fb-98e6-202473fde5e8
Reasonstring · min: 1Required

[Mandatory] Reason for retraction

Example: Reason
Messagestring | nullableOptional

[Optional] Additional message

Responses
chevron-right
200

Success

application/json
post
/api/Bundle/Retract

Mark Bundle for Archive

post

Mark the bundle as "Closed" which will allow it to be archived

Authorizations
OAuth2authorizationCodeRequired

FuseSign OAuth 2. Use this for most implementations.

Authorization URL: Token URL: Refresh URL:
Available scopes:
  • : Manage FuseSign Bundles and corresponding data.
  • : Ability to send bundles and extract bundles created by this user only. Special purpose scope, contact support@fuse.work.
Query parameters
TenantIdstring · guidRequired

FuseSign Tenant Id

Example: 9105cb67-5c89-4554-bf2e-0cd518726ad8
Body
BundleIdstring · guid · min: 1Required

Bundle Id

Example: 008f4d2d-8788-4c50-be85-d6b00d8f234f
Responses
chevron-right
200

Success

application/json
post
/api/Bundle/MarkReadyForArchive

Gets a list of bundles.

post

Gets a list of bundles for the specified tenant.

Authorizations
OAuth2authorizationCodeRequired

FuseSign OAuth 2. Use this for most implementations.

Authorization URL: Token URL: Refresh URL:
Available scopes:
  • : Manage FuseSign Bundles and corresponding data.
  • : Ability to send bundles and extract bundles created by this user only. Special purpose scope, contact support@fuse.work.
Query parameters
TenantIdstring · guidRequired

FuseSign Tenant Id

Example: 90af2c63-fadc-4690-aa62-a52cb320708d
Body
Pageinteger · int32Optional

Search page (50 records per page). 0 Based indexing.

Example: 0
Responses
chevron-right
200

Success

application/json
post
/api/Bundle/Search

Archive a completed bundle

post

Request bundle Archive. This will schedule any bundle documents for deletion. Bundles can only be archived if they are in a Retracted, Rejected or Finalised state

Authorizations
OAuth2authorizationCodeRequired

FuseSign OAuth 2. Use this for most implementations.

Authorization URL: Token URL: Refresh URL:
Available scopes:
  • : Manage FuseSign Bundles and corresponding data.
  • : Ability to send bundles and extract bundles created by this user only. Special purpose scope, contact support@fuse.work.
Query parameters
TenantIdstring · guidRequired

FuseSign Tenant Id

Example: f8d50bdc-db0a-4972-a9a9-6b3f13c97568
Body
BundleIdstring · guid · min: 1Required

Bundle Id

Example: ceb8705d-08d1-4c73-9375-7cd0fe84e617
Responses
chevron-right
200

Success

application/json
post
/api/Bundle/Archive

Remind a bundle.

post

Send a reminder for a bundle (Requires Emails to be enabled for the bundle)

Authorizations
OAuth2authorizationCodeRequired

FuseSign OAuth 2. Use this for most implementations.

Authorization URL: Token URL: Refresh URL:
Available scopes:
  • : Manage FuseSign Bundles and corresponding data.
  • : Ability to send bundles and extract bundles created by this user only. Special purpose scope, contact support@fuse.work.
Query parameters
TenantIdstring · guidRequired

FuseSign Tenant Id

Example: ab52cf7d-dbaf-44b4-897d-cd40d7dadef5
Body
BundleIdstring · guid · min: 1Required

Bundle Id

Example: d37d0200-34af-4899-8e05-e529a75b6a58
ReminderNotesstring | nullableOptional

Notes to include in the email

TargetCustomerIdsstring · guid[] · min: 1Required

List of customer IDs (can be retrieved on Bundle/Get

Example: ["9ecb3b18-b706-4740-a8df-b596c7cda41d"]
Responses
chevron-right
200

Success

application/json
post
/api/Bundle/SendReminder

Delete a Bundle Draft

post

For a given bundle in draft state, delete the draft. This will consequently unlink associated documents and customer actions. Documents will not be deleted.

Authorizations
OAuth2authorizationCodeRequired

FuseSign OAuth 2. Use this for most implementations.

Authorization URL: Token URL: Refresh URL:
Available scopes:
  • : Manage FuseSign Bundles and corresponding data.
  • : Ability to send bundles and extract bundles created by this user only. Special purpose scope, contact support@fuse.work.
Query parameters
TenantIdstring · guidRequired

FuseSign Tenant Id

Example: aea1b9b3-e4e7-451a-a377-505da1e31934
Body
BundleIdstring · guid · min: 1Required

Bundle Id

Example: 0bc57f38-7100-48ef-8b3c-05cec2dcde51
Responses
chevron-right
200

Success

application/json
post
/api/Bundle/DeleteBundleDraft

Update the webhook URL for a bundle

post

Update the webhook URL. All future webhooks will be sent to the new URL.

Authorizations
OAuth2authorizationCodeRequired

FuseSign OAuth 2. Use this for most implementations.

Authorization URL: Token URL: Refresh URL:
Available scopes:
  • : Manage FuseSign Bundles and corresponding data.
  • : Ability to send bundles and extract bundles created by this user only. Special purpose scope, contact support@fuse.work.
Query parameters
TenantIdstring · guidRequired

FuseSign Tenant Id

Example: 9594ff04-e7df-4ded-848b-a18140c9230d
Body
BundleIdstring · guid · min: 1Required

Bundle Id

Example: d746a327-084b-4de7-8364-da79fd350636
EventWebhookUrlstring · min: 1Required

New webhook URL

Responses
chevron-right
200

Success

application/json
post
/api/Bundle/UpdateWebhookUrl

List Pending archive bundles

get

Request a list of all bundles which have been finalised/retracted or rejected which are yet to be archived. These bundles and associated documents will be automatically archived in 14 days

Authorizations
OAuth2authorizationCodeRequired

FuseSign OAuth 2. Use this for most implementations.

Authorization URL: Token URL: Refresh URL:
Available scopes:
  • : Manage FuseSign Bundles and corresponding data.
  • : Ability to send bundles and extract bundles created by this user only. Special purpose scope, contact support@fuse.work.
Query parameters
TenantIdstring · guidRequired

FuseSign Tenant Id

Example: 5992ce00-a7ff-403f-ab4d-ceffe7e2d2d0
Responses
chevron-right
200

Success

application/json
get
/api/Bundle/ListPendingArchive

Last updated