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:

Query parameters

TenantIdstring · guidRequired

FuseSign Tenant Id

Example: b83a571f-af29-400a-96bf-905a453ff54f

BundleIdstring · guidRequired

Bundle Id

Example: 4e13e8ba-f4bb-49db-94ba-a2a7a6b1ee97

Responses

200

Success

application/json

Idstring · guidOptional

Unique bundle ID

TenantIdstring · guidOptional

Bundle Tenant ID

ReviewUrlstring · nullableOptional

This URL will be set if the bundle is active with a link to the review page

DraftUrlstring · nullableOptional

This URL will be set if the bundle is in draft phase and allows for the bundle to be edited.

Subjectstring · nullableOptional

Bundle subject

Bodystring · nullableOptional

Bundle Body message

FromNamestring · nullableOptional

Who the bundle is from (included in email)

DueDatestring · date-time · nullableOptional

The bundle due date (optional)

DueReminderModeone ofOptional

Bundle reminder mode

string · enumOptionalPossible values:

OverdueReminderModeone ofOptional

Bundle overdue reminder mode

string · enumOptionalPossible values:

DateSentstring · date-time · nullableOptional

Date the bundle was sent if it is live

DateCompletedstring · date-time · nullableOptional

Date the bundle was completed if it is finalised

DateArchivedstring · date-time · nullableOptional

Date the bundle was archived if it is archived

LastReminderSentstring · date-time · nullableOptional

Date the last reminder was sent

Stateone ofOptional

Current bundle state

string · enumOptionalPossible values:

ViewModeone ofOptional

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:

SigningModeone ofOptional

The bundle signing mode

string · enumOptionalPossible values:

Settingsone of · nullableOptional

Bundle settings object

Metastring · nullableOptional

Bundle lookup metadata

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

get/api/Bundle/Get

GET /api/Bundle/Get?TenantId=text&BundleId=text HTTP/1.1
Host: api.fuse.work
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "Id": "text",
  "TenantId": "text",
  "ReviewUrl": "text",
  "DraftUrl": "text",
  "Subject": "text",
  "Body": "text",
  "FromName": "text",
  "Customers": [
    {
      "Customer": {
        "CustomerId": "text",
        "TenantId": "text",
        "Name": "text",
        "Email": "text",
        "PhoneNumber": "text",
        "NoMobile": true,
        "Meta": "text",
        "CannotModify": true,
        "Source": "Manual",
        "CustomerEditLink": "text",
        "TotalLiveBundlesForCustomer": 1,
        "TotalBundlesForCustomer": 1,
        "PreferredName": "text"
      },
      "LastSigner": true,
      "SigningGroup": 1,
      "CustomerSignUrl": "text",
      "CustomerBundleStatus": "NoActions",
      "LockLastSigningGroup": true,
      "CannotRemoveFromBundleDraft": true
    }
  ],
  "Documents": [
    {
      "Document": {
        "DocumentId": "text",
        "BundleId": "text",
        "Meta": "text",
        "DisplayName": "text",
        "EstimatedSize": 1,
        "SignedPDFDownloadUrl": "text"
      },
      "DocumentOrder": 1,
      "CustomerSigners": [
        {
          "Customer": {
            "CustomerId": "text",
            "TenantId": "text",
            "Name": "text",
            "Email": "text",
            "PhoneNumber": "text",
            "NoMobile": true,
            "Meta": "text",
            "CannotModify": true,
            "Source": "Manual",
            "CustomerEditLink": "text",
            "TotalLiveBundlesForCustomer": 1,
            "TotalBundlesForCustomer": 1,
            "PreferredName": "text"
          },
          "LastSigner": true,
          "SigningGroup": 1,
          "CustomerSignUrl": "text",
          "CustomerBundleStatus": "NoActions",
          "LockLastSigningGroup": true,
          "CannotRemoveFromBundleDraft": true
        }
      ],
      "CustomerViewers": [
        {
          "Customer": {
            "CustomerId": "text",
            "TenantId": "text",
            "Name": "text",
            "Email": "text",
            "PhoneNumber": "text",
            "NoMobile": true,
            "Meta": "text",
            "CannotModify": true,
            "Source": "Manual",
            "CustomerEditLink": "text",
            "TotalLiveBundlesForCustomer": 1,
            "TotalBundlesForCustomer": 1,
            "PreferredName": "text"
          },
          "LastSigner": true,
          "SigningGroup": 1,
          "CustomerSignUrl": "text",
          "CustomerBundleStatus": "NoActions",
          "LockLastSigningGroup": true,
          "CannotRemoveFromBundleDraft": true
        }
      ],
      "DocumentState": "Draft"
    }
  ],
  "DueDate": "2026-01-01T00:00:00.000Z",
  "DueReminderMode": "DontRemind",
  "OverdueReminderMode": "DontRemind",
  "DateSent": "2026-01-01T00:00:00.000Z",
  "DateCompleted": "2026-01-01T00:00:00.000Z",
  "DateArchived": "2026-01-01T00:00:00.000Z",
  "LastReminderSent": "2026-01-01T00:00:00.000Z",
  "State": "Draft",
  "ViewMode": "SmsToSign",
  "SigningMode": "SignWhole",
  "Settings": {
    "EmailPreference": "FuseSignEmails",
    "AlwaysSendFinalisationEmail": true,
    "WebhookUrl": "text",
    "DisableFinaliseNow": true,
    "DisableRetract": true,
    "DisableReminders": true,
    "CustomBranding": {
      "ButtonColor": "text",
      "BannerColor": "text",
      "LogoUrl": "text",
      "FromName": "text"
    },
    "RedirectUrl": "text",
    "RedirectDelaySeconds": 1,
    "AuditType": "Included",
    "ContextUrl": "text"
  },
  "Meta": "text"
}

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:

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

200

Success

application/json

Idstring · guidOptional

Unique bundle ID

TenantIdstring · guidOptional

Bundle Tenant ID

ReviewUrlstring · nullableOptional

This URL will be set if the bundle is active with a link to the review page

DraftUrlstring · nullableOptional

This URL will be set if the bundle is in draft phase and allows for the bundle to be edited.

Subjectstring · nullableOptional

Bundle subject

Bodystring · nullableOptional

Bundle Body message

FromNamestring · nullableOptional

Who the bundle is from (included in email)

DueDatestring · date-time · nullableOptional

The bundle due date (optional)

DueReminderModeone ofOptional

Bundle reminder mode

string · enumOptionalPossible values:

OverdueReminderModeone ofOptional

Bundle overdue reminder mode

string · enumOptionalPossible values:

DateSentstring · date-time · nullableOptional

Date the bundle was sent if it is live

DateCompletedstring · date-time · nullableOptional

Date the bundle was completed if it is finalised

DateArchivedstring · date-time · nullableOptional

Date the bundle was archived if it is archived

LastReminderSentstring · date-time · nullableOptional

Date the last reminder was sent

Stateone ofOptional

Current bundle state

string · enumOptionalPossible values:

ViewModeone ofOptional

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:

SigningModeone ofOptional

The bundle signing mode

string · enumOptionalPossible values:

Settingsone of · nullableOptional

Bundle settings object

Metastring · nullableOptional

Bundle lookup metadata

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

post/api/Bundle/Create

POST /api/Bundle/Create?TenantId=text HTTP/1.1
Host: api.fuse.work
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 1133

{
  "Subject": "test",
  "Body": "body",
  "CreateMode": "CreateAndSend",
  "CreatedBy": null,
  "Customers": [
    {
      "Customer": {
        "CustomerId": null,
        "Name": "Your Name",
        "Email": "youremail@yourdomain.com",
        "PhoneNumber": null,
        "NoMobile": true,
        "Meta": null,
        "CannotModify": false,
        "Options": {
          "IgnorePhoneNumberIfInvalid": false,
          "UpdateExistingCustomersByMetaMatch": false
        }
      },
      "LastSigner": null,
      "SigningGroup": 0,
      "LockLastSigningGroup": false,
      "CannotRemoveFromBundleDraft": false,
      "SMSNotify": false
    }
  ],
  "Documents": [
    {
      "DisplayName": "Signing document",
      "DocumentId": null,
      "DocumentBase64": null,
      "DocumentUrl": "https://www.w3.org/WAI/ER/tests/xhtml/testfiles/resources/pdf/dummy.pdf",
      "DocumentOrder": 0,
      "CustomerSigners": [],
      "CustomerInputElements": [
        {
          "CustomerIndex": 0,
          "InputElements": [
            {
              "PageIndex": 0,
              "X": 10,
              "Y": 10,
              "W": 50,
              "H": 20,
              "Type": "Standard",
              "PlacementType": "ByCoordinate",
              "AnchorText": null,
              "AnchorXOffset": 0,
              "AnchorYOffset": 0,
              "AnchorFindCount": 0
            }
          ]
        }
      ],
      "CustomerViewers": [],
      "Meta": null
    }
  ],
  "DueDate": null,
  "DueReminderMode": null,
  "OverdueReminderMode": null,
  "ViewMode": null,
  "RecipientReceiveMode": null,
  "SigningMode": "SignPlacements",
  "Settings": null,
  "Meta": null,
  "TeamId": null,
  "SenderIP": null
}

{
  "Id": "text",
  "TenantId": "text",
  "ReviewUrl": "text",
  "DraftUrl": "text",
  "Subject": "text",
  "Body": "text",
  "FromName": "text",
  "Customers": [
    {
      "Customer": {
        "CustomerId": "text",
        "TenantId": "text",
        "Name": "text",
        "Email": "text",
        "PhoneNumber": "text",
        "NoMobile": true,
        "Meta": "text",
        "CannotModify": true,
        "Source": "Manual",
        "CustomerEditLink": "text",
        "TotalLiveBundlesForCustomer": 1,
        "TotalBundlesForCustomer": 1,
        "PreferredName": "text"
      },
      "LastSigner": true,
      "SigningGroup": 1,
      "CustomerSignUrl": "text",
      "CustomerBundleStatus": "NoActions",
      "LockLastSigningGroup": true,
      "CannotRemoveFromBundleDraft": true
    }
  ],
  "Documents": [
    {
      "Document": {
        "DocumentId": "text",
        "BundleId": "text",
        "Meta": "text",
        "DisplayName": "text",
        "EstimatedSize": 1,
        "SignedPDFDownloadUrl": "text"
      },
      "DocumentOrder": 1,
      "CustomerSigners": [
        {
          "Customer": {
            "CustomerId": "text",
            "TenantId": "text",
            "Name": "text",
            "Email": "text",
            "PhoneNumber": "text",
            "NoMobile": true,
            "Meta": "text",
            "CannotModify": true,
            "Source": "Manual",
            "CustomerEditLink": "text",
            "TotalLiveBundlesForCustomer": 1,
            "TotalBundlesForCustomer": 1,
            "PreferredName": "text"
          },
          "LastSigner": true,
          "SigningGroup": 1,
          "CustomerSignUrl": "text",
          "CustomerBundleStatus": "NoActions",
          "LockLastSigningGroup": true,
          "CannotRemoveFromBundleDraft": true
        }
      ],
      "CustomerViewers": [
        {
          "Customer": {
            "CustomerId": "text",
            "TenantId": "text",
            "Name": "text",
            "Email": "text",
            "PhoneNumber": "text",
            "NoMobile": true,
            "Meta": "text",
            "CannotModify": true,
            "Source": "Manual",
            "CustomerEditLink": "text",
            "TotalLiveBundlesForCustomer": 1,
            "TotalBundlesForCustomer": 1,
            "PreferredName": "text"
          },
          "LastSigner": true,
          "SigningGroup": 1,
          "CustomerSignUrl": "text",
          "CustomerBundleStatus": "NoActions",
          "LockLastSigningGroup": true,
          "CannotRemoveFromBundleDraft": true
        }
      ],
      "DocumentState": "Draft"
    }
  ],
  "DueDate": "2026-01-01T00:00:00.000Z",
  "DueReminderMode": "DontRemind",
  "OverdueReminderMode": "DontRemind",
  "DateSent": "2026-01-01T00:00:00.000Z",
  "DateCompleted": "2026-01-01T00:00:00.000Z",
  "DateArchived": "2026-01-01T00:00:00.000Z",
  "LastReminderSent": "2026-01-01T00:00:00.000Z",
  "State": "Draft",
  "ViewMode": "SmsToSign",
  "SigningMode": "SignWhole",
  "Settings": {
    "EmailPreference": "FuseSignEmails",
    "AlwaysSendFinalisationEmail": true,
    "WebhookUrl": "text",
    "DisableFinaliseNow": true,
    "DisableRetract": true,
    "DisableReminders": true,
    "CustomBranding": {
      "ButtonColor": "text",
      "BannerColor": "text",
      "LogoUrl": "text",
      "FromName": "text"
    },
    "RedirectUrl": "text",
    "RedirectDelaySeconds": 1,
    "AuditType": "Included",
    "ContextUrl": "text"
  },
  "Meta": "text"
}

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:

Query parameters

TenantIdstring · guidRequired

FuseSign Tenant Id

Example: 57b5932d-c918-4ddd-9855-ea6ff723d87d

BundleIdstring · guidRequired

Bundle Id

Example: 12ab346b-e9e4-408e-a4f8-b6024b7fa406

Responses

200

Success

application/json

Idstring · guidOptional

Event ID

DateTimestring · date-timeOptional

Event Time

BundleIdstring · guidOptional

Bundle ID

DocumentIdstring · guid · nullableOptional

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:

Query parameters

TenantIdstring · guidRequired

FuseSign Tenant Id

Example: cc38e75f-ebdf-46af-97fc-d17268acfd4e

Body

BundleIdstring · guid · min: 1Required

Bundle Id

Example: e71c8dda-d461-4c6c-9a8b-d41b07cf9929

Reasonstring · min: 1Required

[Mandatory] Reason for retraction

Example: Reason

Messagestring · nullableOptional

[Optional] Additional message

Responses

200

Success

application/json

ResultbooleanOptional

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

post/api/Bundle/Retract

POST /api/Bundle/Retract?TenantId=text HTTP/1.1
Host: api.fuse.work
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: */*
Accept: */*
Content-Length: 84

{
  "BundleId": "e71c8dda-d461-4c6c-9a8b-d41b07cf9929",
  "Reason": "Reason",
  "Message": null
}

{
  "Result": true
}

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:

Query parameters

TenantIdstring · guidRequired

FuseSign Tenant Id

Example: 1f42c6ad-39e7-41f9-be1d-b0e85557d265

Body

BundleIdstring · guid · min: 1Required

Bundle Id

Example: 751dee44-ab5f-4a12-929c-3ed762e70c4a

Responses

200

Success

application/json

ResultbooleanOptional

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

post/api/Bundle/MarkReadyForArchive

POST /api/Bundle/MarkReadyForArchive?TenantId=text HTTP/1.1
Host: api.fuse.work
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: */*
Accept: */*
Content-Length: 51

{
  "BundleId": "751dee44-ab5f-4a12-929c-3ed762e70c4a"
}

{
  "Result": true
}

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:

Query parameters

TenantIdstring · guidRequired

FuseSign Tenant Id

Example: 6c5041f7-8144-4b7c-9676-734800e40d94

Body

Pageinteger · int32Optional

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

Example: 0

Responses

200

Success

application/json

Pageinteger · int32Optional

Search page

TotalPagesinteger · int32Optional

Total pages

RecordsPerPageinteger · int32Optional

Number of records per page

Countinteger · int32Optional

Number of records returned for this page

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

post/api/Bundle/Search

POST /api/Bundle/Search?TenantId=text HTTP/1.1
Host: api.fuse.work
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 28

{
  "Page": 0,
  "States": [
    "Live"
  ]
}

{
  "Page": 1,
  "TotalPages": 1,
  "RecordsPerPage": 1,
  "Count": 1,
  "SearchResults": [
    {
      "Id": "text",
      "TenantId": "text",
      "ReviewUrl": "text",
      "DraftUrl": "text",
      "Subject": "text",
      "Body": "text",
      "FromName": "text",
      "Customers": [
        {
          "Customer": {
            "CustomerId": "text",
            "TenantId": "text",
            "Name": "text",
            "Email": "text",
            "PhoneNumber": "text",
            "NoMobile": true,
            "Meta": "text",
            "CannotModify": true,
            "Source": "Manual",
            "CustomerEditLink": "text",
            "TotalLiveBundlesForCustomer": 1,
            "TotalBundlesForCustomer": 1,
            "PreferredName": "text"
          },
          "LastSigner": true,
          "SigningGroup": 1,
          "CustomerSignUrl": "text",
          "CustomerBundleStatus": "NoActions",
          "LockLastSigningGroup": true,
          "CannotRemoveFromBundleDraft": true
        }
      ],
      "Documents": [
        {
          "Document": {
            "DocumentId": "text",
            "BundleId": "text",
            "Meta": "text",
            "DisplayName": "text",
            "EstimatedSize": 1,
            "SignedPDFDownloadUrl": "text"
          },
          "DocumentOrder": 1,
          "CustomerSigners": [
            {
              "Customer": {
                "CustomerId": "text",
                "TenantId": "text",
                "Name": "text",
                "Email": "text",
                "PhoneNumber": "text",
                "NoMobile": true,
                "Meta": "text",
                "CannotModify": true,
                "Source": "Manual",
                "CustomerEditLink": "text",
                "TotalLiveBundlesForCustomer": 1,
                "TotalBundlesForCustomer": 1,
                "PreferredName": "text"
              },
              "LastSigner": true,
              "SigningGroup": 1,
              "CustomerSignUrl": "text",
              "CustomerBundleStatus": "NoActions",
              "LockLastSigningGroup": true,
              "CannotRemoveFromBundleDraft": true
            }
          ],
          "CustomerViewers": [
            {
              "Customer": {
                "CustomerId": "text",
                "TenantId": "text",
                "Name": "text",
                "Email": "text",
                "PhoneNumber": "text",
                "NoMobile": true,
                "Meta": "text",
                "CannotModify": true,
                "Source": "Manual",
                "CustomerEditLink": "text",
                "TotalLiveBundlesForCustomer": 1,
                "TotalBundlesForCustomer": 1,
                "PreferredName": "text"
              },
              "LastSigner": true,
              "SigningGroup": 1,
              "CustomerSignUrl": "text",
              "CustomerBundleStatus": "NoActions",
              "LockLastSigningGroup": true,
              "CannotRemoveFromBundleDraft": true
            }
          ],
          "DocumentState": "Draft"
        }
      ],
      "DueDate": "2026-01-01T00:00:00.000Z",
      "DueReminderMode": "DontRemind",
      "OverdueReminderMode": "DontRemind",
      "DateSent": "2026-01-01T00:00:00.000Z",
      "DateCompleted": "2026-01-01T00:00:00.000Z",
      "DateArchived": "2026-01-01T00:00:00.000Z",
      "LastReminderSent": "2026-01-01T00:00:00.000Z",
      "State": "Draft",
      "ViewMode": "SmsToSign",
      "SigningMode": "SignWhole",
      "Settings": {
        "EmailPreference": "FuseSignEmails",
        "AlwaysSendFinalisationEmail": true,
        "WebhookUrl": "text",
        "DisableFinaliseNow": true,
        "DisableRetract": true,
        "DisableReminders": true,
        "CustomBranding": {
          "ButtonColor": "text",
          "BannerColor": "text",
          "LogoUrl": "text",
          "FromName": "text"
        },
        "RedirectUrl": "text",
        "RedirectDelaySeconds": 1,
        "AuditType": "Included",
        "ContextUrl": "text"
      },
      "Meta": "text"
    }
  ]
}

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:

Query parameters

TenantIdstring · guidRequired

FuseSign Tenant Id

Example: 3712113b-72a8-4e85-9082-0d025d043903

Body

BundleIdstring · guid · min: 1Required

Bundle Id

Example: f29f8201-e3f7-492e-8f0d-a67ecde1b5a0

Responses

200

Success

application/json

ResultbooleanOptional

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

post/api/Bundle/Archive

POST /api/Bundle/Archive?TenantId=text HTTP/1.1
Host: api.fuse.work
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: */*
Accept: */*
Content-Length: 51

{
  "BundleId": "f29f8201-e3f7-492e-8f0d-a67ecde1b5a0"
}

{
  "Result": true
}

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:

Query parameters

TenantIdstring · guidRequired

FuseSign Tenant Id

Example: 7306de0e-ef52-4902-b821-726a597555e7

Body

BundleIdstring · guid · min: 1Required

Bundle Id

Example: a6e9e745-d927-42a6-808b-566adf4172f2

ReminderNotesstring · nullableOptional

Notes to include in the email

TargetCustomerIdsstring · guid[] · min: 1Required

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

Example: ["196ab9d6-7fcd-4c16-932c-14fd9354defd"]

Responses

200

Success

application/json

ResultbooleanOptional

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

post/api/Bundle/SendReminder

POST /api/Bundle/SendReminder?TenantId=text HTTP/1.1
Host: api.fuse.work
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 133

{
  "BundleId": "a6e9e745-d927-42a6-808b-566adf4172f2",
  "ReminderNotes": null,
  "TargetCustomerIds": [
    "196ab9d6-7fcd-4c16-932c-14fd9354defd"
  ]
}

{
  "Result": true
}

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:

Query parameters

TenantIdstring · guidRequired

FuseSign Tenant Id

Example: 5e568613-e6a1-48e5-bc8d-fabf95a503cd

Body

BundleIdstring · guid · min: 1Required

Bundle Id

Example: 60c5ecb4-4df3-46a7-a842-034627aa77d9

Responses

200

Success

application/json

ResultbooleanOptional

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

post/api/Bundle/DeleteBundleDraft

POST /api/Bundle/DeleteBundleDraft?TenantId=text HTTP/1.1
Host: api.fuse.work
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: */*
Accept: */*
Content-Length: 51

{
  "BundleId": "60c5ecb4-4df3-46a7-a842-034627aa77d9"
}

{
  "Result": true
}

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:

Query parameters

TenantIdstring · guidRequired

FuseSign Tenant Id

Example: f13c1d12-1d09-4f66-9ef9-4f64fb04adf4

Body

BundleIdstring · guid · min: 1Required

Bundle Id

Example: 93dd46a0-c5c8-45cf-89f5-f83f2a0be48a

EventWebhookUrlstring · min: 1Required

New webhook URL

Responses

200

Success

application/json

ResultbooleanOptional

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

post/api/Bundle/UpdateWebhookUrl

POST /api/Bundle/UpdateWebhookUrl?TenantId=text HTTP/1.1
Host: api.fuse.work
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: */*
Accept: */*
Content-Length: 72

{
  "BundleId": "93dd46a0-c5c8-45cf-89f5-f83f2a0be48a",
  "EventWebhookUrl": ""
}

{
  "Result": true
}

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:

Query parameters

TenantIdstring · guidRequired

FuseSign Tenant Id

Example: e7713aa3-0a11-4542-981a-2a02d8df92f1

Responses

200

Success

application/json

Idstring · guidOptional

Unique bundle ID

TenantIdstring · guidOptional

Bundle Tenant ID

ReviewUrlstring · nullableOptional

This URL will be set if the bundle is active with a link to the review page

DraftUrlstring · nullableOptional

This URL will be set if the bundle is in draft phase and allows for the bundle to be edited.

Subjectstring · nullableOptional

Bundle subject

Bodystring · nullableOptional

Bundle Body message

FromNamestring · nullableOptional

Who the bundle is from (included in email)

DueDatestring · date-time · nullableOptional

The bundle due date (optional)

DueReminderModeone ofOptional

Bundle reminder mode

string · enumOptionalPossible values:

OverdueReminderModeone ofOptional

Bundle overdue reminder mode

string · enumOptionalPossible values:

DateSentstring · date-time · nullableOptional

Date the bundle was sent if it is live

DateCompletedstring · date-time · nullableOptional

Date the bundle was completed if it is finalised

DateArchivedstring · date-time · nullableOptional

Date the bundle was archived if it is archived

LastReminderSentstring · date-time · nullableOptional

Date the last reminder was sent

Stateone ofOptional

Current bundle state

string · enumOptionalPossible values:

ViewModeone ofOptional

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:

SigningModeone ofOptional

The bundle signing mode

string · enumOptionalPossible values:

Settingsone of · nullableOptional

Bundle settings object

Metastring · nullableOptional

Bundle lookup metadata

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

get/api/Bundle/ListPendingArchive

GET /api/Bundle/ListPendingArchive?TenantId=text HTTP/1.1
Host: api.fuse.work
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

[
  {
    "Id": "text",
    "TenantId": "text",
    "ReviewUrl": "text",
    "DraftUrl": "text",
    "Subject": "text",
    "Body": "text",
    "FromName": "text",
    "Customers": [
      {
        "Customer": {
          "CustomerId": "text",
          "TenantId": "text",
          "Name": "text",
          "Email": "text",
          "PhoneNumber": "text",
          "NoMobile": true,
          "Meta": "text",
          "CannotModify": true,
          "Source": "Manual",
          "CustomerEditLink": "text",
          "TotalLiveBundlesForCustomer": 1,
          "TotalBundlesForCustomer": 1,
          "PreferredName": "text"
        },
        "LastSigner": true,
        "SigningGroup": 1,
        "CustomerSignUrl": "text",
        "CustomerBundleStatus": "NoActions",
        "LockLastSigningGroup": true,
        "CannotRemoveFromBundleDraft": true
      }
    ],
    "Documents": [
      {
        "Document": {
          "DocumentId": "text",
          "BundleId": "text",
          "Meta": "text",
          "DisplayName": "text",
          "EstimatedSize": 1,
          "SignedPDFDownloadUrl": "text"
        },
        "DocumentOrder": 1,
        "CustomerSigners": [
          {
            "Customer": {
              "CustomerId": "text",
              "TenantId": "text",
              "Name": "text",
              "Email": "text",
              "PhoneNumber": "text",
              "NoMobile": true,
              "Meta": "text",
              "CannotModify": true,
              "Source": "Manual",
              "CustomerEditLink": "text",
              "TotalLiveBundlesForCustomer": 1,
              "TotalBundlesForCustomer": 1,
              "PreferredName": "text"
            },
            "LastSigner": true,
            "SigningGroup": 1,
            "CustomerSignUrl": "text",
            "CustomerBundleStatus": "NoActions",
            "LockLastSigningGroup": true,
            "CannotRemoveFromBundleDraft": true
          }
        ],
        "CustomerViewers": [
          {
            "Customer": {
              "CustomerId": "text",
              "TenantId": "text",
              "Name": "text",
              "Email": "text",
              "PhoneNumber": "text",
              "NoMobile": true,
              "Meta": "text",
              "CannotModify": true,
              "Source": "Manual",
              "CustomerEditLink": "text",
              "TotalLiveBundlesForCustomer": 1,
              "TotalBundlesForCustomer": 1,
              "PreferredName": "text"
            },
            "LastSigner": true,
            "SigningGroup": 1,
            "CustomerSignUrl": "text",
            "CustomerBundleStatus": "NoActions",
            "LockLastSigningGroup": true,
            "CannotRemoveFromBundleDraft": true
          }
        ],
        "DocumentState": "Draft"
      }
    ],
    "DueDate": "2026-01-01T00:00:00.000Z",
    "DueReminderMode": "DontRemind",
    "OverdueReminderMode": "DontRemind",
    "DateSent": "2026-01-01T00:00:00.000Z",
    "DateCompleted": "2026-01-01T00:00:00.000Z",
    "DateArchived": "2026-01-01T00:00:00.000Z",
    "LastReminderSent": "2026-01-01T00:00:00.000Z",
    "State": "Draft",
    "ViewMode": "SmsToSign",
    "SigningMode": "SignWhole",
    "Settings": {
      "EmailPreference": "FuseSignEmails",
      "AlwaysSendFinalisationEmail": true,
      "WebhookUrl": "text",
      "DisableFinaliseNow": true,
      "DisableRetract": true,
      "DisableReminders": true,
      "CustomBranding": {
        "ButtonColor": "text",
        "BannerColor": "text",
        "LogoUrl": "text",
        "FromName": "text"
      },
      "RedirectUrl": "text",
      "RedirectDelaySeconds": 1,
      "AuditType": "Included",
      "ContextUrl": "text"
    },
    "Meta": "text"
  }
]

Gets the signing link for a specific customer on a bundle. This requires special permission for your use case, please contact support@fuse.work

get

Returns the signing URL for a given customer on a bundle. Requires the CanGetSigningLinks developer permission.

Authorizations

OAuth2authorizationCodeRequired

FuseSign OAuth 2. Use this for most implementations.

Authorization URL: Token URL: Refresh URL:

Query parameters

TenantIdstring · guidRequired

FuseSign Tenant Id

Example: 19dad925-3bd2-4890-8753-670c70dc75a6

BundleIdstring · guidRequired

Bundle Id

Example: 6f84c053-33d6-40df-8a42-e6acdc7a64c3

CustomerIdstring · guidRequired

Customer Id

Example: e53cd2be-8e4b-4ec5-8db6-f8dda6a9e0d0

Responses

200

Success

application/json

SigningLinkstringRequired

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

get/api/Bundle/GetCustomerSigningLink

GET /api/Bundle/GetCustomerSigningLink?TenantId=text&BundleId=text&CustomerId=text HTTP/1.1
Host: api.fuse.work
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "SigningLink": "text"
}

PreviousSession

NextCustomer

Last updated 6 months ago