Dropbox Account API

openapi: 3.2.0
info:
  title: Dropbox Account API
  version: 1.0.0
  description: 'Operations tagged Account across 2 of this provider''s published API definitions: dropbox-openapi-original.yml, dropbox-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.dropbox.com
- url: https://api.hellosign.com/v3
  description: https://api.hellosign.com/v3
tags:
- name: Account
paths:
  /2/account/set_profile_photo:
    post:
      tags:
      - Account
      summary: Dropbox set_profile_photo
      description: 'set_profile_photo


        scope: `account_info.write`


        Sets a user''s profile photo.'
      requestBody:
        content:
          '*/*':
            schema:
              type: string
              example: '"{\n    \"photo\": {\n        \".tag\": \"base64_data\", \n        \"base64_data\": \"SW1hZ2UgZGF0YSBpbiBiYXNlNjQtZW5jb2RlZCBieXRlcy4gTm90IGEgdmFsaWQgZXhhbXBsZS4=\"\n    }\n}"'
      parameters:
      - name: Content-Type
        in: header
        schema:
          type: string
        example: application/json
      responses:
        '200':
          description: OK
          headers:
            X-Dropbox-Request-Id:
              schema:
                type: integer
                example: '1234'
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                profile_photo_url: https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128
      security:
      - bearerAuth: []
      operationId: post2AccountSetProfilePhoto
      x-operation-id-source: derived
    servers:
    - url: https://api.dropbox.com
  /account:
    get:
      operationId: account_get
      summary: Get Account
      description: Returns the properties and settings of your Account.
      tags:
      - Account
      parameters:
      - name: account_id
        in: query
        description: '`account_id` or `email_address` is required. If both are provided, the account id prevails.


          The ID of the Account.'
        required: false
        schema:
          type: string
      - name: email_address
        in: query
        description: '`account_id` or `email_address` is required, If both are provided, the account id prevails.


          The email address of the Account.'
        required: false
        schema:
          type: string
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccountGetResponse'
        '400':
          description: failed_operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
      - Basic: []
    put:
      operationId: account_update
      summary: Update Account
      description: Updates the properties and settings of your Account. Currently only allows for updates to the Callback URL and locale.
      tags:
      - Account
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccountGetResponse'
        '400':
          description: failed_operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AccountUpdateRequest'
      security:
      - Basic: []
    servers:
    - url: https://api.hellosign.com/v3
      description: https://api.hellosign.com/v3
  /account/create:
    post:
      operationId: account_create
      summary: Create Account
      description: Creates a new Dropbox Sign Account that is associated with the specified `email_address`.
      tags:
      - Account
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccountCreateResponse'
        '400':
          description: failed_operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AccountCreateRequest'
      security:
      - Basic: []
    servers:
    - url: https://api.hellosign.com/v3
      description: https://api.hellosign.com/v3
  /account/verify:
    post:
      operationId: account_verify
      summary: Verify Account
      description: Verifies whether an Dropbox Sign Account exists for the given email address.
      tags:
      - Account
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccountVerifyResponse'
        '400':
          description: failed_operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AccountVerifyRequest'
      security:
      - Basic: []
    servers:
    - url: https://api.hellosign.com/v3
      description: https://api.hellosign.com/v3
components:
  schemas:
    AccountVerifyResponseAccount:
      type: object
      properties:
        email_address:
          type: string
          description: The email address associated with the Account.
      title: AccountVerifyResponseAccount
    AccountGetResponse:
      type: object
      properties:
        account:
          $ref: '#/components/schemas/AccountResponse'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/WarningResponse'
          description: A list of warnings.
      required:
      - account
      title: AccountGetResponse
    OAuthTokenResponse:
      type: object
      properties:
        access_token:
          type: string
        token_type:
          type: string
        refresh_token:
          type: string
        expires_in:
          type: integer
          description: Number of seconds until the `access_token` expires. Uses epoch time.
        state:
          type:
          - string
          - 'null'
      title: OAuthTokenResponse
    AccountResponse:
      type: object
      properties:
        account_id:
          type: string
          description: The ID of the Account
        email_address:
          type: string
          description: The email address associated with the Account.
        is_locked:
          type: boolean
          description: Returns `true` if the user has been locked out of their account by a team admin.
        is_paid_hs:
          type: boolean
          description: Returns `true` if the user has a paid Dropbox Sign account.
        is_paid_hf:
          type: boolean
          description: Returns `true` if the user has a paid HelloFax account.
        quotas:
          $ref: '#/components/schemas/AccountResponseQuotas'
        callback_url:
          type:
          - string
          - 'null'
          description: The URL that Dropbox Sign events will `POST` to.
        role_code:
          type:
          - string
          - 'null'
          description: The membership role for the team.
        team_id:
          type:
          - string
          - 'null'
          description: The id of the team account belongs to.
        locale:
          type:
          - string
          - 'null'
          description: The locale used in this Account. Check out the list of [supported locales](/api/reference/constants/#supported-locales) to learn more about the possible values.
        usage:
          $ref: '#/components/schemas/AccountResponseUsage'
        settings:
          $ref: '#/components/schemas/AccountResponseSettings'
      title: AccountResponse
    AccountResponseUsage:
      type: object
      properties:
        fax_pages_sent:
          type:
          - integer
          - 'null'
          description: Number of fax pages sent
      description: Details concerning monthly usage
      title: AccountResponseUsage
    AccountCreateRequest:
      type: object
      properties:
        client_id:
          type: string
          description: 'Used when creating a new account with OAuth authorization.


            See [OAuth 2.0 Authorization](https://app.hellosign.com/api/oauthWalkthrough#OAuthAuthorization)'
        client_secret:
          type: string
          description: 'Used when creating a new account with OAuth authorization.


            See [OAuth 2.0 Authorization](https://app.hellosign.com/api/oauthWalkthrough#OAuthAuthorization)'
        email_address:
          type: string
          format: email
          description: The email address which will be associated with the new Account.
        locale:
          type: string
          description: The locale used in this Account. Check out the list of [supported locales](/api/reference/constants/#supported-locales) to learn more about the possible values.
      required:
      - email_address
      title: AccountCreateRequest
    ErrorResponse:
      type: object
      properties:
        error:
          $ref: '#/components/schemas/ErrorResponseError'
      required:
      - error
      title: ErrorResponse
    AccountUpdateRequest:
      type: object
      properties:
        account_id:
          type:
          - string
          - 'null'
          description: The ID of the Account
        callback_url:
          type: string
          description: The URL that Dropbox Sign should POST events to.
        locale:
          type: string
          description: The locale used in this Account. Check out the list of [supported locales](/api/reference/constants/#supported-locales) to learn more about the possible values.
      title: AccountUpdateRequest
    AccountResponseQuotas:
      type: object
      properties:
        api_signature_requests_left:
          type:
          - integer
          - 'null'
          description: API signature requests remaining.
        documents_left:
          type:
          - integer
          - 'null'
          description: Signature requests remaining.
        templates_total:
          type:
          - integer
          - 'null'
          description: Total API templates allowed.
        templates_left:
          type:
          - integer
          - 'null'
          description: API templates remaining.
        sms_verifications_left:
          type:
          - integer
          - 'null'
          description: SMS verifications remaining.
        num_fax_pages_left:
          type:
          - integer
          - 'null'
          description: Number of fax pages left
      description: Details concerning remaining monthly quotas.
      title: AccountResponseQuotas
    AccountCreateResponse:
      type: object
      properties:
        account:
          $ref: '#/components/schemas/AccountResponse'
        oauth_data:
          $ref: '#/components/schemas/OAuthTokenResponse'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/WarningResponse'
          description: A list of warnings.
      required:
      - account
      title: AccountCreateResponse
    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
    AccountResponseSettings:
      type: object
      properties:
        signer_access_codes:
          type: boolean
          description: Returns `true` if _Custom access codes_ is enabled in Admin Console. [Read more](https://developers.hellosign.com/docs/sms-tools/walkthrough).
        sms_delivery:
          type: boolean
          description: Returns `true` if _Text message_ is enabled in Admin Console. [Read more](https://developers.hellosign.com/docs/sms-tools/walkthrough).
        sms_authentication:
          type: boolean
          description: Returns `true` if _Signer authentication_ is enabled in Admin Console. [Read more](https://developers.hellosign.com/docs/sms-tools/walkthrough).
      description: Subset of configured settings
      title: AccountResponseSettings
    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
    AccountVerifyRequest:
      type: object
      properties:
        email_address:
          type: string
          format: email
          description: Email address to run the verification for.
      required:
      - email_address
      title: AccountVerifyRequest
    AccountVerifyResponse:
      type: object
      properties:
        account:
          $ref: '#/components/schemas/AccountVerifyResponseAccount'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/WarningResponse'
          description: A list of warnings.
      title: AccountVerifyResponse
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
    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-refined-from:
- dropbox-openapi-original.yml
- dropbox-openapi.yml