# Bundle

## Gets the details of a bundle.

> Gets the detailed information of a bundle

```json
{"openapi":"3.0.0","info":{"title":"FuseSign API","version":"v1"},"servers":[{"url":"https://api.fuse.work","description":"FuseSign API"}],"security":[{"OAuthToken":[]},{"ApiKey":[]}],"components":{"securitySchemes":{"OAuthToken":{"type":"oauth2","description":"FuseSign OAuth 2. Use this for most implementations.","name":"FuseSign OAuth 2","flows":{"authorizationCode":{"authorizationUrl":"https://api.fuse.work/api/Session/OAuthRegister","tokenUrl":"https://api.fuse.work/api/Session/OAuthGetToken","refreshUrl":"https://api.fuse.work/api/Session/OAuthRefreshToken","scopes":{"FUSESIGN":"Manage FuseSign Bundles and corresponding data.","FUSESIGN:OWN":"Ability to send bundles and extract bundles created by this user only. Special purpose scope, contact support@fuse.work."}}}},"ApiKey":{"type":"apiKey","description":"Wholesale API Token","name":"X-API-Token","in":"header"}},"schemas":{"ExternalApiExternalHandlersDtosResponsesBundleBundleDto":{"type":"object","additionalProperties":false,"properties":{"Id":{"type":"string","description":"Unique bundle ID","format":"guid"},"TenantId":{"type":"string","description":"Bundle Tenant ID","format":"guid"},"ReviewUrl":{"type":"string","description":"This URL will be set if the bundle is active with a link to the review page","nullable":true},"DraftUrl":{"type":"string","description":"This URL will be set if the bundle is in draft phase and allows for the bundle to be edited.","nullable":true},"Subject":{"type":"string","description":"Bundle subject","nullable":true},"Body":{"type":"string","description":"Bundle Body message","nullable":true},"FromName":{"type":"string","description":"Who the bundle is from (included in email)","nullable":true},"Customers":{"type":"array","description":"List of bundle customers","nullable":true,"items":{"$ref":"#/components/schemas/ExternalApiExternalHandlersDtosResponsesBundleBundleCustomerDto"}},"Documents":{"type":"array","description":"List of bundle documents","nullable":true,"items":{"$ref":"#/components/schemas/ExternalApiExternalHandlersDtosResponsesBundleBundleDocumentDto"}},"DueDate":{"type":"string","description":"The bundle due date (optional)","format":"date-time","nullable":true},"DueReminderMode":{"description":"Bundle reminder mode","oneOf":[{"$ref":"#/components/schemas/FuseWebSharedObjectsFuseSignEnumsBundleReminderMode"}]},"OverdueReminderMode":{"description":"Bundle overdue reminder mode","oneOf":[{"$ref":"#/components/schemas/FuseWebSharedObjectsFuseSignEnumsBundleOverdueReminderMode"}]},"DateSent":{"type":"string","description":"Date the bundle was sent if it is live","format":"date-time","nullable":true},"DateCompleted":{"type":"string","description":"Date the bundle was completed if it is finalised","format":"date-time","nullable":true},"DateArchived":{"type":"string","description":"Date the bundle was archived if it is archived","format":"date-time","nullable":true},"LastReminderSent":{"type":"string","description":"Date the last reminder was sent","format":"date-time","nullable":true},"State":{"description":"Current bundle state","oneOf":[{"$ref":"#/components/schemas/FuseWebSharedObjectsFuseSignEnumsSigningBundleState"}]},"ViewMode":{"description":"The bundle view mode setting. If this is blank the business default is selected and the system falls back to the highest available authentication","oneOf":[{"$ref":"#/components/schemas/FuseWebSharedObjectsFuseSignEnumsBundleViewMode"}]},"SigningMode":{"description":"The bundle signing mode","oneOf":[{"$ref":"#/components/schemas/FuseWebSharedObjectsFuseSignEnumsSigningMode"}]},"Settings":{"description":"Bundle settings object","nullable":true,"oneOf":[{"$ref":"#/components/schemas/ExternalApiExternalHandlersDtosResponsesBundleBundleSettingsDto"}]},"Meta":{"type":"string","description":"Bundle lookup metadata","nullable":true}}},"ExternalApiExternalHandlersDtosResponsesBundleBundleCustomerDto":{"type":"object","additionalProperties":false,"properties":{"Customer":{"description":"Customer object","nullable":true,"oneOf":[{"$ref":"#/components/schemas/ExternalApiExternalHandlersDtosResponsesBundleBundleCustomerDetailsDto"}]},"LastSigner":{"type":"boolean","description":"Optional argument which can only be present on ONE customer to specify signer order and they are the last signer"},"SigningGroup":{"type":"integer","description":"Zero based index of signer order. Lower numbers will sign first, then next etc. If multiple customers share the number then they will sign at the same time.","format":"int32"},"CustomerSignUrl":{"type":"string","description":"[Obsolete] The URL where this customer can sign","nullable":true},"CustomerBundleStatus":{"description":"The current status of this customer relative to the bundle. NOTE: At bundle creation this status is Pending because the bundle has been scheduled to be sent (and will send shortly thereafter)","nullable":true,"oneOf":[{"$ref":"#/components/schemas/FuseWebSharedObjectsFuseSignEnumsCustomerBundleStatus"}]},"LockLastSigningGroup":{"type":"boolean","description":"Lock this contact in the last signing group"},"CannotRemoveFromBundleDraft":{"type":"boolean","description":"Don't allow removal of this contact from a draft bundle"}}},"ExternalApiExternalHandlersDtosResponsesBundleBundleCustomerDetailsDto":{"type":"object","additionalProperties":false,"properties":{"CustomerId":{"type":"string","description":"Customer ID","format":"guid"},"TenantId":{"type":"string","description":"Customer tenant ID","format":"guid"},"Name":{"type":"string","description":"Customer Name","nullable":true},"Email":{"type":"string","description":"Customer Email","nullable":true},"PhoneNumber":{"type":"string","description":"Customer mobile number. Required for 2FA. If NoMobile is true this is not required. Must be in international format:   +61413121121","nullable":true},"NoMobile":{"type":"boolean","description":"No Mobile flag, means Phone Number is ignored"},"Meta":{"type":"string","description":"Optional external lookup ID. Can be used for searching","nullable":true},"CannotModify":{"type":"boolean","description":"Don't allow modification of this contact"},"Source":{"description":"Customer data source","oneOf":[{"$ref":"#/components/schemas/FuseWebSharedObjectsFuseSignEnumsSource"}]},"CustomerEditLink":{"type":"string","description":"Link to edit customer details directly","nullable":true},"TotalLiveBundlesForCustomer":{"type":"integer","description":"Number of bundles assigned to the user which are yet to be actioned","format":"int32","nullable":true},"TotalBundlesForCustomer":{"type":"integer","description":"Number of bundles assigned to the user","format":"int32","nullable":true},"PreferredName":{"type":"string","description":"Customer preferred name. The customer will be addressed by this name when signing.","nullable":true}}},"FuseWebSharedObjectsFuseSignEnumsSource":{"type":"string","description":"","enum":["Manual","XPM","Test","CSV","External","APS","MYOB","FileFYI","FileIManage","FYIElite","Karbon","SyncedContact","FuseDocs"]},"FuseWebSharedObjectsFuseSignEnumsCustomerBundleStatus":{"type":"string","description":"","enum":["NoActions","ActionsCompleted","ActionsCancelled","DocumentsRetracted","NotOpenedActionsRequired","NotOpenedFYIOnly","Pending","Rejected","Retracted","Seen"]},"ExternalApiExternalHandlersDtosResponsesBundleBundleDocumentDto":{"type":"object","additionalProperties":false,"properties":{"Document":{"description":"Document information","nullable":true,"oneOf":[{"$ref":"#/components/schemas/ExternalApiExternalHandlersDtosResponsesBundleBundleDocumentDetailsDto"}]},"DocumentOrder":{"type":"integer","description":"Optional: The order that this document will be presented in the pack. Must be a unique integer.","format":"int32"},"CustomerSigners":{"type":"array","description":"A list of customers for which customers must SIGN this document","nullable":true,"items":{"$ref":"#/components/schemas/ExternalApiExternalHandlersDtosResponsesBundleBundleCustomerDto"}},"CustomerViewers":{"type":"array","description":"A list of customers for which customers can VIEW this document","nullable":true,"items":{"$ref":"#/components/schemas/ExternalApiExternalHandlersDtosResponsesBundleBundleCustomerDto"}},"DocumentState":{"description":"The state of the Document.","oneOf":[{"$ref":"#/components/schemas/FuseWebSharedObjectsFuseSignEnumsTransactionalDocumentState"}]}}},"ExternalApiExternalHandlersDtosResponsesBundleBundleDocumentDetailsDto":{"type":"object","additionalProperties":false,"properties":{"DocumentId":{"type":"string","description":"Document ID","format":"guid"},"BundleId":{"type":"string","description":"Related bundle ID. Can be null if not yet assigned to a bundle","format":"guid","nullable":true},"Meta":{"type":"string","description":"Lookup metadata","nullable":true},"DisplayName":{"type":"string","description":"Document Display name","nullable":true},"EstimatedSize":{"type":"integer","description":"Estimated size of the document (Affects inbox limit)","format":"int64"},"SignedPDFDownloadUrl":{"type":"string","description":"URL to download the signed PDF","nullable":true}}},"FuseWebSharedObjectsFuseSignEnumsTransactionalDocumentState":{"type":"string","description":"","enum":["Draft","Live","Signed","Rejected","Retracted","Finalised"]},"FuseWebSharedObjectsFuseSignEnumsBundleReminderMode":{"type":"string","description":"","enum":["DontRemind","DayBeforeDue","OnDueDate"]},"FuseWebSharedObjectsFuseSignEnumsBundleOverdueReminderMode":{"type":"string","description":"","enum":["DontRemind","Weekly"]},"FuseWebSharedObjectsFuseSignEnumsSigningBundleState":{"type":"string","description":"","enum":["Draft","Live","Finalised","Retracted","Rejected","Error","PendingArchive","Archived","DraftDeleted","PurgedArchive","ArchiveNoRetention","NewDraft"]},"FuseWebSharedObjectsFuseSignEnumsBundleViewMode":{"type":"string","description":"","enum":["SmsToSign","SmsToView","EmailToSign","Unauthenticated","EmailToView","Mixed"]},"FuseWebSharedObjectsFuseSignEnumsSigningMode":{"type":"string","description":"","enum":["SignWhole","SignPlacements"]},"ExternalApiExternalHandlersDtosResponsesBundleBundleSettingsDto":{"type":"object","additionalProperties":false,"properties":{"EmailPreference":{"description":"Indicate that no emails should be sent by fusesign and that communication will be sent by webhooks","oneOf":[{"$ref":"#/components/schemas/FuseWebSharedObjectsFuseSignEnumsEmailPreference"}]},"AlwaysSendFinalisationEmail":{"type":"boolean","description":"Always send the finalisation emails regardless of the EmailPreference setting"},"WebhookUrl":{"type":"string","description":"The callback URL for bundle events","nullable":true},"DisableFinaliseNow":{"type":"boolean","description":"Disable the ability for the user to Finalise early from the FuseSign webapp."},"DisableRetract":{"type":"boolean","description":"Disable the ability for the user to Retract the bundle from the FuseSign webapp."},"DisableReminders":{"type":"boolean","description":"Disable the ability for the user to request reminder emails from the FuseSign webapp."},"CustomBranding":{"description":"Specify custom branding for this specific bundle. All properties on this object must be set if the object is specified.","nullable":true,"oneOf":[{"$ref":"#/components/schemas/ExternalApiExternalHandlersDtosResponsesBundleBundleFormattingSettingsDto"}]},"RedirectUrl":{"type":"string","description":"Optional URL to redirect the signer to after signing","nullable":true},"RedirectDelaySeconds":{"type":"integer","description":"Optional Number of seconds to delay before redirecting. Default 10.","format":"int32"},"AuditType":{"description":"How to create the bundle audit (included in the signed document or as a separate signed file","oneOf":[{"$ref":"#/components/schemas/FuseWebSharedObjectsFuseSignEnumsAuditType"}]},"ContextUrl":{"type":"string","description":"Context Url - will display a link back to this link within the FuseSign interface.","nullable":true}}},"FuseWebSharedObjectsFuseSignEnumsEmailPreference":{"type":"string","description":"","enum":["FuseSignEmails","NoFuseSignEmails"]},"ExternalApiExternalHandlersDtosResponsesBundleBundleFormattingSettingsDto":{"type":"object","additionalProperties":false,"properties":{"ButtonColor":{"type":"string","description":"Custom for this bundle - this controls the color of the buttons and key UI items on the page. Accepted #RRGGBB format."},"BannerColor":{"type":"string","description":"Custom for this bundle - this controls the color of the banner across the top of the page and is shown BEHIND the log image. Accepted #RRGGBB format."},"LogoUrl":{"type":"string","description":"Set a custom branding Logo URL for this specific bundle. This must be an absolute URL and is hosted."},"FromName":{"type":"string","description":"This will come through in the email FROM field as well as presented on the bundle signing page.","nullable":true}}},"FuseWebSharedObjectsFuseSignEnumsAuditType":{"type":"string","description":"","enum":["Included","Separate"]},"ExternalApiCommonModelsApiErrorResponse":{"type":"object","additionalProperties":false,"properties":{"Result":{"type":"boolean"},"Message":{"type":"string"},"Errors":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/FuseWebSharedObjectsModelsValidationError"}}}},"FuseWebSharedObjectsModelsValidationError":{"type":"object","additionalProperties":false,"properties":{"Property":{"type":"string"},"ErrorMessage":{"type":"string"},"ErrorCode":{"type":"string"}}}}},"paths":{"/api/Bundle/Get":{"get":{"tags":["Bundle"],"summary":"Gets the details of a bundle.","description":"Gets the detailed information of a bundle","operationId":"ExternalApiExternalHandlersFeaturesBundleGetGetBundleEndpoint","parameters":[{"name":"TenantId","in":"query","required":true,"description":"FuseSign Tenant Id","schema":{"type":"string","format":"guid"}},{"name":"BundleId","in":"query","required":true,"description":"Bundle Id","schema":{"type":"string","format":"guid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExternalApiExternalHandlersDtosResponsesBundleBundleDto"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExternalApiCommonModelsApiErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"string"}}}},"403":{"description":"Forbidden"}}}}}}
```

{% hint style="info" %}
see [Bundle Create](/fusesign/deep-dives/bundle-create.md)for a deep dive with more explanation
{% endhint %}

## Creates a new bundle.

> 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.

```json
{"openapi":"3.0.0","info":{"title":"FuseSign API","version":"v1"},"servers":[{"url":"https://api.fuse.work","description":"FuseSign API"}],"security":[{"OAuthToken":[]},{"ApiKey":[]}],"components":{"securitySchemes":{"OAuthToken":{"type":"oauth2","description":"FuseSign OAuth 2. Use this for most implementations.","name":"FuseSign OAuth 2","flows":{"authorizationCode":{"authorizationUrl":"https://api.fuse.work/api/Session/OAuthRegister","tokenUrl":"https://api.fuse.work/api/Session/OAuthGetToken","refreshUrl":"https://api.fuse.work/api/Session/OAuthRefreshToken","scopes":{"FUSESIGN":"Manage FuseSign Bundles and corresponding data.","FUSESIGN:OWN":"Ability to send bundles and extract bundles created by this user only. Special purpose scope, contact support@fuse.work."}}}},"ApiKey":{"type":"apiKey","description":"Wholesale API Token","name":"X-API-Token","in":"header"}},"schemas":{"ExternalApiExternalHandlersFeaturesBundleCreateCreateBundleRequest":{"type":"object","additionalProperties":false,"required":["Customers"],"properties":{"Subject":{"type":"string","description":"Bundle subject","maxLength":200,"minLength":0},"Body":{"type":"string","description":"Bundle Body message"},"CreateMode":{"description":"Create and send or create as draft","oneOf":[{"$ref":"#/components/schemas/FuseWebExternalCoreModelsTransactionalBundleCreateRequestMode"}]},"CreatedBy":{"type":"string","description":"Sets the created by user email. If the user exists and the requestor has permissions, then the bundle will be \"created\" by the specified user. Will cause an error to throw if the user does not have permissions to do this.","format":"email","pattern":"^[^@]+@[^@]+$"},"Customers":{"type":"array","description":"List of bundle customers","minLength":1,"nullable":false,"items":{"$ref":"#/components/schemas/ExternalApiExternalHandlersFeaturesBundleCreateBundleCustomerCreateRequestDto"}},"Documents":{"type":"array","description":"List of bundle documents","nullable":true,"items":{"$ref":"#/components/schemas/ExternalApiExternalHandlersFeaturesBundleCreateDocumentCreateRequestDto"}},"DueDate":{"type":"string","description":"The bundle due date (optional)","format":"date-time","nullable":true},"DueReminderMode":{"description":"Bundle reminder mode (optional)","nullable":true,"oneOf":[{"$ref":"#/components/schemas/FuseWebSharedObjectsFuseSignEnumsBundleReminderMode"}]},"OverdueReminderMode":{"description":"Bundle overdue reminder mode (optional)","nullable":true,"oneOf":[{"$ref":"#/components/schemas/FuseWebSharedObjectsFuseSignEnumsBundleOverdueReminderMode"}]},"ViewMode":{"description":"The bundle view mode setting. If this is blank the business default is selected and the system falls back to the highest available authentication","nullable":true,"oneOf":[{"$ref":"#/components/schemas/FuseWebSharedObjectsFuseSignEnumsBundleViewMode"}]},"RecipientReceiveMode":{"description":"How the recipients receive signed documents","nullable":true,"oneOf":[{"$ref":"#/components/schemas/FuseWebSharedObjectsFuseSignEnumsRecipientReceiveMode"}]},"SigningMode":{"description":"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.].","nullable":true,"oneOf":[{"$ref":"#/components/schemas/FuseWebSharedObjectsFuseSignEnumsSigningMode"}]},"Settings":{"description":"Bundle settings object - API related options.","oneOf":[{"$ref":"#/components/schemas/FuseWebExternalCoreModelsBundleSettings"}]},"Meta":{"type":"string","description":"Bundle lookup metadata","maxLength":1000,"minLength":0},"TeamId":{"type":"string","description":"If assigned - apply this team to the bundle. Verify that the user sending the bundle can send on behalf of this team.","format":"guid","nullable":true},"SenderIP":{"type":"string","description":"IP Address applied to the bundle Audit. Automatic Field - no need to set.","nullable":true}}},"FuseWebExternalCoreModelsTransactionalBundleCreateRequestMode":{"type":"string","description":"","enum":["CreateAndSend","CreateAsDraft"]},"ExternalApiExternalHandlersFeaturesBundleCreateBundleCustomerCreateRequestDto":{"type":"object","additionalProperties":false,"properties":{"Customer":{"description":"Create request customer","oneOf":[{"$ref":"#/components/schemas/ExternalApiExternalHandlersFeaturesBundleCreateCustomerCreateRequestDto"}]},"LastSigner":{"type":"boolean","description":"Optional argument which can only be present on ONE customer to specify signer order and they are the last signer","deprecated":true,"nullable":true},"SigningGroup":{"type":"integer","description":"Zero based index of signer order. Lower numbers will sign first, then next etc. If multiple customers share the number then they will sign at the same time.","format":"int32"},"LockLastSigningGroup":{"type":"boolean","description":"Lock this contact in the last signing group"},"CannotRemoveFromBundleDraft":{"type":"boolean","description":"Don't allow removal of this contact from a draft bundle"},"SMSNotify":{"type":"boolean","description":"Notify this customer via SMS"}}},"ExternalApiExternalHandlersFeaturesBundleCreateCustomerCreateRequestDto":{"type":"object","additionalProperties":false,"required":["Name","Email"],"properties":{"CustomerId":{"type":"string","description":"Customer ID For updating an existing customer","format":"guid","nullable":true},"Name":{"type":"string","description":"Customer Name (Required)","minLength":1,"nullable":false},"Email":{"type":"string","description":"Customer Email (Required)","format":"email","minLength":1,"pattern":"^[^@]+@[^@]+$","nullable":false},"PhoneNumber":{"type":"string","description":"Customer mobile number. Required for 2FA. If NoMobile is true this is not required. Must be in international format:   +61413121121"},"NoMobile":{"type":"boolean","description":"No Mobile flag, means Phone Number is ignored"},"Meta":{"type":"string","description":"Optional external lookup ID. Can be used for searching later. Note: This is used to uniquely identify this contact and will cause duplicate contacts if not reused","maxLength":128,"minLength":0},"CannotModify":{"type":"boolean","description":"Prevents end users from modifying this contact within the FuseSign application"},"Options":{"description":"Options for contact creation and validation","oneOf":[{"$ref":"#/components/schemas/ExternalApiExternalHandlersDtosRequestsCustomerContactCreationOptionsDto"}]}}},"ExternalApiExternalHandlersDtosRequestsCustomerContactCreationOptionsDto":{"type":"object","additionalProperties":false,"properties":{"IgnorePhoneNumberIfInvalid":{"type":"boolean"},"UpdateExistingCustomersByMetaMatch":{"type":"boolean"}}},"ExternalApiExternalHandlersFeaturesBundleCreateDocumentCreateRequestDto":{"type":"object","additionalProperties":false,"required":["DisplayName"],"properties":{"DisplayName":{"type":"string","description":"The display name for the document to show to the client.","maxLength":300,"minLength":0,"nullable":false},"DocumentId":{"type":"string","description":"Optional Document ID. If document is already uploaded, include it here. Otherwise must provide Documentbase64 or DocumentUrl.","format":"guid","nullable":true},"DocumentBase64":{"type":"string","description":"Optional Document base64 data. Otherwise must provide DocumentId or DocumentUrl."},"DocumentUrl":{"type":"string","description":"Optional public URL. Otherwise must provide DocumentId or DocumentUrl."},"DocumentOrder":{"type":"integer","description":"Optional: The order that this document will be presented in the pack. Must be a unique integer.","format":"int32"},"CustomerSigners":{"type":"array","description":"A list of indexes of uploaded customers for which customers must SIGN this document. 0 based from the Bundle customers list","nullable":true,"items":{"type":"integer","format":"int32"}},"CustomerInputElements":{"type":"array","description":"Optional list of Customer Signer locations","nullable":true,"items":{"$ref":"#/components/schemas/ExternalApiExternalHandlersFeaturesBundleCreateCustomerInputElementDetailsDto"}},"CustomerViewers":{"type":"array","description":"A list of indexes of uploaded customers for which customers can VIEW this document. This is optional - customers that must sign need to be in the CustomerSigners list","nullable":true,"items":{"type":"integer","format":"int32"}},"Meta":{"type":"string","description":"This is a external system generated key/string. Populated by the external system and tied to a bundle."}}},"ExternalApiExternalHandlersFeaturesBundleCreateCustomerInputElementDetailsDto":{"type":"object","additionalProperties":false,"properties":{"CustomerIndex":{"type":"integer","description":"The 0 based index in the bundle customers list","format":"int32"},"InputElements":{"type":"array","description":"List of signature placement locations","nullable":true,"items":{"$ref":"#/components/schemas/ExternalApiExternalHandlersFeaturesBundleCreateApiInputElementDto"}}}},"ExternalApiExternalHandlersFeaturesBundleCreateApiInputElementDto":{"type":"object","additionalProperties":false,"properties":{"PageIndex":{"type":"integer","description":"Required for coordinate placement. The target page.","format":"int32","nullable":true},"X":{"type":"number","description":"Required for coordinate placement. The X coordinate (from top left).","format":"decimal","nullable":true},"Y":{"type":"number","description":"Required for coordinate placement. The Y coordinate (from top left).","format":"decimal","nullable":true},"W":{"type":"number","description":"Width of placeholder","format":"decimal","nullable":true},"H":{"type":"number","description":"Height of placeholder","format":"decimal","nullable":true},"Type":{"$ref":"#/components/schemas/ExternalApiExternalHandlersFeaturesBundleCreateRequestSignaturePlacementType"},"PlacementType":{"$ref":"#/components/schemas/FuseSignApiCoreModelsBundlesInputElementPlacementType"},"AnchorText":{"type":"string","description":"Required for anchor placement. The text being searched for. We recommend avoiding special characters."},"AnchorXOffset":{"type":"number","format":"decimal"},"AnchorYOffset":{"type":"number","format":"decimal"},"AnchorFindCount":{"type":"integer","description":"For anchor placement. Number of instances being placed. (0 = unlimited)","format":"int32"}}},"ExternalApiExternalHandlersFeaturesBundleCreateRequestSignaturePlacementType":{"type":"string","description":"","enum":["Standard","WithDate","TextLine","Paragraph","Date","CheckBox","SignedDate","SignerName"]},"FuseSignApiCoreModelsBundlesInputElementPlacementType":{"type":"string","description":"","enum":["ByCoordinate","ByAnchorText"]},"FuseWebSharedObjectsFuseSignEnumsBundleReminderMode":{"type":"string","description":"","enum":["DontRemind","DayBeforeDue","OnDueDate"]},"FuseWebSharedObjectsFuseSignEnumsBundleOverdueReminderMode":{"type":"string","description":"","enum":["DontRemind","Weekly"]},"FuseWebSharedObjectsFuseSignEnumsBundleViewMode":{"type":"string","description":"","enum":["SmsToSign","SmsToView","EmailToSign","Unauthenticated","EmailToView","Mixed"]},"FuseWebSharedObjectsFuseSignEnumsRecipientReceiveMode":{"type":"string","description":"","enum":["EmailWithAttachments","EmailWithLinkOnly"]},"FuseWebSharedObjectsFuseSignEnumsSigningMode":{"type":"string","description":"","enum":["SignWhole","SignPlacements"]},"FuseWebExternalCoreModelsBundleSettings":{"type":"object","additionalProperties":false,"properties":{"EmailPreference":{"description":"Indicate that no emails should be sent by fusesign and that communication will be sent by webhooks","oneOf":[{"$ref":"#/components/schemas/FuseWebSharedObjectsFuseSignEnumsEmailPreference"}]},"AlwaysSendFinalisationEmail":{"type":"boolean","description":"Always send the finalisation emails regardless of the EmailPreference setting"},"WebhookUrl":{"type":"string","description":"The callback URL for bundle events","nullable":true},"DisableFinaliseNow":{"type":"boolean","description":"Disable the ability for the user to Finalise early from the FuseSign webapp."},"DisableRetract":{"type":"boolean","description":"Disable the ability for the user to Retract the bundle from the FuseSign webapp."},"DisableReminders":{"type":"boolean","description":"Disable the ability for the user to request reminder emails from the FuseSign webapp."},"CustomBranding":{"description":"Specify custom branding for this specific bundle. All properties on this object must be set if the object is specified.","nullable":true,"oneOf":[{"$ref":"#/components/schemas/FuseWebExternalCoreModelsBundleFormattingSettings"}]},"RedirectUrl":{"type":"string","description":"Optional URL to redirect the signer to after signing","nullable":true},"RedirectDelaySeconds":{"type":"integer","description":"Optional Number of seconds to delay before redirecting. Default 10.","format":"int32"},"AuditType":{"description":"How to create the bundle audit (included in the signed document or as a separate signed file","oneOf":[{"$ref":"#/components/schemas/FuseWebSharedObjectsFuseSignEnumsAuditType"}]},"ContextUrl":{"type":"string","description":"Context Url - will display a link back to this link within the FuseSign interface.","nullable":true}}},"FuseWebSharedObjectsFuseSignEnumsEmailPreference":{"type":"string","description":"","enum":["FuseSignEmails","NoFuseSignEmails"]},"FuseWebExternalCoreModelsBundleFormattingSettings":{"type":"object","additionalProperties":false,"properties":{"ButtonColor":{"type":"string","description":"Custom for this bundle - this controls the color of the buttons and key UI items on the page. Accepted #RRGGBB format.","nullable":true},"BannerColor":{"type":"string","description":"Custom for this bundle - this controls the color of the banner across the top of the page and is shown BEHIND the log image. Accepted #RRGGBB format.","nullable":true},"LogoUrl":{"type":"string","description":"Set a custom branding Logo URL for this specific bundle. This must be an absolute URL and is hosted.","nullable":true},"FromName":{"type":"string","description":"This will come through in the email FROM field as well as presented on the bundle signing page.","nullable":true}}},"FuseWebSharedObjectsFuseSignEnumsAuditType":{"type":"string","description":"","enum":["Included","Separate"]},"ExternalApiExternalHandlersDtosResponsesBundleBundleDto":{"type":"object","additionalProperties":false,"properties":{"Id":{"type":"string","description":"Unique bundle ID","format":"guid"},"TenantId":{"type":"string","description":"Bundle Tenant ID","format":"guid"},"ReviewUrl":{"type":"string","description":"This URL will be set if the bundle is active with a link to the review page","nullable":true},"DraftUrl":{"type":"string","description":"This URL will be set if the bundle is in draft phase and allows for the bundle to be edited.","nullable":true},"Subject":{"type":"string","description":"Bundle subject","nullable":true},"Body":{"type":"string","description":"Bundle Body message","nullable":true},"FromName":{"type":"string","description":"Who the bundle is from (included in email)","nullable":true},"Customers":{"type":"array","description":"List of bundle customers","nullable":true,"items":{"$ref":"#/components/schemas/ExternalApiExternalHandlersDtosResponsesBundleBundleCustomerDto"}},"Documents":{"type":"array","description":"List of bundle documents","nullable":true,"items":{"$ref":"#/components/schemas/ExternalApiExternalHandlersDtosResponsesBundleBundleDocumentDto"}},"DueDate":{"type":"string","description":"The bundle due date (optional)","format":"date-time","nullable":true},"DueReminderMode":{"description":"Bundle reminder mode","oneOf":[{"$ref":"#/components/schemas/FuseWebSharedObjectsFuseSignEnumsBundleReminderMode"}]},"OverdueReminderMode":{"description":"Bundle overdue reminder mode","oneOf":[{"$ref":"#/components/schemas/FuseWebSharedObjectsFuseSignEnumsBundleOverdueReminderMode"}]},"DateSent":{"type":"string","description":"Date the bundle was sent if it is live","format":"date-time","nullable":true},"DateCompleted":{"type":"string","description":"Date the bundle was completed if it is finalised","format":"date-time","nullable":true},"DateArchived":{"type":"string","description":"Date the bundle was archived if it is archived","format":"date-time","nullable":true},"LastReminderSent":{"type":"string","description":"Date the last reminder was sent","format":"date-time","nullable":true},"State":{"description":"Current bundle state","oneOf":[{"$ref":"#/components/schemas/FuseWebSharedObjectsFuseSignEnumsSigningBundleState"}]},"ViewMode":{"description":"The bundle view mode setting. If this is blank the business default is selected and the system falls back to the highest available authentication","oneOf":[{"$ref":"#/components/schemas/FuseWebSharedObjectsFuseSignEnumsBundleViewMode"}]},"SigningMode":{"description":"The bundle signing mode","oneOf":[{"$ref":"#/components/schemas/FuseWebSharedObjectsFuseSignEnumsSigningMode"}]},"Settings":{"description":"Bundle settings object","nullable":true,"oneOf":[{"$ref":"#/components/schemas/ExternalApiExternalHandlersDtosResponsesBundleBundleSettingsDto"}]},"Meta":{"type":"string","description":"Bundle lookup metadata","nullable":true}}},"ExternalApiExternalHandlersDtosResponsesBundleBundleCustomerDto":{"type":"object","additionalProperties":false,"properties":{"Customer":{"description":"Customer object","nullable":true,"oneOf":[{"$ref":"#/components/schemas/ExternalApiExternalHandlersDtosResponsesBundleBundleCustomerDetailsDto"}]},"LastSigner":{"type":"boolean","description":"Optional argument which can only be present on ONE customer to specify signer order and they are the last signer"},"SigningGroup":{"type":"integer","description":"Zero based index of signer order. Lower numbers will sign first, then next etc. If multiple customers share the number then they will sign at the same time.","format":"int32"},"CustomerSignUrl":{"type":"string","description":"[Obsolete] The URL where this customer can sign","nullable":true},"CustomerBundleStatus":{"description":"The current status of this customer relative to the bundle. NOTE: At bundle creation this status is Pending because the bundle has been scheduled to be sent (and will send shortly thereafter)","nullable":true,"oneOf":[{"$ref":"#/components/schemas/FuseWebSharedObjectsFuseSignEnumsCustomerBundleStatus"}]},"LockLastSigningGroup":{"type":"boolean","description":"Lock this contact in the last signing group"},"CannotRemoveFromBundleDraft":{"type":"boolean","description":"Don't allow removal of this contact from a draft bundle"}}},"ExternalApiExternalHandlersDtosResponsesBundleBundleCustomerDetailsDto":{"type":"object","additionalProperties":false,"properties":{"CustomerId":{"type":"string","description":"Customer ID","format":"guid"},"TenantId":{"type":"string","description":"Customer tenant ID","format":"guid"},"Name":{"type":"string","description":"Customer Name","nullable":true},"Email":{"type":"string","description":"Customer Email","nullable":true},"PhoneNumber":{"type":"string","description":"Customer mobile number. Required for 2FA. If NoMobile is true this is not required. Must be in international format:   +61413121121","nullable":true},"NoMobile":{"type":"boolean","description":"No Mobile flag, means Phone Number is ignored"},"Meta":{"type":"string","description":"Optional external lookup ID. Can be used for searching","nullable":true},"CannotModify":{"type":"boolean","description":"Don't allow modification of this contact"},"Source":{"description":"Customer data source","oneOf":[{"$ref":"#/components/schemas/FuseWebSharedObjectsFuseSignEnumsSource"}]},"CustomerEditLink":{"type":"string","description":"Link to edit customer details directly","nullable":true},"TotalLiveBundlesForCustomer":{"type":"integer","description":"Number of bundles assigned to the user which are yet to be actioned","format":"int32","nullable":true},"TotalBundlesForCustomer":{"type":"integer","description":"Number of bundles assigned to the user","format":"int32","nullable":true},"PreferredName":{"type":"string","description":"Customer preferred name. The customer will be addressed by this name when signing.","nullable":true}}},"FuseWebSharedObjectsFuseSignEnumsSource":{"type":"string","description":"","enum":["Manual","XPM","Test","CSV","External","APS","MYOB","FileFYI","FileIManage","FYIElite","Karbon","SyncedContact","FuseDocs"]},"FuseWebSharedObjectsFuseSignEnumsCustomerBundleStatus":{"type":"string","description":"","enum":["NoActions","ActionsCompleted","ActionsCancelled","DocumentsRetracted","NotOpenedActionsRequired","NotOpenedFYIOnly","Pending","Rejected","Retracted","Seen"]},"ExternalApiExternalHandlersDtosResponsesBundleBundleDocumentDto":{"type":"object","additionalProperties":false,"properties":{"Document":{"description":"Document information","nullable":true,"oneOf":[{"$ref":"#/components/schemas/ExternalApiExternalHandlersDtosResponsesBundleBundleDocumentDetailsDto"}]},"DocumentOrder":{"type":"integer","description":"Optional: The order that this document will be presented in the pack. Must be a unique integer.","format":"int32"},"CustomerSigners":{"type":"array","description":"A list of customers for which customers must SIGN this document","nullable":true,"items":{"$ref":"#/components/schemas/ExternalApiExternalHandlersDtosResponsesBundleBundleCustomerDto"}},"CustomerViewers":{"type":"array","description":"A list of customers for which customers can VIEW this document","nullable":true,"items":{"$ref":"#/components/schemas/ExternalApiExternalHandlersDtosResponsesBundleBundleCustomerDto"}},"DocumentState":{"description":"The state of the Document.","oneOf":[{"$ref":"#/components/schemas/FuseWebSharedObjectsFuseSignEnumsTransactionalDocumentState"}]}}},"ExternalApiExternalHandlersDtosResponsesBundleBundleDocumentDetailsDto":{"type":"object","additionalProperties":false,"properties":{"DocumentId":{"type":"string","description":"Document ID","format":"guid"},"BundleId":{"type":"string","description":"Related bundle ID. Can be null if not yet assigned to a bundle","format":"guid","nullable":true},"Meta":{"type":"string","description":"Lookup metadata","nullable":true},"DisplayName":{"type":"string","description":"Document Display name","nullable":true},"EstimatedSize":{"type":"integer","description":"Estimated size of the document (Affects inbox limit)","format":"int64"},"SignedPDFDownloadUrl":{"type":"string","description":"URL to download the signed PDF","nullable":true}}},"FuseWebSharedObjectsFuseSignEnumsTransactionalDocumentState":{"type":"string","description":"","enum":["Draft","Live","Signed","Rejected","Retracted","Finalised"]},"FuseWebSharedObjectsFuseSignEnumsSigningBundleState":{"type":"string","description":"","enum":["Draft","Live","Finalised","Retracted","Rejected","Error","PendingArchive","Archived","DraftDeleted","PurgedArchive","ArchiveNoRetention","NewDraft"]},"ExternalApiExternalHandlersDtosResponsesBundleBundleSettingsDto":{"type":"object","additionalProperties":false,"properties":{"EmailPreference":{"description":"Indicate that no emails should be sent by fusesign and that communication will be sent by webhooks","oneOf":[{"$ref":"#/components/schemas/FuseWebSharedObjectsFuseSignEnumsEmailPreference"}]},"AlwaysSendFinalisationEmail":{"type":"boolean","description":"Always send the finalisation emails regardless of the EmailPreference setting"},"WebhookUrl":{"type":"string","description":"The callback URL for bundle events","nullable":true},"DisableFinaliseNow":{"type":"boolean","description":"Disable the ability for the user to Finalise early from the FuseSign webapp."},"DisableRetract":{"type":"boolean","description":"Disable the ability for the user to Retract the bundle from the FuseSign webapp."},"DisableReminders":{"type":"boolean","description":"Disable the ability for the user to request reminder emails from the FuseSign webapp."},"CustomBranding":{"description":"Specify custom branding for this specific bundle. All properties on this object must be set if the object is specified.","nullable":true,"oneOf":[{"$ref":"#/components/schemas/ExternalApiExternalHandlersDtosResponsesBundleBundleFormattingSettingsDto"}]},"RedirectUrl":{"type":"string","description":"Optional URL to redirect the signer to after signing","nullable":true},"RedirectDelaySeconds":{"type":"integer","description":"Optional Number of seconds to delay before redirecting. Default 10.","format":"int32"},"AuditType":{"description":"How to create the bundle audit (included in the signed document or as a separate signed file","oneOf":[{"$ref":"#/components/schemas/FuseWebSharedObjectsFuseSignEnumsAuditType"}]},"ContextUrl":{"type":"string","description":"Context Url - will display a link back to this link within the FuseSign interface.","nullable":true}}},"ExternalApiExternalHandlersDtosResponsesBundleBundleFormattingSettingsDto":{"type":"object","additionalProperties":false,"properties":{"ButtonColor":{"type":"string","description":"Custom for this bundle - this controls the color of the buttons and key UI items on the page. Accepted #RRGGBB format."},"BannerColor":{"type":"string","description":"Custom for this bundle - this controls the color of the banner across the top of the page and is shown BEHIND the log image. Accepted #RRGGBB format."},"LogoUrl":{"type":"string","description":"Set a custom branding Logo URL for this specific bundle. This must be an absolute URL and is hosted."},"FromName":{"type":"string","description":"This will come through in the email FROM field as well as presented on the bundle signing page.","nullable":true}}},"ExternalApiCommonModelsApiErrorResponse":{"type":"object","additionalProperties":false,"properties":{"Result":{"type":"boolean"},"Message":{"type":"string"},"Errors":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/FuseWebSharedObjectsModelsValidationError"}}}},"FuseWebSharedObjectsModelsValidationError":{"type":"object","additionalProperties":false,"properties":{"Property":{"type":"string"},"ErrorMessage":{"type":"string"},"ErrorCode":{"type":"string"}}}}},"paths":{"/api/Bundle/Create":{"post":{"tags":["Bundle"],"summary":"Creates a new bundle.","description":"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.","operationId":"ExternalApiExternalHandlersFeaturesBundleCreateCreateBundleEndpoint","parameters":[{"name":"TenantId","in":"query","required":true,"description":"FuseSign Tenant Id","schema":{"type":"string","format":"guid"}}],"requestBody":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExternalApiExternalHandlersFeaturesBundleCreateCreateBundleRequest"}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExternalApiExternalHandlersDtosResponsesBundleBundleDto"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExternalApiCommonModelsApiErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"string"}}}},"403":{"description":"Forbidden"}}}}}}
```

## Get bundle audit history.

> Get a bundles history, including things like Finalisation, Errors and other actions. We recommend using Webhooks instead where appropriate.

```json
{"openapi":"3.0.0","info":{"title":"FuseSign API","version":"v1"},"servers":[{"url":"https://api.fuse.work","description":"FuseSign API"}],"security":[{"OAuthToken":[]},{"ApiKey":[]}],"components":{"securitySchemes":{"OAuthToken":{"type":"oauth2","description":"FuseSign OAuth 2. Use this for most implementations.","name":"FuseSign OAuth 2","flows":{"authorizationCode":{"authorizationUrl":"https://api.fuse.work/api/Session/OAuthRegister","tokenUrl":"https://api.fuse.work/api/Session/OAuthGetToken","refreshUrl":"https://api.fuse.work/api/Session/OAuthRefreshToken","scopes":{"FUSESIGN":"Manage FuseSign Bundles and corresponding data.","FUSESIGN:OWN":"Ability to send bundles and extract bundles created by this user only. Special purpose scope, contact support@fuse.work."}}}},"ApiKey":{"type":"apiKey","description":"Wholesale API Token","name":"X-API-Token","in":"header"}},"schemas":{"ExternalApiExternalHandlersFeaturesBundleGetHistoryGetHistoryResponse_BundleHistoryEvent":{"type":"object","additionalProperties":false,"properties":{"Id":{"type":"string","description":"Event ID","format":"guid"},"DateTime":{"type":"string","description":"Event Time","format":"date-time"},"BundleId":{"type":"string","description":"Bundle ID","format":"guid"},"DocumentId":{"type":"string","description":"Related Document ID","format":"guid","nullable":true},"CustomerId":{"type":"string","description":"Related Customer ID","format":"guid","nullable":true},"Action":{"description":"Event Action type","oneOf":[{"$ref":"#/components/schemas/FuseWebSharedObjectsFuseSignEnumsSigningBundleAuditActionAction"}]},"ActionNotes":{"type":"string","description":"Event information","nullable":true},"IP":{"type":"string","description":"Customer IP if applicable","nullable":true}}},"FuseWebSharedObjectsFuseSignEnumsSigningBundleAuditActionAction":{"type":"string","description":"","enum":["Sent","Viewed","Downloaded","Verified","Signed","Retracted","Finalised","Rejected","Error","Initiated","Reminder","EmailSent","UpdateDueDate","DownloadedSigned","EmailSentAttachment","ArchiveWarningSent","CustomerRequestedNewLink","AttributeChanged","FormFieldSubmission","UpdateSmsNotify","DeletedDraft","MarkedForClosure","DocumentFiledBack","UserMarkedBundleForClosure","ReminderNotSentPastOverdue","Cloned"]},"ExternalApiCommonModelsApiErrorResponse":{"type":"object","additionalProperties":false,"properties":{"Result":{"type":"boolean"},"Message":{"type":"string"},"Errors":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/FuseWebSharedObjectsModelsValidationError"}}}},"FuseWebSharedObjectsModelsValidationError":{"type":"object","additionalProperties":false,"properties":{"Property":{"type":"string"},"ErrorMessage":{"type":"string"},"ErrorCode":{"type":"string"}}}}},"paths":{"/api/Bundle/GetHistory":{"get":{"tags":["Bundle"],"summary":"Get bundle audit history.","description":"Get a bundles history, including things like Finalisation, Errors and other actions. We recommend using Webhooks instead where appropriate.","operationId":"ExternalApiExternalHandlersFeaturesBundleGetHistoryGetHistoryEndpoint","parameters":[{"name":"TenantId","in":"query","required":true,"description":"FuseSign Tenant Id","schema":{"type":"string","format":"guid"}},{"name":"BundleId","in":"query","required":true,"description":"Bundle Id","schema":{"type":"string","format":"guid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ExternalApiExternalHandlersFeaturesBundleGetHistoryGetHistoryResponse_BundleHistoryEvent"}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExternalApiCommonModelsApiErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"string"}}}},"403":{"description":"Forbidden"}}}}}}
```

## Retract a bundle.

> Request bundle retraction. This will cancel the outstanding sign request

```json
{"openapi":"3.0.0","info":{"title":"FuseSign API","version":"v1"},"servers":[{"url":"https://api.fuse.work","description":"FuseSign API"}],"security":[{"OAuthToken":[]},{"ApiKey":[]}],"components":{"securitySchemes":{"OAuthToken":{"type":"oauth2","description":"FuseSign OAuth 2. Use this for most implementations.","name":"FuseSign OAuth 2","flows":{"authorizationCode":{"authorizationUrl":"https://api.fuse.work/api/Session/OAuthRegister","tokenUrl":"https://api.fuse.work/api/Session/OAuthGetToken","refreshUrl":"https://api.fuse.work/api/Session/OAuthRefreshToken","scopes":{"FUSESIGN":"Manage FuseSign Bundles and corresponding data.","FUSESIGN:OWN":"Ability to send bundles and extract bundles created by this user only. Special purpose scope, contact support@fuse.work."}}}},"ApiKey":{"type":"apiKey","description":"Wholesale API Token","name":"X-API-Token","in":"header"}},"schemas":{"ExternalApiExternalHandlersFeaturesBundleRetractRetractBundleRequest":{"type":"object","additionalProperties":false,"required":["BundleId","Reason"],"properties":{"BundleId":{"type":"string","description":"Bundle Id","format":"guid","minLength":1,"nullable":false},"Reason":{"type":"string","description":"[Mandatory] Reason for retraction","minLength":1,"nullable":false},"Message":{"type":"string","description":"[Optional] Additional message","nullable":true}}},"ExternalApiExternalHandlersFeaturesBundleRetractRetractBundleResponse":{"type":"object","additionalProperties":false,"properties":{"Result":{"type":"boolean"}}},"ExternalApiCommonModelsApiErrorResponse":{"type":"object","additionalProperties":false,"properties":{"Result":{"type":"boolean"},"Message":{"type":"string"},"Errors":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/FuseWebSharedObjectsModelsValidationError"}}}},"FuseWebSharedObjectsModelsValidationError":{"type":"object","additionalProperties":false,"properties":{"Property":{"type":"string"},"ErrorMessage":{"type":"string"},"ErrorCode":{"type":"string"}}}}},"paths":{"/api/Bundle/Retract":{"post":{"tags":["Bundle"],"summary":"Retract a bundle.","description":"Request bundle retraction. This will cancel the outstanding sign request","operationId":"ExternalApiExternalHandlersFeaturesBundleRetractRetractBundleEndpoint","parameters":[{"name":"TenantId","in":"query","required":true,"description":"FuseSign Tenant Id","schema":{"type":"string","format":"guid"}}],"requestBody":{"description":"","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExternalApiExternalHandlersFeaturesBundleRetractRetractBundleRequest"}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExternalApiExternalHandlersFeaturesBundleRetractRetractBundleResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExternalApiCommonModelsApiErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"string"}}}},"403":{"description":"Forbidden"}}}}}}
```

## Mark Bundle for Archive

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

```json
{"openapi":"3.0.0","info":{"title":"FuseSign API","version":"v1"},"servers":[{"url":"https://api.fuse.work","description":"FuseSign API"}],"security":[{"OAuthToken":[]},{"ApiKey":[]}],"components":{"securitySchemes":{"OAuthToken":{"type":"oauth2","description":"FuseSign OAuth 2. Use this for most implementations.","name":"FuseSign OAuth 2","flows":{"authorizationCode":{"authorizationUrl":"https://api.fuse.work/api/Session/OAuthRegister","tokenUrl":"https://api.fuse.work/api/Session/OAuthGetToken","refreshUrl":"https://api.fuse.work/api/Session/OAuthRefreshToken","scopes":{"FUSESIGN":"Manage FuseSign Bundles and corresponding data.","FUSESIGN:OWN":"Ability to send bundles and extract bundles created by this user only. Special purpose scope, contact support@fuse.work."}}}},"ApiKey":{"type":"apiKey","description":"Wholesale API Token","name":"X-API-Token","in":"header"}},"schemas":{"ExternalApiExternalHandlersFeaturesBundleMarkReadyForArchiveMarkReadyForArchiveRequest":{"type":"object","additionalProperties":false,"required":["BundleId"],"properties":{"BundleId":{"type":"string","description":"Bundle Id","format":"guid","minLength":1,"nullable":false}}},"ExternalApiExternalHandlersFeaturesBundleMarkReadyForArchiveMarkReadyForArchiveBundleResponse":{"type":"object","additionalProperties":false,"properties":{"Result":{"type":"boolean"}}}}},"paths":{"/api/Bundle/MarkReadyForArchive":{"post":{"tags":["Bundle"],"summary":"Mark Bundle for Archive","description":"Mark the bundle as \"Closed\" which will allow it to be archived","operationId":"ExternalApiExternalHandlersFeaturesBundleMarkReadyForArchiveMarkReadyForArchiveEndpoint","parameters":[{"name":"TenantId","in":"query","required":true,"description":"FuseSign Tenant Id","schema":{"type":"string","format":"guid"}}],"requestBody":{"description":"","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExternalApiExternalHandlersFeaturesBundleMarkReadyForArchiveMarkReadyForArchiveRequest"}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExternalApiExternalHandlersFeaturesBundleMarkReadyForArchiveMarkReadyForArchiveBundleResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExternalApiExternalHandlersFeaturesBundleMarkReadyForArchiveMarkReadyForArchiveBundleResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"string"}}}},"403":{"description":"Forbidden"}}}}}}
```

## Gets a list of bundles.

> Gets a list of bundles for the specified tenant.

```json
{"openapi":"3.0.0","info":{"title":"FuseSign API","version":"v1"},"servers":[{"url":"https://api.fuse.work","description":"FuseSign API"}],"security":[{"OAuthToken":[]},{"ApiKey":[]}],"components":{"securitySchemes":{"OAuthToken":{"type":"oauth2","description":"FuseSign OAuth 2. Use this for most implementations.","name":"FuseSign OAuth 2","flows":{"authorizationCode":{"authorizationUrl":"https://api.fuse.work/api/Session/OAuthRegister","tokenUrl":"https://api.fuse.work/api/Session/OAuthGetToken","refreshUrl":"https://api.fuse.work/api/Session/OAuthRefreshToken","scopes":{"FUSESIGN":"Manage FuseSign Bundles and corresponding data.","FUSESIGN:OWN":"Ability to send bundles and extract bundles created by this user only. Special purpose scope, contact support@fuse.work."}}}},"ApiKey":{"type":"apiKey","description":"Wholesale API Token","name":"X-API-Token","in":"header"}},"schemas":{"ExternalApiExternalHandlersFeaturesBundleSearchSearchBundleRequest":{"type":"object","additionalProperties":false,"properties":{"Page":{"type":"integer","description":"Search page (50 records per page). 0 Based indexing.","format":"int32","minimum":0},"States":{"type":"array","description":"Return bundles with this state. Leave empty to return all states","items":{"$ref":"#/components/schemas/FuseWebSharedObjectsFuseSignEnumsSigningBundleState"}}}},"FuseWebSharedObjectsFuseSignEnumsSigningBundleState":{"type":"string","description":"","enum":["Draft","Live","Finalised","Retracted","Rejected","Error","PendingArchive","Archived","DraftDeleted","PurgedArchive","ArchiveNoRetention","NewDraft"]},"ExternalApiExternalHandlersFeaturesBundleSearchSearchBundleResponse":{"type":"object","additionalProperties":false,"properties":{"Page":{"type":"integer","description":"Search page","format":"int32"},"TotalPages":{"type":"integer","description":"Total pages","format":"int32"},"RecordsPerPage":{"type":"integer","description":"Number of records per page","format":"int32"},"Count":{"type":"integer","description":"Number of records returned for this page","format":"int32"},"SearchResults":{"type":"array","description":"Search Results","items":{"$ref":"#/components/schemas/ExternalApiExternalHandlersDtosResponsesBundleBundleDto"}}}},"ExternalApiExternalHandlersDtosResponsesBundleBundleDto":{"type":"object","additionalProperties":false,"properties":{"Id":{"type":"string","description":"Unique bundle ID","format":"guid"},"TenantId":{"type":"string","description":"Bundle Tenant ID","format":"guid"},"ReviewUrl":{"type":"string","description":"This URL will be set if the bundle is active with a link to the review page","nullable":true},"DraftUrl":{"type":"string","description":"This URL will be set if the bundle is in draft phase and allows for the bundle to be edited.","nullable":true},"Subject":{"type":"string","description":"Bundle subject","nullable":true},"Body":{"type":"string","description":"Bundle Body message","nullable":true},"FromName":{"type":"string","description":"Who the bundle is from (included in email)","nullable":true},"Customers":{"type":"array","description":"List of bundle customers","nullable":true,"items":{"$ref":"#/components/schemas/ExternalApiExternalHandlersDtosResponsesBundleBundleCustomerDto"}},"Documents":{"type":"array","description":"List of bundle documents","nullable":true,"items":{"$ref":"#/components/schemas/ExternalApiExternalHandlersDtosResponsesBundleBundleDocumentDto"}},"DueDate":{"type":"string","description":"The bundle due date (optional)","format":"date-time","nullable":true},"DueReminderMode":{"description":"Bundle reminder mode","oneOf":[{"$ref":"#/components/schemas/FuseWebSharedObjectsFuseSignEnumsBundleReminderMode"}]},"OverdueReminderMode":{"description":"Bundle overdue reminder mode","oneOf":[{"$ref":"#/components/schemas/FuseWebSharedObjectsFuseSignEnumsBundleOverdueReminderMode"}]},"DateSent":{"type":"string","description":"Date the bundle was sent if it is live","format":"date-time","nullable":true},"DateCompleted":{"type":"string","description":"Date the bundle was completed if it is finalised","format":"date-time","nullable":true},"DateArchived":{"type":"string","description":"Date the bundle was archived if it is archived","format":"date-time","nullable":true},"LastReminderSent":{"type":"string","description":"Date the last reminder was sent","format":"date-time","nullable":true},"State":{"description":"Current bundle state","oneOf":[{"$ref":"#/components/schemas/FuseWebSharedObjectsFuseSignEnumsSigningBundleState"}]},"ViewMode":{"description":"The bundle view mode setting. If this is blank the business default is selected and the system falls back to the highest available authentication","oneOf":[{"$ref":"#/components/schemas/FuseWebSharedObjectsFuseSignEnumsBundleViewMode"}]},"SigningMode":{"description":"The bundle signing mode","oneOf":[{"$ref":"#/components/schemas/FuseWebSharedObjectsFuseSignEnumsSigningMode"}]},"Settings":{"description":"Bundle settings object","nullable":true,"oneOf":[{"$ref":"#/components/schemas/ExternalApiExternalHandlersDtosResponsesBundleBundleSettingsDto"}]},"Meta":{"type":"string","description":"Bundle lookup metadata","nullable":true}}},"ExternalApiExternalHandlersDtosResponsesBundleBundleCustomerDto":{"type":"object","additionalProperties":false,"properties":{"Customer":{"description":"Customer object","nullable":true,"oneOf":[{"$ref":"#/components/schemas/ExternalApiExternalHandlersDtosResponsesBundleBundleCustomerDetailsDto"}]},"LastSigner":{"type":"boolean","description":"Optional argument which can only be present on ONE customer to specify signer order and they are the last signer"},"SigningGroup":{"type":"integer","description":"Zero based index of signer order. Lower numbers will sign first, then next etc. If multiple customers share the number then they will sign at the same time.","format":"int32"},"CustomerSignUrl":{"type":"string","description":"[Obsolete] The URL where this customer can sign","nullable":true},"CustomerBundleStatus":{"description":"The current status of this customer relative to the bundle. NOTE: At bundle creation this status is Pending because the bundle has been scheduled to be sent (and will send shortly thereafter)","nullable":true,"oneOf":[{"$ref":"#/components/schemas/FuseWebSharedObjectsFuseSignEnumsCustomerBundleStatus"}]},"LockLastSigningGroup":{"type":"boolean","description":"Lock this contact in the last signing group"},"CannotRemoveFromBundleDraft":{"type":"boolean","description":"Don't allow removal of this contact from a draft bundle"}}},"ExternalApiExternalHandlersDtosResponsesBundleBundleCustomerDetailsDto":{"type":"object","additionalProperties":false,"properties":{"CustomerId":{"type":"string","description":"Customer ID","format":"guid"},"TenantId":{"type":"string","description":"Customer tenant ID","format":"guid"},"Name":{"type":"string","description":"Customer Name","nullable":true},"Email":{"type":"string","description":"Customer Email","nullable":true},"PhoneNumber":{"type":"string","description":"Customer mobile number. Required for 2FA. If NoMobile is true this is not required. Must be in international format:   +61413121121","nullable":true},"NoMobile":{"type":"boolean","description":"No Mobile flag, means Phone Number is ignored"},"Meta":{"type":"string","description":"Optional external lookup ID. Can be used for searching","nullable":true},"CannotModify":{"type":"boolean","description":"Don't allow modification of this contact"},"Source":{"description":"Customer data source","oneOf":[{"$ref":"#/components/schemas/FuseWebSharedObjectsFuseSignEnumsSource"}]},"CustomerEditLink":{"type":"string","description":"Link to edit customer details directly","nullable":true},"TotalLiveBundlesForCustomer":{"type":"integer","description":"Number of bundles assigned to the user which are yet to be actioned","format":"int32","nullable":true},"TotalBundlesForCustomer":{"type":"integer","description":"Number of bundles assigned to the user","format":"int32","nullable":true},"PreferredName":{"type":"string","description":"Customer preferred name. The customer will be addressed by this name when signing.","nullable":true}}},"FuseWebSharedObjectsFuseSignEnumsSource":{"type":"string","description":"","enum":["Manual","XPM","Test","CSV","External","APS","MYOB","FileFYI","FileIManage","FYIElite","Karbon","SyncedContact","FuseDocs"]},"FuseWebSharedObjectsFuseSignEnumsCustomerBundleStatus":{"type":"string","description":"","enum":["NoActions","ActionsCompleted","ActionsCancelled","DocumentsRetracted","NotOpenedActionsRequired","NotOpenedFYIOnly","Pending","Rejected","Retracted","Seen"]},"ExternalApiExternalHandlersDtosResponsesBundleBundleDocumentDto":{"type":"object","additionalProperties":false,"properties":{"Document":{"description":"Document information","nullable":true,"oneOf":[{"$ref":"#/components/schemas/ExternalApiExternalHandlersDtosResponsesBundleBundleDocumentDetailsDto"}]},"DocumentOrder":{"type":"integer","description":"Optional: The order that this document will be presented in the pack. Must be a unique integer.","format":"int32"},"CustomerSigners":{"type":"array","description":"A list of customers for which customers must SIGN this document","nullable":true,"items":{"$ref":"#/components/schemas/ExternalApiExternalHandlersDtosResponsesBundleBundleCustomerDto"}},"CustomerViewers":{"type":"array","description":"A list of customers for which customers can VIEW this document","nullable":true,"items":{"$ref":"#/components/schemas/ExternalApiExternalHandlersDtosResponsesBundleBundleCustomerDto"}},"DocumentState":{"description":"The state of the Document.","oneOf":[{"$ref":"#/components/schemas/FuseWebSharedObjectsFuseSignEnumsTransactionalDocumentState"}]}}},"ExternalApiExternalHandlersDtosResponsesBundleBundleDocumentDetailsDto":{"type":"object","additionalProperties":false,"properties":{"DocumentId":{"type":"string","description":"Document ID","format":"guid"},"BundleId":{"type":"string","description":"Related bundle ID. Can be null if not yet assigned to a bundle","format":"guid","nullable":true},"Meta":{"type":"string","description":"Lookup metadata","nullable":true},"DisplayName":{"type":"string","description":"Document Display name","nullable":true},"EstimatedSize":{"type":"integer","description":"Estimated size of the document (Affects inbox limit)","format":"int64"},"SignedPDFDownloadUrl":{"type":"string","description":"URL to download the signed PDF","nullable":true}}},"FuseWebSharedObjectsFuseSignEnumsTransactionalDocumentState":{"type":"string","description":"","enum":["Draft","Live","Signed","Rejected","Retracted","Finalised"]},"FuseWebSharedObjectsFuseSignEnumsBundleReminderMode":{"type":"string","description":"","enum":["DontRemind","DayBeforeDue","OnDueDate"]},"FuseWebSharedObjectsFuseSignEnumsBundleOverdueReminderMode":{"type":"string","description":"","enum":["DontRemind","Weekly"]},"FuseWebSharedObjectsFuseSignEnumsBundleViewMode":{"type":"string","description":"","enum":["SmsToSign","SmsToView","EmailToSign","Unauthenticated","EmailToView","Mixed"]},"FuseWebSharedObjectsFuseSignEnumsSigningMode":{"type":"string","description":"","enum":["SignWhole","SignPlacements"]},"ExternalApiExternalHandlersDtosResponsesBundleBundleSettingsDto":{"type":"object","additionalProperties":false,"properties":{"EmailPreference":{"description":"Indicate that no emails should be sent by fusesign and that communication will be sent by webhooks","oneOf":[{"$ref":"#/components/schemas/FuseWebSharedObjectsFuseSignEnumsEmailPreference"}]},"AlwaysSendFinalisationEmail":{"type":"boolean","description":"Always send the finalisation emails regardless of the EmailPreference setting"},"WebhookUrl":{"type":"string","description":"The callback URL for bundle events","nullable":true},"DisableFinaliseNow":{"type":"boolean","description":"Disable the ability for the user to Finalise early from the FuseSign webapp."},"DisableRetract":{"type":"boolean","description":"Disable the ability for the user to Retract the bundle from the FuseSign webapp."},"DisableReminders":{"type":"boolean","description":"Disable the ability for the user to request reminder emails from the FuseSign webapp."},"CustomBranding":{"description":"Specify custom branding for this specific bundle. All properties on this object must be set if the object is specified.","nullable":true,"oneOf":[{"$ref":"#/components/schemas/ExternalApiExternalHandlersDtosResponsesBundleBundleFormattingSettingsDto"}]},"RedirectUrl":{"type":"string","description":"Optional URL to redirect the signer to after signing","nullable":true},"RedirectDelaySeconds":{"type":"integer","description":"Optional Number of seconds to delay before redirecting. Default 10.","format":"int32"},"AuditType":{"description":"How to create the bundle audit (included in the signed document or as a separate signed file","oneOf":[{"$ref":"#/components/schemas/FuseWebSharedObjectsFuseSignEnumsAuditType"}]},"ContextUrl":{"type":"string","description":"Context Url - will display a link back to this link within the FuseSign interface.","nullable":true}}},"FuseWebSharedObjectsFuseSignEnumsEmailPreference":{"type":"string","description":"","enum":["FuseSignEmails","NoFuseSignEmails"]},"ExternalApiExternalHandlersDtosResponsesBundleBundleFormattingSettingsDto":{"type":"object","additionalProperties":false,"properties":{"ButtonColor":{"type":"string","description":"Custom for this bundle - this controls the color of the buttons and key UI items on the page. Accepted #RRGGBB format."},"BannerColor":{"type":"string","description":"Custom for this bundle - this controls the color of the banner across the top of the page and is shown BEHIND the log image. Accepted #RRGGBB format."},"LogoUrl":{"type":"string","description":"Set a custom branding Logo URL for this specific bundle. This must be an absolute URL and is hosted."},"FromName":{"type":"string","description":"This will come through in the email FROM field as well as presented on the bundle signing page.","nullable":true}}},"FuseWebSharedObjectsFuseSignEnumsAuditType":{"type":"string","description":"","enum":["Included","Separate"]},"ExternalApiCommonModelsApiErrorResponse":{"type":"object","additionalProperties":false,"properties":{"Result":{"type":"boolean"},"Message":{"type":"string"},"Errors":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/FuseWebSharedObjectsModelsValidationError"}}}},"FuseWebSharedObjectsModelsValidationError":{"type":"object","additionalProperties":false,"properties":{"Property":{"type":"string"},"ErrorMessage":{"type":"string"},"ErrorCode":{"type":"string"}}}}},"paths":{"/api/Bundle/Search":{"post":{"tags":["Bundle"],"summary":"Gets a list of bundles.","description":"Gets a list of bundles for the specified tenant.","operationId":"ExternalApiExternalHandlersFeaturesBundleSearchSearchBundleEndpoint","parameters":[{"name":"TenantId","in":"query","required":true,"description":"FuseSign Tenant Id","schema":{"type":"string","format":"guid"}}],"requestBody":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExternalApiExternalHandlersFeaturesBundleSearchSearchBundleRequest"}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExternalApiExternalHandlersFeaturesBundleSearchSearchBundleResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExternalApiCommonModelsApiErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"string"}}}},"403":{"description":"Forbidden"}}}}}}
```

## Archive a completed bundle

> 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

```json
{"openapi":"3.0.0","info":{"title":"FuseSign API","version":"v1"},"servers":[{"url":"https://api.fuse.work","description":"FuseSign API"}],"security":[{"OAuthToken":[]},{"ApiKey":[]}],"components":{"securitySchemes":{"OAuthToken":{"type":"oauth2","description":"FuseSign OAuth 2. Use this for most implementations.","name":"FuseSign OAuth 2","flows":{"authorizationCode":{"authorizationUrl":"https://api.fuse.work/api/Session/OAuthRegister","tokenUrl":"https://api.fuse.work/api/Session/OAuthGetToken","refreshUrl":"https://api.fuse.work/api/Session/OAuthRefreshToken","scopes":{"FUSESIGN":"Manage FuseSign Bundles and corresponding data.","FUSESIGN:OWN":"Ability to send bundles and extract bundles created by this user only. Special purpose scope, contact support@fuse.work."}}}},"ApiKey":{"type":"apiKey","description":"Wholesale API Token","name":"X-API-Token","in":"header"}},"schemas":{"ExternalApiExternalHandlersFeaturesBundleArchiveArchiveBundleRequest":{"type":"object","additionalProperties":false,"required":["BundleId"],"properties":{"BundleId":{"type":"string","description":"Bundle Id","format":"guid","minLength":1,"nullable":false}}},"ExternalApiExternalHandlersFeaturesBundleArchiveArchiveBundleResponse":{"type":"object","additionalProperties":false,"properties":{"Result":{"type":"boolean"}}},"ExternalApiCommonModelsApiErrorResponse":{"type":"object","additionalProperties":false,"properties":{"Result":{"type":"boolean"},"Message":{"type":"string"},"Errors":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/FuseWebSharedObjectsModelsValidationError"}}}},"FuseWebSharedObjectsModelsValidationError":{"type":"object","additionalProperties":false,"properties":{"Property":{"type":"string"},"ErrorMessage":{"type":"string"},"ErrorCode":{"type":"string"}}}}},"paths":{"/api/Bundle/Archive":{"post":{"tags":["Bundle"],"summary":"Archive a completed bundle","description":"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","operationId":"ExternalApiExternalHandlersFeaturesBundleArchiveArchiveBundleEndpoint","parameters":[{"name":"TenantId","in":"query","required":true,"description":"FuseSign Tenant Id","schema":{"type":"string","format":"guid"}}],"requestBody":{"description":"","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExternalApiExternalHandlersFeaturesBundleArchiveArchiveBundleRequest"}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExternalApiExternalHandlersFeaturesBundleArchiveArchiveBundleResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExternalApiCommonModelsApiErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"string"}}}},"403":{"description":"Forbidden"}}}}}}
```

## Remind a bundle.

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

```json
{"openapi":"3.0.0","info":{"title":"FuseSign API","version":"v1"},"servers":[{"url":"https://api.fuse.work","description":"FuseSign API"}],"security":[{"OAuthToken":[]},{"ApiKey":[]}],"components":{"securitySchemes":{"OAuthToken":{"type":"oauth2","description":"FuseSign OAuth 2. Use this for most implementations.","name":"FuseSign OAuth 2","flows":{"authorizationCode":{"authorizationUrl":"https://api.fuse.work/api/Session/OAuthRegister","tokenUrl":"https://api.fuse.work/api/Session/OAuthGetToken","refreshUrl":"https://api.fuse.work/api/Session/OAuthRefreshToken","scopes":{"FUSESIGN":"Manage FuseSign Bundles and corresponding data.","FUSESIGN:OWN":"Ability to send bundles and extract bundles created by this user only. Special purpose scope, contact support@fuse.work."}}}},"ApiKey":{"type":"apiKey","description":"Wholesale API Token","name":"X-API-Token","in":"header"}},"schemas":{"ExternalApiExternalHandlersFeaturesBundleSendReminderSendReminderRequest":{"type":"object","additionalProperties":false,"required":["BundleId","TargetCustomerIds"],"properties":{"BundleId":{"type":"string","description":"Bundle Id","format":"guid","minLength":1,"nullable":false},"ReminderNotes":{"type":"string","description":"Notes to include in the email","nullable":true},"TargetCustomerIds":{"type":"array","description":"List of customer IDs (can be retrieved on Bundle/Get","minLength":1,"nullable":false,"items":{"type":"string","format":"guid"}}}},"ExternalApiExternalHandlersFeaturesBundleSendReminderSendReminderResponse":{"type":"object","additionalProperties":false,"properties":{"Result":{"type":"boolean"}}},"ExternalApiCommonModelsApiErrorResponse":{"type":"object","additionalProperties":false,"properties":{"Result":{"type":"boolean"},"Message":{"type":"string"},"Errors":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/FuseWebSharedObjectsModelsValidationError"}}}},"FuseWebSharedObjectsModelsValidationError":{"type":"object","additionalProperties":false,"properties":{"Property":{"type":"string"},"ErrorMessage":{"type":"string"},"ErrorCode":{"type":"string"}}}}},"paths":{"/api/Bundle/SendReminder":{"post":{"tags":["Bundle"],"summary":"Remind a bundle.","description":"Send a reminder for a bundle (Requires Emails to be enabled for the bundle)","operationId":"ExternalApiExternalHandlersFeaturesBundleSendReminderSendReminderEndpoint","parameters":[{"name":"TenantId","in":"query","required":true,"description":"FuseSign Tenant Id","schema":{"type":"string","format":"guid"}}],"requestBody":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExternalApiExternalHandlersFeaturesBundleSendReminderSendReminderRequest"}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExternalApiExternalHandlersFeaturesBundleSendReminderSendReminderResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExternalApiCommonModelsApiErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"string"}}}},"403":{"description":"Forbidden"}}}}}}
```

## Delete a Bundle Draft

> For a given bundle in draft state, delete the draft. This will consequently unlink associated documents and customer actions. Documents will not be deleted.

```json
{"openapi":"3.0.0","info":{"title":"FuseSign API","version":"v1"},"servers":[{"url":"https://api.fuse.work","description":"FuseSign API"}],"security":[{"OAuthToken":[]},{"ApiKey":[]}],"components":{"securitySchemes":{"OAuthToken":{"type":"oauth2","description":"FuseSign OAuth 2. Use this for most implementations.","name":"FuseSign OAuth 2","flows":{"authorizationCode":{"authorizationUrl":"https://api.fuse.work/api/Session/OAuthRegister","tokenUrl":"https://api.fuse.work/api/Session/OAuthGetToken","refreshUrl":"https://api.fuse.work/api/Session/OAuthRefreshToken","scopes":{"FUSESIGN":"Manage FuseSign Bundles and corresponding data.","FUSESIGN:OWN":"Ability to send bundles and extract bundles created by this user only. Special purpose scope, contact support@fuse.work."}}}},"ApiKey":{"type":"apiKey","description":"Wholesale API Token","name":"X-API-Token","in":"header"}},"schemas":{"ExternalApiExternalHandlersFeaturesBundleDeleteBundleDraftDeleteBundleDraftRequest":{"type":"object","additionalProperties":false,"required":["BundleId"],"properties":{"BundleId":{"type":"string","description":"Bundle Id","format":"guid","minLength":1,"nullable":false}}},"ExternalApiExternalHandlersFeaturesBundleDeleteBundleDraftDeleteBundleDraftBundleResponse":{"type":"object","additionalProperties":false,"properties":{"Result":{"type":"boolean"}}},"ExternalApiCommonModelsApiErrorResponse":{"type":"object","additionalProperties":false,"properties":{"Result":{"type":"boolean"},"Message":{"type":"string"},"Errors":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/FuseWebSharedObjectsModelsValidationError"}}}},"FuseWebSharedObjectsModelsValidationError":{"type":"object","additionalProperties":false,"properties":{"Property":{"type":"string"},"ErrorMessage":{"type":"string"},"ErrorCode":{"type":"string"}}}}},"paths":{"/api/Bundle/DeleteBundleDraft":{"post":{"tags":["Bundle"],"summary":"Delete a Bundle Draft","description":"For a given bundle in draft state, delete the draft. This will consequently unlink associated documents and customer actions. Documents will not be deleted.","operationId":"ExternalApiExternalHandlersFeaturesBundleDeleteBundleDraftDeleteBundleDraftEndpoint","parameters":[{"name":"TenantId","in":"query","required":true,"description":"FuseSign Tenant Id","schema":{"type":"string","format":"guid"}}],"requestBody":{"description":"","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExternalApiExternalHandlersFeaturesBundleDeleteBundleDraftDeleteBundleDraftRequest"}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExternalApiExternalHandlersFeaturesBundleDeleteBundleDraftDeleteBundleDraftBundleResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExternalApiCommonModelsApiErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"string"}}}},"403":{"description":"Forbidden"}}}}}}
```

## Update the webhook URL for a bundle

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

```json
{"openapi":"3.0.0","info":{"title":"FuseSign API","version":"v1"},"servers":[{"url":"https://api.fuse.work","description":"FuseSign API"}],"security":[{"OAuthToken":[]},{"ApiKey":[]}],"components":{"securitySchemes":{"OAuthToken":{"type":"oauth2","description":"FuseSign OAuth 2. Use this for most implementations.","name":"FuseSign OAuth 2","flows":{"authorizationCode":{"authorizationUrl":"https://api.fuse.work/api/Session/OAuthRegister","tokenUrl":"https://api.fuse.work/api/Session/OAuthGetToken","refreshUrl":"https://api.fuse.work/api/Session/OAuthRefreshToken","scopes":{"FUSESIGN":"Manage FuseSign Bundles and corresponding data.","FUSESIGN:OWN":"Ability to send bundles and extract bundles created by this user only. Special purpose scope, contact support@fuse.work."}}}},"ApiKey":{"type":"apiKey","description":"Wholesale API Token","name":"X-API-Token","in":"header"}},"schemas":{"ExternalApiExternalHandlersFeaturesBundleUpdateWebhookUrlUpdateWebhookUrlRequest":{"type":"object","additionalProperties":false,"required":["BundleId","EventWebhookUrl"],"properties":{"BundleId":{"type":"string","description":"Bundle Id","format":"guid","minLength":1,"nullable":false},"EventWebhookUrl":{"type":"string","description":"New webhook URL","minLength":1,"nullable":false}}},"ExternalApiExternalHandlersFeaturesBundleUpdateWebhookUrlUpdateWebhookUrlResponse":{"type":"object","additionalProperties":false,"properties":{"Result":{"type":"boolean"}}},"ExternalApiCommonModelsApiErrorResponse":{"type":"object","additionalProperties":false,"properties":{"Result":{"type":"boolean"},"Message":{"type":"string"},"Errors":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/FuseWebSharedObjectsModelsValidationError"}}}},"FuseWebSharedObjectsModelsValidationError":{"type":"object","additionalProperties":false,"properties":{"Property":{"type":"string"},"ErrorMessage":{"type":"string"},"ErrorCode":{"type":"string"}}}}},"paths":{"/api/Bundle/UpdateWebhookUrl":{"post":{"tags":["Bundle"],"summary":"Update the webhook URL for a bundle","description":"Update the webhook URL. All future webhooks will be sent to the new URL.","operationId":"ExternalApiExternalHandlersFeaturesBundleUpdateWebhookUrlUpdateWebhookUrlEndpoint","parameters":[{"name":"TenantId","in":"query","required":true,"description":"FuseSign Tenant Id","schema":{"type":"string","format":"guid"}}],"requestBody":{"description":"","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExternalApiExternalHandlersFeaturesBundleUpdateWebhookUrlUpdateWebhookUrlRequest"}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExternalApiExternalHandlersFeaturesBundleUpdateWebhookUrlUpdateWebhookUrlResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExternalApiCommonModelsApiErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"string"}}}},"403":{"description":"Forbidden"}}}}}}
```

## List Pending archive bundles

> 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

```json
{"openapi":"3.0.0","info":{"title":"FuseSign API","version":"v1"},"servers":[{"url":"https://api.fuse.work","description":"FuseSign API"}],"security":[{"OAuthToken":[]},{"ApiKey":[]}],"components":{"securitySchemes":{"OAuthToken":{"type":"oauth2","description":"FuseSign OAuth 2. Use this for most implementations.","name":"FuseSign OAuth 2","flows":{"authorizationCode":{"authorizationUrl":"https://api.fuse.work/api/Session/OAuthRegister","tokenUrl":"https://api.fuse.work/api/Session/OAuthGetToken","refreshUrl":"https://api.fuse.work/api/Session/OAuthRefreshToken","scopes":{"FUSESIGN":"Manage FuseSign Bundles and corresponding data.","FUSESIGN:OWN":"Ability to send bundles and extract bundles created by this user only. Special purpose scope, contact support@fuse.work."}}}},"ApiKey":{"type":"apiKey","description":"Wholesale API Token","name":"X-API-Token","in":"header"}},"schemas":{"ExternalApiExternalHandlersDtosResponsesBundleBundleDto":{"type":"object","additionalProperties":false,"properties":{"Id":{"type":"string","description":"Unique bundle ID","format":"guid"},"TenantId":{"type":"string","description":"Bundle Tenant ID","format":"guid"},"ReviewUrl":{"type":"string","description":"This URL will be set if the bundle is active with a link to the review page","nullable":true},"DraftUrl":{"type":"string","description":"This URL will be set if the bundle is in draft phase and allows for the bundle to be edited.","nullable":true},"Subject":{"type":"string","description":"Bundle subject","nullable":true},"Body":{"type":"string","description":"Bundle Body message","nullable":true},"FromName":{"type":"string","description":"Who the bundle is from (included in email)","nullable":true},"Customers":{"type":"array","description":"List of bundle customers","nullable":true,"items":{"$ref":"#/components/schemas/ExternalApiExternalHandlersDtosResponsesBundleBundleCustomerDto"}},"Documents":{"type":"array","description":"List of bundle documents","nullable":true,"items":{"$ref":"#/components/schemas/ExternalApiExternalHandlersDtosResponsesBundleBundleDocumentDto"}},"DueDate":{"type":"string","description":"The bundle due date (optional)","format":"date-time","nullable":true},"DueReminderMode":{"description":"Bundle reminder mode","oneOf":[{"$ref":"#/components/schemas/FuseWebSharedObjectsFuseSignEnumsBundleReminderMode"}]},"OverdueReminderMode":{"description":"Bundle overdue reminder mode","oneOf":[{"$ref":"#/components/schemas/FuseWebSharedObjectsFuseSignEnumsBundleOverdueReminderMode"}]},"DateSent":{"type":"string","description":"Date the bundle was sent if it is live","format":"date-time","nullable":true},"DateCompleted":{"type":"string","description":"Date the bundle was completed if it is finalised","format":"date-time","nullable":true},"DateArchived":{"type":"string","description":"Date the bundle was archived if it is archived","format":"date-time","nullable":true},"LastReminderSent":{"type":"string","description":"Date the last reminder was sent","format":"date-time","nullable":true},"State":{"description":"Current bundle state","oneOf":[{"$ref":"#/components/schemas/FuseWebSharedObjectsFuseSignEnumsSigningBundleState"}]},"ViewMode":{"description":"The bundle view mode setting. If this is blank the business default is selected and the system falls back to the highest available authentication","oneOf":[{"$ref":"#/components/schemas/FuseWebSharedObjectsFuseSignEnumsBundleViewMode"}]},"SigningMode":{"description":"The bundle signing mode","oneOf":[{"$ref":"#/components/schemas/FuseWebSharedObjectsFuseSignEnumsSigningMode"}]},"Settings":{"description":"Bundle settings object","nullable":true,"oneOf":[{"$ref":"#/components/schemas/ExternalApiExternalHandlersDtosResponsesBundleBundleSettingsDto"}]},"Meta":{"type":"string","description":"Bundle lookup metadata","nullable":true}}},"ExternalApiExternalHandlersDtosResponsesBundleBundleCustomerDto":{"type":"object","additionalProperties":false,"properties":{"Customer":{"description":"Customer object","nullable":true,"oneOf":[{"$ref":"#/components/schemas/ExternalApiExternalHandlersDtosResponsesBundleBundleCustomerDetailsDto"}]},"LastSigner":{"type":"boolean","description":"Optional argument which can only be present on ONE customer to specify signer order and they are the last signer"},"SigningGroup":{"type":"integer","description":"Zero based index of signer order. Lower numbers will sign first, then next etc. If multiple customers share the number then they will sign at the same time.","format":"int32"},"CustomerSignUrl":{"type":"string","description":"[Obsolete] The URL where this customer can sign","nullable":true},"CustomerBundleStatus":{"description":"The current status of this customer relative to the bundle. NOTE: At bundle creation this status is Pending because the bundle has been scheduled to be sent (and will send shortly thereafter)","nullable":true,"oneOf":[{"$ref":"#/components/schemas/FuseWebSharedObjectsFuseSignEnumsCustomerBundleStatus"}]},"LockLastSigningGroup":{"type":"boolean","description":"Lock this contact in the last signing group"},"CannotRemoveFromBundleDraft":{"type":"boolean","description":"Don't allow removal of this contact from a draft bundle"}}},"ExternalApiExternalHandlersDtosResponsesBundleBundleCustomerDetailsDto":{"type":"object","additionalProperties":false,"properties":{"CustomerId":{"type":"string","description":"Customer ID","format":"guid"},"TenantId":{"type":"string","description":"Customer tenant ID","format":"guid"},"Name":{"type":"string","description":"Customer Name","nullable":true},"Email":{"type":"string","description":"Customer Email","nullable":true},"PhoneNumber":{"type":"string","description":"Customer mobile number. Required for 2FA. If NoMobile is true this is not required. Must be in international format:   +61413121121","nullable":true},"NoMobile":{"type":"boolean","description":"No Mobile flag, means Phone Number is ignored"},"Meta":{"type":"string","description":"Optional external lookup ID. Can be used for searching","nullable":true},"CannotModify":{"type":"boolean","description":"Don't allow modification of this contact"},"Source":{"description":"Customer data source","oneOf":[{"$ref":"#/components/schemas/FuseWebSharedObjectsFuseSignEnumsSource"}]},"CustomerEditLink":{"type":"string","description":"Link to edit customer details directly","nullable":true},"TotalLiveBundlesForCustomer":{"type":"integer","description":"Number of bundles assigned to the user which are yet to be actioned","format":"int32","nullable":true},"TotalBundlesForCustomer":{"type":"integer","description":"Number of bundles assigned to the user","format":"int32","nullable":true},"PreferredName":{"type":"string","description":"Customer preferred name. The customer will be addressed by this name when signing.","nullable":true}}},"FuseWebSharedObjectsFuseSignEnumsSource":{"type":"string","description":"","enum":["Manual","XPM","Test","CSV","External","APS","MYOB","FileFYI","FileIManage","FYIElite","Karbon","SyncedContact","FuseDocs"]},"FuseWebSharedObjectsFuseSignEnumsCustomerBundleStatus":{"type":"string","description":"","enum":["NoActions","ActionsCompleted","ActionsCancelled","DocumentsRetracted","NotOpenedActionsRequired","NotOpenedFYIOnly","Pending","Rejected","Retracted","Seen"]},"ExternalApiExternalHandlersDtosResponsesBundleBundleDocumentDto":{"type":"object","additionalProperties":false,"properties":{"Document":{"description":"Document information","nullable":true,"oneOf":[{"$ref":"#/components/schemas/ExternalApiExternalHandlersDtosResponsesBundleBundleDocumentDetailsDto"}]},"DocumentOrder":{"type":"integer","description":"Optional: The order that this document will be presented in the pack. Must be a unique integer.","format":"int32"},"CustomerSigners":{"type":"array","description":"A list of customers for which customers must SIGN this document","nullable":true,"items":{"$ref":"#/components/schemas/ExternalApiExternalHandlersDtosResponsesBundleBundleCustomerDto"}},"CustomerViewers":{"type":"array","description":"A list of customers for which customers can VIEW this document","nullable":true,"items":{"$ref":"#/components/schemas/ExternalApiExternalHandlersDtosResponsesBundleBundleCustomerDto"}},"DocumentState":{"description":"The state of the Document.","oneOf":[{"$ref":"#/components/schemas/FuseWebSharedObjectsFuseSignEnumsTransactionalDocumentState"}]}}},"ExternalApiExternalHandlersDtosResponsesBundleBundleDocumentDetailsDto":{"type":"object","additionalProperties":false,"properties":{"DocumentId":{"type":"string","description":"Document ID","format":"guid"},"BundleId":{"type":"string","description":"Related bundle ID. Can be null if not yet assigned to a bundle","format":"guid","nullable":true},"Meta":{"type":"string","description":"Lookup metadata","nullable":true},"DisplayName":{"type":"string","description":"Document Display name","nullable":true},"EstimatedSize":{"type":"integer","description":"Estimated size of the document (Affects inbox limit)","format":"int64"},"SignedPDFDownloadUrl":{"type":"string","description":"URL to download the signed PDF","nullable":true}}},"FuseWebSharedObjectsFuseSignEnumsTransactionalDocumentState":{"type":"string","description":"","enum":["Draft","Live","Signed","Rejected","Retracted","Finalised"]},"FuseWebSharedObjectsFuseSignEnumsBundleReminderMode":{"type":"string","description":"","enum":["DontRemind","DayBeforeDue","OnDueDate"]},"FuseWebSharedObjectsFuseSignEnumsBundleOverdueReminderMode":{"type":"string","description":"","enum":["DontRemind","Weekly"]},"FuseWebSharedObjectsFuseSignEnumsSigningBundleState":{"type":"string","description":"","enum":["Draft","Live","Finalised","Retracted","Rejected","Error","PendingArchive","Archived","DraftDeleted","PurgedArchive","ArchiveNoRetention","NewDraft"]},"FuseWebSharedObjectsFuseSignEnumsBundleViewMode":{"type":"string","description":"","enum":["SmsToSign","SmsToView","EmailToSign","Unauthenticated","EmailToView","Mixed"]},"FuseWebSharedObjectsFuseSignEnumsSigningMode":{"type":"string","description":"","enum":["SignWhole","SignPlacements"]},"ExternalApiExternalHandlersDtosResponsesBundleBundleSettingsDto":{"type":"object","additionalProperties":false,"properties":{"EmailPreference":{"description":"Indicate that no emails should be sent by fusesign and that communication will be sent by webhooks","oneOf":[{"$ref":"#/components/schemas/FuseWebSharedObjectsFuseSignEnumsEmailPreference"}]},"AlwaysSendFinalisationEmail":{"type":"boolean","description":"Always send the finalisation emails regardless of the EmailPreference setting"},"WebhookUrl":{"type":"string","description":"The callback URL for bundle events","nullable":true},"DisableFinaliseNow":{"type":"boolean","description":"Disable the ability for the user to Finalise early from the FuseSign webapp."},"DisableRetract":{"type":"boolean","description":"Disable the ability for the user to Retract the bundle from the FuseSign webapp."},"DisableReminders":{"type":"boolean","description":"Disable the ability for the user to request reminder emails from the FuseSign webapp."},"CustomBranding":{"description":"Specify custom branding for this specific bundle. All properties on this object must be set if the object is specified.","nullable":true,"oneOf":[{"$ref":"#/components/schemas/ExternalApiExternalHandlersDtosResponsesBundleBundleFormattingSettingsDto"}]},"RedirectUrl":{"type":"string","description":"Optional URL to redirect the signer to after signing","nullable":true},"RedirectDelaySeconds":{"type":"integer","description":"Optional Number of seconds to delay before redirecting. Default 10.","format":"int32"},"AuditType":{"description":"How to create the bundle audit (included in the signed document or as a separate signed file","oneOf":[{"$ref":"#/components/schemas/FuseWebSharedObjectsFuseSignEnumsAuditType"}]},"ContextUrl":{"type":"string","description":"Context Url - will display a link back to this link within the FuseSign interface.","nullable":true}}},"FuseWebSharedObjectsFuseSignEnumsEmailPreference":{"type":"string","description":"","enum":["FuseSignEmails","NoFuseSignEmails"]},"ExternalApiExternalHandlersDtosResponsesBundleBundleFormattingSettingsDto":{"type":"object","additionalProperties":false,"properties":{"ButtonColor":{"type":"string","description":"Custom for this bundle - this controls the color of the buttons and key UI items on the page. Accepted #RRGGBB format."},"BannerColor":{"type":"string","description":"Custom for this bundle - this controls the color of the banner across the top of the page and is shown BEHIND the log image. Accepted #RRGGBB format."},"LogoUrl":{"type":"string","description":"Set a custom branding Logo URL for this specific bundle. This must be an absolute URL and is hosted."},"FromName":{"type":"string","description":"This will come through in the email FROM field as well as presented on the bundle signing page.","nullable":true}}},"FuseWebSharedObjectsFuseSignEnumsAuditType":{"type":"string","description":"","enum":["Included","Separate"]},"ExternalApiCommonModelsApiErrorResponse":{"type":"object","additionalProperties":false,"properties":{"Result":{"type":"boolean"},"Message":{"type":"string"},"Errors":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/FuseWebSharedObjectsModelsValidationError"}}}},"FuseWebSharedObjectsModelsValidationError":{"type":"object","additionalProperties":false,"properties":{"Property":{"type":"string"},"ErrorMessage":{"type":"string"},"ErrorCode":{"type":"string"}}}}},"paths":{"/api/Bundle/ListPendingArchive":{"get":{"tags":["Bundle"],"summary":"List Pending archive bundles","description":"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","operationId":"ExternalApiExternalHandlersFeaturesBundleListPendingArchiveListPendingArchiveEndpoint","parameters":[{"name":"TenantId","in":"query","required":true,"description":"FuseSign Tenant Id","schema":{"type":"string","format":"guid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ExternalApiExternalHandlersDtosResponsesBundleBundleDto"}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExternalApiCommonModelsApiErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"string"}}}},"403":{"description":"Forbidden"}}}}}}
```

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

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

```json
{"openapi":"3.0.0","info":{"title":"FuseSign API","version":"v1"},"servers":[{"url":"https://api.fuse.work","description":"FuseSign API"}],"security":[{"OAuthToken":[]},{"ApiKey":[]}],"components":{"securitySchemes":{"OAuthToken":{"type":"oauth2","description":"FuseSign OAuth 2. Use this for most implementations.","name":"FuseSign OAuth 2","flows":{"authorizationCode":{"authorizationUrl":"https://api.fuse.work/api/Session/OAuthRegister","tokenUrl":"https://api.fuse.work/api/Session/OAuthGetToken","refreshUrl":"https://api.fuse.work/api/Session/OAuthRefreshToken","scopes":{"FUSESIGN":"Manage FuseSign Bundles and corresponding data.","FUSESIGN:OWN":"Ability to send bundles and extract bundles created by this user only. Special purpose scope, contact support@fuse.work."}}}},"ApiKey":{"type":"apiKey","description":"Wholesale API Token","name":"X-API-Token","in":"header"}},"schemas":{"ExternalApiExternalHandlersFeaturesBundleGetCustomerSigningLinkGetCustomerSigningLinkResponse":{"type":"object","additionalProperties":false,"properties":{"SigningLink":{"type":"string"}}},"ExternalApiCommonModelsApiErrorResponse":{"type":"object","additionalProperties":false,"properties":{"Result":{"type":"boolean"},"Message":{"type":"string"},"Errors":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/FuseWebSharedObjectsModelsValidationError"}}}},"FuseWebSharedObjectsModelsValidationError":{"type":"object","additionalProperties":false,"properties":{"Property":{"type":"string"},"ErrorMessage":{"type":"string"},"ErrorCode":{"type":"string"}}}}},"paths":{"/api/Bundle/GetCustomerSigningLink":{"get":{"tags":["Bundle"],"summary":"Gets the signing link for a specific customer on a bundle. This requires special permission for your use case, please contact support@fuse.work","description":"Returns the signing URL for a given customer on a bundle. Requires the CanGetSigningLinks developer permission.","operationId":"ExternalApiExternalHandlersFeaturesBundleGetCustomerSigningLinkGetCustomerSigningLinkEndpoint","parameters":[{"name":"TenantId","in":"query","required":true,"description":"FuseSign Tenant Id","schema":{"type":"string","format":"guid"}},{"name":"BundleId","in":"query","required":true,"description":"Bundle Id","schema":{"type":"string","format":"guid"}},{"name":"CustomerId","in":"query","required":true,"description":"Customer Id","schema":{"type":"string","format":"guid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExternalApiExternalHandlersFeaturesBundleGetCustomerSigningLinkGetCustomerSigningLinkResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExternalApiCommonModelsApiErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"string"}}}},"403":{"description":"Forbidden"}}}}}}
```


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://fuseworks.gitbook.io/fusesign/api-references/bundle.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.