HelloSign's API.To get started building, add your HelloSign api_key and client_id to the collection variables.
Additional information is available here.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"5021038","collectionId":"7bc2aa44-a050-410b-9b6c-0c4f95af6f50","publishedId":"S17ru7ui","public":true,"customColor":{"top-bar":"00B3E6","right-sidebar":"F7F8F9","highlight":"00B3E6"},"publishDate":"2019-03-21T21:39:10.000Z"},"item":[{"name":"Account","item":[{"name":"Get Account","id":"4a1fd627-6b3e-4ea1-b9eb-215a4967f604","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.hellosign.com/v3/account","description":"Returns the properties and settings of your Account. Additional information can be found here.
\n","auth":{"type":"basic","basic":{"username":""},"isInherited":true,"source":{"_postman_id":"7bc2aa44-a050-410b-9b6c-0c4f95af6f50","id":"7bc2aa44-a050-410b-9b6c-0c4f95af6f50","name":"Dropbox Sign API","type":"collection"}},"urlObject":{"protocol":"https","path":["v3","account"],"host":["api","hellosign","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"4a1fd627-6b3e-4ea1-b9eb-215a4967f604"},{"name":"Update Account","id":"74d969c3-1db4-410a-a4f9-11e64f6c6280","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"callback_url","value":"example.com/callback","description":"The URL that HelloSign should POST events to. (optional)
\n","type":"text","disabled":true}]},"url":"https://api.hellosign.com/v3/account","description":"Updates the properties and settings of your Account. Additional information can be found here.
\n","auth":{"type":"basic","basic":{"username":""},"isInherited":true,"source":{"_postman_id":"7bc2aa44-a050-410b-9b6c-0c4f95af6f50","id":"7bc2aa44-a050-410b-9b6c-0c4f95af6f50","name":"Dropbox Sign API","type":"collection"}},"urlObject":{"protocol":"https","path":["v3","account"],"host":["api","hellosign","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"74d969c3-1db4-410a-a4f9-11e64f6c6280"},{"name":"Create Account","id":"d5bd1e9b-0cab-4875-b31b-9b44eea754ac","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"email_address","value":"alice@example.com","description":"The email address to create a new Account for.
\n","type":"text"}]},"url":"https://api.hellosign.com/v3/account/create","description":"Creates a new HelloSign Account that is associated with the specified email_address. Additional information can be found here.
Email address to run the verification for.
\n","type":"text"}]},"url":"https://api.hellosign.com/v3/account/verify","description":"Verifies whether an HelloSign Account exists for the given email address. NOTE This method is restricted to paid API users.
\nAdditional information can be found here.
\n","auth":{"type":"basic","basic":{"username":""},"isInherited":true,"source":{"_postman_id":"7bc2aa44-a050-410b-9b6c-0c4f95af6f50","id":"7bc2aa44-a050-410b-9b6c-0c4f95af6f50","name":"Dropbox Sign API","type":"collection"}},"urlObject":{"protocol":"https","path":["v3","account","verify"],"host":["api","hellosign","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"2ccf6685-52da-4314-aa20-7ccc07f2fb42"}],"id":"6e6b4ac6-28e5-4434-b24a-dc6d8ba32289","description":"Contains information about an account and its settings. Additional information can be found here.
\n","event":[{"listen":"prerequest","script":{"id":"eaa9565d-783a-4c7e-b27c-dd0ffbc1ee28","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"9d1c2ad6-94ea-4d19-a408-8f263e804fd1","type":"text/javascript","exec":[""]}}],"_postman_id":"6e6b4ac6-28e5-4434-b24a-dc6d8ba32289","auth":{"type":"basic","basic":{"username":""},"isInherited":true,"source":{"_postman_id":"7bc2aa44-a050-410b-9b6c-0c4f95af6f50","id":"7bc2aa44-a050-410b-9b6c-0c4f95af6f50","name":"Dropbox Sign API","type":"collection"}}},{"name":"Signature Request","item":[{"name":"Get Signature Request","id":"553e16ff-723d-46e2-b13e-144a353e467b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.hellosign.com/v3/signature_request/:signature_request_id","description":"Returns the status of the SignatureRequest specified by the signature_request_id parameter. Additional information can be found here.
Returns a list of SignatureRequests that you can access. This includes SignatureRequests you have sent as well as received, but not ones that you have been CCed on.
\nTake a look at our search guide to learn more about querying signature requests.
\nAdditional information can be found here.
\n","auth":{"type":"basic","basic":{"username":""},"isInherited":true,"source":{"_postman_id":"7bc2aa44-a050-410b-9b6c-0c4f95af6f50","id":"7bc2aa44-a050-410b-9b6c-0c4f95af6f50","name":"Dropbox Sign API","type":"collection"}},"urlObject":{"protocol":"https","path":["v3","signature_request","list"],"host":["api","hellosign","com"],"query":[{"key":"page_size","value":"1"}],"variable":[]}},"response":[],"_postman_id":"ca02e87d-c522-489d-b91a-1fcf97549509"},{"name":"Send Signature Request","id":"73af017e-fd91-44ea-8205-de0a47147305","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"test_mode","value":"1","description":"Whether this is a test, the signature request will not be legally binding if set to 1. Defaults to 0. (optional)
\n","type":"text"},{"key":"file[0]","description":"Use file[] to indicate the uploaded file(s) to send for signature.
\n","type":"file","value":null},{"key":"file_url[0]","value":"http://www.example.com/contract.pdf","description":"Use file_url[] to have HelloSign download the file(s) to send for signature.
\n","type":"text","disabled":true},{"key":"title","value":"Example Signature Request Title","description":"The title you want to assign to the SignatureRequest. (optional)
\n","type":"text","disabled":true},{"key":"subject","value":"Example Email Subject","description":"The subject in the email that will be sent to the signers. (optional)
\n","type":"text","disabled":true},{"key":"message","value":"Example Email Message","description":"The custom message in the email that will be sent to the signers. (optional)
\n","type":"text","disabled":true},{"key":"signing_redirect_url","value":"http://www.example.com","description":"The URL you want the signer redirected to after they successfully sign. (optional)
\n","type":"text","disabled":true},{"key":"signers[0][name]","value":"Alice","description":"The name of the signer. %i% is an integer that should be unique for each signer.
\n","type":"text"},{"key":"signers[0][email_address]","value":"alice@example.com","description":"The email address of the signer. %i% is an integer that should be unique for each signer.
\n","type":"text"},{"key":"signers[0][order]","value":"0","description":"The order the signer is required to sign in. %i% is an integer that should be unique for each signer. (optional)
\n","type":"text","disabled":true},{"key":"signers[0][pin]","value":"1234","description":"The 4- to 12-character access code that will secure this signer's signature page. (optional)
\n","type":"text","disabled":true},{"key":"signers[0][group]","value":"Example Signer Group","description":"To send to a signer group, specify the name of the group and assign the signers that are part of it under the same index. (optional)
\n","type":"text","disabled":true},{"key":"signers[0][1][name]","value":"Alice","description":"Any of the signers is eligible to sign for the entire group. (optional)
\n","type":"text","disabled":true},{"key":"signers[0][1][email_address]","value":"alice@example.com","description":"Any of the signers is eligible to sign for the entire group. (optional)
\n","type":"text","disabled":true},{"key":"signers[0][2][name]","value":"Bob","description":"Any of the signers is eligible to sign for the entire group. (optional)
\n","type":"text","disabled":true},{"key":"signers[0][2][email_address]","value":"bob@example.com","description":"Any of the signers is eligible to sign for the entire group. (optional)
\n","type":"text","disabled":true},{"key":"attachments[0][name]","value":"Example Attachment","description":"The name of attachment. (optional)
\n","type":"text","disabled":true},{"key":"attachments[0][instructions]","value":"Add your attachment","description":"The instructions for uploading the attachment. (optional)
\n","type":"text","disabled":true},{"key":"attachments[0][signer_index]","value":"0","description":"The signer's unique number, see signers[%i%][name] for more details.
\n","type":"text","disabled":true},{"key":"attachments[0][required]","value":"1","description":"Determines if the attachment must be uploaded. (optional)
\n","type":"text","disabled":true},{"key":"custom_fields","value":"[{\"name\": \"Address\", \"value\": \"123 Main St.\"}, {\"name\": \"zip\", \"value\": \"92606\"}]","description":"A JSON array defining values and options for custom fields from Text Tags or form_fields_per_document. (optional)
\n","type":"text","disabled":true},{"key":"cc_email_addresses[0]","value":"charlie@example.com","description":"The email addresses that should be CCed. (optional)
\n","type":"text","disabled":true},{"key":"use_text_tags","value":"1","description":"Send with a value of 1 if you wish to enable Text Tags parsing in your document. Defaults to 0. (optional)
\n","type":"text","disabled":true},{"key":"hide_text_tags","value":"0","description":"Send with a value of 1 if you wish to enable automatic Text Tag removal. Defaults to 0. (optional)
\n","type":"text","disabled":true},{"key":"metadata[example_key]","value":"Example Metadata Value","description":"Key-value data that should be attached to the signature request. (optional)
\n","type":"text","disabled":true},{"key":"client_id","value":"","description":"The client ID of the ApiApp you want to associate with this request. (optional)
\n","type":"text","disabled":true},{"key":"allow_decline","value":"0","description":"Allows signers to decline to sign a document if set to 1. Defaults to 0. (optional)
\n","type":"text","disabled":true},{"key":"allow_reassign","value":"0","description":"Allows signers to reassign their signature requests to other signers if set to 1. Defaults to 0. (optional)
\n","type":"text","disabled":true},{"key":"form_fields_per_document","value":"[[{\"api_id\": \"field1\", \"name\": \"address\", \"type\": \"text\", \"x\": 160, \"y\": 80, \"page\": 1, \"width\": 206, \"height\": 32, \"required\": true, \"signer\": 0}]]","description":"The fields that should appear on the document, expressed as a 2-dimensional JSON array serialized to a string. (optional)
\n","type":"text","disabled":true}]},"url":"https://api.hellosign.com/v3/signature_request/send","description":"Creates and sends a new SignatureRequest with the submitted documents. If form_fields_per_document is not specified, a signature page will be affixed where all signers will be required to add their signature, signifying their agreement to all contained documents.
Additional information can be found here.
\n","auth":{"type":"basic","basic":{"username":""},"isInherited":true,"source":{"_postman_id":"7bc2aa44-a050-410b-9b6c-0c4f95af6f50","id":"7bc2aa44-a050-410b-9b6c-0c4f95af6f50","name":"Dropbox Sign API","type":"collection"}},"urlObject":{"protocol":"https","path":["v3","signature_request","send"],"host":["api","hellosign","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"73af017e-fd91-44ea-8205-de0a47147305"},{"name":"Send with Template","id":"a33eb557-87b2-4934-9f2f-2971269eb867","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"test_mode","value":"1","description":"Whether this is a test, the signature request will not be legally binding if set to 1. Defaults to 0. (optional)
\n","type":"text"},{"key":"allow_decline","value":"0","description":"Allows signers to decline to sign a document if set to 1. Defaults to 0. (optional)
\n","type":"text","disabled":true},{"key":"template_id","value":":template_id","description":"Use template_id to create a SignatureRequest from a single Template. Use template_ids[%i%] to create a SignatureRequest from multiple templates, where %i% is an integer indicating the order in which the template will be used.
\n","type":"text"},{"key":"title","value":"Example Signature Request Title","description":"The title you want to assign to the SignatureRequest. (optional)
\n","type":"text","disabled":true},{"key":"subject","value":"Example Email Subject","description":"The subject in the email that will be sent to the signers. (optional)
\n","type":"text","disabled":true},{"key":"message","value":"Example Email Message","description":"The custom message in the email that will be sent to the signers. (optional)
\n","type":"text","disabled":true},{"key":"signing_redirect_url","value":"http://www.example.com","description":"The URL you want the signer redirected to after they successfully sign. (optional)
\n","type":"text","disabled":true},{"key":"signers[ExampleRole][name]","value":"Alice","description":"The name of the signer filling the role of RoleName. RoleName is case-sensitive.
\n","type":"text"},{"key":"signers[ExampleRole][email_address]","value":"alice@example.com","description":"The email address of the signer filling the role of RoleName. RoleName is case-sensitive.
\n","type":"text"},{"key":"signers[ExampleRole][pin]","value":"1234","description":"The 4- to 12-character access code that will secure this signer's signature page. RoleName is case-sensitive.
\n","type":"text","disabled":true},{"key":"signers[ExampleRole][group]","value":"Example Signer Group","description":"To send to a signer group, specify the name of the group and assign the signers that are part of it under the same RoleName. (optional)
\n","type":"text","disabled":true},{"key":"signers[ExampleRole][1][name]","value":"Alice","description":"Any of the signers is eligible to sign for the entire group. (optional)
\n","type":"text","disabled":true},{"key":"signers[ExampleRole][1][email_address]","value":"alice@example.com","description":"Any of the signers is eligible to sign for the entire group. (optional)
\n","type":"text","disabled":true},{"key":"signers[ExampleRole][2][name]","value":"Bob","description":"Any of the signers is eligible to sign for the entire group. (optional)
\n","type":"text","disabled":true},{"key":"signers[ExampleRole][2][email_address]","value":"bob@example.com","description":"Any of the signers is eligible to sign for the entire group. (optional)
\n","type":"text","disabled":true},{"key":"ccs[ExampleCCRole][email_address]","value":"charlie@example.com","description":"The email address of the CC filling the role of RoleName. Required when a CC role exists for the Template. (optional)
\n","type":"text","disabled":true},{"key":"custom_fields","value":"[{\"name\": \"Address\", \"value\": \"123 Main St.\"}, {\"name\": \"zip\", \"value\": \"92606\"}]","description":"A JSON array defining values and options for custom fields. Required when a custom field exists in the Template. (optional)
\n","type":"text","disabled":true},{"key":"metadata[example_key]","value":"Example Metadata Value","description":"Key-value data that should be attached to the signature request. (optional)
\n","type":"text","disabled":true},{"key":"client_id","value":"","description":"The client ID of the ApiApp you want to associate with this request. (optional)
\n","type":"text","disabled":true},{"key":"file[0]","description":"Append additional files to the signature request. (optional)
\n","type":"file","value":null,"disabled":true}]},"url":"https://api.hellosign.com/v3/signature_request/send_with_template","description":"Creates and sends a new SignatureRequest based off of the Template specified with the template_id parameter. Additional information can be found here.
Whether this is a test, the signature request will not be legally binding if set to 1. Defaults to 0. (optional)
\n","type":"text"},{"key":"allow_decline","value":"0","description":"Allows signers to decline to sign a document if set to 1. Defaults to 0. (optional)
\n","type":"text","disabled":true},{"key":"template_id","value":":template_id","description":"Use template_id to create a SignatureRequest from a single Template. Use template_ids[%i%] to create a SignatureRequest from multiple templates, where %i% is an integer indicating the order in which the template will be used.
\n","type":"text"},{"key":"title","value":"Example Signature Request Title","description":"The title you want to assign to the SignatureRequest. (optional)
\n","type":"text","disabled":true},{"key":"subject","value":"Example Email Subject","description":"The subject in the email that will be sent to the signers. (optional)
\n","type":"text","disabled":true},{"key":"message","value":"Example Email Message","description":"The custom message in the email that will be sent to the signers. (optional)
\n","type":"text","disabled":true},{"key":"signing_redirect_url","value":"http://www.calbears.com","description":"The URL you want the signer redirected to after they successfully sign. (optional)
\n","type":"text","disabled":true},{"key":"signer_file","description":"A CSV file defining values and options for signer fields. Required unless a signer_list is used, you may not use both.
\n","type":"file","value":null,"disabled":true},{"key":"signer_list","value":"[{\n\t\t\"signers\": {\n\t\t\t\"Client\": {\n\t\t\t\t\"name\": \"Bulk Send Signer 1\",\n\t\t\t\t\"email_address\": \"bulksign1@example.com\"\n\t\t\t}\n\t\t},\n\t\t\"custom_fields\": {\n\t\t\t\"address\": \"100 Main St.\"\n\t\t}\n\t},\n\t{\n\t\t\"signers\": {\n\t\t\t\"Client\": {\n\t\t\t\t\"name\": \"Bulk Send Signer 2\",\n\t\t\t\t\"email_address\": \"bulksign2@example.com\"\n\t\t\t}\n\t\t},\n\t\t\"custom_fields\": {\n\t\t\t\"address\": \"2421 Durant Ave.\"\n\t\t}\n\t}\n]","description":"A JSON array defining values and options for signer fields. Required unless a signer_file is used, you may not use both.
\n","type":"text"},{"key":"custom_fields","value":"[{\"name\": \"zip\", \"value\": \"92606\"}]","description":"A JSON array defining values and options for custom fields. Required when a custom field exists in the Template. (optional)
\n","type":"text","disabled":true},{"key":"ccs[ExampleCCRole][email_address]","value":"cc@example.com","description":"The email address of the CC filling the role of RoleName. Required when a CC role exists for the Template. (optional)
\n","type":"text","disabled":true},{"key":"metadata[example_key]","value":"Example Metadata Value","description":"Key-value data that should be attached to the signature request. (optional)
\n","type":"text","disabled":true},{"key":"client_id","value":"","description":"The client ID of the ApiApp you want to associate with this request. (optional)
\n","type":"text","disabled":true}]},"url":"https://api.hellosign.com/v3/signature_request/bulk_send_with_template","description":"Creates BulkSendJob which sends up to 250 SignatureRequests in bulk based off of the Template specified with the template_id parameter. Note: Only available for Gold plan and higher.
Additional information can be found here.
\n","auth":{"type":"basic","basic":{"username":""},"isInherited":true,"source":{"_postman_id":"7bc2aa44-a050-410b-9b6c-0c4f95af6f50","id":"7bc2aa44-a050-410b-9b6c-0c4f95af6f50","name":"Dropbox Sign API","type":"collection"}},"urlObject":{"protocol":"https","path":["v3","signature_request","bulk_send_with_template"],"host":["api","hellosign","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"a239a7c8-bc04-43c0-a42a-0a768620d67d"},{"name":"Send Request Reminder","id":"1db1782f-84f9-4677-9da9-9cb52e0ea237","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"email_address","value":"alice@example.com","description":"The email address of the signer to send a reminder to.
\n","type":"text"},{"key":"name","value":"Alice","description":"The name of the signer to send a reminder to. (optional)
\n","type":"text","disabled":true}]},"url":"https://api.hellosign.com/v3/signature_request/remind/:signature_request_id","description":"Sends an email to the signer reminding them to sign the signature request. You cannot send a reminder within 1 hour of the last reminder that was sent. This includes manual AND automatic reminders.
\nAdditional information can be found here.
\n","auth":{"type":"basic","basic":{"username":""},"isInherited":true,"source":{"_postman_id":"7bc2aa44-a050-410b-9b6c-0c4f95af6f50","id":"7bc2aa44-a050-410b-9b6c-0c4f95af6f50","name":"Dropbox Sign API","type":"collection"}},"urlObject":{"protocol":"https","path":["v3","signature_request","remind",":signature_request_id"],"host":["api","hellosign","com"],"query":[],"variable":[{"type":"any","value":"","key":"signature_request_id"}]}},"response":[],"_postman_id":"1db1782f-84f9-4677-9da9-9cb52e0ea237"},{"name":"Update Signature Request","id":"05ef730a-8230-4f9d-b3df-b94ff4cb3d37","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"signature_id","value":"","description":"The signature ID for the recipient.
\n","type":"text"},{"key":"email_address","value":"alice@example.com","description":"The new email address for the recipient.
\n","type":"text"}]},"url":"https://api.hellosign.com/v3/signature_request/update/:signature_request_id","description":"Updates the email address for a given signer on a signature request. You can listen for the \"signature_request_email_bounce\" event on your app or account to detect bounced emails, and respond with this method.
Additional information can be found here.
\n","auth":{"type":"basic","basic":{"username":""},"isInherited":true,"source":{"_postman_id":"7bc2aa44-a050-410b-9b6c-0c4f95af6f50","id":"7bc2aa44-a050-410b-9b6c-0c4f95af6f50","name":"Dropbox Sign API","type":"collection"}},"urlObject":{"protocol":"https","path":["v3","signature_request","update",":signature_request_id"],"host":["api","hellosign","com"],"query":[],"variable":[{"type":"any","value":"","key":"signature_request_id"}]}},"response":[],"_postman_id":"05ef730a-8230-4f9d-b3df-b94ff4cb3d37"},{"name":"Cancel Incomplete Signature Request","id":"3e84bead-a379-496f-9f3a-93f86036e0cc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":""},"url":"https://api.hellosign.com/v3/signature_request/cancel/:signature_request_id","description":"Cancels an incomplete signature request. This action is not reversible.
\nSigners will no longer be able to sign and the request will be canceled. Cancelation is asynchronous and a successful call to this endpoint will return an empty 200 OK response if the signature request is eligible to be canceled and has been successfully queued.
\nTo be eligible for cancelation, a signature request must have been sent successfully, must not yet have been signed by all signers, and you must either be the sender or own the API app under which it was sent. A partially signed signature request can be canceled.
\nIt is recommended that a callback handler be implemented to listen for the \"signature_request_canceled\" event. This notification will be sent when the cancelation has completed successfully. If a callback handler has been configured and the event has not been received within 60 minutes of making the call, check the status of the request in the API Dashboard and retry the cancelation if necessary.
Additional information can be found here.
\n","auth":{"type":"basic","basic":{"username":""},"isInherited":true,"source":{"_postman_id":"7bc2aa44-a050-410b-9b6c-0c4f95af6f50","id":"7bc2aa44-a050-410b-9b6c-0c4f95af6f50","name":"Dropbox Sign API","type":"collection"}},"urlObject":{"protocol":"https","path":["v3","signature_request","cancel",":signature_request_id"],"host":["api","hellosign","com"],"query":[],"variable":[{"type":"any","value":"","key":"signature_request_id"}]}},"response":[],"_postman_id":"3e84bead-a379-496f-9f3a-93f86036e0cc"},{"name":"Remove Signature Request Access","id":"76750682-d9e9-43c2-bda1-60f17fbc3606","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"signature_id","value":"","description":"The signature ID for the recipient.
\n","type":"text"},{"key":"email_address","value":"alice@example.com","description":"The new email address for the recipient.
\n","type":"text"}]},"url":"https://api.hellosign.com/v3/signature_request/remove/:signature_request_id","description":"Removes your access to a completed signature request. This action is not reversible.
\nThe signature request must be fully executed by all parties (signed or declined to sign). Other parties will continue to maintain access to the completed signature request document(s).
\nUnlike /signature_request/cancel, this endpoint is synchronous and your access will be immediately removed. Upon successful removal, this endpoint will return a 200 OK response.
\nAdditional information can be found here.
\n","auth":{"type":"basic","basic":{"username":""},"isInherited":true,"source":{"_postman_id":"7bc2aa44-a050-410b-9b6c-0c4f95af6f50","id":"7bc2aa44-a050-410b-9b6c-0c4f95af6f50","name":"Dropbox Sign API","type":"collection"}},"urlObject":{"protocol":"https","path":["v3","signature_request","remove",":signature_request_id"],"host":["api","hellosign","com"],"query":[],"variable":[{"type":"any","value":"","key":"signature_request_id"}]}},"response":[],"_postman_id":"76750682-d9e9-43c2-bda1-60f17fbc3606"},{"name":"Get Files","id":"1c3377af-7586-49f0-805f-28c1af1cb5cf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.hellosign.com/v3/signature_request/files/:signature_request_id?get_url=true","description":"Obtain a copy of the current documents specified by the signature_request_id parameter. Additional information can be found here.
Whether this is a test, the signature request will not be legally binding if set to 1. Defaults to 0. (optional)
\n","type":"text"},{"key":"client_id","value":"","description":"Client ID of the app you're using to create this embedded signature request.
\n","type":"text"},{"key":"file[0]","description":"Use file[] to indicate the uploaded file(s) to send for signature.
\n","type":"file","value":null},{"key":"file_url[0]","value":"http://www.example.com/contract.pdf","description":"Use file_url[] to have HelloSign download the file(s) to send for signature.
\n","type":"text","disabled":true},{"key":"title","value":"Example Signature Request Title","description":"The title you want to assign to the SignatureRequest. (optional)
\n","type":"text","disabled":true},{"key":"subject","value":"Example Email Subject","description":"The subject in the email that will be sent to the signers. (optional)
\n","type":"text","disabled":true},{"key":"message","value":"Example Email Message","description":"The custom message in the email that will be sent to the signers. (optional)
\n","type":"text","disabled":true},{"key":"signers[0][name]","value":"Alice","description":"The name of the signer. %i% is an integer that should be unique for each signer.
\n","type":"text"},{"key":"signers[0][email_address]","value":"alice@example.com","description":"The email address of the signer. %i% is an integer that should be unique for each signer.
\n","type":"text"},{"key":"signers[0][order]","value":"0","description":"The order the signer is required to sign in. %i% is an integer that should be unique for each signer. (optional)
\n","type":"text","disabled":true},{"key":"signers[0][pin]","value":"1234","description":"The 4- to 12-character access code that will secure this signer's signature page. (optional)
\n","type":"text","disabled":true},{"key":"attachments[0][name]","value":"Example Attachment","description":"The name of attachment. (optional)
\n","type":"text","disabled":true},{"key":"attachments[0][instructions]","value":"Add your attachment","description":"The instructions for uploading the attachment. (optional)
\n","type":"text","disabled":true},{"key":"attachments[0][signer_index]","value":"0","description":"The signer's unique number, see signers[%i%][name] for more details.
\n","type":"text","disabled":true},{"key":"attachments[0][required]","value":"1","description":"Determines if the attachment must be uploaded. (optional)
\n","type":"text","disabled":true},{"key":"custom_fields","value":"[{\"name\": \"Address\", \"value\": \"123 Main St.\"}, {\"name\": \"zip\", \"value\": \"92606\"}]","description":"A JSON array defining values and options for custom fields from Text Tags or form_fields_per_document. (optional)
\n","type":"text","disabled":true},{"key":"cc_email_addresses[0]","value":"charlie@example.com","description":"The email addresses that should be CCed. (optional)
\n","type":"text","disabled":true},{"key":"use_text_tags","value":"1","description":"Send with a value of 1 if you wish to enable Text Tags parsing in your document. Defaults to 0. (optional)
\n","type":"text","disabled":true},{"key":"hide_text_tags","value":"0","description":"Send with a value of 1 if you wish to enable automatic Text Tag removal. Defaults to 0. (optional)
\n","type":"text","disabled":true},{"key":"metadata[example_key]","value":"Example Metadata Value","description":"Key-value data that should be attached to the signature request. (optional)
\n","type":"text","disabled":true},{"key":"allow_decline","value":"0","description":"Allows signers to decline to sign a document if set to 1. Defaults to 0. (optional)
\n","type":"text","disabled":true},{"key":"allow_reassign","value":"0","description":"Allows signers to reassign their signature requests to other signers if set to 1. Defaults to 0. (optional)
\n","type":"text","disabled":true},{"key":"form_fields_per_document","value":"[[{\"api_id\": \"field1\", \"name\": \"address\", \"type\": \"text\", \"x\": 160, \"y\": 80, \"page\": 1, \"width\": 206, \"height\": 32, \"required\": true, \"signer\": 0}]]","description":"The fields that should appear on the document, expressed as a 2-dimensional JSON array serialized to a string. (optional)
\n","type":"text","disabled":true}]},"url":"https://api.hellosign.com/v3/signature_request/create_embedded","description":"Creates a new SignatureRequest with the submitted documents to be signed in an embedded iFrame. If form_fields_per_document is not specified, a signature page will be affixed where all signers will be required to add their signature, signifying their agreement to all contained documents. Note: embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on HelloSign.
Additional information can be found here.
\n","auth":{"type":"basic","basic":{"username":""},"isInherited":true,"source":{"_postman_id":"7bc2aa44-a050-410b-9b6c-0c4f95af6f50","id":"7bc2aa44-a050-410b-9b6c-0c4f95af6f50","name":"Dropbox Sign API","type":"collection"}},"urlObject":{"protocol":"https","path":["v3","signature_request","create_embedded"],"host":["api","hellosign","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"36c48376-3459-4d1e-933f-4a70298cc5e6"},{"name":"Send Embedded Signature Request with Template","id":"d377cf11-4174-47dd-adea-1ccdeb1245a1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"test_mode","value":"1","description":"Whether this is a test, the signature request will not be legally binding if set to 1. Defaults to 0. (optional)
\n","type":"text"},{"key":"allow_decline","value":"0","description":"Allows signers to decline to sign a document if set to 1. Defaults to 0. (optional)
\n","type":"text","disabled":true},{"key":"client_id","value":"","description":"Client ID of the app you're using to create this embedded signature request.
\n","type":"text"},{"key":"template_id","value":":template_id","description":"Use template_id to create a SignatureRequest from a single Template. Use template_ids[%i%] to create a SignatureRequest from multiple templates, where %i% is an integer indicating the order in which the template will be used.
\n","type":"text"},{"key":"title","value":"Example Signature Request Title","description":"The title you want to assign to the SignatureRequest. (optional)
\n","type":"text","disabled":true},{"key":"subject","value":"Example Email Subject","description":"The subject in the email that will be sent to the signers. (optional)
\n","type":"text","disabled":true},{"key":"message","value":"Example Email Message","description":"The custom message in the email that will be sent to the signers. (optional)
\n","type":"text","disabled":true},{"key":"signers[ExampleRole][name]","value":"Alice","description":"The name of the signer filling the role of RoleName. RoleName is case-sensitive.
\n","type":"text"},{"key":"signers[ExampleRole][email_address]","value":"alice@example.com","description":"The email address of the signer filling the role of RoleName. RoleName is case-sensitive.
\n","type":"text"},{"key":"signers[ExampleRole][pin]","value":"1234","description":"The 4- to 12-character access code that will secure this signer's signature page. RoleName is case-sensitive.
\n","type":"text","disabled":true},{"key":"ccs[ExampleCCRole][email_address]","value":"charlie@example.com","description":"The email address of the CC filling the role of RoleName. Required when a CC role exists for the Template. (optional)
\n","type":"text","disabled":true},{"key":"custom_fields","value":"[{\"name\": \"Address\", \"value\": \"123 Main St.\"}, {\"name\": \"zip\", \"value\": \"92606\"}]","description":"A JSON array defining values and options for custom fields. Required when a custom field exists in the Template. (optional)
\n","type":"text","disabled":true},{"key":"metadata[example_key]","value":"Example Metadata Value","description":"Key-value data that should be attached to the signature request. (optional)
\n","type":"text","disabled":true},{"key":"file[0]","description":"Append additional files to the signature request. (optional)
\n","type":"file","value":null,"disabled":true},{"key":"file_url[0]","value":"http://www.example.com/contract.pdf","description":"Append additional files to the signature request. (optional)
\n","type":"text","disabled":true}]},"url":"https://api.hellosign.com/v3/signature_request/create_embedded_with_template","description":"Creates a new SignatureRequest based on the given Template to be signed in an embedded iFrame. Note: embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on HelloSign.
\nAdditional information can be found here.
\n","auth":{"type":"basic","basic":{"username":""},"isInherited":true,"source":{"_postman_id":"7bc2aa44-a050-410b-9b6c-0c4f95af6f50","id":"7bc2aa44-a050-410b-9b6c-0c4f95af6f50","name":"Dropbox Sign API","type":"collection"}},"urlObject":{"protocol":"https","path":["v3","signature_request","create_embedded_with_template"],"host":["api","hellosign","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"d377cf11-4174-47dd-adea-1ccdeb1245a1"},{"name":"Destroy Signature Request","id":"bb922420-61fb-44c3-850f-51884059178c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"test_mode","value":"1","description":"Whether this is a test, the signature request will not be legally binding if set to 1. Defaults to 0. (optional)
\n","type":"text"},{"key":"allow_decline","value":"0","description":"Allows signers to decline to sign a document if set to 1. Defaults to 0. (optional)
\n","type":"text","disabled":true},{"key":"client_id","value":"","description":"Client ID of the app you're using to create this embedded signature request.
\n","type":"text"},{"key":"template_id","value":":template_id","description":"Use template_id to create a SignatureRequest from a single Template. Use template_ids[%i%] to create a SignatureRequest from multiple templates, where %i% is an integer indicating the order in which the template will be used.
\n","type":"text"},{"key":"title","value":"Example Signature Request Title","description":"The title you want to assign to the SignatureRequest. (optional)
\n","type":"text","disabled":true},{"key":"subject","value":"Example Email Subject","description":"The subject in the email that will be sent to the signers. (optional)
\n","type":"text","disabled":true},{"key":"message","value":"Example Email Message","description":"The custom message in the email that will be sent to the signers. (optional)
\n","type":"text","disabled":true},{"key":"signers[ExampleRole][name]","value":"Alice","description":"The name of the signer filling the role of RoleName. RoleName is case-sensitive.
\n","type":"text"},{"key":"signers[ExampleRole][email_address]","value":"alice@example.com","description":"The email address of the signer filling the role of RoleName. RoleName is case-sensitive.
\n","type":"text"},{"key":"signers[ExampleRole][pin]","value":"1234","description":"The 4- to 12-character access code that will secure this signer's signature page. RoleName is case-sensitive.
\n","type":"text","disabled":true},{"key":"ccs[ExampleCCRole][email_address]","value":"charlie@example.com","description":"The email address of the CC filling the role of RoleName. Required when a CC role exists for the Template. (optional)
\n","type":"text","disabled":true},{"key":"custom_fields","value":"[{\"name\": \"Address\", \"value\": \"123 Main St.\"}, {\"name\": \"zip\", \"value\": \"92606\"}]","description":"A JSON array defining values and options for custom fields. Required when a custom field exists in the Template. (optional)
\n","type":"text","disabled":true},{"key":"metadata[example_key]","value":"Example Metadata Value","description":"Key-value data that should be attached to the signature request. (optional)
\n","type":"text","disabled":true},{"key":"file[0]","description":"Append additional files to the signature request. (optional)
\n","type":"file","value":null,"disabled":true},{"key":"file_url[0]","value":"http://www.example.com/contract.pdf","description":"Append additional files to the signature request. (optional)
\n","type":"text","disabled":true}]},"url":"https://api.hellosign.com/v3/signature_request/destroy/:signature_request_id","description":"Destroys a SignatureRequest. Note: User must be pre-approved to destroy documents.
\n","auth":{"type":"basic","basic":{"username":""},"isInherited":true,"source":{"_postman_id":"7bc2aa44-a050-410b-9b6c-0c4f95af6f50","id":"7bc2aa44-a050-410b-9b6c-0c4f95af6f50","name":"Dropbox Sign API","type":"collection"}},"urlObject":{"protocol":"https","path":["v3","signature_request","destroy",":signature_request_id"],"host":["api","hellosign","com"],"query":[],"variable":[{"type":"any","value":"","key":"signature_request_id"}]}},"response":[],"_postman_id":"bb922420-61fb-44c3-850f-51884059178c"}],"id":"70398e36-d3cb-4088-ba60-8e1d27e79359","description":"Contains information regarding documents that need to be signed. Additional information can be found here.
\n","event":[{"listen":"prerequest","script":{"id":"a646002a-c43d-4f2a-94bc-b695072ae706","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"39ab0dd7-5b0e-4ba0-ac9c-91f4ba2c9d4f","type":"text/javascript","exec":[""]}}],"_postman_id":"70398e36-d3cb-4088-ba60-8e1d27e79359","auth":{"type":"basic","basic":{"username":""},"isInherited":true,"source":{"_postman_id":"7bc2aa44-a050-410b-9b6c-0c4f95af6f50","id":"7bc2aa44-a050-410b-9b6c-0c4f95af6f50","name":"Dropbox Sign API","type":"collection"}}},{"name":"Template","item":[{"name":"Get Template","id":"4980ad8f-9f84-4507-b30a-9da2a1997394","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.hellosign.com/v3/template/:template_id","description":"Returns the Template specified by the template_id parameter. Additional information can be found here.
Returns a list of the Templates that are accessible by you. Take a look at our search guide to learn more about querying templates.
\nAdditional information can be found here.
\n","auth":{"type":"basic","basic":{"username":""},"isInherited":true,"source":{"_postman_id":"7bc2aa44-a050-410b-9b6c-0c4f95af6f50","id":"7bc2aa44-a050-410b-9b6c-0c4f95af6f50","name":"Dropbox Sign API","type":"collection"}},"urlObject":{"protocol":"https","path":["v3","template","list"],"host":["api","hellosign","com"],"query":[{"key":"page_size","value":"1"}],"variable":[]}},"response":[],"_postman_id":"ccfb2325-a0ba-41ff-a09d-cab959ee1e13"},{"name":"Add User Access to Template","id":"2933a38a-2fff-4104-8f55-6bd500c90e9e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"account_id","value":"1234567","description":"The id or email address of the Account to give access to the Template. The account id prevails if both are provided.
\n","type":"text"},{"key":"email_address","value":"alice@example.com","description":"The id or email address of the Account to give access to the Template. The account id prevails if both are provided.
\n","type":"text","disabled":true}]},"url":"https://api.hellosign.com/v3/template/add_user/:template_id","description":"Gives the specified Account access to the specified Template. The specified Account must be a part of your Team. Additional information can be found here.
\n","auth":{"type":"basic","basic":{"username":""},"isInherited":true,"source":{"_postman_id":"7bc2aa44-a050-410b-9b6c-0c4f95af6f50","id":"7bc2aa44-a050-410b-9b6c-0c4f95af6f50","name":"Dropbox Sign API","type":"collection"}},"urlObject":{"protocol":"https","path":["v3","template","add_user",":template_id"],"host":["api","hellosign","com"],"query":[],"variable":[{"type":"any","key":"template_id"}]}},"response":[],"_postman_id":"2933a38a-2fff-4104-8f55-6bd500c90e9e"},{"name":"Remove User Access to Template","id":"8204d9d5-d7e6-44e9-97aa-309b89656cd4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"account_id","value":"1234567","description":"The id or email address of the Account to remove access to the Template. The account id prevails if both are provided.
\n","type":"text"},{"key":"email_address","value":"alice@example.com","description":"The id or email address of the Account to remove access to the Template. The account id prevails if both are provided.
\n","type":"text","disabled":true}]},"url":"https://api.hellosign.com/v3/template/remove_user/:template_id","description":"Removes the specified Account's access to the specified Template. Additional information can be found here.
\n","auth":{"type":"basic","basic":{"username":""},"isInherited":true,"source":{"_postman_id":"7bc2aa44-a050-410b-9b6c-0c4f95af6f50","id":"7bc2aa44-a050-410b-9b6c-0c4f95af6f50","name":"Dropbox Sign API","type":"collection"}},"urlObject":{"protocol":"https","path":["v3","template","remove_user",":template_id"],"host":["api","hellosign","com"],"query":[],"variable":[{"type":"any","key":"template_id"}]}},"response":[],"_postman_id":"8204d9d5-d7e6-44e9-97aa-309b89656cd4"},{"name":"Create Embedded Template Draft","id":"a4593af0-60ea-4a4b-98ab-8f3548b4f830","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"test_mode","value":"1","description":"Whether this is a test, the signature request created from this draft will not be legally binding if set to 1. Defaults to 0. (optional)
\n","type":"text"},{"key":"client_id","value":"","description":"Client ID of the app you're using to create this draft.
\n","type":"text"},{"key":"file[0]","description":"Use file[] to indicate the uploaded file(s) to use for the template.
\n","type":"file","value":null},{"key":"file_url[0]","value":"http://www.example.com/contract.pdf","description":"Use file_url[] to have HelloSign download the file(s) to use for the template.
\n","type":"text","disabled":true},{"key":"title","value":"Example Embedded Template Draft Title","description":"The template title (optional)
\n","type":"text","disabled":true},{"key":"subject","value":"Example Embedded Template Draft Email Subject","description":"The template title (alias) (optional)
\n","type":"text","disabled":true},{"key":"message","value":"Example Embedded Template Draft Email Message","description":"The default template email message (optional)
\n","type":"text","disabled":true},{"key":"signer_roles[0][name]","value":"ExampleRole","description":"The role name of the signer that will be displayed when the template is used to create a signature request.
\n","type":"text","disabled":true},{"key":"signer_roles[0][order]","value":"0","description":"The order in which this signer role is required to sign. (optional)
\n","type":"text","disabled":true},{"key":"attachments[0][name]","value":"Example Attachment","description":"The name of attachment. (optional)
\n","type":"text","disabled":true},{"key":"attachments[0][instructions]","value":"Add your attachment","description":"The instructions for uploading the attachment. (optional)
\n","type":"text","disabled":true},{"key":"attachments[0][signer_index]","value":"0","description":"The signer's unique number. (optional)
\n","type":"text","disabled":true},{"key":"attachments[0][required]","value":"1","description":"Determines if the attachment must be uploaded. (optional)
\n","type":"text","disabled":true},{"key":"cc_roles","value":"CCRole","description":"The CC roles that must be assigned when using the template to send a signature request. (optional)
\n","type":"text","disabled":true},{"key":"merge_fields","value":"[{\"name\":\"Address\",\"type\":\"text\"}]","description":"The merge fields that can be placed on the template's document(s) by the user claiming the template draft. (optional)
\n","type":"text","disabled":true},{"key":"skip_me_now","value":"1","description":"Disables the \"Me (Now)\" option for the person preparing the document. Defaults to 0. (optional)
\n","type":"text","disabled":true},{"key":"use_preexisting_fields","value":"1","description":"Enable the detection of predefined PDF fields. (optional)
\n","type":"text","disabled":true},{"key":"metadata[example_key]","value":"Example Value","description":"Key-value data that should be attached to the signature request. (optional)
\n","type":"text","disabled":true},{"key":"allow_reassign","value":"1","description":"Allows signers to reassign their signature requests to other signers if set to 1. Defaults to 0. (optional)
\n","type":"text","disabled":true}]},"url":"https://api.hellosign.com/v3/template/create_embedded_draft","description":"The first step in an embedded template workflow. Creates a draft template that can then be further set up in the template 'edit' stage. Additional information can be found here.
\n","auth":{"type":"basic","basic":{"username":""},"isInherited":true,"source":{"_postman_id":"7bc2aa44-a050-410b-9b6c-0c4f95af6f50","id":"7bc2aa44-a050-410b-9b6c-0c4f95af6f50","name":"Dropbox Sign API","type":"collection"}},"urlObject":{"protocol":"https","path":["v3","template","create_embedded_draft"],"host":["api","hellosign","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"a4593af0-60ea-4a4b-98ab-8f3548b4f830"},{"name":"Delete Template","id":"77e77cbf-7d82-4209-a860-97137cf78bd8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"test_mode","value":"1","description":"Whether this is a test, the signature request created from this draft will not be legally binding if set to 1. Defaults to 0. (optional)
\n","type":"text"},{"key":"client_id","value":"","description":"Client ID of the app you're using to create this draft.
\n","type":"text"},{"key":"file[0]","description":"Use file[] to indicate the uploaded file(s) to use for the template.
\n","type":"file","value":null},{"key":"file_url[0]","value":"http://www.example.com/contract.pdf","description":"Use file_url[] to have HelloSign download the file(s) to use for the template.
\n","type":"text","disabled":true},{"key":"title","value":"Example Embedded Template Draft Title","description":"The template title (optional)
\n","type":"text","disabled":true},{"key":"subject","value":"Example Embedded Template Draft Email Subject","description":"The template title (alias) (optional)
\n","type":"text","disabled":true},{"key":"message","value":"Example Embedded Template Draft Email Message","description":"The default template email message (optional)
\n","type":"text","disabled":true},{"key":"signer_roles[0][name]","value":"ExampleRole","description":"The role name of the signer that will be displayed when the template is used to create a signature request.
\n","type":"text","disabled":true},{"key":"signer_roles[0][order]","value":"0","description":"The order in which this signer role is required to sign. (optional)
\n","type":"text","disabled":true},{"key":"attachments[0][name]","value":"Example Attachment","description":"The name of attachment. (optional)
\n","type":"text","disabled":true},{"key":"attachments[0][instructions]","value":"Add your attachment","description":"The instructions for uploading the attachment. (optional)
\n","type":"text","disabled":true},{"key":"attachments[0][signer_index]","value":"0","description":"The signer's unique number. (optional)
\n","type":"text","disabled":true},{"key":"attachments[0][required]","value":"1","description":"Determines if the attachment must be uploaded. (optional)
\n","type":"text","disabled":true},{"key":"cc_roles","value":"CCRole","description":"The CC roles that must be assigned when using the template to send a signature request. (optional)
\n","type":"text","disabled":true},{"key":"merge_fields","value":"[{\"name\":\"Address\",\"type\":\"text\"}]","description":"The merge fields that can be placed on the template's document(s) by the user claiming the template draft. (optional)
\n","type":"text","disabled":true},{"key":"skip_me_now","value":"1","description":"Disables the \"Me (Now)\" option for the person preparing the document. Defaults to 0. (optional)
\n","type":"text","disabled":true},{"key":"use_preexisting_fields","value":"1","description":"Enable the detection of predefined PDF fields. (optional)
\n","type":"text","disabled":true},{"key":"metadata[example_key]","value":"Example Value","description":"Key-value data that should be attached to the signature request. (optional)
\n","type":"text","disabled":true},{"key":"allow_reassign","value":"1","description":"Allows signers to reassign their signature requests to other signers if set to 1. Defaults to 0. (optional)
\n","type":"text","disabled":true}]},"url":"https://api.hellosign.com/v3/template/delete/:template_id","description":"Completely deletes the specified template from the account. Additional information can be found here.
\n","auth":{"type":"basic","basic":{"username":""},"isInherited":true,"source":{"_postman_id":"7bc2aa44-a050-410b-9b6c-0c4f95af6f50","id":"7bc2aa44-a050-410b-9b6c-0c4f95af6f50","name":"Dropbox Sign API","type":"collection"}},"urlObject":{"protocol":"https","path":["v3","template","delete",":template_id"],"host":["api","hellosign","com"],"query":[],"variable":[{"type":"any","key":"template_id"}]}},"response":[],"_postman_id":"77e77cbf-7d82-4209-a860-97137cf78bd8"},{"name":"Get Template Files","id":"c2c2f903-14df-425e-ac0a-19e6305ffb7c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.hellosign.com/v3/template/files/:template_id?get_url=true","description":"Obtain a copy of the original files specified by the template_id parameter. Additional information can be found here.
Overlays a new file with the overlay of an existing template. The new file(s) must have the same page count and orientation as the file(s) being replaced. This will not overwrite or in any way affect the existing template. Both the existing template and new template will be available for use after executing this endpoint. Also note that this will decrement your template quota.
\nOverlaying new files is asynchronous and a successful call to this endpoint will return an empty 200 OK response if the request passes initial validation checks.
\nIt is recommended that a callback be implemented to listen for the callback event. A \"template_created\" event will be sent when the files are updated or a \"template_error\" event will be sent if there was a problem while updating the files. If a callback handler has been configured and the event has not been received within 60 minutes of making the call, check the status of the request in the API dashboard and retry the request if necessary.
If the page orientation or page count is different from the original template document, we will notify you with a \"template_error\" callback event.
Additional information can be found here.
\n","auth":{"type":"basic","basic":{"username":""},"isInherited":true,"source":{"_postman_id":"7bc2aa44-a050-410b-9b6c-0c4f95af6f50","id":"7bc2aa44-a050-410b-9b6c-0c4f95af6f50","name":"Dropbox Sign API","type":"collection"}},"urlObject":{"protocol":"https","path":["v3","template","update_files",":template_id"],"host":["api","hellosign","com"],"query":[],"variable":[{"type":"any","key":"template_id"}]}},"response":[],"_postman_id":"085042df-9427-4769-bf09-c89708caed73"}],"id":"fad3cfda-774a-419f-ad8c-cfed6976a172","description":"Contains information about the templates you and your team have created. Additional information can be found here.
\n","event":[{"listen":"prerequest","script":{"id":"d264f964-2f4e-4b77-9c49-627c6a3e1bbd","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"8964e5c7-df45-4225-a588-b26966a9ef99","type":"text/javascript","exec":[""]}}],"_postman_id":"fad3cfda-774a-419f-ad8c-cfed6976a172","auth":{"type":"basic","basic":{"username":""},"isInherited":true,"source":{"_postman_id":"7bc2aa44-a050-410b-9b6c-0c4f95af6f50","id":"7bc2aa44-a050-410b-9b6c-0c4f95af6f50","name":"Dropbox Sign API","type":"collection"}}},{"name":"Bulk Send Job","item":[{"name":"Get Bulk Send Job","id":"f2c3901b-aabc-46cd-8395-1ecd3c358f17","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.hellosign.com/v3/bulk_send_job/:bulk_send_job_id","description":"Returns the status of the BulkSendJob and its SignatureRequests specified by the bulk_send_job_id parameter. Additional information can be found here.
Returns a list of BulkSendJob that you can access. Additional information can be found here.
\n","auth":{"type":"basic","basic":{"username":""},"isInherited":true,"source":{"_postman_id":"7bc2aa44-a050-410b-9b6c-0c4f95af6f50","id":"7bc2aa44-a050-410b-9b6c-0c4f95af6f50","name":"Dropbox Sign API","type":"collection"}},"urlObject":{"protocol":"https","path":["v3","bulk_send_job","list"],"host":["api","hellosign","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"ab4087ea-0415-453e-ba38-1c8dd6eaf8b2"}],"id":"a5caf875-aae3-409b-9846-9670c45be50e","description":"Contains information about bulk sent signature requests. Additional information can be found here.
\n","event":[{"listen":"prerequest","script":{"id":"cff4262f-118e-494a-bbc3-ca6c496994a9","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"25d1d0c5-ebdb-46e8-86c0-0454d428ce85","type":"text/javascript","exec":[""]}}],"_postman_id":"a5caf875-aae3-409b-9846-9670c45be50e","auth":{"type":"basic","basic":{"username":""},"isInherited":true,"source":{"_postman_id":"7bc2aa44-a050-410b-9b6c-0c4f95af6f50","id":"7bc2aa44-a050-410b-9b6c-0c4f95af6f50","name":"Dropbox Sign API","type":"collection"}}},{"name":"Team","item":[{"name":"Get Team","id":"44428c40-2027-4726-9598-21eac0d2501c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.hellosign.com/v3/team","description":"Returns information about your Team as well as a list of its members. If you do not belong to a Team, a 404 error with an error_name of \"not_found\" will be returned.
Additional information can be found here.
\n","auth":{"type":"basic","basic":{"username":""},"isInherited":true,"source":{"_postman_id":"7bc2aa44-a050-410b-9b6c-0c4f95af6f50","id":"7bc2aa44-a050-410b-9b6c-0c4f95af6f50","name":"Dropbox Sign API","type":"collection"}},"urlObject":{"protocol":"https","path":["v3","team"],"host":["api","hellosign","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"44428c40-2027-4726-9598-21eac0d2501c"},{"name":"Create Team","id":"742c2fcd-3950-4eb6-a21b-0e86f0b48f1d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"name","value":"Example Team Name","description":"The name for your Team.
\n","type":"text"}]},"url":"https://api.hellosign.com/v3/team/create","description":"Creates a new Team and makes you a member. You must not currently belong to a Team to invoke. Additional information can be found here.
\n","auth":{"type":"basic","basic":{"username":""},"isInherited":true,"source":{"_postman_id":"7bc2aa44-a050-410b-9b6c-0c4f95af6f50","id":"7bc2aa44-a050-410b-9b6c-0c4f95af6f50","name":"Dropbox Sign API","type":"collection"}},"urlObject":{"protocol":"https","path":["v3","team","create"],"host":["api","hellosign","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"742c2fcd-3950-4eb6-a21b-0e86f0b48f1d"},{"name":"Update Team","id":"b892b8db-7c38-4578-94dd-caf1c6dd60cf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"name","value":"New Team Name","description":"The new name for your Team.
\n","type":"text"}]},"url":"https://api.hellosign.com/v3/team","description":"Updates the name of your Team. Additional information can be found here.
\n","auth":{"type":"basic","basic":{"username":""},"isInherited":true,"source":{"_postman_id":"7bc2aa44-a050-410b-9b6c-0c4f95af6f50","id":"7bc2aa44-a050-410b-9b6c-0c4f95af6f50","name":"Dropbox Sign API","type":"collection"}},"urlObject":{"protocol":"https","path":["v3","team"],"host":["api","hellosign","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"b892b8db-7c38-4578-94dd-caf1c6dd60cf"},{"name":"Delete Team","id":"920b31c1-999e-4232-bcca-f9924fcdfefc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"name","value":"New Team Name","description":"The new name for your Team.
\n","type":"text"}]},"url":"https://api.hellosign.com/v3/team/destroy","description":"Deletes your Team. Can only be invoked when you have a Team with only one member (yourself). Additional information can be found here.
\n","auth":{"type":"basic","basic":{"username":""},"isInherited":true,"source":{"_postman_id":"7bc2aa44-a050-410b-9b6c-0c4f95af6f50","id":"7bc2aa44-a050-410b-9b6c-0c4f95af6f50","name":"Dropbox Sign API","type":"collection"}},"urlObject":{"protocol":"https","path":["v3","team","destroy"],"host":["api","hellosign","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"920b31c1-999e-4232-bcca-f9924fcdfefc"},{"name":"Add User to Team","id":"7aed447c-7434-4cac-9296-e4b6030eb3cf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"account_id","value":"1234567","description":"The account ID of the user to invite to your Team.
\n","type":"text"},{"key":"email_address","value":"alice@example.com","description":"The email address of the user to invite to your Team.
\n","type":"text","disabled":true}]},"url":"https://api.hellosign.com/v3/team/add_member","description":"Invites a user (specified using the email_address or account_id parameters) to your Team. If the user does not currently have a HelloSign Account, a new one will be created for them. If a user is already a part of another Team, a \"team_invite_failed\" error will be returned.
Additional information can be found here.
\n","auth":{"type":"basic","basic":{"username":""},"isInherited":true,"source":{"_postman_id":"7bc2aa44-a050-410b-9b6c-0c4f95af6f50","id":"7bc2aa44-a050-410b-9b6c-0c4f95af6f50","name":"Dropbox Sign API","type":"collection"}},"urlObject":{"protocol":"https","path":["v3","team","add_member"],"host":["api","hellosign","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"7aed447c-7434-4cac-9296-e4b6030eb3cf"},{"name":"Remove User from Team","id":"c2a98e66-5d88-48c5-84aa-5ec7ba1d0ace","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"account_id","value":"1234567","description":"The ID or email address of the Account to remove from your Team. The account ID prevails if both are provided.
\n","type":"text"},{"key":"email_address","value":"bob@example.com","description":"The ID or email address of the Account to remove from your Team. The account ID prevails if both are provided.
\n","type":"text","disabled":true},{"key":"new_owner_email_address","value":"alice@example.com","description":"The email address of an Account on this Team to receive all documents, API apps (if applicable), and API key (if applicable) from the removed Account.
\n","type":"text"}]},"url":"https://api.hellosign.com/v3/team/remove_member","description":"Removes the provided user Account from your Team. If the Account had an outstanding invitation to your Team, the invitation will be expired. If you choose to transfer documents from the removed Account to an Account provided in the new_owner_email_address parameter (available only for Enterprise plans), the response status code will be 201, which indicates that your request has been queued but not fully executed.
Additional information can be found here.
\n","auth":{"type":"basic","basic":{"username":""},"isInherited":true,"source":{"_postman_id":"7bc2aa44-a050-410b-9b6c-0c4f95af6f50","id":"7bc2aa44-a050-410b-9b6c-0c4f95af6f50","name":"Dropbox Sign API","type":"collection"}},"urlObject":{"protocol":"https","path":["v3","team","remove_member"],"host":["api","hellosign","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"c2a98e66-5d88-48c5-84aa-5ec7ba1d0ace"}],"id":"67d13e49-b28f-45f2-923a-9629ad048aa9","description":"Contains information about your team and its members. Additional information can be found here.
\n","event":[{"listen":"prerequest","script":{"id":"098629fd-ef3c-48f0-98ea-023c9a584eba","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"ba5d33d0-0200-4cd5-91ec-bcfb8996f506","type":"text/javascript","exec":[""]}}],"_postman_id":"67d13e49-b28f-45f2-923a-9629ad048aa9","auth":{"type":"basic","basic":{"username":""},"isInherited":true,"source":{"_postman_id":"7bc2aa44-a050-410b-9b6c-0c4f95af6f50","id":"7bc2aa44-a050-410b-9b6c-0c4f95af6f50","name":"Dropbox Sign API","type":"collection"}}},{"name":"Unclaimed Draft","item":[{"name":"Create Unclaimed Draft","id":"ff02531c-42ae-40c1-bb5d-46135da7d6a9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"test_mode","value":"1","description":"Whether this is a test, the signature request created from this draft will not be legally binding if set to 1. Defaults to 0. (optional)
\n","type":"text"},{"key":"file[0]","description":"Use file[] to indicate the uploaded file(s) to send for signature.
\n","type":"file","value":null},{"key":"file_url[0]","value":"http://www.example.com/contract.pdf","description":"Use file_url[] to have HelloSign download the file(s) to send for signature.
\n","type":"text","disabled":true},{"key":"type","value":"request_signature","description":"The type of unclaimed draft to create. Use \"send_document\" to create a claimable file, and \"request_signature\" for a claimable signature request. If the type is \"request_signature\" then signers name and email_address are not optional.
\n","type":"text"},{"key":"subject","value":"Example Email Subject","description":"The subject in the email that will be sent to the signers. (optional)
\n","type":"text","disabled":true},{"key":"message","value":"Example Email Message","description":"The custom message in the email that will be sent to the signers. (optional)
\n","type":"text","disabled":true},{"key":"signers[0][name]","value":"Alice","description":"The name of the signer. %i% is an integer that should be unique for each signer.
\n","type":"text"},{"key":"signers[0][email_address]","value":"alice@example.com","description":"The email address of the signer. %i% is an integer that should be unique for each signer.
\n","type":"text"},{"key":"signers[0][order]","value":"0","description":"The order the signer is required to sign in. %i% is an integer that should be unique for each signer. (optional)
\n","type":"text","disabled":true},{"key":"custom_fields","value":"[{\"name\": \"Address\", \"value\": \"123 Main St.\"}, {\"name\": \"zip\", \"value\": \"92606\"}]","description":"A JSON array defining values and options for custom fields from Text Tags or form_fields_per_document. (optional)
\n","type":"text","disabled":true},{"key":"cc_email_addresses[0]","value":"charlie@example.com","description":"The email addresses that should be CCed. (optional)
\n","type":"text","disabled":true},{"key":"signing_redirect_url","value":"http://www.example.com","description":"The URL you want the signer redirected to after they successfully sign. (optional)
\n","type":"text","disabled":true},{"key":"use_preexisting_fields","value":"1","description":"Enable the detection of predefined PDF fields. (optional)
\n","type":"text","disabled":true},{"key":"use_text_tags","value":"1","description":"Send with a value of 1 if you wish to enable Text Tags parsing in your document. Defaults to 0. (optional)
\n","type":"text","disabled":true},{"key":"hide_text_tags","value":"0","description":"Send with a value of 1 if you wish to enable automatic Text Tag removal. Defaults to 0. (optional)
\n","type":"text","disabled":true},{"key":"metadata[example_key]","value":"Example Metadata Value","description":"Key-value data that should be attached to the signature request. (optional)
\n","type":"text","disabled":true},{"key":"allow_decline","value":"0","description":"Allows signers to decline to sign a document if set to 1. Defaults to 0. (optional)
\n","type":"text","disabled":true},{"key":"allow_reassign","value":"0","description":"Allows signers to reassign their signature requests to other signers if set to 1. Defaults to 0. (optional)
\n","type":"text","disabled":true},{"key":"form_fields_per_document","value":"[[{\"api_id\": \"field1\", \"name\": \"address\", \"type\": \"text\", \"x\": 160, \"y\": 80, \"page\": 1, \"width\": 206, \"height\": 32, \"required\": true, \"signer\": 0}]]","description":"The fields that should appear on the document, expressed as a 2-dimensional JSON array serialized to a string. (optional)
\n","type":"text","disabled":true}]},"url":"https://api.hellosign.com/v3/unclaimed_draft/create","description":"Creates a new Draft that can be claimed using the claim URL. The first authenticated user to access the URL will claim the Draft and will be shown either the \"Sign and send\" or the \"Request signature\" page with the Draft loaded. Subsequent access to the claim URL will result in a 404.
\nAdditional information can be found here.
\n","auth":{"type":"basic","basic":{"username":""},"isInherited":true,"source":{"_postman_id":"7bc2aa44-a050-410b-9b6c-0c4f95af6f50","id":"7bc2aa44-a050-410b-9b6c-0c4f95af6f50","name":"Dropbox Sign API","type":"collection"}},"urlObject":{"protocol":"https","path":["v3","unclaimed_draft","create"],"host":["api","hellosign","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"ff02531c-42ae-40c1-bb5d-46135da7d6a9"},{"name":"Create Embedded Unclaimed Draft","id":"b9b6be7a-baa9-4fcc-805f-5233934a9add","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"test_mode","value":"1","description":"Whether this is a test, the signature request created from this draft will not be legally binding if set to 1. Defaults to 0. (optional)
\n","type":"text"},{"key":"client_id","value":"","description":"Client ID of the app you're using to create this draft.
\n","type":"text"},{"key":"file[0]","description":"Use file[] to indicate the uploaded file(s) to send for signature.
\n","type":"file","value":null},{"key":"file_url[0]","value":"http://www.example.com/contract.pdf","description":"Use file_url[] to have HelloSign download the file(s) to send for signature.
\n","type":"text","disabled":true},{"key":"requester_email_address","value":"alice@example.com","description":"The email address of the user that should be designated as the requester of this draft, if the draft type is \"request_signature.\"
\n","type":"text"},{"key":"type","value":"request_signature","description":"The type of the draft. By default this is \"request_signature\", but you can set it to \"send_document\" if you want to self sign a document and download it. (optional)
\n","type":"text"},{"key":"subject","value":"Example Email Subject","description":"The subject in the email that will be sent to the signers. (optional)
\n","type":"text","disabled":true},{"key":"message","value":"Example Email Message","description":"The custom message in the email that will be sent to the signers. (optional)
\n","type":"text","disabled":true},{"key":"signers[0][name]","value":"Bob","description":"The name of the signer. %i% is an integer that should be unique for each signer.
\n","type":"text"},{"key":"signers[0][email_address]","value":"bob@example.com","description":"The email address of the signer. %i% is an integer that should be unique for each signer.
\n","type":"text"},{"key":"signers[0][order]","value":"0","description":"The order the signer is required to sign in. %i% is an integer that should be unique for each signer. (optional)
\n","type":"text","disabled":true},{"key":"attachments[0][name]","value":"Example Attachment","description":"The name of attachment. (optional)
\n","type":"text","disabled":true},{"key":"attachments[0][instructions]","value":"Add your attachment","description":"The instructions for uploading the attachment. (optional)
\n","type":"text","disabled":true},{"key":"attachments[0][signer_index]","value":"0","description":"The signer's unique number. (optional)
\n","type":"text","disabled":true},{"key":"attachments[0][required]","value":"1","description":"Determines if the attachment must be uploaded. (optional)
\n","type":"text","disabled":true},{"key":"cc_email_addresses[0]","value":"charlie@example.com","description":"The email addresses that should be CCed. (optional)
\n","type":"text","disabled":true},{"key":"signing_redirect_url","value":"http://www.example.com","description":"The URL you want the signer redirected to after they successfully sign. (optional)
\n","type":"text","disabled":true},{"key":"custom_fields","value":"[{\"name\": \"Address\", \"value\": \"123 Main St.\"}, {\"name\": \"zip\", \"value\": \"92606\"}]","description":"A JSON array defining values and options for custom fields from Text Tags or form_fields_per_document. (optional)
\n","type":"text","disabled":true},{"key":"use_preexisting_fields","value":"1","description":"Enable the detection of predefined PDF fields. (optional)
\n","type":"text","disabled":true},{"key":"use_text_tags","value":"1","description":"Send with a value of 1 if you wish to enable Text Tags parsing in your document. Defaults to 0. (optional)
\n","type":"text","disabled":true},{"key":"hide_text_tags","value":"0","description":"Send with a value of 1 if you wish to enable automatic Text Tag removal. Defaults to 0. (optional)
\n","type":"text","disabled":true},{"key":"is_for_embedded_signing","value":"1","description":"The request created from this draft will also be signable in embedded mode if set to 1. Defaults to 0. (optional)
\n","type":"text","disabled":true},{"key":"skip_me_now","value":"1","description":"Disables the \"Me (Now)\" option for the person preparing the document. Does not work with type \"send_document\". Defaults to 0. (optional)
\n","type":"text","disabled":true},{"key":"metadata[example_key]","value":"Example Metadata Value","description":"Key-value data that should be attached to the signature request. (optional)
\n","type":"text","disabled":true},{"key":"allow_decline","value":"0","description":"Allows signers to decline to sign a document if set to 1. Defaults to 0. (optional)
\n","type":"text","disabled":true},{"key":"allow_reassign","value":"0","description":"Allows signers to reassign their signature requests to other signers if set to 1. Defaults to 0. (optional)
\n","type":"text","disabled":true},{"key":"form_fields_per_document","value":"[[{\"api_id\": \"field1\", \"name\": \"address\", \"type\": \"text\", \"x\": 160, \"y\": 80, \"page\": 1, \"width\": 206, \"height\": 32, \"required\": true, \"signer\": 0}]]","description":"The fields that should appear on the document, expressed as a 2-dimensional JSON array serialized to a string. (optional)
\n","type":"text","disabled":true}]},"url":"https://api.hellosign.com/v3/unclaimed_draft/create_embedded","description":"Creates a new Draft that can be claimed and used in an embedded iFrame. The first authenticated user to access the URL will claim the Draft and will be shown the \"Request signature\" page with the Draft loaded. Subsequent access to the claim URL will result in a 404. For this embedded endpoint the requester_email_address parameter is required. Note: embedded unclaimed drafts can only be accessed in embedded iFrames whereas normal drafts can be used and accessed on HelloSign.
Additional information can be found here.
\n","auth":{"type":"basic","basic":{"username":""},"isInherited":true,"source":{"_postman_id":"7bc2aa44-a050-410b-9b6c-0c4f95af6f50","id":"7bc2aa44-a050-410b-9b6c-0c4f95af6f50","name":"Dropbox Sign API","type":"collection"}},"urlObject":{"protocol":"https","path":["v3","unclaimed_draft","create_embedded"],"host":["api","hellosign","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"b9b6be7a-baa9-4fcc-805f-5233934a9add"},{"name":"Create Embedded Unclaimed Draft with Template","id":"4143ce00-97a8-43ae-8bc9-51e931615592","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"test_mode","value":"1","description":"Whether this is a test, the signature request created from this draft will not be legally binding if set to 1. Defaults to 0. (optional)
\n","type":"text"},{"key":"client_id","value":"","description":"Client ID of the app you're using to create this draft.
\n","type":"text"},{"key":"template_id","value":":template_id","description":"Use template_id to create a SignatureRequest from a single Template. Use template_ids[%i%] to create a SignatureRequest from multiple templates, where %i% is an integer indicating the order in which the template will be used.
\n","type":"text"},{"key":"requester_email_address","value":"alice@example.com","description":"The email address of the user that should be designated as the requester of this draft, if the draft type is \"request_signature.\"
\n","type":"text"},{"key":"type","value":"request_signature","description":"The type of the draft. By default this is \"request_signature\", but you can set it to \"send_document\" if you want to self sign a document and download it. (optional)
\n","type":"text"},{"key":"subject","value":"Example Email Subject","description":"The subject in the email that will be sent to the signers. (optional)
\n","type":"text","disabled":true},{"key":"message","value":"Example Email Message","description":"The custom message in the email that will be sent to the signers. (optional)
\n","type":"text","disabled":true},{"key":"signers[ExampleRole][name]","value":"Bob","description":"The name of the signer. %i% is an integer that should be unique for each signer.
\n","type":"text"},{"key":"signers[ExampleRole][email_address]","value":"bob@example.com","description":"The email address of the signer. %i% is an integer that should be unique for each signer.
\n","type":"text"},{"key":"ccs[CCRole][email_address]","value":"charlie@example.com","description":"The email addresses that should be CCed. (optional)
\n","type":"text","disabled":true},{"key":"signing_redirect_url","value":"http://www.example.com","description":"The URL you want the signer redirected to after they successfully sign. (optional)
\n","type":"text","disabled":true},{"key":"requesting_redirect_url","value":"http://www.example.com","description":"The URL you want signers redirected to after they successfully request a signature. (optional)
\n","type":"text","disabled":true},{"key":"is_for_embedded_signing","value":"1","description":"The request created from this draft will also be signable in embedded mode if set to 1. Defaults to 0. (optional)
\n","type":"text","disabled":true},{"key":"metadata[example_key]","value":"Example Metadata Value","description":"Key-value data that should be attached to the signature request. (optional)
\n","type":"text","disabled":true},{"key":"custom_fields","value":"[{\"name\": \"Address\", \"value\": \"123 Main St.\"}, {\"name\": \"zip\", \"value\": \"92606\"}]","description":"A JSON array defining values for custom fields. Required when a custom field exists in the Template. (optional)
\n","type":"text","disabled":true},{"key":"file[0]","description":"Append additional files to the signature request. (optional)
\n","type":"file","value":null,"disabled":true},{"key":"file_url[0]","value":"http://www.example.com/contract.pdf","description":"Append additional files to the signature request. (optional)
\n","type":"text","disabled":true},{"key":"skip_me_now","value":"1","description":"Disables the \"Me (Now)\" option for the person preparing the document. Does not work with type \"send_document\". Defaults to 0. (optional)
\n","type":"text","disabled":true},{"key":"allow_decline","value":"0","description":"Allows signers to decline to sign a document if set to 1. Defaults to 0. (optional)
\n","type":"text","disabled":true},{"key":"allow_reassign","value":"0","description":"Allows signers to reassign their signature requests to other signers if set to 1. Defaults to 0. (optional)
\n","type":"text","disabled":true}]},"url":"https://api.hellosign.com/v3/unclaimed_draft/create_embedded_with_template","description":"Creates a new Draft with a previously saved template that can be claimed and used in an embedded iFrame. The first authenticated user to access the URL will claim the Draft and will be shown the \"Request signature\" page with the Draft loaded. Subsequent access to the claim URL will result in a 404. For this embedded endpoint the requester_email_address parameter is required. Note: embedded unclaimed drafts can only be accessed in embedded iFrames whereas normal drafts can be used and accessed on HelloSign.
Additional information can be found here.
\n","auth":{"type":"basic","basic":{"username":""},"isInherited":true,"source":{"_postman_id":"7bc2aa44-a050-410b-9b6c-0c4f95af6f50","id":"7bc2aa44-a050-410b-9b6c-0c4f95af6f50","name":"Dropbox Sign API","type":"collection"}},"urlObject":{"protocol":"https","path":["v3","unclaimed_draft","create_embedded_with_template"],"host":["api","hellosign","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"4143ce00-97a8-43ae-8bc9-51e931615592"},{"name":"Unclaimed Draft Edit and Resend","id":"4562fc70-9e87-4644-a3d5-e9ca5268920e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"client_id","value":"","description":"Client ID of the app you're using to create this draft.
\n","type":"text"},{"key":"test_mode","value":"1","description":"Whether this is a test, the signature request created from this draft will not be legally binding if set to 1. Defaults to 0. (optional)
\n","type":"text"},{"key":"requesting_redirect_url","value":"http://www.example.com","description":"The URL you want signers redirected to after they successfully request a signature. (optional)
\n","type":"text","disabled":true},{"key":"signing_redirect_url","value":"http://www.example.com","description":"The URL you want the signer redirected to after they successfully sign. (optional)
\n","type":"text","disabled":true},{"key":"is_for_embedded_signing","value":"1","description":"The request created from this draft will also be signable in embedded mode if set to 1. Defaults to 0. (optional)
\n","type":"text","disabled":true}]},"url":"https://api.hellosign.com/v3/unclaimed_draft/edit_and_resend/:signature_request_id","description":"Creates a new signature request from an embedded request that can be edited prior to being sent to the recipients. The test_mode parameter can be edited prior to request. Signers can be edited in embedded editor. Requester's email address will remain unchanged if requester_email_address parameter is not set. Note that embedded unclaimed drafts can only be accessed in embedded iFrames whereas normal drafts can be used and accessed on HelloSign.
Additional information can be found here.
\n","auth":{"type":"basic","basic":{"username":""},"isInherited":true,"source":{"_postman_id":"7bc2aa44-a050-410b-9b6c-0c4f95af6f50","id":"7bc2aa44-a050-410b-9b6c-0c4f95af6f50","name":"Dropbox Sign API","type":"collection"}},"urlObject":{"protocol":"https","path":["v3","unclaimed_draft","edit_and_resend",":signature_request_id"],"host":["api","hellosign","com"],"query":[],"variable":[{"type":"any","value":"","key":"signature_request_id"}]}},"response":[],"_postman_id":"4562fc70-9e87-4644-a3d5-e9ca5268920e"}],"id":"2dfd383c-ce3f-493c-9eb6-3f8a1f8c4978","description":"A group of documents that a user can take ownership of via the claim URL. Additional information can be found here.
\n","event":[{"listen":"prerequest","script":{"id":"953a8f4d-d8bb-4172-b4bf-a3caf85ac082","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"5cebd5f8-d89b-4dc2-b944-9f824a2a4911","type":"text/javascript","exec":[""]}}],"_postman_id":"2dfd383c-ce3f-493c-9eb6-3f8a1f8c4978","auth":{"type":"basic","basic":{"username":""},"isInherited":true,"source":{"_postman_id":"7bc2aa44-a050-410b-9b6c-0c4f95af6f50","id":"7bc2aa44-a050-410b-9b6c-0c4f95af6f50","name":"Dropbox Sign API","type":"collection"}}},{"name":"Embedded","item":[{"name":"Get Embedded Sign URL","id":"6da41fb4-1e9b-45f0-a9a2-ff6d219017cf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.hellosign.com/v3/embedded/sign_url/:signature_id","description":"Retrieves an embedded object containing a signature url that can be opened in an iFrame. Note: templates created via the embedded template process will only be accessible through the API.
\nAdditional information can be found here.
\n","auth":{"type":"basic","basic":{"username":""},"isInherited":true,"source":{"_postman_id":"7bc2aa44-a050-410b-9b6c-0c4f95af6f50","id":"7bc2aa44-a050-410b-9b6c-0c4f95af6f50","name":"Dropbox Sign API","type":"collection"}},"urlObject":{"protocol":"https","path":["v3","embedded","sign_url",":signature_id"],"host":["api","hellosign","com"],"query":[],"variable":[{"type":"any","value":"","key":"signature_id"}]}},"response":[],"_postman_id":"6da41fb4-1e9b-45f0-a9a2-ff6d219017cf"},{"name":"Get Embedded Template Edit URL","id":"1030d642-bfae-40b4-99cb-9ebc77281ab6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"test_mode","value":"1","description":"Whether this is a test, locked templates will only be available for editing if this is set to 1. Defaults to 0. (optional)
\n","type":"text"},{"key":"cc_roles[0]","value":"CCRole","description":"The CC roles that must be assigned when using the template to send a signature request. To remove all CC roles, pass in a single role with no name. For use in a POST request. (optional)
\n","type":"text","disabled":true},{"key":"merge_fields","value":"[{\"name\":\"Address\",\"type\":\"text\"}]","description":"The merge fields that can be placed on the template's document(s) by the user claiming the template draft. (optional)
\n","type":"text","disabled":true},{"key":"skip_signer_roles","value":"1","description":"If signer roles are already provided, the user will not be prompted to edit them. (optional)
\n","type":"text","disabled":true},{"key":"skip_subject_message","value":"1","description":"If the subject and message has already been provided, the user will not be prompted to edit them. (optional)
\n","type":"text","disabled":true}]},"url":"https://api.hellosign.com/v3/embedded/edit_url/:template_id","description":"Retrieves an embedded object containing a template url that can be opened in an iFrame. Note: only templates created via the embedded template process are available to be edited with this endpoint.
\nAdditional information can be found here.
\n","auth":{"type":"basic","basic":{"username":""},"isInherited":true,"source":{"_postman_id":"7bc2aa44-a050-410b-9b6c-0c4f95af6f50","id":"7bc2aa44-a050-410b-9b6c-0c4f95af6f50","name":"Dropbox Sign API","type":"collection"}},"urlObject":{"protocol":"https","path":["v3","embedded","edit_url",":template_id"],"host":["api","hellosign","com"],"query":[],"variable":[{"type":"any","key":"template_id"}]}},"response":[],"_postman_id":"1030d642-bfae-40b4-99cb-9ebc77281ab6"}],"id":"7081ff35-d87e-4095-891f-81e7d8b04684","description":"An object that contains necessary information to set up embedded signing. Additional information can be found here.
\n","event":[{"listen":"prerequest","script":{"id":"52613b5e-7358-474a-8317-10e76b5d4af0","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"3b3db0ee-9ee0-40d0-ae6b-fc98143b481c","type":"text/javascript","exec":[""]}}],"_postman_id":"7081ff35-d87e-4095-891f-81e7d8b04684","auth":{"type":"basic","basic":{"username":""},"isInherited":true,"source":{"_postman_id":"7bc2aa44-a050-410b-9b6c-0c4f95af6f50","id":"7bc2aa44-a050-410b-9b6c-0c4f95af6f50","name":"Dropbox Sign API","type":"collection"}}},{"name":"API App","item":[{"name":"Get API App","id":"fe1952fe-1e46-42f9-9fd1-7d0153340de3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.hellosign.com/v3/api_app/:client_id","description":"Returns an object with information about an API App. Additional information can be found here.
\n","auth":{"type":"basic","basic":{"username":""},"isInherited":true,"source":{"_postman_id":"7bc2aa44-a050-410b-9b6c-0c4f95af6f50","id":"7bc2aa44-a050-410b-9b6c-0c4f95af6f50","name":"Dropbox Sign API","type":"collection"}},"urlObject":{"protocol":"https","path":["v3","api_app",":client_id"],"host":["api","hellosign","com"],"query":[],"variable":[{"type":"any","value":"","key":"client_id"}]}},"response":[],"_postman_id":"fe1952fe-1e46-42f9-9fd1-7d0153340de3"},{"name":"List API Apps","id":"47dbb856-8e93-4b38-b4de-23097deed224","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.hellosign.com/v3/api_app/list?page_size=1","description":"Returns a list of API Apps that are accessible by you. If you are on a team with an Admin or Developer role, this list will include apps owned by teammates.
\nAdditional information can be found here.
\n","auth":{"type":"basic","basic":{"username":""},"isInherited":true,"source":{"_postman_id":"7bc2aa44-a050-410b-9b6c-0c4f95af6f50","id":"7bc2aa44-a050-410b-9b6c-0c4f95af6f50","name":"Dropbox Sign API","type":"collection"}},"urlObject":{"protocol":"https","path":["v3","api_app","list"],"host":["api","hellosign","com"],"query":[{"key":"page_size","value":"1"}],"variable":[]}},"response":[],"_postman_id":"47dbb856-8e93-4b38-b4de-23097deed224"},{"name":"Create API App","id":"e7feda60-da1a-458a-b84a-bafde6877237","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"name","value":"New Example API App","description":"The name you want to assign to the ApiApp.
\n","type":"text"},{"key":"domain","value":"example.com","description":"The domain name the ApiApp will be associated with.
\n","type":"text"},{"key":"callback_url","value":"https://www.example.com/callback","description":"The URL at which the ApiApp should receive event callbacks. (optional)
\n","type":"text","disabled":true},{"key":"oauth[callback_url]","value":"https://www.example.com/oauth","description":"An image file to use as a custom logo in embedded contexts. (Only applies to some API plans) (optional)
\n","type":"text","disabled":true},{"key":"oauth[scopes]","value":"account_access, signature_request_access","description":"The callback URL to be used for OAuth flows. (Required if oauth[scopes] is provided)
\n","type":"text","disabled":true},{"key":"white_labeling_options","value":"{\"header_background_color\": \"#F7F8F9\", \"primary_button_color\": \"#C0A464\", \"text_color2\": \"#808080\"}","description":"A comma-separated list of OAuth scopes to be granted to the app. (Required if oauth[callback_url] is provided).
\n","type":"text","disabled":true},{"key":"options[can_insert_everywhere]","value":"1","description":"An array of elements and values serialized to a string, to be used to customize the app's signer page. (Only applies to some API plans) (optional)
\n","type":"text","disabled":true},{"key":"custom_logo_file","description":"An image file to use as a custom logo in embedded contexts. (Only applies to some API plans) (optional)
\n","type":"file","value":null,"disabled":true}]},"url":"https://api.hellosign.com/v3/api_app","description":"Creates a new API App. Additional information can be found here.
\n","auth":{"type":"basic","basic":{"username":""},"isInherited":true,"source":{"_postman_id":"7bc2aa44-a050-410b-9b6c-0c4f95af6f50","id":"7bc2aa44-a050-410b-9b6c-0c4f95af6f50","name":"Dropbox Sign API","type":"collection"}},"urlObject":{"protocol":"https","path":["v3","api_app"],"host":["api","hellosign","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"e7feda60-da1a-458a-b84a-bafde6877237"},{"name":"Update API App","id":"200b4d07-1de0-4408-a561-4691b9c2b370","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"name","value":"Updated Name","description":"The name you want to assign to the ApiApp. (optional)
\n","type":"text","disabled":true},{"key":"domain","value":"example.com","description":"The domain name the ApiApp will be associated with. (optional)
\n","type":"text","disabled":true},{"key":"callback_url","value":"https://www.example.com/callback","description":"The URL at which the ApiApp should receive event callbacks. (optional)
\n","type":"text","disabled":true},{"key":"oauth[callback_url]","value":"https://www.example.com/oauth","description":"An image file to use as a custom logo in embedded contexts. (Only applies to some API plans) (optional)
\n","type":"text","disabled":true},{"key":"oauth[scopes]","value":"account_access, signature_request_access","description":"The callback URL to be used for OAuth flows. (Required if oauth[scopes] is provided)
\n","type":"text","disabled":true},{"key":"white_labeling_options","value":"{\"header_background_color\": \"#F7F8F9\", \"primary_button_color\": \"#C0A464\", \"text_color2\": \"#808080\"}","description":"A comma-separated list of OAuth scopes to be granted to the app. (Required if oauth[callback_url] is provided).
\n","type":"text","disabled":true},{"key":"options[can_insert_everywhere]","value":"1","description":"An array of elements and values serialized to a string, to be used to customize the app's signer page. (Only applies to some API plans) (optional)
\n","type":"text","disabled":true},{"key":"custom_logo_file","description":"An image file to use as a custom logo in embedded contexts. (Only applies to some API plans) (optional)
\n","type":"file","value":null,"disabled":true}]},"url":"https://api.hellosign.com/v3/api_app/:client_id","description":"Updates an existing API App. Can only be invoked for apps you own. Only the fields you provide will be updated. If you wish to clear an existing optional field, provide an empty string.
\nAdditional information can be found here.
\n","auth":{"type":"basic","basic":{"username":""},"isInherited":true,"source":{"_postman_id":"7bc2aa44-a050-410b-9b6c-0c4f95af6f50","id":"7bc2aa44-a050-410b-9b6c-0c4f95af6f50","name":"Dropbox Sign API","type":"collection"}},"urlObject":{"protocol":"https","path":["v3","api_app",":client_id"],"host":["api","hellosign","com"],"query":[],"variable":[{"type":"any","value":"","key":"client_id"}]}},"response":[],"_postman_id":"200b4d07-1de0-4408-a561-4691b9c2b370"},{"name":"Delete API App","id":"7ed3d5ea-eec7-422e-9d3f-960018f5f08a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"name","value":"Updated Name","description":"The name you want to assign to the ApiApp. (optional)
\n","type":"text","disabled":true},{"key":"domain","value":"example.com","description":"The domain name the ApiApp will be associated with. (optional)
\n","type":"text","disabled":true},{"key":"callback_url","value":"https://www.example.com/callback","description":"The URL at which the ApiApp should receive event callbacks. (optional)
\n","type":"text","disabled":true},{"key":"oauth[callback_url]","value":"https://www.example.com/oauth","description":"An image file to use as a custom logo in embedded contexts. (Only applies to some API plans) (optional)
\n","type":"text","disabled":true},{"key":"oauth[scopes]","value":"account_access, signature_request_access","description":"The callback URL to be used for OAuth flows. (Required if oauth[scopes] is provided)
\n","type":"text","disabled":true},{"key":"white_labeling_options","value":"{\"header_background_color\": \"#F7F8F9\", \"primary_button_color\": \"#C0A464\", \"text_color2\": \"#808080\"}","description":"A comma-separated list of OAuth scopes to be granted to the app. (Required if oauth[callback_url] is provided).
\n","type":"text","disabled":true},{"key":"options[can_insert_everywhere]","value":"1","description":"An array of elements and values serialized to a string, to be used to customize the app's signer page. (Only applies to some API plans) (optional)
\n","type":"text","disabled":true},{"key":"custom_logo_file","description":"An image file to use as a custom logo in embedded contexts. (Only applies to some API plans) (optional)
\n","type":"file","value":null,"disabled":true}]},"url":"https://api.hellosign.com/v3/api_app/:client_id","description":"Deletes an API App. Can only be invoked for apps you own. Additional information can be found here.
\n","auth":{"type":"basic","basic":{"username":""},"isInherited":true,"source":{"_postman_id":"7bc2aa44-a050-410b-9b6c-0c4f95af6f50","id":"7bc2aa44-a050-410b-9b6c-0c4f95af6f50","name":"Dropbox Sign API","type":"collection"}},"urlObject":{"protocol":"https","path":["v3","api_app",":client_id"],"host":["api","hellosign","com"],"query":[],"variable":[{"type":"any","value":"","key":"client_id"}]}},"response":[],"_postman_id":"7ed3d5ea-eec7-422e-9d3f-960018f5f08a"}],"id":"e2ae9025-9d58-46f9-b47e-3ea4dac0fef9","description":"Contains information about an API App. Additional information can be found here.
\n","event":[{"listen":"prerequest","script":{"id":"5272be5f-620b-43c6-bccf-3cdca04b8b4b","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"75051c54-7eaf-470e-92ff-45b660529be1","type":"text/javascript","exec":[""]}}],"_postman_id":"e2ae9025-9d58-46f9-b47e-3ea4dac0fef9","auth":{"type":"basic","basic":{"username":""},"isInherited":true,"source":{"_postman_id":"7bc2aa44-a050-410b-9b6c-0c4f95af6f50","id":"7bc2aa44-a050-410b-9b6c-0c4f95af6f50","name":"Dropbox Sign API","type":"collection"}}}],"auth":{"type":"basic","basic":{"username":""}},"event":[{"listen":"prerequest","script":{"id":"8ea06860-1af4-4082-a32b-a41f31585bc1","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"2d270fb0-8195-485b-abb4-fcc3ad487ac9","type":"text/javascript","exec":[""]}}],"variable":[{"id":"c320dc64-7309-4028-bed7-8e4b7aa7d777","key":"api_key","value":"","type":"string"},{"id":"91b2cb7a-9791-453c-95bc-c522f76af18e","key":"client_id","value":"","type":"string"},{"id":"25858929-24f2-45d7-9a1e-44d548470abe","key":"test_mode","value":"1","type":"string"}]}