Bundle
A bundle is a collection of messages, settings, recipients, documents and optionally placeholders.
Gets the detailed information of a bundle
FuseSign Tenant Id
71d93054-d095-4458-aad0-a010ca1f2ed7Bundle Id
1cafcbbb-1e6e-4d8e-a333-052668b39769Success
Bad Request
Unauthorized
Forbidden
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": "2025-11-02T01:33:44.217Z",
"DueReminderMode": "DontRemind",
"OverdueReminderMode": "DontRemind",
"DateSent": "2025-11-02T01:33:44.217Z",
"DateCompleted": "2025-11-02T01:33:44.217Z",
"DateArchived": "2025-11-02T01:33:44.217Z",
"LastReminderSent": "2025-11-02T01:33:44.217Z",
"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
Bundle subject
testBundle Body message
bodyCreate and send or create as draft
CreateAndSendSets 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.
^[^@]+@[^@]+$The bundle due date (optional)
Bundle reminder mode (optional)
Bundle overdue reminder mode (optional)
The bundle view mode setting. If this is blank the business default is selected and the system falls back to the highest available authentication
How the recipients receive signed documents
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.].
SignPlacementsBundle settings object - API related options.
Bundle lookup metadata
If assigned - apply this team to the bundle. Verify that the user sending the bundle can send on behalf of this team.
IP Address applied to the bundle Audit. Automatic Field - no need to set.
Success
Bad Request
Unauthorized
Forbidden
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": "2025-11-02T01:33:44.217Z",
"DueReminderMode": "DontRemind",
"OverdueReminderMode": "DontRemind",
"DateSent": "2025-11-02T01:33:44.217Z",
"DateCompleted": "2025-11-02T01:33:44.217Z",
"DateArchived": "2025-11-02T01:33:44.217Z",
"LastReminderSent": "2025-11-02T01:33:44.217Z",
"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
04d2b8a4-261b-49f8-9786-8a216710821dBundle Id
ddbf5f17-6e4e-46b8-8109-2a1364b311edSuccess
Bad Request
Unauthorized
Forbidden
GET /api/Bundle/GetHistory?TenantId=text&BundleId=text HTTP/1.1
Host: api.fuse.work
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
[
{
"Id": "text",
"DateTime": "2025-11-02T01:33:44.217Z",
"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
3d4f18b8-b485-4d53-b0da-a9fabd9aa7b8Bundle Id
49540c47-b417-4522-873b-14569ea5f674[Mandatory] Reason for retraction
Reason[Optional] Additional message
Success
Bad Request
Unauthorized
Forbidden
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": "49540c47-b417-4522-873b-14569ea5f674",
"Reason": "Reason",
"Message": null
}{
"Result": true
}Mark the bundle as "Closed" which will allow it to be archived
FuseSign Tenant Id
2bcdca1c-ac35-4274-8097-81a4a0e1c1cfBundle Id
3186943f-3bad-4587-a6c3-adff1fdcdd4aSuccess
Bad Request
Unauthorized
Forbidden
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": "3186943f-3bad-4587-a6c3-adff1fdcdd4a"
}{
"Result": true
}Gets a list of bundles for the specified tenant.
FuseSign Tenant Id
6dfdfe78-e7e4-4210-ab57-27f3fd370264Search page (50 records per page). 0 Based indexing.
0Success
Bad Request
Unauthorized
Forbidden
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": "2025-11-02T01:33:44.217Z",
"DueReminderMode": "DontRemind",
"OverdueReminderMode": "DontRemind",
"DateSent": "2025-11-02T01:33:44.217Z",
"DateCompleted": "2025-11-02T01:33:44.217Z",
"DateArchived": "2025-11-02T01:33:44.217Z",
"LastReminderSent": "2025-11-02T01:33:44.217Z",
"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
8a8ea5be-cce8-4116-81eb-282a9cc56416Bundle Id
ee4876a9-06d4-4c15-bf69-1fd65778f3cbSuccess
Bad Request
Unauthorized
Forbidden
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": "ee4876a9-06d4-4c15-bf69-1fd65778f3cb"
}{
"Result": true
}Send a reminder for a bundle (Requires Emails to be enabled for the bundle)
FuseSign Tenant Id
464711cd-0078-424e-a38f-3dcd4fafddd9Bundle Id
cc0d9edc-f11d-405f-85d5-349a5c478926Notes to include in the email
List of customer IDs (can be retrieved on Bundle/Get
["408eaab9-9ea9-4e11-8656-25dec53428b0"]Success
Bad Request
Unauthorized
Forbidden
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": "cc0d9edc-f11d-405f-85d5-349a5c478926",
"ReminderNotes": null,
"TargetCustomerIds": [
"408eaab9-9ea9-4e11-8656-25dec53428b0"
]
}{
"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
35853b3b-b658-42cb-bfbb-f3dde4dbf120Bundle Id
2082f23f-7571-4c53-a2b5-3f6d1a24880dSuccess
Bad Request
Unauthorized
Forbidden
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": "2082f23f-7571-4c53-a2b5-3f6d1a24880d"
}{
"Result": true
}Update the webhook URL. All future webhooks will be sent to the new URL.
FuseSign Tenant Id
14af8f28-84de-4e28-b3fb-dfd5e7814fb3Bundle Id
3170b17d-71c0-4278-acef-46c720a4ae5bNew webhook URL
Success
Bad Request
Unauthorized
Forbidden
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": "3170b17d-71c0-4278-acef-46c720a4ae5b",
"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
87b4c097-68a6-4512-932d-48880bd7523fSuccess
Bad Request
Unauthorized
Forbidden
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": "2025-11-02T01:33:44.217Z",
"DueReminderMode": "DontRemind",
"OverdueReminderMode": "DontRemind",
"DateSent": "2025-11-02T01:33:44.217Z",
"DateCompleted": "2025-11-02T01:33:44.217Z",
"DateArchived": "2025-11-02T01:33:44.217Z",
"LastReminderSent": "2025-11-02T01:33:44.217Z",
"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