Bundle
A bundle is a collection of messages, settings, recipients, documents and optionally placeholders.
Gets the detailed information of a bundle
Authorizations
Query parameters
tenantIdstring · guidRequired
FuseSign Tenant Id
bundleIdstring · guidRequired
Bundle Id
Responses
200
Success
application/json
400
Bad Request
application/json
401
Unauthorized
application/json
403
Forbidden
get
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-07-15T19:46:12.665Z",
"dueReminderMode": "DontRemind",
"overdueReminderMode": "DontRemind",
"dateSent": "2025-07-15T19:46:12.665Z",
"dateCompleted": "2025-07-15T19:46:12.665Z",
"dateArchived": "2025-07-15T19:46:12.665Z",
"lastReminderSent": "2025-07-15T19:46:12.665Z",
"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.
Authorizations
Query parameters
tenantIdstring · guidRequired
FuseSign Tenant Id
Body
all ofOptionalExample:
{"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}and
objectOptional
Responses
200
Success
application/json
400
Bad Request
application/json
401
Unauthorized
application/json
403
Forbidden
post
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-07-15T19:46:12.665Z",
"dueReminderMode": "DontRemind",
"overdueReminderMode": "DontRemind",
"dateSent": "2025-07-15T19:46:12.665Z",
"dateCompleted": "2025-07-15T19:46:12.665Z",
"dateArchived": "2025-07-15T19:46:12.665Z",
"lastReminderSent": "2025-07-15T19:46:12.665Z",
"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.
Authorizations
Query parameters
tenantIdstring · guidRequired
FuseSign Tenant Id
bundleIdstring · guidRequired
Bundle Id
Responses
200
Success
application/json
400
Bad Request
application/json
401
Unauthorized
application/json
403
Forbidden
get
GET /api/Bundle/GetHistory HTTP/1.1
Host: api.fuse.work
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
[
{
"id": "text",
"dateTime": "2025-07-15T19:46:12.665Z",
"bundleId": "text",
"documentId": "text",
"customerId": "text",
"action": "Sent",
"actionNotes": "text",
"ip": "text"
}
]Request bundle retraction. This will cancel the outstanding sign request
Authorizations
Query parameters
tenantIdstring · guidRequired
FuseSign Tenant Id
Body
bundleIdstring · guid · min: 1Required
Bundle Id
reasonstring · min: 1Required
[Mandatory] Reason for retraction
messagestring | nullableOptional
[Optional] Additional message
Responses
200
Success
application/json
400
Bad Request
application/json
401
Unauthorized
application/json
403
Forbidden
post
POST /api/Bundle/Retract HTTP/1.1
Host: api.fuse.work
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: */*
Accept: */*
Content-Length: 84
{
"bundleId": "099bfdc9-e1c9-4e7c-8028-ee88700ceac6",
"reason": "Reason",
"message": null
}{
"result": true
}Mark the bundle as "Closed" which will allow it to be archived
Authorizations
Query parameters
tenantIdstring · guidRequired
FuseSign Tenant Id
Body
bundleIdstring · guid · min: 1Required
Bundle Id
Responses
200
Success
application/json
400
Bad Request
application/json
401
Unauthorized
application/json
403
Forbidden
post
POST /api/Bundle/MarkReadyForArchive HTTP/1.1
Host: api.fuse.work
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: */*
Accept: */*
Content-Length: 51
{
"bundleId": "330a5281-3c18-4e91-a7a8-7c9bed44565f"
}{
"result": true
}Gets a list of bundles for the specified tenant.
Authorizations
Query parameters
tenantIdstring · guidRequired
FuseSign Tenant Id
Body
pageinteger · int32Optional
Search page (50 records per page). 0 Based indexing.
Responses
200
Success
application/json
400
Bad Request
application/json
401
Unauthorized
application/json
403
Forbidden
post
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-07-15T19:46:12.665Z",
"dueReminderMode": "DontRemind",
"overdueReminderMode": "DontRemind",
"dateSent": "2025-07-15T19:46:12.665Z",
"dateCompleted": "2025-07-15T19:46:12.665Z",
"dateArchived": "2025-07-15T19:46:12.665Z",
"lastReminderSent": "2025-07-15T19:46:12.665Z",
"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
Authorizations
Query parameters
tenantIdstring · guidRequired
FuseSign Tenant Id
Body
bundleIdstring · guid · min: 1Required
Bundle Id
Responses
200
Success
application/json
400
Bad Request
application/json
401
Unauthorized
application/json
403
Forbidden
post
POST /api/Bundle/Archive HTTP/1.1
Host: api.fuse.work
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: */*
Accept: */*
Content-Length: 51
{
"bundleId": "904fef93-6b47-43c0-a71f-d7d8601036a6"
}{
"result": true
}Send a reminder for a bundle (Requires Emails to be enabled for the bundle)
Authorizations
Query parameters
tenantIdstring · guidRequired
FuseSign Tenant Id
Body
bundleIdstring · guid · min: 1Required
Bundle Id
reminderNotesstring | nullableOptional
Notes to include in the email
targetCustomerIdsstring · guid[]Optional
List of customer IDs (can be retrieved on Bundle/Get
Responses
200
Success
application/json
400
Bad Request
application/json
401
Unauthorized
application/json
403
Forbidden
post
POST /api/Bundle/SendReminder HTTP/1.1
Host: api.fuse.work
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: */*
Accept: */*
Content-Length: 133
{
"bundleId": "3f36c9c3-5646-4649-8798-cb9e8d3724f3",
"reminderNotes": null,
"targetCustomerIds": [
"009b065b-46d8-45ee-816b-cf73d496fef3"
]
}{
"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.
Authorizations
Query parameters
tenantIdstring · guidRequired
FuseSign Tenant Id
Body
bundleIdstring · guid · min: 1Required
Bundle Id
Responses
200
Success
application/json
400
Bad Request
application/json
401
Unauthorized
application/json
403
Forbidden
post
POST /api/Bundle/DeleteBundleDraft HTTP/1.1
Host: api.fuse.work
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: */*
Accept: */*
Content-Length: 51
{
"bundleId": "770cc8a1-4d78-43ed-b8cd-e391cd7ed677"
}{
"result": true
}Update the webhook URL. All future webhooks will be sent to the new URL.
Authorizations
Query parameters
tenantIdstring · guidRequired
FuseSign Tenant Id
Body
bundleIdstring · guid · min: 1Required
Bundle Id
eventWebhookUrlstring · min: 1Required
New webhook URL
Responses
200
Success
application/json
400
Bad Request
application/json
401
Unauthorized
application/json
403
Forbidden
post
POST /api/Bundle/UpdateWebhookUrl HTTP/1.1
Host: api.fuse.work
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: */*
Accept: */*
Content-Length: 72
{
"bundleId": "8f3bbcb5-f275-474c-98ce-911bd590c815",
"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
Authorizations
Query parameters
tenantIdstring · guidRequired
FuseSign Tenant Id
Responses
200
Success
application/json
400
Bad Request
application/json
401
Unauthorized
application/json
403
Forbidden
get
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-07-15T19:46:12.665Z",
"dueReminderMode": "DontRemind",
"overdueReminderMode": "DontRemind",
"dateSent": "2025-07-15T19:46:12.665Z",
"dateCompleted": "2025-07-15T19:46:12.665Z",
"dateArchived": "2025-07-15T19:46:12.665Z",
"lastReminderSent": "2025-07-15T19:46:12.665Z",
"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