Bundle

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: 94a86cdd-96d8-444a-bd7f-19b3ed9f967f
BundleIdstring · guidRequired

Bundle Id

Example: d29c6e79-4228-4514-a03b-84986f503e78
Responses
200

Success

application/json
get
/api/Bundle/Get

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.

SenderIPstringOptional

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

Responses
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: 7d06c62f-f50e-47b0-96ec-87098b576142
BundleIdstring · guidRequired

Bundle Id

Example: 577e6afb-fce1-4eaf-9507-34e1a9e29f05
Responses
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: 00660dc9-29e3-4213-bd4f-803f69f26613
Body
BundleIdstring · guid · min: 1Required

Bundle Id

Example: a1dc4b21-e848-4305-a27b-51e562034cb7
Reasonstring · min: 1Required

[Mandatory] Reason for retraction

Example: Reason
Messagestring | nullableOptional

[Optional] Additional message

Responses
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: 6cc6db7e-627f-48ef-b4fe-04453639fddc
Body
BundleIdstring · guid · min: 1Required

Bundle Id

Example: 267b7e3d-b124-4e1b-88f3-f4907777b17d
Responses
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: 12335d3d-9fb1-4ae9-8afa-4314afaeb223
Body
Pageinteger · int32Optional

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

Example: 0
Responses
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: b5bb27bc-71af-4d54-bcd9-c58e0018d0ab
Body
BundleIdstring · guid · min: 1Required

Bundle Id

Example: 59d2fd4e-f260-48cb-8e3a-adb202103e44
Responses
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: e978371c-ef7f-45fe-84c2-9192607c2d0a
Body
BundleIdstring · guid · min: 1Required

Bundle Id

Example: d80ce806-efa1-4f3f-a51e-faa93d659b4a
ReminderNotesstring | nullableOptional

Notes to include in the email

TargetCustomerIdsstring · guid[] · min: 1Required

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

Example: ["37442881-ece8-4e05-bff2-762dea2bfb3c"]
Responses
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: 49cb62de-380f-460b-9977-f60788008c64
Body
BundleIdstring · guid · min: 1Required

Bundle Id

Example: 1c7260af-af3b-476e-b24c-bb9b19930e05
Responses
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: a145d8e3-99ac-44ae-8001-67e1793ec506
Body
BundleIdstring · guid · min: 1Required

Bundle Id

Example: fe3bb605-de02-471b-8152-567bd4d8a62a
EventWebhookUrlstring · min: 1Required

New webhook URL

Responses
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: adbe82e5-bec9-4491-afb7-0a714bf2d33c
Responses
200

Success

application/json
get
/api/Bundle/ListPendingArchive

Last updated