Dropbox Embedded API

openapi: 3.2.0
info:
  title: Reference Embedded API
  version: 1.0.0
servers:
- url: https://api.hellosign.com/v3
  description: https://api.hellosign.com/v3
tags:
- name: Embedded
paths:
  /embedded/sign_url/{signature_id}:
    get:
      operationId: embedded_signUrl
      summary: Get Embedded Sign URL
      description: Retrieves an embedded object containing a signature url that can be opened in an iFrame. Note that templates created via the embedded template process will only be accessible through the API.
      tags:
      - Embedded
      parameters:
      - name: signature_id
        in: path
        description: The id of the signature to get a signature url for.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmbeddedSignUrlResponse'
        '400':
          description: failed_operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
      - Basic: []
  /embedded/edit_url/{template_id}:
    post:
      operationId: embedded_editUrl
      summary: Get Embedded Template Edit URL
      description: Retrieves an embedded object containing a template url that can be opened in an iFrame. Note that only templates created via the embedded template process are available to be edited with this endpoint.
      tags:
      - Embedded
      parameters:
      - name: template_id
        in: path
        description: The id of the template to edit.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmbeddedEditUrlResponse'
        '400':
          description: failed_operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EmbeddedEditUrlRequest'
      security:
      - Basic: []
components:
  schemas:
    EmbeddedEditUrlResponse:
      type: object
      properties:
        embedded:
          $ref: '#/components/schemas/EmbeddedEditUrlResponseEmbedded'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/WarningResponse'
          description: A list of warnings.
      required:
      - embedded
      title: EmbeddedEditUrlResponse
    SubMergeFieldType:
      type: string
      enum:
      - text
      - checkbox
      description: The type of merge field.
      title: SubMergeFieldType
    ErrorResponse:
      type: object
      properties:
        error:
          $ref: '#/components/schemas/ErrorResponseError'
      required:
      - error
      title: ErrorResponse
    EmbeddedEditUrlRequest:
      type: object
      properties:
        allow_edit_ccs:
          type: boolean
          default: false
          description: This allows the requester to enable/disable to add or change CC roles when editing the template.
        cc_roles:
          type: array
          items:
            type: string
          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.
        editor_options:
          $ref: '#/components/schemas/SubEditorOptions'
        force_signer_roles:
          type: boolean
          default: false
          description: Provide users the ability to review/edit the template signer roles.
        force_subject_message:
          type: boolean
          default: false
          description: Provide users the ability to review/edit the template subject and message.
        merge_fields:
          type: array
          items:
            $ref: '#/components/schemas/SubMergeField'
          description: 'Add additional merge fields to the template, which can be used used to pre-fill data by passing values into signature requests made with that template.


            Remove all merge fields on the template by passing an empty array `[]`.'
        preview_only:
          type: boolean
          default: false
          description: 'This allows the requester to enable the preview experience (i.e. does not allow the requester''s end user to add any additional fields via the editor).


            **NOTE:** This parameter overwrites `show_preview=true` (if set).'
        show_preview:
          type: boolean
          default: false
          description: This allows the requester to enable the editor/preview experience.
        show_progress_stepper:
          type: boolean
          default: true
          description: When only one step remains in the signature request process and this parameter is set to `false` then the progress stepper will be hidden.
        test_mode:
          type: boolean
          default: false
          description: Whether this is a test, locked templates will only be available for editing if this is set to `true`. Defaults to `false`.
      title: EmbeddedEditUrlRequest
    ErrorResponseError:
      type: object
      properties:
        error_msg:
          type: string
          description: Message describing an error.
        error_path:
          type: string
          description: Path at which an error occurred.
        error_name:
          type: string
          description: Name of the error. See the `x-error-codes` catalog in openapi file for a complete list of possible error codes with detailed information including HTTP status codes, causes, remediation steps, and retry guidance.
      required:
      - error_msg
      - error_name
      description: Contains information about an error that occurred.
      title: ErrorResponseError
    SubEditorOptions:
      type: object
      properties:
        allow_edit_signers:
          type: boolean
          default: false
          description: Allows requesters to edit the list of signers
        allow_edit_documents:
          type: boolean
          default: false
          description: Allows requesters to edit documents, including delete and add
      description: This allows the requester to specify editor options when a preparing a document
      title: SubEditorOptions
    SubMergeField:
      type: object
      properties:
        name:
          type: string
          description: The name of the merge field. Must be unique.
        type:
          $ref: '#/components/schemas/SubMergeFieldType'
          description: The type of merge field.
      required:
      - name
      - type
      title: SubMergeField
    EmbeddedEditUrlResponseEmbedded:
      type: object
      properties:
        edit_url:
          type: string
          description: A template url that can be opened in an iFrame.
        expires_at:
          type: integer
          description: The specific time that the the `edit_url` link expires, in epoch.
      description: An embedded template object.
      title: EmbeddedEditUrlResponseEmbedded
    EmbeddedSignUrlResponseEmbedded:
      type: object
      properties:
        sign_url:
          type: string
          description: A signature url that can be opened in an iFrame.
        expires_at:
          type: integer
          description: The specific time that the the `sign_url` link expires, in epoch.
      description: An object that contains necessary information to set up embedded signing.
      title: EmbeddedSignUrlResponseEmbedded
    WarningResponse:
      type: object
      properties:
        warning_msg:
          type: string
          description: Warning message
        warning_name:
          type: string
          description: Warning name
      required:
      - warning_msg
      - warning_name
      description: A list of warnings.
      title: WarningResponse
    EmbeddedSignUrlResponse:
      type: object
      properties:
        embedded:
          $ref: '#/components/schemas/EmbeddedSignUrlResponseEmbedded'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/WarningResponse'
          description: A list of warnings.
      required:
      - embedded
      title: EmbeddedSignUrlResponse
  securitySchemes:
    Basic:
      type: http
      scheme: basic
      description: "Use your API key with HTTP Basic authentication in the form `Basic <api_key>`. See [Authentication](/api/reference/authentication) for more information.\n✅ Supported by Try it console (calls sent in `test_mode` only).            \n"
    Bearer:
      type: http
      scheme: bearer
      description: "You can use an Access Token issued through an OAuth flow to send calls to the Dropbox Sign API from your app. The access scopes required by this endpoint are listed in the gray box above. See [Authentication](/api/reference/authentication) for more information.\n  ❌ **Not supported** by Try it console.\n"
x-provenance:
  method: harvested
  publisher: Dropbox
  source: https://developers.hellosign.com/openapi/api-reference.yaml
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)