Bundle
A bundle is a collection of messages, settings, recipients, documents and optionally placeholders.
Gets the detailed information of a bundle
FuseSign Tenant Id
Bundle Id
Success
Bad Request
Unauthorized
Forbidden
GET /api/Bundle/Get 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
},
"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
},
"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
},
"lastSigner": true,
"signingGroup": 1,
"customerSignUrl": "text",
"customerBundleStatus": "NoActions",
"lockLastSigningGroup": true,
"cannotRemoveFromBundleDraft": true
}
],
"documentState": "Draft"
}
],
"dueDate": "2025-09-19T12:15:25.771Z",
"dueReminderMode": "DontRemind",
"overdueReminderMode": "DontRemind",
"dateSent": "2025-09-19T12:15:25.771Z",
"dateCompleted": "2025-09-19T12:15:25.771Z",
"dateArchived": "2025-09-19T12:15:25.771Z",
"lastReminderSent": "2025-09-19T12:15:25.771Z",
"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"
}
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.
FuseSign Tenant Id
{"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":false,"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":"0001-01-01T00:00:00+00:00","dueReminderMode":null,"overdueReminderMode":null,"viewMode":null,"recipientReceiveMode":null,"signingMode":"SignPlacements","settings":null,"meta":null,"teamId":null,"senderIP":null}
Success
Bad Request
Unauthorized
Forbidden
POST /api/Bundle/Create HTTP/1.1
Host: api.fuse.work
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 1157
{
"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": false,
"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": "0001-01-01T00:00:00+00:00",
"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
},
"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
},
"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
},
"lastSigner": true,
"signingGroup": 1,
"customerSignUrl": "text",
"customerBundleStatus": "NoActions",
"lockLastSigningGroup": true,
"cannotRemoveFromBundleDraft": true
}
],
"documentState": "Draft"
}
],
"dueDate": "2025-09-19T12:15:25.771Z",
"dueReminderMode": "DontRemind",
"overdueReminderMode": "DontRemind",
"dateSent": "2025-09-19T12:15:25.771Z",
"dateCompleted": "2025-09-19T12:15:25.771Z",
"dateArchived": "2025-09-19T12:15:25.771Z",
"lastReminderSent": "2025-09-19T12:15:25.771Z",
"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 a bundles history, including things like Finalisation, Errors and other actions. We recommend using Webhooks instead where appropriate.
FuseSign Tenant Id
Bundle Id
Success
Bad Request
Unauthorized
Forbidden
GET /api/Bundle/GetHistory HTTP/1.1
Host: api.fuse.work
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
[
{
"id": "text",
"dateTime": "2025-09-19T12:15:25.771Z",
"bundleId": "text",
"documentId": "text",
"customerId": "text",
"action": "Sent",
"actionNotes": "text",
"ip": "text"
}
]
Request bundle retraction. This will cancel the outstanding sign request
FuseSign Tenant Id
Bundle Id
[Mandatory] Reason for retraction
[Optional] Additional message
Success
Bad Request
Unauthorized
Forbidden
POST /api/Bundle/Retract HTTP/1.1
Host: api.fuse.work
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: */*
Accept: */*
Content-Length: 84
{
"bundleId": "f32cb987-9594-4c8c-a1d0-35d5713525c4",
"reason": "Reason",
"message": null
}
{
"result": true
}
Mark the bundle as "Closed" which will allow it to be archived
FuseSign Tenant Id
Bundle Id
Success
Bad Request
Unauthorized
Forbidden
POST /api/Bundle/MarkReadyForArchive HTTP/1.1
Host: api.fuse.work
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: */*
Accept: */*
Content-Length: 51
{
"bundleId": "d6b11a1a-c30b-41a1-8a24-1bee2b03b578"
}
{
"result": true
}
Gets a list of bundles for the specified tenant.
FuseSign Tenant Id
Search page (50 records per page). 0 Based indexing.
Success
Bad Request
Unauthorized
Forbidden
POST /api/Bundle/Search 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
},
"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
},
"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
},
"lastSigner": true,
"signingGroup": 1,
"customerSignUrl": "text",
"customerBundleStatus": "NoActions",
"lockLastSigningGroup": true,
"cannotRemoveFromBundleDraft": true
}
],
"documentState": "Draft"
}
],
"dueDate": "2025-09-19T12:15:25.771Z",
"dueReminderMode": "DontRemind",
"overdueReminderMode": "DontRemind",
"dateSent": "2025-09-19T12:15:25.771Z",
"dateCompleted": "2025-09-19T12:15:25.771Z",
"dateArchived": "2025-09-19T12:15:25.771Z",
"lastReminderSent": "2025-09-19T12:15:25.771Z",
"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"
}
]
}
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
FuseSign Tenant Id
Bundle Id
Success
Bad Request
Unauthorized
Forbidden
POST /api/Bundle/Archive HTTP/1.1
Host: api.fuse.work
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: */*
Accept: */*
Content-Length: 51
{
"bundleId": "2bbb8eaa-0d26-44dc-adbc-84f271b27c5e"
}
{
"result": true
}
Send a reminder for a bundle (Requires Emails to be enabled for the bundle)
FuseSign Tenant Id
Bundle Id
Notes to include in the email
List of customer IDs (can be retrieved on Bundle/Get
Success
Bad Request
Unauthorized
Forbidden
POST /api/Bundle/SendReminder HTTP/1.1
Host: api.fuse.work
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: */*
Accept: */*
Content-Length: 133
{
"bundleId": "fcaaea96-abaf-49ba-8bd1-210f6cb40755",
"reminderNotes": null,
"targetCustomerIds": [
"759ed8b1-160f-4fc1-9ab0-4276ea0e7aae"
]
}
{
"result": true
}
For a given bundle in draft state, delete the draft. This will consequently unlink associated documents and customer actions. Documents will not be deleted.
FuseSign Tenant Id
Bundle Id
Success
Bad Request
Unauthorized
Forbidden
POST /api/Bundle/DeleteBundleDraft HTTP/1.1
Host: api.fuse.work
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: */*
Accept: */*
Content-Length: 51
{
"bundleId": "b9133b13-baef-4bc9-8acc-a616a7a9067a"
}
{
"result": true
}
Update the webhook URL. All future webhooks will be sent to the new URL.
FuseSign Tenant Id
Bundle Id
New webhook URL
Success
Bad Request
Unauthorized
Forbidden
POST /api/Bundle/UpdateWebhookUrl HTTP/1.1
Host: api.fuse.work
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: */*
Accept: */*
Content-Length: 72
{
"bundleId": "3aa3236a-5d6e-4e3f-b4d7-c3f6a15224c7",
"eventWebhookUrl": ""
}
{
"result": true
}
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
FuseSign Tenant Id
Success
Bad Request
Unauthorized
Forbidden
GET /api/Bundle/ListPendingArchive 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
},
"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
},
"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
},
"lastSigner": true,
"signingGroup": 1,
"customerSignUrl": "text",
"customerBundleStatus": "NoActions",
"lockLastSigningGroup": true,
"cannotRemoveFromBundleDraft": true
}
],
"documentState": "Draft"
}
],
"dueDate": "2025-09-19T12:15:25.771Z",
"dueReminderMode": "DontRemind",
"overdueReminderMode": "DontRemind",
"dateSent": "2025-09-19T12:15:25.771Z",
"dateCompleted": "2025-09-19T12:15:25.771Z",
"dateArchived": "2025-09-19T12:15:25.771Z",
"lastReminderSent": "2025-09-19T12:15:25.771Z",
"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"
}
]
Last updated