{
  "opencollection": "1.0.0",
  "info": {
    "name": "Dropbox Sign Account Template API",
    "version": "3.0.0"
  },
  "request": {
    "auth": {
      "type": "basic",
      "username": "{{username}}",
      "password": "{{password}}"
    }
  },
  "items": [
    {
      "info": {
        "name": "Template",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Add User to Template",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.hellosign.com/v3/template/add_user/:template_id",
            "params": [
              {
                "name": "template_id",
                "value": "f57db65d3f933b5316d398057a36176831451a35",
                "type": "path",
                "description": "The id of the Template to give the Account access to."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "basic",
              "username": "{{username}}",
              "password": "{{password}}"
            }
          },
          "docs": "Gives the specified Account access to the specified Template. The specified Account must be a part of your Team."
        },
        {
          "info": {
            "name": "Create Template",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.hellosign.com/v3/template/create",
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "basic",
              "username": "{{username}}",
              "password": "{{password}}"
            }
          },
          "docs": "Creates a template that can be used in future signature requests.\n\nIf `client_id` is provided, the template will be created as an embedded template. Embedded templates can be used for embedded signature requests and can be edited later by generating a new `edit_url` with [/embedded/edit_url/{template_id}](/api/reference/operation/embeddedEditUrl/).\n\nTemplate creation may complete asynchronously after the initial request is accepted. It is recommended that a callback be implemented to listen for "
        },
        {
          "info": {
            "name": "Create Embedded Template Draft",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.hellosign.com/v3/template/create_embedded_draft",
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "basic",
              "username": "{{username}}",
              "password": "{{password}}"
            }
          },
          "docs": "The first step in an embedded template workflow. Creates a draft template that can then be further set up in the template 'edit' stage."
        },
        {
          "info": {
            "name": "Delete Template",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.hellosign.com/v3/template/delete/:template_id",
            "params": [
              {
                "name": "template_id",
                "value": "f57db65d3f933b5316d398057a36176831451a35",
                "type": "path",
                "description": "The id of the Template to delete."
              }
            ],
            "auth": {
              "type": "basic",
              "username": "{{username}}",
              "password": "{{password}}"
            }
          },
          "docs": "Completely deletes the template specified from the account."
        },
        {
          "info": {
            "name": "Get Template Files",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.hellosign.com/v3/template/files/:template_id",
            "params": [
              {
                "name": "template_id",
                "value": "f57db65d3f933b5316d398057a36176831451a35",
                "type": "path",
                "description": "The id of the template files to retrieve."
              },
              {
                "name": "file_type",
                "value": "",
                "type": "query",
                "description": "Set to `pdf` for a single merged document or `zip` for a collection of individual documents."
              }
            ],
            "auth": {
              "type": "basic",
              "username": "{{username}}",
              "password": "{{password}}"
            }
          },
          "docs": "Obtain a copy of the current documents specified by the `template_id` parameter. Returns a PDF or ZIP file.\n\nIf the files are currently being prepared, a status code of `409` will be returned instead. In this case please wait for the `template_created` callback event."
        },
        {
          "info": {
            "name": "Get Template Files as Data Uri",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.hellosign.com/v3/template/files_as_data_uri/:template_id",
            "params": [
              {
                "name": "template_id",
                "value": "f57db65d3f933b5316d398057a36176831451a35",
                "type": "path",
                "description": "The id of the template files to retrieve."
              }
            ],
            "auth": {
              "type": "basic",
              "username": "{{username}}",
              "password": "{{password}}"
            }
          },
          "docs": "Obtain a copy of the current documents specified by the `template_id` parameter. Returns a JSON object with a `data_uri` representing the base64 encoded file (PDFs only).\n\nIf the files are currently being prepared, a status code of `409` will be returned instead. In this case please wait for the `template_created` callback event."
        },
        {
          "info": {
            "name": "Get Template Files as File Url",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.hellosign.com/v3/template/files_as_file_url/:template_id",
            "params": [
              {
                "name": "template_id",
                "value": "f57db65d3f933b5316d398057a36176831451a35",
                "type": "path",
                "description": "The id of the template files to retrieve."
              },
              {
                "name": "force_download",
                "value": "",
                "type": "query",
                "description": "By default when opening the `file_url` a browser will download the PDF and save it locally. When set to `0` the PDF file will be displayed in the browser."
              }
            ],
            "auth": {
              "type": "basic",
              "username": "{{username}}",
              "password": "{{password}}"
            }
          },
          "docs": "Obtain a copy of the current documents specified by the `template_id` parameter. Returns a JSON object with a url to the file (PDFs only).\n\nIf the files are currently being prepared, a status code of `409` will be returned instead. In this case please wait for the `template_created` callback event."
        },
        {
          "info": {
            "name": "Get Template",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.hellosign.com/v3/template/:template_id",
            "params": [
              {
                "name": "template_id",
                "value": "f57db65d3f933b5316d398057a36176831451a35",
                "type": "path",
                "description": "The id of the Template to retrieve."
              }
            ],
            "auth": {
              "type": "basic",
              "username": "{{username}}",
              "password": "{{password}}"
            }
          },
          "docs": "Returns the Template specified by the `template_id` parameter."
        },
        {
          "info": {
            "name": "List Templates",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.hellosign.com/v3/template/list",
            "params": [
              {
                "name": "account_id",
                "value": "",
                "type": "query",
                "description": "Which account to return Templates for. Must be a team member. Use `all` to indicate all team members. Defaults to your account."
              },
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "Which page number of the Template List to return. Defaults to `1`."
              },
              {
                "name": "page_size",
                "value": "",
                "type": "query",
                "description": "Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`."
              },
              {
                "name": "query",
                "value": "",
                "type": "query",
                "description": "String that includes search terms and/or fields to be used to filter the Template objects."
              }
            ],
            "auth": {
              "type": "basic",
              "username": "{{username}}",
              "password": "{{password}}"
            }
          },
          "docs": "Returns a list of the Templates that are accessible by you.\n\nTake a look at our [search guide](/api/reference/search/) to learn more about querying templates."
        },
        {
          "info": {
            "name": "Remove User from Template",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.hellosign.com/v3/template/remove_user/:template_id",
            "params": [
              {
                "name": "template_id",
                "value": "f57db65d3f933b5316d398057a36176831451a35",
                "type": "path",
                "description": "The id of the Template to remove the Account's access to."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "basic",
              "username": "{{username}}",
              "password": "{{password}}"
            }
          },
          "docs": "Removes the specified Account's access to the specified Template."
        },
        {
          "info": {
            "name": "Update Template Files",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.hellosign.com/v3/template/update_files/:template_id",
            "params": [
              {
                "name": "template_id",
                "value": "f57db65d3f933b5316d398057a36176831451a35",
                "type": "path",
                "description": "The ID of the template whose files to update."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "basic",
              "username": "{{username}}",
              "password": "{{password}}"
            }
          },
          "docs": "Overlays a new file with the overlay of an existing template. The new file(s) must:\n\n1. have the same or higher page count\n2. the same orientation as the file(s) being replaced.\n\nThis 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.\n\nOverlaying new files is asynchronous and a successful call to this endpoint will return 200 OK "
        }
      ]
    }
  ],
  "bundled": true
}