FuseWorks
  • GETTING STARTED
    • An Overview
    • QuickStart Guide
  • Deep Dives
    • Webhooks
    • Scopes
    • Bundle Create
  • API References
    • Session
    • Bundle
    • Customer
    • Document
    • Tenant
  • Resources
    • OpenApi Spec
  • Swagger
  • Integrate with Us
Powered by GitBook
On this page
Export as PDF
  1. API References

Bundle

A bundle is a collection of messages, settings, recipients, documents and optionally placeholders.

PreviousSessionNextCustomer

Last updated 12 days ago

see Bundle Createfor a deep dive with more explanation

Get a Bundle history

get

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

FuseSign Bundle ID

Responses
application/json
object[]Optional
application/json
get
GET /api/Bundle/GetHistory HTTP/1.1
Host: localhost:3003
Accept: */*

{
  "Example 1": null
}

Retract a bundle

post

Request bundle retraction. This will cancel the outstanding sign request

Authorizations
Query parameters
tenantIdstring · guidRequired

FuseSign Tenant ID

bundleIdstring · guidRequired

FuseSign Bundle ID

reasonstring | nullableRequired

Retraction Reason

messagestring | nullableOptional

Retraction Message for client email (Optional) (Requires FuseSignEmails to be enabled)

Responses
application/json
objectOptional
application/json
post
POST /api/Bundle/Retract HTTP/1.1
Host: localhost:3003
Accept: */*

{
  "Result": true,
  "Message": "text",
  "Error": "text",
  "Errors": [
    {
      "Property": "text",
      "ErrorMessage": "text",
      "ErrorCode": "text"
    }
  ]
}

CloseBundle

post

Mark the bundle as "Closed" which will allow it to be archived

Authorizations
Query parameters
tenantIdstring · guidRequired

FuseSign Tenant ID

bundleIdstring · guidRequired

FuseSign Bundle ID

Responses
application/json
objectOptional
application/json
post
POST /api/Bundle/MarkReadyForArchive HTTP/1.1
Host: localhost:3003
Accept: */*

{
  "Result": true,
  "Message": "text",
  "Error": "text",
  "Errors": [
    {
      "Property": "text",
      "ErrorMessage": "text",
      "ErrorCode": "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
Query parameters
tenantIdstring · guidRequired

FuseSign Tenant ID

bundleIdstring · guidRequired

FuseSign Bundle ID

Responses
application/json
objectOptional
application/json
post
POST /api/Bundle/Archive HTTP/1.1
Host: localhost:3003
Accept: */*

{
  "Result": true,
  "Message": "text",
  "Error": "text",
  "Errors": [
    {
      "Property": "text",
      "ErrorMessage": "text",
      "ErrorCode": "text"
    }
  ]
}

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
Query parameters
businessIdstring · guidRequired
draftBundleIdstring · guidRequired
Responses
application/json
objectOptional
post
POST /api/Bundle/DeleteBundleDraft HTTP/1.1
Host: localhost:3003
Accept: */*
200Success
{
  "Result": true,
  "Message": "text",
  "Error": "text",
  "Errors": [
    {
      "Property": "text",
      "ErrorMessage": "text",
      "ErrorCode": "text"
    }
  ]
}

Dummy for documentation

get

This is to workaround swagger and expose the webhook payload object for doco

Authorizations
Responses
application/json
objectOptional
get
GET /api/Bundle/WebhookExample HTTP/1.1
Host: localhost:3003
Accept: */*
200Success
{
  "WebhookId": "text",
  "BundleId": "text",
  "EventType": "CustomerEmailDelivered",
  "BundleHistoryEvent": {
    "Id": "text",
    "DateTime": "2025-04-19T14:47:13.841Z",
    "BundleId": "text",
    "DocumentId": "text",
    "CustomerId": "text",
    "Action": "Sent",
    "ActionNotes": "text",
    "IP": "text"
  },
  "ActionDescription": "text"
}

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
Query parameters
tenantIdstring · guidRequired

FuseSign Tenant ID

Responses
application/json
object[]OptionalExample: {"Id":"2d3bebc1-cde0-4f51-9a45-981fcfb7297e","TenantId":"17db3324-c754-4c6a-988a-402b232a0bd6","ReviewUrl":"https://bundle.review.url","DraftUrl":null,"Subject":"This is the subject field in the email","Body":"Hello Signer, Could you please sign please","FromName":null,"Customers":[{"Customer":{"CustomerId":"62901503-5b28-49e6-966c-1c41b5342732","TenantId":"17db3324-c754-4c6a-988a-402b232a0bd6","Name":"Signer One","Email":"Signer@email.com","PhoneNumber":"+61411111111","NoMobile":false,"Meta":"mylookupkey","CannotModify":false,"Source":"Manual","CustomerEditLink":null,"TotalLiveBundlesForCustomer":null,"TotalBundlesForCustomer":null},"LastSigner":false,"SigningGroup":0,"CustomerSignUrl":"https://customer.sign/url","CustomerBundleStatus":null,"LockLastSigningGroup":false,"CannotRemoveFromBundleDraft":false},{"Customer":{"CustomerId":"885f490b-71ed-4d13-94a2-16f86ae0353e","TenantId":"17db3324-c754-4c6a-988a-402b232a0bd6","Name":"Signer Two","Email":"Signer2@email.com","PhoneNumber":"+61411111112","NoMobile":false,"Meta":"mysecondlookupkey","CannotModify":false,"Source":"Manual","CustomerEditLink":null,"TotalLiveBundlesForCustomer":null,"TotalBundlesForCustomer":null},"LastSigner":false,"SigningGroup":1,"CustomerSignUrl":"https://customer.sign/url","CustomerBundleStatus":null,"LockLastSigningGroup":false,"CannotRemoveFromBundleDraft":false}],"Documents":[{"Document":{"DocumentId":"7d6edd10-7a58-4240-8327-4f2206202e15","BundleId":"2d3bebc1-cde0-4f51-9a45-981fcfb7297e","Meta":"mylookupkey","DisplayName":"myPdf","EstimatedSize":1000,"SignedPDFDownloadUrl":"https://download.url/docid"},"DocumentOrder":0,"CustomerSigners":[{"Customer":{"CustomerId":"62901503-5b28-49e6-966c-1c41b5342732","TenantId":"17db3324-c754-4c6a-988a-402b232a0bd6","Name":"Signer One","Email":"Signer@email.com","PhoneNumber":"+61411111111","NoMobile":false,"Meta":"mylookupkey","CannotModify":false,"Source":"Manual","CustomerEditLink":null,"TotalLiveBundlesForCustomer":null,"TotalBundlesForCustomer":null},"LastSigner":false,"SigningGroup":0,"CustomerSignUrl":"https://customer.sign/url","CustomerBundleStatus":null,"LockLastSigningGroup":false,"CannotRemoveFromBundleDraft":false},{"Customer":{"CustomerId":"885f490b-71ed-4d13-94a2-16f86ae0353e","TenantId":"17db3324-c754-4c6a-988a-402b232a0bd6","Name":"Signer Two","Email":"Signer2@email.com","PhoneNumber":"+61411111112","NoMobile":false,"Meta":"mysecondlookupkey","CannotModify":false,"Source":"Manual","CustomerEditLink":null,"TotalLiveBundlesForCustomer":null,"TotalBundlesForCustomer":null},"LastSigner":false,"SigningGroup":1,"CustomerSignUrl":"https://customer.sign/url","CustomerBundleStatus":null,"LockLastSigningGroup":false,"CannotRemoveFromBundleDraft":false}],"DocumentState":"Draft"}],"DueDate":"2025-04-21T16:46:26.3410486+10:00","DueReminderMode":"DontRemind","OverdueReminderMode":"DontRemind","DateSent":"2025-04-07T16:46:26.3410486+10:00","DateCompleted":"0001-01-01T00:00:00+00:00","DateArchived":"0001-01-01T00:00:00+00:00","LastReminderSent":"0001-01-01T00:00:00+00:00","State":"Live","ViewMode":"SmsToView","SigningMode":"SignWhole","Settings":{"EmailPreference":"NoFuseSignEmails","AlwaysSendFinalisationEmail":false,"WebhookUrl":"https://your.webhook/url","DisableFinaliseNow":false,"DisableRetract":false,"DisableReminders":false,"CustomBranding":null,"RedirectUrl":null,"RedirectDelaySeconds":10,"AuditType":"Included","ContextUrl":null},"Meta":null}
application/json
get
GET /api/Bundle/ListPendingArchive HTTP/1.1
Host: localhost:3003
Accept: */*

{
  "Example 1": null
}
  • GETGet a Bundle
  • POSTCreate a Bundle
  • GETGet a Bundle history
  • POSTRetract a bundle
  • POSTCloseBundle
  • POSTDelegate a recipient to a new recipient
  • POSTBundle Summary
  • POSTArchive a completed bundle
  • POSTSend a reminder
  • POSTDelete a Bundle Draft
  • POSTUpdate the webhook URL for a bundle
  • GETDummy for documentation
  • GETList Pending archive bundles
  • POSTGenerate new signing links

Get a Bundle

get

Get a bundle by its ID

Authorizations
Query parameters
tenantIdstring · guidRequired

FuseSign Tenant ID

bundleIdstring · guidRequired

FuseSign Bundle ID

Responses
application/json
objectOptionalExample: {"Id":"2d3bebc1-cde0-4f51-9a45-981fcfb7297e","TenantId":"17db3324-c754-4c6a-988a-402b232a0bd6","ReviewUrl":"https://bundle.review.url","DraftUrl":null,"Subject":"This is the subject field in the email","Body":"Hello Signer, Could you please sign please","FromName":null,"Customers":[{"Customer":{"CustomerId":"62901503-5b28-49e6-966c-1c41b5342732","TenantId":"17db3324-c754-4c6a-988a-402b232a0bd6","Name":"Signer One","Email":"Signer@email.com","PhoneNumber":"+61411111111","NoMobile":false,"Meta":"mylookupkey","CannotModify":false,"Source":"Manual","CustomerEditLink":null,"TotalLiveBundlesForCustomer":null,"TotalBundlesForCustomer":null},"LastSigner":false,"SigningGroup":0,"CustomerSignUrl":"https://customer.sign/url","CustomerBundleStatus":null,"LockLastSigningGroup":false,"CannotRemoveFromBundleDraft":false},{"Customer":{"CustomerId":"885f490b-71ed-4d13-94a2-16f86ae0353e","TenantId":"17db3324-c754-4c6a-988a-402b232a0bd6","Name":"Signer Two","Email":"Signer2@email.com","PhoneNumber":"+61411111112","NoMobile":false,"Meta":"mysecondlookupkey","CannotModify":false,"Source":"Manual","CustomerEditLink":null,"TotalLiveBundlesForCustomer":null,"TotalBundlesForCustomer":null},"LastSigner":false,"SigningGroup":1,"CustomerSignUrl":"https://customer.sign/url","CustomerBundleStatus":null,"LockLastSigningGroup":false,"CannotRemoveFromBundleDraft":false}],"Documents":[{"Document":{"DocumentId":"7d6edd10-7a58-4240-8327-4f2206202e15","BundleId":"2d3bebc1-cde0-4f51-9a45-981fcfb7297e","Meta":"mylookupkey","DisplayName":"myPdf","EstimatedSize":1000,"SignedPDFDownloadUrl":"https://download.url/docid"},"DocumentOrder":0,"CustomerSigners":[{"Customer":{"CustomerId":"62901503-5b28-49e6-966c-1c41b5342732","TenantId":"17db3324-c754-4c6a-988a-402b232a0bd6","Name":"Signer One","Email":"Signer@email.com","PhoneNumber":"+61411111111","NoMobile":false,"Meta":"mylookupkey","CannotModify":false,"Source":"Manual","CustomerEditLink":null,"TotalLiveBundlesForCustomer":null,"TotalBundlesForCustomer":null},"LastSigner":false,"SigningGroup":0,"CustomerSignUrl":"https://customer.sign/url","CustomerBundleStatus":null,"LockLastSigningGroup":false,"CannotRemoveFromBundleDraft":false},{"Customer":{"CustomerId":"885f490b-71ed-4d13-94a2-16f86ae0353e","TenantId":"17db3324-c754-4c6a-988a-402b232a0bd6","Name":"Signer Two","Email":"Signer2@email.com","PhoneNumber":"+61411111112","NoMobile":false,"Meta":"mysecondlookupkey","CannotModify":false,"Source":"Manual","CustomerEditLink":null,"TotalLiveBundlesForCustomer":null,"TotalBundlesForCustomer":null},"LastSigner":false,"SigningGroup":1,"CustomerSignUrl":"https://customer.sign/url","CustomerBundleStatus":null,"LockLastSigningGroup":false,"CannotRemoveFromBundleDraft":false}],"DocumentState":"Draft"}],"DueDate":"2025-04-21T16:46:26.3410486+10:00","DueReminderMode":"DontRemind","OverdueReminderMode":"DontRemind","DateSent":"2025-04-07T16:46:26.3410486+10:00","DateCompleted":"0001-01-01T00:00:00+00:00","DateArchived":"0001-01-01T00:00:00+00:00","LastReminderSent":"0001-01-01T00:00:00+00:00","State":"Live","ViewMode":"SmsToView","SigningMode":"SignWhole","Settings":{"EmailPreference":"NoFuseSignEmails","AlwaysSendFinalisationEmail":false,"WebhookUrl":"https://your.webhook/url","DisableFinaliseNow":false,"DisableRetract":false,"DisableReminders":false,"CustomBranding":null,"RedirectUrl":null,"RedirectDelaySeconds":10,"AuditType":"Included","ContextUrl":null},"Meta":null}
application/json
get
GET /api/Bundle/Get HTTP/1.1
Host: localhost:3003
Accept: */*

{
  "Example 1": {
    "Id": "00387d16-572d-4337-86da-b64e79f98eed",
    "TenantId": "a199d151-58b8-4d1e-b086-d9b09feaa077",
    "ReviewUrl": "https://bundle.review.url",
    "DraftUrl": null,
    "Subject": "This is the subject field in the email",
    "Body": "Hello Signer, Could you please sign please",
    "FromName": null,
    "Customers": [
      {
        "Customer": {
          "CustomerId": "2d74f1ca-4719-483b-b27b-0887aab77a7d",
          "TenantId": "a199d151-58b8-4d1e-b086-d9b09feaa077",
          "Name": "Signer One",
          "Email": "Signer@email.com",
          "PhoneNumber": "+61411111111",
          "NoMobile": false,
          "Meta": "mylookupkey",
          "CannotModify": false,
          "Source": "Manual",
          "CustomerEditLink": null,
          "TotalLiveBundlesForCustomer": null,
          "TotalBundlesForCustomer": null
        },
        "LastSigner": false,
        "SigningGroup": 0,
        "CustomerSignUrl": "https://customer.sign/url",
        "CustomerBundleStatus": null,
        "LockLastSigningGroup": false,
        "CannotRemoveFromBundleDraft": false
      },
      {
        "Customer": {
          "CustomerId": "7604d64b-a057-4ee9-8e69-38148af7d934",
          "TenantId": "a199d151-58b8-4d1e-b086-d9b09feaa077",
          "Name": "Signer Two",
          "Email": "Signer2@email.com",
          "PhoneNumber": "+61411111112",
          "NoMobile": false,
          "Meta": "mysecondlookupkey",
          "CannotModify": false,
          "Source": "Manual",
          "CustomerEditLink": null,
          "TotalLiveBundlesForCustomer": null,
          "TotalBundlesForCustomer": null
        },
        "LastSigner": false,
        "SigningGroup": 1,
        "CustomerSignUrl": "https://customer.sign/url",
        "CustomerBundleStatus": null,
        "LockLastSigningGroup": false,
        "CannotRemoveFromBundleDraft": false
      }
    ],
    "Documents": [
      {
        "Document": {
          "DocumentId": "3d9d1af7-79f1-4ef4-b954-c3230d8e59a7",
          "BundleId": "00387d16-572d-4337-86da-b64e79f98eed",
          "Meta": "mylookupkey",
          "DisplayName": "myPdf",
          "EstimatedSize": 1000,
          "SignedPDFDownloadUrl": "https://download.url/docid"
        },
        "DocumentOrder": 0,
        "CustomerSigners": [
          {
            "Customer": {
              "CustomerId": "2d74f1ca-4719-483b-b27b-0887aab77a7d",
              "TenantId": "a199d151-58b8-4d1e-b086-d9b09feaa077",
              "Name": "Signer One",
              "Email": "Signer@email.com",
              "PhoneNumber": "+61411111111",
              "NoMobile": false,
              "Meta": "mylookupkey",
              "CannotModify": false,
              "Source": "Manual",
              "CustomerEditLink": null,
              "TotalLiveBundlesForCustomer": null,
              "TotalBundlesForCustomer": null
            },
            "LastSigner": false,
            "SigningGroup": 0,
            "CustomerSignUrl": "https://customer.sign/url",
            "CustomerBundleStatus": null,
            "LockLastSigningGroup": false,
            "CannotRemoveFromBundleDraft": false
          },
          {
            "Customer": {
              "CustomerId": "7604d64b-a057-4ee9-8e69-38148af7d934",
              "TenantId": "a199d151-58b8-4d1e-b086-d9b09feaa077",
              "Name": "Signer Two",
              "Email": "Signer2@email.com",
              "PhoneNumber": "+61411111112",
              "NoMobile": false,
              "Meta": "mysecondlookupkey",
              "CannotModify": false,
              "Source": "Manual",
              "CustomerEditLink": null,
              "TotalLiveBundlesForCustomer": null,
              "TotalBundlesForCustomer": null
            },
            "LastSigner": false,
            "SigningGroup": 1,
            "CustomerSignUrl": "https://customer.sign/url",
            "CustomerBundleStatus": null,
            "LockLastSigningGroup": false,
            "CannotRemoveFromBundleDraft": false
          }
        ],
        "DocumentState": "Draft"
      }
    ],
    "DueDate": "2025-04-21T16:46:26.2937123+10:00",
    "DueReminderMode": "DontRemind",
    "OverdueReminderMode": "DontRemind",
    "DateSent": "2025-04-07T16:46:26.2937123+10:00",
    "DateCompleted": "0001-01-01T00:00:00+00:00",
    "DateArchived": "0001-01-01T00:00:00+00:00",
    "LastReminderSent": "0001-01-01T00:00:00+00:00",
    "State": "Live",
    "ViewMode": "SmsToView",
    "SigningMode": "SignWhole",
    "Settings": {
      "EmailPreference": "NoFuseSignEmails",
      "AlwaysSendFinalisationEmail": false,
      "WebhookUrl": "https://your.webhook/url",
      "DisableFinaliseNow": false,
      "DisableRetract": false,
      "DisableReminders": false,
      "CustomBranding": null,
      "RedirectUrl": null,
      "RedirectDelaySeconds": 10,
      "AuditType": "Included",
      "ContextUrl": null
    },
    "Meta": null
  }
}

Create a 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 rather than DocumentUrl.

Authorizations
Query parameters
tenantIdstring · guidRequired

FuseSign Tenant

Body
one of | nullableOptional
Responses
application/json
objectOptionalExample: {"Id":"2d3bebc1-cde0-4f51-9a45-981fcfb7297e","TenantId":"17db3324-c754-4c6a-988a-402b232a0bd6","ReviewUrl":"https://bundle.review.url","DraftUrl":null,"Subject":"This is the subject field in the email","Body":"Hello Signer, Could you please sign please","FromName":null,"Customers":[{"Customer":{"CustomerId":"62901503-5b28-49e6-966c-1c41b5342732","TenantId":"17db3324-c754-4c6a-988a-402b232a0bd6","Name":"Signer One","Email":"Signer@email.com","PhoneNumber":"+61411111111","NoMobile":false,"Meta":"mylookupkey","CannotModify":false,"Source":"Manual","CustomerEditLink":null,"TotalLiveBundlesForCustomer":null,"TotalBundlesForCustomer":null},"LastSigner":false,"SigningGroup":0,"CustomerSignUrl":"https://customer.sign/url","CustomerBundleStatus":null,"LockLastSigningGroup":false,"CannotRemoveFromBundleDraft":false},{"Customer":{"CustomerId":"885f490b-71ed-4d13-94a2-16f86ae0353e","TenantId":"17db3324-c754-4c6a-988a-402b232a0bd6","Name":"Signer Two","Email":"Signer2@email.com","PhoneNumber":"+61411111112","NoMobile":false,"Meta":"mysecondlookupkey","CannotModify":false,"Source":"Manual","CustomerEditLink":null,"TotalLiveBundlesForCustomer":null,"TotalBundlesForCustomer":null},"LastSigner":false,"SigningGroup":1,"CustomerSignUrl":"https://customer.sign/url","CustomerBundleStatus":null,"LockLastSigningGroup":false,"CannotRemoveFromBundleDraft":false}],"Documents":[{"Document":{"DocumentId":"7d6edd10-7a58-4240-8327-4f2206202e15","BundleId":"2d3bebc1-cde0-4f51-9a45-981fcfb7297e","Meta":"mylookupkey","DisplayName":"myPdf","EstimatedSize":1000,"SignedPDFDownloadUrl":"https://download.url/docid"},"DocumentOrder":0,"CustomerSigners":[{"Customer":{"CustomerId":"62901503-5b28-49e6-966c-1c41b5342732","TenantId":"17db3324-c754-4c6a-988a-402b232a0bd6","Name":"Signer One","Email":"Signer@email.com","PhoneNumber":"+61411111111","NoMobile":false,"Meta":"mylookupkey","CannotModify":false,"Source":"Manual","CustomerEditLink":null,"TotalLiveBundlesForCustomer":null,"TotalBundlesForCustomer":null},"LastSigner":false,"SigningGroup":0,"CustomerSignUrl":"https://customer.sign/url","CustomerBundleStatus":null,"LockLastSigningGroup":false,"CannotRemoveFromBundleDraft":false},{"Customer":{"CustomerId":"885f490b-71ed-4d13-94a2-16f86ae0353e","TenantId":"17db3324-c754-4c6a-988a-402b232a0bd6","Name":"Signer Two","Email":"Signer2@email.com","PhoneNumber":"+61411111112","NoMobile":false,"Meta":"mysecondlookupkey","CannotModify":false,"Source":"Manual","CustomerEditLink":null,"TotalLiveBundlesForCustomer":null,"TotalBundlesForCustomer":null},"LastSigner":false,"SigningGroup":1,"CustomerSignUrl":"https://customer.sign/url","CustomerBundleStatus":null,"LockLastSigningGroup":false,"CannotRemoveFromBundleDraft":false}],"DocumentState":"Draft"}],"DueDate":"2025-04-21T16:46:26.3410486+10:00","DueReminderMode":"DontRemind","OverdueReminderMode":"DontRemind","DateSent":"2025-04-07T16:46:26.3410486+10:00","DateCompleted":"0001-01-01T00:00:00+00:00","DateArchived":"0001-01-01T00:00:00+00:00","LastReminderSent":"0001-01-01T00:00:00+00:00","State":"Live","ViewMode":"SmsToView","SigningMode":"SignWhole","Settings":{"EmailPreference":"NoFuseSignEmails","AlwaysSendFinalisationEmail":false,"WebhookUrl":"https://your.webhook/url","DisableFinaliseNow":false,"DisableRetract":false,"DisableReminders":false,"CustomBranding":null,"RedirectUrl":null,"RedirectDelaySeconds":10,"AuditType":"Included","ContextUrl":null},"Meta":null}
application/json
post
POST /api/Bundle/Create HTTP/1.1
Host: localhost:3003
Content-Type: application/json
Accept: */*
Content-Length: 3196

{
  "Subject": "This is the subject field in the email",
  "Body": "Hello Signer, Could you please sign please",
  "CreateMode": "CreateAndSend",
  "CreatedBy": null,
  "Customers": [
    {
      "Customer": {
        "CustomerId": null,
        "Name": "Signer One",
        "Email": "Signer@email.com",
        "PhoneNumber": "+61411111111",
        "NoMobile": false,
        "Meta": "mylookupkey",
        "CannotModify": false,
        "Options": {
          "IgnorePhoneNumberIfInvalid": false,
          "UpdateExistingCustomersByMetaMatch": false
        }
      },
      "LastSigner": false,
      "SigningGroup": 0,
      "LockLastSigningGroup": false,
      "CannotRemoveFromBundleDraft": false,
      "SMSNotify": false
    },
    {
      "Customer": {
        "CustomerId": null,
        "Name": "Signer Two",
        "Email": "Signer2@email.com",
        "PhoneNumber": "+61411111112",
        "NoMobile": false,
        "Meta": "mysecondlookupkey",
        "CannotModify": false,
        "Options": {
          "IgnorePhoneNumberIfInvalid": false,
          "UpdateExistingCustomersByMetaMatch": false
        }
      },
      "LastSigner": false,
      "SigningGroup": 1,
      "LockLastSigningGroup": false,
      "CannotRemoveFromBundleDraft": false,
      "SMSNotify": false
    }
  ],
  "Documents": [
    {
      "DisplayName": null,
      "DocumentId": "2ba7c7d9-383e-4376-8daf-42c03762501c",
      "DocumentBase64": null,
      "DocumentUrl": null,
      "DocumentOrder": 0,
      "CustomerSigners": [
        0
      ],
      "CustomerInputElements": [
        {
          "CustomerIndex": 0,
          "InputElements": [
            {
              "PageIndex": 0,
              "X": 50,
              "Y": 50,
              "W": 100,
              "H": 50,
              "Type": "Standard",
              "PlacementType": "ByCoordinate",
              "AnchorText": null,
              "AnchorXOffset": 0,
              "AnchorYOffset": 0,
              "AnchorFindCount": 0
            }
          ]
        }
      ],
      "CustomerViewers": null,
      "Meta": "mylookupkey"
    },
    {
      "DisplayName": null,
      "DocumentId": "17c7277e-1ee9-45ca-9241-57340f24c212",
      "DocumentBase64": null,
      "DocumentUrl": null,
      "DocumentOrder": 0,
      "CustomerSigners": [
        0
      ],
      "CustomerInputElements": [
        {
          "CustomerIndex": 1,
          "InputElements": [
            {
              "PageIndex": 1,
              "X": 250,
              "Y": 250,
              "W": 100,
              "H": 20,
              "Type": "Paragraph",
              "PlacementType": "ByCoordinate",
              "AnchorText": null,
              "AnchorXOffset": 0,
              "AnchorYOffset": 0,
              "AnchorFindCount": 0
            }
          ]
        }
      ],
      "CustomerViewers": null,
      "Meta": "mylookupkey"
    },
    {
      "DisplayName": null,
      "DocumentId": "1b0ad7b3-3af8-438e-9ab6-22a1171c94b1",
      "DocumentBase64": null,
      "DocumentUrl": null,
      "DocumentOrder": 0,
      "CustomerSigners": [
        0
      ],
      "CustomerInputElements": [
        {
          "CustomerIndex": 1,
          "InputElements": [
            {
              "PageIndex": 1,
              "X": 50,
              "Y": 50,
              "W": 100,
              "H": 50,
              "Type": "WithDate",
              "PlacementType": "ByCoordinate",
              "AnchorText": null,
              "AnchorXOffset": 0,
              "AnchorYOffset": 0,
              "AnchorFindCount": 0
            }
          ]
        }
      ],
      "CustomerViewers": null,
      "Meta": "mylookupkey"
    },
    {
      "DisplayName": null,
      "DocumentId": "a056d4d1-fbe2-43d9-b8d9-889c00879500",
      "DocumentBase64": null,
      "DocumentUrl": null,
      "DocumentOrder": 0,
      "CustomerSigners": [
        0
      ],
      "CustomerInputElements": [
        {
          "CustomerIndex": 1,
          "InputElements": [
            {
              "PageIndex": 1,
              "X": 250,
              "Y": 250,
              "W": 100,
              "H": 20,
              "Type": "CheckBox",
              "PlacementType": "ByCoordinate",
              "AnchorText": null,
              "AnchorXOffset": 0,
              "AnchorYOffset": 0,
              "AnchorFindCount": 0
            }
          ]
        }
      ],
      "CustomerViewers": null,
      "Meta": "mylookupkey"
    }
  ],
  "DueDate": "2025-04-21T16:46:26.2757322+10:00",
  "DueReminderMode": null,
  "OverdueReminderMode": null,
  "ViewMode": "SmsToView",
  "RecipientReceiveMode": null,
  "SigningMode": null,
  "Settings": {
    "EmailPreference": "NoFuseSignEmails",
    "AlwaysSendFinalisationEmail": false,
    "WebhookUrl": "https://mywebhook.com/fusesign",
    "DisableFinaliseNow": false,
    "DisableRetract": false,
    "DisableReminders": false,
    "CustomBranding": null,
    "RedirectUrl": null,
    "RedirectDelaySeconds": 10,
    "AuditType": "Included",
    "ContextUrl": null
  },
  "Meta": "myBundleKey",
  "TeamId": null,
  "SenderIP": null
}
{
  "Example 1": {
    "Id": "40006501-e6ad-4685-b154-fd456d0bc1da",
    "TenantId": "17d37d9e-4d0d-422c-a4df-82ebcf672035",
    "ReviewUrl": "https://bundle.review.url",
    "DraftUrl": null,
    "Subject": "This is the subject field in the email",
    "Body": "Hello Signer, Could you please sign please",
    "FromName": null,
    "Customers": [
      {
        "Customer": {
          "CustomerId": "9fe94918-de65-4967-a2d5-5a4bffd62a3f",
          "TenantId": "17d37d9e-4d0d-422c-a4df-82ebcf672035",
          "Name": "Signer One",
          "Email": "Signer@email.com",
          "PhoneNumber": "+61411111111",
          "NoMobile": false,
          "Meta": "mylookupkey",
          "CannotModify": false,
          "Source": "Manual",
          "CustomerEditLink": null,
          "TotalLiveBundlesForCustomer": null,
          "TotalBundlesForCustomer": null
        },
        "LastSigner": false,
        "SigningGroup": 0,
        "CustomerSignUrl": "https://customer.sign/url",
        "CustomerBundleStatus": null,
        "LockLastSigningGroup": false,
        "CannotRemoveFromBundleDraft": false
      },
      {
        "Customer": {
          "CustomerId": "4c2cd04a-371f-49d6-80fc-665087185a55",
          "TenantId": "17d37d9e-4d0d-422c-a4df-82ebcf672035",
          "Name": "Signer Two",
          "Email": "Signer2@email.com",
          "PhoneNumber": "+61411111112",
          "NoMobile": false,
          "Meta": "mysecondlookupkey",
          "CannotModify": false,
          "Source": "Manual",
          "CustomerEditLink": null,
          "TotalLiveBundlesForCustomer": null,
          "TotalBundlesForCustomer": null
        },
        "LastSigner": false,
        "SigningGroup": 1,
        "CustomerSignUrl": "https://customer.sign/url",
        "CustomerBundleStatus": null,
        "LockLastSigningGroup": false,
        "CannotRemoveFromBundleDraft": false
      }
    ],
    "Documents": [
      {
        "Document": {
          "DocumentId": "c41c8423-77e6-47f8-a926-6952e1d8cf5f",
          "BundleId": "40006501-e6ad-4685-b154-fd456d0bc1da",
          "Meta": "mylookupkey",
          "DisplayName": "myPdf",
          "EstimatedSize": 1000,
          "SignedPDFDownloadUrl": "https://download.url/docid"
        },
        "DocumentOrder": 0,
        "CustomerSigners": [
          {
            "Customer": {
              "CustomerId": "9fe94918-de65-4967-a2d5-5a4bffd62a3f",
              "TenantId": "17d37d9e-4d0d-422c-a4df-82ebcf672035",
              "Name": "Signer One",
              "Email": "Signer@email.com",
              "PhoneNumber": "+61411111111",
              "NoMobile": false,
              "Meta": "mylookupkey",
              "CannotModify": false,
              "Source": "Manual",
              "CustomerEditLink": null,
              "TotalLiveBundlesForCustomer": null,
              "TotalBundlesForCustomer": null
            },
            "LastSigner": false,
            "SigningGroup": 0,
            "CustomerSignUrl": "https://customer.sign/url",
            "CustomerBundleStatus": null,
            "LockLastSigningGroup": false,
            "CannotRemoveFromBundleDraft": false
          },
          {
            "Customer": {
              "CustomerId": "4c2cd04a-371f-49d6-80fc-665087185a55",
              "TenantId": "17d37d9e-4d0d-422c-a4df-82ebcf672035",
              "Name": "Signer Two",
              "Email": "Signer2@email.com",
              "PhoneNumber": "+61411111112",
              "NoMobile": false,
              "Meta": "mysecondlookupkey",
              "CannotModify": false,
              "Source": "Manual",
              "CustomerEditLink": null,
              "TotalLiveBundlesForCustomer": null,
              "TotalBundlesForCustomer": null
            },
            "LastSigner": false,
            "SigningGroup": 1,
            "CustomerSignUrl": "https://customer.sign/url",
            "CustomerBundleStatus": null,
            "LockLastSigningGroup": false,
            "CannotRemoveFromBundleDraft": false
          }
        ],
        "DocumentState": "Draft"
      }
    ],
    "DueDate": "2025-04-21T16:46:26.2837341+10:00",
    "DueReminderMode": "DontRemind",
    "OverdueReminderMode": "DontRemind",
    "DateSent": "2025-04-07T16:46:26.28473+10:00",
    "DateCompleted": "0001-01-01T00:00:00+00:00",
    "DateArchived": "0001-01-01T00:00:00+00:00",
    "LastReminderSent": "0001-01-01T00:00:00+00:00",
    "State": "Live",
    "ViewMode": "SmsToView",
    "SigningMode": "SignWhole",
    "Settings": {
      "EmailPreference": "NoFuseSignEmails",
      "AlwaysSendFinalisationEmail": false,
      "WebhookUrl": "https://your.webhook/url",
      "DisableFinaliseNow": false,
      "DisableRetract": false,
      "DisableReminders": false,
      "CustomBranding": null,
      "RedirectUrl": null,
      "RedirectDelaySeconds": 10,
      "AuditType": "Included",
      "ContextUrl": null
    },
    "Meta": null
  }
}

Delegate a recipient to a new recipient

post

Re-assign a bundle to a new person if they have 0 pending actions.

Authorizations
Query parameters
tenantIdstring · guidRequired

FuseSign Tenant

Body
one of | nullableOptional
Responses
application/json
objectOptionalExample: {"Id":"2d3bebc1-cde0-4f51-9a45-981fcfb7297e","TenantId":"17db3324-c754-4c6a-988a-402b232a0bd6","ReviewUrl":"https://bundle.review.url","DraftUrl":null,"Subject":"This is the subject field in the email","Body":"Hello Signer, Could you please sign please","FromName":null,"Customers":[{"Customer":{"CustomerId":"62901503-5b28-49e6-966c-1c41b5342732","TenantId":"17db3324-c754-4c6a-988a-402b232a0bd6","Name":"Signer One","Email":"Signer@email.com","PhoneNumber":"+61411111111","NoMobile":false,"Meta":"mylookupkey","CannotModify":false,"Source":"Manual","CustomerEditLink":null,"TotalLiveBundlesForCustomer":null,"TotalBundlesForCustomer":null},"LastSigner":false,"SigningGroup":0,"CustomerSignUrl":"https://customer.sign/url","CustomerBundleStatus":null,"LockLastSigningGroup":false,"CannotRemoveFromBundleDraft":false},{"Customer":{"CustomerId":"885f490b-71ed-4d13-94a2-16f86ae0353e","TenantId":"17db3324-c754-4c6a-988a-402b232a0bd6","Name":"Signer Two","Email":"Signer2@email.com","PhoneNumber":"+61411111112","NoMobile":false,"Meta":"mysecondlookupkey","CannotModify":false,"Source":"Manual","CustomerEditLink":null,"TotalLiveBundlesForCustomer":null,"TotalBundlesForCustomer":null},"LastSigner":false,"SigningGroup":1,"CustomerSignUrl":"https://customer.sign/url","CustomerBundleStatus":null,"LockLastSigningGroup":false,"CannotRemoveFromBundleDraft":false}],"Documents":[{"Document":{"DocumentId":"7d6edd10-7a58-4240-8327-4f2206202e15","BundleId":"2d3bebc1-cde0-4f51-9a45-981fcfb7297e","Meta":"mylookupkey","DisplayName":"myPdf","EstimatedSize":1000,"SignedPDFDownloadUrl":"https://download.url/docid"},"DocumentOrder":0,"CustomerSigners":[{"Customer":{"CustomerId":"62901503-5b28-49e6-966c-1c41b5342732","TenantId":"17db3324-c754-4c6a-988a-402b232a0bd6","Name":"Signer One","Email":"Signer@email.com","PhoneNumber":"+61411111111","NoMobile":false,"Meta":"mylookupkey","CannotModify":false,"Source":"Manual","CustomerEditLink":null,"TotalLiveBundlesForCustomer":null,"TotalBundlesForCustomer":null},"LastSigner":false,"SigningGroup":0,"CustomerSignUrl":"https://customer.sign/url","CustomerBundleStatus":null,"LockLastSigningGroup":false,"CannotRemoveFromBundleDraft":false},{"Customer":{"CustomerId":"885f490b-71ed-4d13-94a2-16f86ae0353e","TenantId":"17db3324-c754-4c6a-988a-402b232a0bd6","Name":"Signer Two","Email":"Signer2@email.com","PhoneNumber":"+61411111112","NoMobile":false,"Meta":"mysecondlookupkey","CannotModify":false,"Source":"Manual","CustomerEditLink":null,"TotalLiveBundlesForCustomer":null,"TotalBundlesForCustomer":null},"LastSigner":false,"SigningGroup":1,"CustomerSignUrl":"https://customer.sign/url","CustomerBundleStatus":null,"LockLastSigningGroup":false,"CannotRemoveFromBundleDraft":false}],"DocumentState":"Draft"}],"DueDate":"2025-04-21T16:46:26.3410486+10:00","DueReminderMode":"DontRemind","OverdueReminderMode":"DontRemind","DateSent":"2025-04-07T16:46:26.3410486+10:00","DateCompleted":"0001-01-01T00:00:00+00:00","DateArchived":"0001-01-01T00:00:00+00:00","LastReminderSent":"0001-01-01T00:00:00+00:00","State":"Live","ViewMode":"SmsToView","SigningMode":"SignWhole","Settings":{"EmailPreference":"NoFuseSignEmails","AlwaysSendFinalisationEmail":false,"WebhookUrl":"https://your.webhook/url","DisableFinaliseNow":false,"DisableRetract":false,"DisableReminders":false,"CustomBranding":null,"RedirectUrl":null,"RedirectDelaySeconds":10,"AuditType":"Included","ContextUrl":null},"Meta":null}
application/json
post
POST /api/Bundle/DelegateBundleRecipient HTTP/1.1
Host: localhost:3003
Content-Type: application/json
Accept: */*
Content-Length: 407

{
  "BundleId": "text",
  "DelegateFromCustomerId": "text",
  "DelegateToCustomer": {
    "CustomerId": null,
    "Name": "Customer Lastname",
    "Email": "recipient.email@provider.com",
    "PhoneNumber": "+611111111",
    "NoMobile": false,
    "Meta": "f9f2ffc6-d0e7-4996-a333-4a38247affe1",
    "CannotModify": false,
    "Options": {
      "IgnorePhoneNumberIfInvalid": false,
      "UpdateExistingCustomersByMetaMatch": false
    }
  },
  "SendNotificationEmail": true,
  "SilentAudit": true
}
{
  "Example 1": {
    "Id": "ee168420-37dc-47bf-be73-f98f225ad2b6",
    "TenantId": "e5d02c3b-d0d7-4e12-a2aa-ff25240e9224",
    "ReviewUrl": "https://bundle.review.url",
    "DraftUrl": null,
    "Subject": "This is the subject field in the email",
    "Body": "Hello Signer, Could you please sign please",
    "FromName": null,
    "Customers": [
      {
        "Customer": {
          "CustomerId": "9b1bd25e-cccc-4743-b8a6-eae19fb62e0a",
          "TenantId": "e5d02c3b-d0d7-4e12-a2aa-ff25240e9224",
          "Name": "Signer One",
          "Email": "Signer@email.com",
          "PhoneNumber": "+61411111111",
          "NoMobile": false,
          "Meta": "mylookupkey",
          "CannotModify": false,
          "Source": "Manual",
          "CustomerEditLink": null,
          "TotalLiveBundlesForCustomer": null,
          "TotalBundlesForCustomer": null
        },
        "LastSigner": false,
        "SigningGroup": 0,
        "CustomerSignUrl": "https://customer.sign/url",
        "CustomerBundleStatus": null,
        "LockLastSigningGroup": false,
        "CannotRemoveFromBundleDraft": false
      },
      {
        "Customer": {
          "CustomerId": "af11778f-5bef-48c3-a9a0-b3e77b12cd50",
          "TenantId": "e5d02c3b-d0d7-4e12-a2aa-ff25240e9224",
          "Name": "Signer Two",
          "Email": "Signer2@email.com",
          "PhoneNumber": "+61411111112",
          "NoMobile": false,
          "Meta": "mysecondlookupkey",
          "CannotModify": false,
          "Source": "Manual",
          "CustomerEditLink": null,
          "TotalLiveBundlesForCustomer": null,
          "TotalBundlesForCustomer": null
        },
        "LastSigner": false,
        "SigningGroup": 1,
        "CustomerSignUrl": "https://customer.sign/url",
        "CustomerBundleStatus": null,
        "LockLastSigningGroup": false,
        "CannotRemoveFromBundleDraft": false
      }
    ],
    "Documents": [
      {
        "Document": {
          "DocumentId": "995d334f-b0ee-45e4-a8ca-608e5e773749",
          "BundleId": "ee168420-37dc-47bf-be73-f98f225ad2b6",
          "Meta": "mylookupkey",
          "DisplayName": "myPdf",
          "EstimatedSize": 1000,
          "SignedPDFDownloadUrl": "https://download.url/docid"
        },
        "DocumentOrder": 0,
        "CustomerSigners": [
          {
            "Customer": {
              "CustomerId": "9b1bd25e-cccc-4743-b8a6-eae19fb62e0a",
              "TenantId": "e5d02c3b-d0d7-4e12-a2aa-ff25240e9224",
              "Name": "Signer One",
              "Email": "Signer@email.com",
              "PhoneNumber": "+61411111111",
              "NoMobile": false,
              "Meta": "mylookupkey",
              "CannotModify": false,
              "Source": "Manual",
              "CustomerEditLink": null,
              "TotalLiveBundlesForCustomer": null,
              "TotalBundlesForCustomer": null
            },
            "LastSigner": false,
            "SigningGroup": 0,
            "CustomerSignUrl": "https://customer.sign/url",
            "CustomerBundleStatus": null,
            "LockLastSigningGroup": false,
            "CannotRemoveFromBundleDraft": false
          },
          {
            "Customer": {
              "CustomerId": "af11778f-5bef-48c3-a9a0-b3e77b12cd50",
              "TenantId": "e5d02c3b-d0d7-4e12-a2aa-ff25240e9224",
              "Name": "Signer Two",
              "Email": "Signer2@email.com",
              "PhoneNumber": "+61411111112",
              "NoMobile": false,
              "Meta": "mysecondlookupkey",
              "CannotModify": false,
              "Source": "Manual",
              "CustomerEditLink": null,
              "TotalLiveBundlesForCustomer": null,
              "TotalBundlesForCustomer": null
            },
            "LastSigner": false,
            "SigningGroup": 1,
            "CustomerSignUrl": "https://customer.sign/url",
            "CustomerBundleStatus": null,
            "LockLastSigningGroup": false,
            "CannotRemoveFromBundleDraft": false
          }
        ],
        "DocumentState": "Draft"
      }
    ],
    "DueDate": "2025-04-21T16:46:26.3232561+10:00",
    "DueReminderMode": "DontRemind",
    "OverdueReminderMode": "DontRemind",
    "DateSent": "2025-04-07T16:46:26.3232561+10:00",
    "DateCompleted": "0001-01-01T00:00:00+00:00",
    "DateArchived": "0001-01-01T00:00:00+00:00",
    "LastReminderSent": "0001-01-01T00:00:00+00:00",
    "State": "Live",
    "ViewMode": "SmsToView",
    "SigningMode": "SignWhole",
    "Settings": {
      "EmailPreference": "NoFuseSignEmails",
      "AlwaysSendFinalisationEmail": false,
      "WebhookUrl": "https://your.webhook/url",
      "DisableFinaliseNow": false,
      "DisableRetract": false,
      "DisableReminders": false,
      "CustomBranding": null,
      "RedirectUrl": null,
      "RedirectDelaySeconds": 10,
      "AuditType": "Included",
      "ContextUrl": null
    },
    "Meta": null
  }
}

Bundle Summary

post

Get a summary of bundles sent for the tenant

Authorizations
Query parameters
tenantIdstring · guidRequired

FuseSign Tenant

Body
one of | nullableOptional
Responses
application/json
objectOptional
application/json
post
POST /api/Bundle/Search HTTP/1.1
Host: localhost:3003
Content-Type: application/json
Accept: */*
Content-Length: 29

{
  "Page": 1,
  "States": [
    "Draft"
  ]
}
{
  "Page": 1,
  "TotalPages": 1,
  "RecordsPerPage": 1,
  "Count": 1,
  "SearchResults": [
    {
      "Id": "2d3bebc1-cde0-4f51-9a45-981fcfb7297e",
      "TenantId": "17db3324-c754-4c6a-988a-402b232a0bd6",
      "ReviewUrl": "https://bundle.review.url",
      "DraftUrl": null,
      "Subject": "This is the subject field in the email",
      "Body": "Hello Signer, Could you please sign please",
      "FromName": null,
      "Customers": [
        {
          "Customer": {
            "CustomerId": "62901503-5b28-49e6-966c-1c41b5342732",
            "TenantId": "17db3324-c754-4c6a-988a-402b232a0bd6",
            "Name": "Signer One",
            "Email": "Signer@email.com",
            "PhoneNumber": "+61411111111",
            "NoMobile": false,
            "Meta": "mylookupkey",
            "CannotModify": false,
            "Source": "Manual",
            "CustomerEditLink": null,
            "TotalLiveBundlesForCustomer": null,
            "TotalBundlesForCustomer": null
          },
          "LastSigner": false,
          "SigningGroup": 0,
          "CustomerSignUrl": "https://customer.sign/url",
          "CustomerBundleStatus": null,
          "LockLastSigningGroup": false,
          "CannotRemoveFromBundleDraft": false
        },
        {
          "Customer": {
            "CustomerId": "885f490b-71ed-4d13-94a2-16f86ae0353e",
            "TenantId": "17db3324-c754-4c6a-988a-402b232a0bd6",
            "Name": "Signer Two",
            "Email": "Signer2@email.com",
            "PhoneNumber": "+61411111112",
            "NoMobile": false,
            "Meta": "mysecondlookupkey",
            "CannotModify": false,
            "Source": "Manual",
            "CustomerEditLink": null,
            "TotalLiveBundlesForCustomer": null,
            "TotalBundlesForCustomer": null
          },
          "LastSigner": false,
          "SigningGroup": 1,
          "CustomerSignUrl": "https://customer.sign/url",
          "CustomerBundleStatus": null,
          "LockLastSigningGroup": false,
          "CannotRemoveFromBundleDraft": false
        }
      ],
      "Documents": [
        {
          "Document": {
            "DocumentId": "7d6edd10-7a58-4240-8327-4f2206202e15",
            "BundleId": "2d3bebc1-cde0-4f51-9a45-981fcfb7297e",
            "Meta": "mylookupkey",
            "DisplayName": "myPdf",
            "EstimatedSize": 1000,
            "SignedPDFDownloadUrl": "https://download.url/docid"
          },
          "DocumentOrder": 0,
          "CustomerSigners": [
            {
              "Customer": {
                "CustomerId": "62901503-5b28-49e6-966c-1c41b5342732",
                "TenantId": "17db3324-c754-4c6a-988a-402b232a0bd6",
                "Name": "Signer One",
                "Email": "Signer@email.com",
                "PhoneNumber": "+61411111111",
                "NoMobile": false,
                "Meta": "mylookupkey",
                "CannotModify": false,
                "Source": "Manual",
                "CustomerEditLink": null,
                "TotalLiveBundlesForCustomer": null,
                "TotalBundlesForCustomer": null
              },
              "LastSigner": false,
              "SigningGroup": 0,
              "CustomerSignUrl": "https://customer.sign/url",
              "CustomerBundleStatus": null,
              "LockLastSigningGroup": false,
              "CannotRemoveFromBundleDraft": false
            },
            {
              "Customer": {
                "CustomerId": "885f490b-71ed-4d13-94a2-16f86ae0353e",
                "TenantId": "17db3324-c754-4c6a-988a-402b232a0bd6",
                "Name": "Signer Two",
                "Email": "Signer2@email.com",
                "PhoneNumber": "+61411111112",
                "NoMobile": false,
                "Meta": "mysecondlookupkey",
                "CannotModify": false,
                "Source": "Manual",
                "CustomerEditLink": null,
                "TotalLiveBundlesForCustomer": null,
                "TotalBundlesForCustomer": null
              },
              "LastSigner": false,
              "SigningGroup": 1,
              "CustomerSignUrl": "https://customer.sign/url",
              "CustomerBundleStatus": null,
              "LockLastSigningGroup": false,
              "CannotRemoveFromBundleDraft": false
            }
          ],
          "DocumentState": "Draft"
        }
      ],
      "DueDate": "2025-04-21T16:46:26.3410486+10:00",
      "DueReminderMode": "DontRemind",
      "OverdueReminderMode": "DontRemind",
      "DateSent": "2025-04-07T16:46:26.3410486+10:00",
      "DateCompleted": "0001-01-01T00:00:00+00:00",
      "DateArchived": "0001-01-01T00:00:00+00:00",
      "LastReminderSent": "0001-01-01T00:00:00+00:00",
      "State": "Live",
      "ViewMode": "SmsToView",
      "SigningMode": "SignWhole",
      "Settings": {
        "EmailPreference": "NoFuseSignEmails",
        "AlwaysSendFinalisationEmail": false,
        "WebhookUrl": "https://your.webhook/url",
        "DisableFinaliseNow": false,
        "DisableRetract": false,
        "DisableReminders": false,
        "CustomBranding": null,
        "RedirectUrl": null,
        "RedirectDelaySeconds": 10,
        "AuditType": "Included",
        "ContextUrl": null
      },
      "Meta": null
    }
  ]
}

Send a reminder

post

Send a reminder for a bundle (Requires Emails to be enabled for the bundle)

Authorizations
Query parameters
tenantIdstring · guidRequired
Body
one of | nullableOptional
Responses
application/json
objectOptional
application/json
post
POST /api/Bundle/SendReminder HTTP/1.1
Host: localhost:3003
Content-Type: application/json
Accept: */*
Content-Length: 71

{
  "BundleId": "text",
  "ReminderNotes": "text",
  "TargetCustomerIds": [
    "text"
  ]
}
{
  "Example 1": null
}

Update the webhook URL for a bundle

post

Update the webhook URL. All future webhooks will be sent to the new URL.

Authorizations
Query parameters
tenantIdstring · guidRequired

FuseSign Tenant ID

Body
one of | nullableOptional
Responses
application/json
objectOptional
application/json
post
POST /api/Bundle/UpdateWebhookUrl HTTP/1.1
Host: localhost:3003
Content-Type: application/json
Accept: */*
Content-Length: 44

{
  "BundleId": "text",
  "EventWebhookUrl": "text"
}
{
  "Result": true,
  "Message": "text",
  "Error": "text",
  "Errors": [
    {
      "Property": "text",
      "ErrorMessage": "text",
      "ErrorCode": "text"
    }
  ]
}

Generate new signing links

post

For a given bundle, generate new customer signing links (this will invalidate any existing links). This is only accessible for bundles where FuseSign does not email.It's the providers responsibility to provide the new links to the customers.

Authorizations
Query parameters
tenantIdstring · guidRequired
Body
one of | nullableOptional
Responses
application/json
objectOptionalExample: {"Id":"2d3bebc1-cde0-4f51-9a45-981fcfb7297e","TenantId":"17db3324-c754-4c6a-988a-402b232a0bd6","ReviewUrl":"https://bundle.review.url","DraftUrl":null,"Subject":"This is the subject field in the email","Body":"Hello Signer, Could you please sign please","FromName":null,"Customers":[{"Customer":{"CustomerId":"62901503-5b28-49e6-966c-1c41b5342732","TenantId":"17db3324-c754-4c6a-988a-402b232a0bd6","Name":"Signer One","Email":"Signer@email.com","PhoneNumber":"+61411111111","NoMobile":false,"Meta":"mylookupkey","CannotModify":false,"Source":"Manual","CustomerEditLink":null,"TotalLiveBundlesForCustomer":null,"TotalBundlesForCustomer":null},"LastSigner":false,"SigningGroup":0,"CustomerSignUrl":"https://customer.sign/url","CustomerBundleStatus":null,"LockLastSigningGroup":false,"CannotRemoveFromBundleDraft":false},{"Customer":{"CustomerId":"885f490b-71ed-4d13-94a2-16f86ae0353e","TenantId":"17db3324-c754-4c6a-988a-402b232a0bd6","Name":"Signer Two","Email":"Signer2@email.com","PhoneNumber":"+61411111112","NoMobile":false,"Meta":"mysecondlookupkey","CannotModify":false,"Source":"Manual","CustomerEditLink":null,"TotalLiveBundlesForCustomer":null,"TotalBundlesForCustomer":null},"LastSigner":false,"SigningGroup":1,"CustomerSignUrl":"https://customer.sign/url","CustomerBundleStatus":null,"LockLastSigningGroup":false,"CannotRemoveFromBundleDraft":false}],"Documents":[{"Document":{"DocumentId":"7d6edd10-7a58-4240-8327-4f2206202e15","BundleId":"2d3bebc1-cde0-4f51-9a45-981fcfb7297e","Meta":"mylookupkey","DisplayName":"myPdf","EstimatedSize":1000,"SignedPDFDownloadUrl":"https://download.url/docid"},"DocumentOrder":0,"CustomerSigners":[{"Customer":{"CustomerId":"62901503-5b28-49e6-966c-1c41b5342732","TenantId":"17db3324-c754-4c6a-988a-402b232a0bd6","Name":"Signer One","Email":"Signer@email.com","PhoneNumber":"+61411111111","NoMobile":false,"Meta":"mylookupkey","CannotModify":false,"Source":"Manual","CustomerEditLink":null,"TotalLiveBundlesForCustomer":null,"TotalBundlesForCustomer":null},"LastSigner":false,"SigningGroup":0,"CustomerSignUrl":"https://customer.sign/url","CustomerBundleStatus":null,"LockLastSigningGroup":false,"CannotRemoveFromBundleDraft":false},{"Customer":{"CustomerId":"885f490b-71ed-4d13-94a2-16f86ae0353e","TenantId":"17db3324-c754-4c6a-988a-402b232a0bd6","Name":"Signer Two","Email":"Signer2@email.com","PhoneNumber":"+61411111112","NoMobile":false,"Meta":"mysecondlookupkey","CannotModify":false,"Source":"Manual","CustomerEditLink":null,"TotalLiveBundlesForCustomer":null,"TotalBundlesForCustomer":null},"LastSigner":false,"SigningGroup":1,"CustomerSignUrl":"https://customer.sign/url","CustomerBundleStatus":null,"LockLastSigningGroup":false,"CannotRemoveFromBundleDraft":false}],"DocumentState":"Draft"}],"DueDate":"2025-04-21T16:46:26.3410486+10:00","DueReminderMode":"DontRemind","OverdueReminderMode":"DontRemind","DateSent":"2025-04-07T16:46:26.3410486+10:00","DateCompleted":"0001-01-01T00:00:00+00:00","DateArchived":"0001-01-01T00:00:00+00:00","LastReminderSent":"0001-01-01T00:00:00+00:00","State":"Live","ViewMode":"SmsToView","SigningMode":"SignWhole","Settings":{"EmailPreference":"NoFuseSignEmails","AlwaysSendFinalisationEmail":false,"WebhookUrl":"https://your.webhook/url","DisableFinaliseNow":false,"DisableRetract":false,"DisableReminders":false,"CustomBranding":null,"RedirectUrl":null,"RedirectDelaySeconds":10,"AuditType":"Included","ContextUrl":null},"Meta":null}
application/json
post
POST /api/Bundle/GenerateNewSigningLinks HTTP/1.1
Host: localhost:3003
Content-Type: application/json
Accept: */*
Content-Length: 48

{
  "BundleId": "text",
  "TargetCustomerIds": [
    "text"
  ]
}
{
  "Example 1": {
    "Id": "2d3bebc1-cde0-4f51-9a45-981fcfb7297e",
    "TenantId": "17db3324-c754-4c6a-988a-402b232a0bd6",
    "ReviewUrl": "https://bundle.review.url",
    "DraftUrl": null,
    "Subject": "This is the subject field in the email",
    "Body": "Hello Signer, Could you please sign please",
    "FromName": null,
    "Customers": [
      {
        "Customer": {
          "CustomerId": "62901503-5b28-49e6-966c-1c41b5342732",
          "TenantId": "17db3324-c754-4c6a-988a-402b232a0bd6",
          "Name": "Signer One",
          "Email": "Signer@email.com",
          "PhoneNumber": "+61411111111",
          "NoMobile": false,
          "Meta": "mylookupkey",
          "CannotModify": false,
          "Source": "Manual",
          "CustomerEditLink": null,
          "TotalLiveBundlesForCustomer": null,
          "TotalBundlesForCustomer": null
        },
        "LastSigner": false,
        "SigningGroup": 0,
        "CustomerSignUrl": "https://customer.sign/url",
        "CustomerBundleStatus": null,
        "LockLastSigningGroup": false,
        "CannotRemoveFromBundleDraft": false
      },
      {
        "Customer": {
          "CustomerId": "885f490b-71ed-4d13-94a2-16f86ae0353e",
          "TenantId": "17db3324-c754-4c6a-988a-402b232a0bd6",
          "Name": "Signer Two",
          "Email": "Signer2@email.com",
          "PhoneNumber": "+61411111112",
          "NoMobile": false,
          "Meta": "mysecondlookupkey",
          "CannotModify": false,
          "Source": "Manual",
          "CustomerEditLink": null,
          "TotalLiveBundlesForCustomer": null,
          "TotalBundlesForCustomer": null
        },
        "LastSigner": false,
        "SigningGroup": 1,
        "CustomerSignUrl": "https://customer.sign/url",
        "CustomerBundleStatus": null,
        "LockLastSigningGroup": false,
        "CannotRemoveFromBundleDraft": false
      }
    ],
    "Documents": [
      {
        "Document": {
          "DocumentId": "7d6edd10-7a58-4240-8327-4f2206202e15",
          "BundleId": "2d3bebc1-cde0-4f51-9a45-981fcfb7297e",
          "Meta": "mylookupkey",
          "DisplayName": "myPdf",
          "EstimatedSize": 1000,
          "SignedPDFDownloadUrl": "https://download.url/docid"
        },
        "DocumentOrder": 0,
        "CustomerSigners": [
          {
            "Customer": {
              "CustomerId": "62901503-5b28-49e6-966c-1c41b5342732",
              "TenantId": "17db3324-c754-4c6a-988a-402b232a0bd6",
              "Name": "Signer One",
              "Email": "Signer@email.com",
              "PhoneNumber": "+61411111111",
              "NoMobile": false,
              "Meta": "mylookupkey",
              "CannotModify": false,
              "Source": "Manual",
              "CustomerEditLink": null,
              "TotalLiveBundlesForCustomer": null,
              "TotalBundlesForCustomer": null
            },
            "LastSigner": false,
            "SigningGroup": 0,
            "CustomerSignUrl": "https://customer.sign/url",
            "CustomerBundleStatus": null,
            "LockLastSigningGroup": false,
            "CannotRemoveFromBundleDraft": false
          },
          {
            "Customer": {
              "CustomerId": "885f490b-71ed-4d13-94a2-16f86ae0353e",
              "TenantId": "17db3324-c754-4c6a-988a-402b232a0bd6",
              "Name": "Signer Two",
              "Email": "Signer2@email.com",
              "PhoneNumber": "+61411111112",
              "NoMobile": false,
              "Meta": "mysecondlookupkey",
              "CannotModify": false,
              "Source": "Manual",
              "CustomerEditLink": null,
              "TotalLiveBundlesForCustomer": null,
              "TotalBundlesForCustomer": null
            },
            "LastSigner": false,
            "SigningGroup": 1,
            "CustomerSignUrl": "https://customer.sign/url",
            "CustomerBundleStatus": null,
            "LockLastSigningGroup": false,
            "CannotRemoveFromBundleDraft": false
          }
        ],
        "DocumentState": "Draft"
      }
    ],
    "DueDate": "2025-04-21T16:46:26.3410486+10:00",
    "DueReminderMode": "DontRemind",
    "OverdueReminderMode": "DontRemind",
    "DateSent": "2025-04-07T16:46:26.3410486+10:00",
    "DateCompleted": "0001-01-01T00:00:00+00:00",
    "DateArchived": "0001-01-01T00:00:00+00:00",
    "LastReminderSent": "0001-01-01T00:00:00+00:00",
    "State": "Live",
    "ViewMode": "SmsToView",
    "SigningMode": "SignWhole",
    "Settings": {
      "EmailPreference": "NoFuseSignEmails",
      "AlwaysSendFinalisationEmail": false,
      "WebhookUrl": "https://your.webhook/url",
      "DisableFinaliseNow": false,
      "DisableRetract": false,
      "DisableReminders": false,
      "CustomBranding": null,
      "RedirectUrl": null,
      "RedirectDelaySeconds": 10,
      "AuditType": "Included",
      "ContextUrl": null
    },
    "Meta": null
  }
}