Dropbox Sign (HelloSign) Signature Request API

openapi: 3.0.3
info:
  title: Dropbox Sign Account Signature Request API
  description: Dropbox Sign v3 API
  termsOfService: https://www.hellosign.com/terms
  contact:
    email: apisupport@hellosign.com
  license:
    name: MIT
    url: https://opensource.org/licenses/MIT
  version: 3.0.0
servers:
- url: https://api.hellosign.com/v3
security:
- api_key: []
- oauth2:
  - account_access
  - signature_request_access
  - template_access
  - team_access
  - api_app_access
  - basic_account_info
  - request_signature
tags:
- name: Signature Request
  description:
    $ref: ./markdown/en/tags/signature-request-tag-description.md
paths:
  /signature_request/bulk_create_embedded_with_template:
    post:
      tags:
      - Signature Request
      summary: Embedded Bulk Send with Template
      description: 'Creates BulkSendJob which sends up to 250 SignatureRequests in bulk based off of the provided Template(s) specified with the `template_ids` parameter to be signed in an embedded iFrame. These embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign.


        **NOTE:** Only available for Standard plan and higher.'
      operationId: signatureRequestBulkCreateEmbeddedWithTemplate
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SignatureRequestBulkCreateEmbeddedWithTemplateRequest'
            examples:
              example:
                $ref: '#/components/examples/SignatureRequestBulkCreateEmbeddedWithTemplateRequest'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/SignatureRequestBulkCreateEmbeddedWithTemplateRequest'
      responses:
        '200':
          description: successful operation
          headers:
            X-RateLimit-Limit:
              $ref: '#/components/headers/X-RateLimit-Limit'
            X-RateLimit-Remaining:
              $ref: '#/components/headers/X-RateLimit-Remaining'
            X-Ratelimit-Reset:
              $ref: '#/components/headers/X-Ratelimit-Reset'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BulkSendJobSendResponse'
              examples:
                example:
                  $ref: '#/components/examples/SignatureRequestBulkCreateEmbeddedWithTemplateResponse'
        4XX:
          description: failed_operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                400_example:
                  $ref: '#/components/examples/Error400Response'
                401_example:
                  $ref: '#/components/examples/Error401Response'
                402_example:
                  $ref: '#/components/examples/Error402Response'
                403_example:
                  $ref: '#/components/examples/Error403Response'
                429_example:
                  $ref: '#/components/examples/Error429Response'
                404_example:
                  $ref: '#/components/examples/Error404Response'
                409_example:
                  $ref: '#/components/examples/Error409Response'
                4XX_example:
                  $ref: '#/components/examples/Error4XXResponse'
      security:
      - api_key: []
      x-codeSamples:
      - lang: PHP
        label: PHP
        source:
          $ref: examples/SignatureRequestBulkCreateEmbeddedWithTemplateExample.php
      - lang: C#
        label: C#
        source:
          $ref: examples/SignatureRequestBulkCreateEmbeddedWithTemplateExample.cs
      - lang: TypeScript
        label: TypeScript
        source:
          $ref: examples/SignatureRequestBulkCreateEmbeddedWithTemplateExample.ts
      - lang: Java
        label: Java
        source:
          $ref: examples/SignatureRequestBulkCreateEmbeddedWithTemplateExample.java
      - lang: Ruby
        label: Ruby
        source:
          $ref: examples/SignatureRequestBulkCreateEmbeddedWithTemplateExample.rb
      - lang: Python
        label: Python
        source:
          $ref: examples/SignatureRequestBulkCreateEmbeddedWithTemplateExample.py
      - lang: cURL
        label: cURL
        source:
          $ref: examples/SignatureRequestBulkCreateEmbeddedWithTemplateExample.sh
      x-meta:
        seo:
          title: Embedded Bulk Send with Template | Dropbox Sign for Developers
          description: The RESTful Dropbox Sign API allows you to build custom integrations. To find out how to create embedded BulkSendJob signature requests, click here.
  /signature_request/bulk_send_with_template:
    post:
      tags:
      - Signature Request
      summary: Bulk Send with Template
      description: 'Creates BulkSendJob which sends up to 250 SignatureRequests in bulk based off of the provided Template(s) specified with the `template_ids` parameter.


        **NOTE:** Only available for Standard plan and higher.'
      operationId: signatureRequestBulkSendWithTemplate
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SignatureRequestBulkSendWithTemplateRequest'
            examples:
              example:
                $ref: '#/components/examples/SignatureRequestBulkSendWithTemplateRequest'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/SignatureRequestBulkSendWithTemplateRequest'
      responses:
        '200':
          description: successful operation
          headers:
            X-RateLimit-Limit:
              $ref: '#/components/headers/X-RateLimit-Limit'
            X-RateLimit-Remaining:
              $ref: '#/components/headers/X-RateLimit-Remaining'
            X-Ratelimit-Reset:
              $ref: '#/components/headers/X-Ratelimit-Reset'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BulkSendJobSendResponse'
              examples:
                example:
                  $ref: '#/components/examples/SignatureRequestBulkSendWithTemplateResponse'
        4XX:
          description: failed_operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                400_example:
                  $ref: '#/components/examples/Error400Response'
                401_example:
                  $ref: '#/components/examples/Error401Response'
                402_example:
                  $ref: '#/components/examples/Error402Response'
                403_example:
                  $ref: '#/components/examples/Error403Response'
                429_example:
                  $ref: '#/components/examples/Error429Response'
                404_example:
                  $ref: '#/components/examples/Error404Response'
                4XX_example:
                  $ref: '#/components/examples/Error4XXResponse'
      security:
      - api_key: []
      - oauth2:
        - request_signature
        - signature_request_access
      x-codeSamples:
      - lang: PHP
        label: PHP
        source:
          $ref: examples/SignatureRequestBulkSendWithTemplateExample.php
      - lang: C#
        label: C#
        source:
          $ref: examples/SignatureRequestBulkSendWithTemplateExample.cs
      - lang: TypeScript
        label: TypeScript
        source:
          $ref: examples/SignatureRequestBulkSendWithTemplateExample.ts
      - lang: Java
        label: Java
        source:
          $ref: examples/SignatureRequestBulkSendWithTemplateExample.java
      - lang: Ruby
        label: Ruby
        source:
          $ref: examples/SignatureRequestBulkSendWithTemplateExample.rb
      - lang: Python
        label: Python
        source:
          $ref: examples/SignatureRequestBulkSendWithTemplateExample.py
      - lang: cURL
        label: cURL
        source:
          $ref: examples/SignatureRequestBulkSendWithTemplateExample.sh
      x-meta:
        seo:
          title: Bulk Send with Template | REST API | Dropbox Sign for Developers
          description: The RESTful Dropbox Sign API allows you to build custom integrations. To find out how to create BulkSendJob for up to 250 signature requests, click here.
  /signature_request/cancel/{signature_request_id}:
    post:
      tags:
      - Signature Request
      summary: Cancel Incomplete Signature Request
      description: 'Cancels an incomplete signature request. This action is **not reversible**.


        The request will be canceled and signers will no longer be able to sign. If they try to access the signature request they will receive a HTTP 410 status code indicating that the resource has been deleted. 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.


        This 200 OK response does not indicate a successful cancelation of the signature request itself. The cancelation is confirmed via the `signature_request_canceled` event. It is recommended that a [callback handler](/api/reference/tag/Callbacks-and-Events) be implemented to listen for the `signature_request_canceled` event. This callback will be sent only 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](https://app.hellosign.com/apidashboard) and retry the cancelation if necessary.


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


        **NOTE:** To remove your access to a completed signature request, use the endpoint: `POST /signature_request/remove/[:signature_request_id]`.'
      operationId: signatureRequestCancel
      parameters:
      - name: signature_request_id
        in: path
        description: The id of the incomplete SignatureRequest to cancel.
        required: true
        schema:
          type: string
        example: fa5c8a0b0f492d768749333ad6fcc214c111e967
      responses:
        '200':
          description: successful operation
          headers:
            X-RateLimit-Limit:
              $ref: '#/components/headers/X-RateLimit-Limit'
            X-RateLimit-Remaining:
              $ref: '#/components/headers/X-RateLimit-Remaining'
            X-Ratelimit-Reset:
              $ref: '#/components/headers/X-Ratelimit-Reset'
          content:
            application/json: {}
        4XX:
          description: failed_operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                400_example:
                  $ref: '#/components/examples/Error400Response'
                401_example:
                  $ref: '#/components/examples/Error401Response'
                402_example:
                  $ref: '#/components/examples/Error402Response'
                403_example:
                  $ref: '#/components/examples/Error403Response'
                429_example:
                  $ref: '#/components/examples/Error429Response'
                404_example:
                  $ref: '#/components/examples/Error404Response'
                409_example:
                  $ref: '#/components/examples/Error409Response'
                410_example:
                  $ref: '#/components/examples/Error410Response'
                4XX_example:
                  $ref: '#/components/examples/Error4XXResponse'
      security:
      - api_key: []
      - oauth2:
        - request_signature
        - signature_request_access
      x-codeSamples:
      - lang: PHP
        label: PHP
        source:
          $ref: examples/SignatureRequestCancelExample.php
      - lang: C#
        label: C#
        source:
          $ref: examples/SignatureRequestCancelExample.cs
      - lang: TypeScript
        label: TypeScript
        source:
          $ref: examples/SignatureRequestCancelExample.ts
      - lang: Java
        label: Java
        source:
          $ref: examples/SignatureRequestCancelExample.java
      - lang: Ruby
        label: Ruby
        source:
          $ref: examples/SignatureRequestCancelExample.rb
      - lang: Python
        label: Python
        source:
          $ref: examples/SignatureRequestCancelExample.py
      - lang: cURL
        label: cURL
        source:
          $ref: examples/SignatureRequestCancelExample.sh
      x-meta:
        seo:
          title: Cancel Incomplete Signature Request | Dropbox Sign for Developers
          description: The RESTful Dropbox Sign API easily allows you to build custom eSign integrations. To find out how to cancel an incomplete signature request, click here.
  /signature_request/create_embedded:
    post:
      tags:
      - Signature Request
      summary: Create Embedded Signature Request
      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 that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign.
      operationId: signatureRequestCreateEmbedded
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SignatureRequestCreateEmbeddedRequest'
            examples:
              example:
                $ref: '#/components/examples/SignatureRequestCreateEmbeddedRequest'
              grouped_signers_example:
                $ref: '#/components/examples/SignatureRequestCreateEmbeddedRequestGroupedSigners'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/SignatureRequestCreateEmbeddedRequest'
      responses:
        '200':
          description: successful operation
          headers:
            X-RateLimit-Limit:
              $ref: '#/components/headers/X-RateLimit-Limit'
            X-RateLimit-Remaining:
              $ref: '#/components/headers/X-RateLimit-Remaining'
            X-Ratelimit-Reset:
              $ref: '#/components/headers/X-Ratelimit-Reset'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SignatureRequestGetResponse'
              examples:
                example:
                  $ref: '#/components/examples/SignatureRequestCreateEmbeddedResponse'
        4XX:
          description: failed_operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                400_example:
                  $ref: '#/components/examples/Error400Response'
                401_example:
                  $ref: '#/components/examples/Error401Response'
                402_example:
                  $ref: '#/components/examples/Error402Response'
                403_example:
                  $ref: '#/components/examples/Error403Response'
                429_example:
                  $ref: '#/components/examples/Error429Response'
                409_example:
                  $ref: '#/components/examples/Error409Response'
                4XX_example:
                  $ref: '#/components/examples/Error4XXResponse'
      security:
      - api_key: []
      - oauth2:
        - signature_request_access
      x-codeSamples:
      - lang: PHP
        label: PHP
        source:
          $ref: examples/SignatureRequestCreateEmbeddedExample.php
      - lang: C#
        label: C#
        source:
          $ref: examples/SignatureRequestCreateEmbeddedExample.cs
      - lang: TypeScript
        label: TypeScript
        source:
          $ref: examples/SignatureRequestCreateEmbeddedExample.ts
      - lang: Java
        label: Java
        source:
          $ref: examples/SignatureRequestCreateEmbeddedExample.java
      - lang: Ruby
        label: Ruby
        source:
          $ref: examples/SignatureRequestCreateEmbeddedExample.rb
      - lang: Python
        label: Python
        source:
          $ref: examples/SignatureRequestCreateEmbeddedExample.py
      - lang: cURL
        label: cURL
        source:
          $ref: examples/SignatureRequestCreateEmbeddedExample.sh
      x-meta:
        seo:
          title: Create Embedded Signature Request | Dropbox Sign for Developers
          description: The RESTful Dropbox Sign API easily allows you to build custom integrations. To find out how to create a new SignatureRequest in an iFrame, click here.
  /signature_request/create_embedded_with_template:
    post:
      tags:
      - Signature Request
      summary: Create Embedded Signature Request with Template
      description: Creates a new SignatureRequest based on the given Template(s) to be signed in an embedded iFrame. Note that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign.
      operationId: signatureRequestCreateEmbeddedWithTemplate
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SignatureRequestCreateEmbeddedWithTemplateRequest'
            examples:
              example:
                $ref: '#/components/examples/SignatureRequestCreateEmbeddedWithTemplateRequest'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/SignatureRequestCreateEmbeddedWithTemplateRequest'
      responses:
        '200':
          description: successful operation
          headers:
            X-RateLimit-Limit:
              $ref: '#/components/headers/X-RateLimit-Limit'
            X-RateLimit-Remaining:
              $ref: '#/components/headers/X-RateLimit-Remaining'
            X-Ratelimit-Reset:
              $ref: '#/components/headers/X-Ratelimit-Reset'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SignatureRequestGetResponse'
              examples:
                example:
                  $ref: '#/components/examples/SignatureRequestCreateEmbeddedWithTemplateResponse'
        4XX:
          description: failed_operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                400_example:
                  $ref: '#/components/examples/Error400Response'
                401_example:
                  $ref: '#/components/examples/Error401Response'
                402_example:
                  $ref: '#/components/examples/Error402Response'
                403_example:
                  $ref: '#/components/examples/Error403Response'
                429_example:
                  $ref: '#/components/examples/Error429Response'
                409_example:
                  $ref: '#/components/examples/Error409Response'
                4XX_example:
                  $ref: '#/components/examples/Error4XXResponse'
      security:
      - api_key: []
      - oauth2:
        - signature_request_access
      x-codeSamples:
      - lang: PHP
        label: PHP
        source:
          $ref: examples/SignatureRequestCreateEmbeddedWithTemplateExample.php
      - lang: C#
        label: C#
        source:
          $ref: examples/SignatureRequestCreateEmbeddedWithTemplateExample.cs
      - lang: TypeScript
        label: TypeScript
        source:
          $ref: examples/SignatureRequestCreateEmbeddedWithTemplateExample.ts
      - lang: Java
        label: Java
        source:
          $ref: examples/SignatureRequestCreateEmbeddedWithTemplateExample.java
      - lang: Ruby
        label: Ruby
        source:
          $ref: examples/SignatureRequestCreateEmbeddedWithTemplateExample.rb
      - lang: Python
        label: Python
        source:
          $ref: examples/SignatureRequestCreateEmbeddedWithTemplateExample.py
      - lang: cURL
        label: cURL
        source:
          $ref: examples/SignatureRequestCreateEmbeddedWithTemplateExample.sh
      x-meta:
        seo:
          title: Signature Request with Template | Dropbox Sign for Developers
          description: The Dropbox Sign API allows you to build custom integrations. To find out how to create a new SignatureRequest based on the given Template, click here.
  /signature_request/edit/{signature_request_id}:
    put:
      tags:
      - Signature Request
      summary: Edit Signature Request
      description: 'Edits and sends a 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.


        **NOTE:** Edit and resend *will* deduct your signature request quota.'
      operationId: signatureRequestEdit
      parameters:
      - name: signature_request_id
        in: path
        description: The id of the SignatureRequest to edit.
        required: true
        schema:
          type: string
        example: fa5c8a0b0f492d768749333ad6fcc214c111e967
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SignatureRequestEditRequest'
            examples:
              example:
                $ref: '#/components/examples/SignatureRequestEditRequest'
              grouped_signers_example:
                $ref: '#/components/examples/SignatureRequestEditRequestGroupedSigners'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/SignatureRequestEditRequest'
      responses:
        '200':
          description: successful operation
          headers:
            X-RateLimit-Limit:
              $ref: '#/components/headers/X-RateLimit-Limit'
            X-RateLimit-Remaining:
              $ref: '#/components/headers/X-RateLimit-Remaining'
            X-Ratelimit-Reset:
              $ref: '#/components/headers/X-Ratelimit-Reset'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SignatureRequestGetResponse'
              examples:
                example:
                  $ref: '#/components/examples/SignatureRequestSendResponse'
        4XX:
          description: failed_operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                400_example:
                  $ref: '#/components/examples/Error400Response'
                401_example:
                  $ref: '#/components/examples/Error401Response'
                402_example:
                  $ref: '#/components/examples/Error402Response'
                403_example:
                  $ref: '#/components/examples/Error403Response'
                429_example:
                  $ref: '#/components/examples/Error429Response'
                404_example:
                  $ref: '#/components/examples/Error404Response'
                409_example:
                  $ref: '#/components/examples/Error409Response'
                4XX_example:
                  $ref: '#/components/examples/Error4XXResponse'
      security:
      - api_key: []
      - oauth2:
        - request_signature
        - signature_request_access
      x-codeSamples:
      - lang: PHP
        label: PHP
        source:
          $ref: examples/SignatureRequestEditExample.php
      - lang: C#
        label: C#
        source:
          $ref: examples/SignatureRequestEditExample.cs
      - lang: TypeScript
        label: TypeScript
        source:
          $ref: examples/SignatureRequestEditExample.ts
      - lang: Java
        label: Java
        source:
          $ref: examples/SignatureRequestEditExample.java
      - lang: Ruby
        label: Ruby
        source:
          $ref: examples/SignatureRequestEditExample.rb
      - lang: Python
        label: Python
        source:
          $ref: examples/SignatureRequestEditExample.py
      - lang: cURL
        label: cURL
        source:
          $ref: examples/SignatureRequestEditExample.sh
      x-meta:
        seo:
          title: Edit Signature Request | REST API | Dropbox Sign for Developers
          description: Dropbox Sign API allows you to build custom integrations. To find out how to edit a SignatureRequest with the submitted documents, click here.
  /signature_request/edit_embedded/{signature_request_id}:
    put:
      tags:
      - Signature Request
      summary: Edit Embedded Signature Request
      description: 'Edits a 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 that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign.


        **NOTE:** Edit and resend *will* deduct your signature request quota.'
      operationId: signatureRequestEditEmbedded
      parameters:
      - name: signature_request_id
        in: path
        description: The id of the SignatureRequest to edit.
        required: true
        schema:
          type: string
        example: fa5c8a0b0f492d768749333ad6fcc214c111e967
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SignatureRequestEditEmbeddedRequest'
            examples:
              example:
                $ref: '#/components/examples/SignatureRequestEditEmbeddedRequest'
              grouped_signers_example:
                $ref: '#/components/examples/SignatureRequestEditEmbeddedRequestGroupedSigners'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/SignatureRequestEditEmbeddedRequest'
      responses:
        '200':
          description: successful operation
          headers:
            X-RateLimit-Limit:
              $ref: '#/components/headers/X-RateLimit-Limit'
            X-RateLimit-Remaining:
              $ref: '#/components/headers/X-RateLimit-Remaining'
            X-Ratelimit-Reset:
              $ref: '#/components/headers/X-Ratelimit-Reset'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SignatureRequestGetResponse'
              examples:
                example:
                  $ref: '#/components/examples/SignatureRequestCreateEmbeddedResponse'
        4XX:
          description: failed_operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                400_example:
                  $ref: '#/components/examples/Error400Response'
                401_example:
                  $ref: '#/components/examples/Error401Response'
                402_example:
                  $ref: '#/components/examples/Error402Response'
                403_example:
                  $ref: '#/components/examples/Error403Response'
                429_example:
                  $ref: '#/components/examples/Error429Response'
                404_example:
                  $ref: '#/components/examples/Error404Response'
                409_example:
                  $ref: '#/components/examples/Error409Response'
                4XX_example:
                  $ref: '#/components/examples/Error4XXResponse'
      security:
      - api_key: []
      - oauth2:
        - signature_request_access
      x-codeSamples:
      - lang: PHP
        label: PHP
        source:
          $ref: examples/SignatureRequestEditEmbeddedExample.php
      - lang: C#
        label: C#
        source:
          $ref: examples/SignatureRequestEditEmbeddedExample.cs
      - lang: TypeScript
        label: TypeScript
        source:
          $ref: examples/SignatureRequestEditEmbeddedExample.ts
      - lang: Java
        label: Java
        source:
          $ref: examples/SignatureRequestEditEmbeddedExample.java
      - lang: Ruby
        label: Ruby
        source:
          $ref: examples/SignatureRequestEditEmbeddedExample.rb
      - lang: Python
        label: Python
        source:
          $ref: examples/SignatureRequestEditEmbeddedExample.py
      - lang: cURL
        label: cURL
        source:
          $ref: examples/SignatureRequestEditEmbeddedExample.sh
      x-meta:
        seo:
          title: Edit Embedded Signature Request | Dropbox Sign for Developers
          description: The RESTful Dropbox Sign API easily allows you to build custom integrations. To find out how to edit a SignatureRequest in an iFrame, click here.
  /signature_request/edit_embedded_with_template/{signature_request_id}:
    put:
      tags:
      - Signature Request
      summary: Edit Embedded Signature Request with Template
      description: 'Edits a SignatureRequest based on the given Template(s) to be signed in an embedded iFrame. Note that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign.


        **NOTE:** Edit and resend *will* deduct your signature request quota.'
      operationId: signatureRequestEditEmbeddedWithTemplate
      parameters:
      - name: signature_request_id
        in: path
        description: The id of the SignatureRequest to edit.
        required: true
        schema:
          type: string
        example: fa5c8a0b0f492d768749333ad6fcc214c111e967
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SignatureRequestEditEmbeddedWithTemplateRequest'
            examples:
              example:
                $ref: '#/components/examples/SignatureRequestEditEmbeddedWithTemplateRequest'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/SignatureRequestEditEmbeddedWithTemplateRequest'
      responses:
        '200':
          description: successful operation
          headers:
            X-RateLimit-Limit:
              $ref: '#/components/headers/X-RateLimit-Limit'
            X-RateLimit-Remaining:
              $ref: '#/components/headers/X-RateLimit-Remaining'
            X-Ratelimit-Reset:
              $ref: '#/components/headers/X-Ratelimit-Reset'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SignatureRequestGetResponse'
              examples:
                example:
                  $ref: '#/components/examples/SignatureRequestCreateEmbeddedWithTemplateResponse'
        4XX:
          description: failed_operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                400_example:
                  $ref: '#/components/examples/Error400Response'
                401_example:
                  $ref: '#/components/examples/Error401Response'
                402_example:
                  $ref: '#/components/examples/Error402Response'
                403_example:
                  $ref: '#/components/examples/Error403Response'
                429_example:
                  $ref: '#/components/examples/Error429Response'
                404_example:
                  $ref: '#/components/examples/Error404Response'
                409_example:
                  $ref: '#/components/examples/Error409Response'
                4XX_example:
                  $ref: '#/components/examples/Error4XXResponse'
      security:
      - api_key: []
      - oauth2:
        - signature_request_access
      x-codeSamples:
      - lang: PHP
        label: PHP
        source:
          $ref: examples/SignatureRequestEditEmbeddedWithTem

# --- truncated at 32 KB (195 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/hellosign/refs/heads/main/openapi/hellosign-signature-request-api-openapi.yml