openapi: 3.0.3
info:
  title: Docupilot accounts APIs ai linked_accounts API
  version: '1.0'
  description: Docupilot accounts APIs
  termsOfService: https://docupilot.app/terms-and-conditions/
  contact:
    name: Team Docupilot
    email: support@docupilot.app
tags:
- name: linked_accounts
paths:
  /dashboard/api/v2/linked_accounts/:
    get:
      operationId: list_delivery_accounts
      summary: Get list of linked accounts
      parameters:
      - in: header
        name: X-Workspace
        schema:
          type: string
        description: Workspace unique_key
        required: true
      - name: ordering
        required: false
        in: query
        description: Which field to use when ordering the results.
        schema:
          type: string
      - name: search
        required: false
        in: query
        description: A search term.
        schema:
          type: string
      - in: query
        name: type
        schema:
          type: string
          enum:
          - aws_s3
          - azure_storage
          - box
          - docu_sign
          - dropbox
          - email
          - eversign
          - google_drive
          - hellosign
          - one_drive
          - podio
          - sftp
          - sharepoint
          - sign_now
          - signable
          - yousign
          - zoho
          - zoho_crm
      tags:
      - linked_accounts
      security:
      - SessionAuthentication: []
      responses:
        '200':
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/DeliveryAccount'
          description: ''
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthenticatedError'
          description: ''
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenError'
          description: ''
    post:
      operationId: add_delivery_account
      summary: Create linked account
      parameters:
      - in: header
        name: X-Workspace
        schema:
          type: string
        description: Workspace unique_key
        required: true
      tags:
      - linked_accounts
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeliveryAccount'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/DeliveryAccount'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/DeliveryAccount'
        required: true
      security:
      - SessionAuthentication: []
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeliveryAccount'
          description: ''
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationError'
          description: ''
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthenticatedError'
          description: ''
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenError'
          description: ''
  /dashboard/api/v2/linked_accounts/{integrator_type}/invoke/:
    get:
      operationId: invoke_integrator
      description: Redirects to oauth endpoint to add a new linked account of given 'integrator_type'
      parameters:
      - in: header
        name: X-Workspace
        schema:
          type: string
        description: Workspace unique_key
        required: true
      - in: query
        name: environment
        schema:
          type: string
        description: 'sub-type of integrator. For example: sandbox or production for docu_sign'
      - in: path
        name: integrator_type
        schema:
          type: string
          enum:
          - box
          - docu_sign
          - dropbox
          - eversign
          - google_drive
          - one_drive
          - podio
          - sharepoint
          - sign_now
          - zoho
        description: Type of integrator
        required: true
      tags:
      - linked_accounts
      security:
      - SessionAuthentication: []
      responses:
        '302':
          description: No response body
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthenticatedError'
          description: ''
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenError'
          description: ''
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundError'
          description: ''
  /dashboard/api/v2/linked_accounts/{id}/:
    put:
      operationId: update_delivery_account
      summary: Refresh linked account
      parameters:
      - in: header
        name: X-Workspace
        schema:
          type: string
        description: Workspace unique_key
        required: true
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this delivery account.
        required: true
      tags:
      - linked_accounts
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateDeliveryAccount'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/UpdateDeliveryAccount'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/UpdateDeliveryAccount'
        required: true
      security:
      - SessionAuthentication: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeliveryAccount'
          description: ''
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationError'
          description: ''
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthenticatedError'
          description: ''
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenError'
          description: ''
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundError'
          description: ''
    delete:
      operationId: revoke_delivery_account
      summary: Revoke linked account
      parameters:
      - in: header
        name: X-Workspace
        schema:
          type: string
        description: Workspace unique_key
        required: true
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this delivery account.
        required: true
      tags:
      - linked_accounts
      security:
      - SessionAuthentication: []
      responses:
        '204':
          description: No response body
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationError'
          description: ''
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthenticatedError'
          description: ''
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenError'
          description: ''
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundError'
          description: ''
  /dashboard/api/v2/linked_accounts/{id}/box_drive_picker_payload/:
    get:
      operationId: get_box_drive_picker_payload
      description: Get box drive picker payload
      parameters:
      - in: header
        name: X-Workspace
        schema:
          type: string
        description: Workspace unique_key
        required: true
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this delivery account.
        required: true
      tags:
      - linked_accounts
      security:
      - SessionAuthentication: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BoxDrivePickerPayload'
          description: ''
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationError'
          description: ''
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthenticatedError'
          description: ''
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenError'
          description: ''
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundError'
          description: ''
  /dashboard/api/v2/linked_accounts/{id}/deliveries/:
    get:
      operationId: list_account_deliveries
      description: List account deliveries
      parameters:
      - in: header
        name: X-Workspace
        schema:
          type: string
        description: Workspace unique_key
        required: true
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this delivery account.
        required: true
      - name: page
        required: false
        in: query
        description: A page number within the paginated result set.
        schema:
          type: integer
      - in: query
        name: type
        schema:
          type: string
          enum:
          - aws_s3
          - azure_storage
          - box
          - docu_sign
          - dropbox
          - email
          - eversign
          - google_drive
          - hellosign
          - one_drive
          - podio
          - sftp
          - sharepoint
          - sign_now
          - signable
          - yousign
          - zoho
          - zoho_crm
      tags:
      - linked_accounts
      security:
      - SessionAuthentication: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedAccountDeliveryList'
          description: ''
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthenticatedError'
          description: ''
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenError'
          description: ''
  /dashboard/api/v2/linked_accounts/{id}/delivery_emails/:
    get:
      operationId: list_delivery_emails_for_email_account
      description: List delivery emails for email account
      parameters:
      - in: header
        name: X-Workspace
        schema:
          type: string
        description: Workspace unique_key
        required: true
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this delivery account.
        required: true
      tags:
      - linked_accounts
      security:
      - SessionAuthentication: []
      responses:
        '200':
          content:
            application/json:
              schema:
                type: array
                items:
                  type: string
              examples:
                ResponseExample:
                  value:
                  - abc@gmail.com
                  - abcd@gmail.com
                  summary: Response Example
          description: An array of emails
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthenticatedError'
          description: ''
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenError'
          description: ''
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundError'
          description: ''
  /dashboard/api/v2/linked_accounts/{id}/docusign_folders/:
    get:
      operationId: get_docusign_folders
      description: Get docusign folders
      parameters:
      - in: header
        name: X-Workspace
        schema:
          type: string
        description: Workspace unique_key
        required: true
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this delivery account.
        required: true
      tags:
      - linked_accounts
      security:
      - SessionAuthentication: []
      responses:
        '200':
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/DocuSignFolder'
          description: ''
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthenticatedError'
          description: ''
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenError'
          description: ''
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundError'
          description: ''
  /dashboard/api/v2/linked_accounts/{id}/google_picker_payload/:
    get:
      operationId: get_google_picker_payload
      description: Get google picker payload
      parameters:
      - in: header
        name: X-Workspace
        schema:
          type: string
        description: Workspace unique_key
        required: true
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this delivery account.
        required: true
      tags:
      - linked_accounts
      security:
      - SessionAuthentication: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GoogleDrivePickerPayload'
          description: ''
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationError'
          description: ''
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthenticatedError'
          description: ''
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenError'
          description: ''
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundError'
          description: ''
  /dashboard/api/v2/linked_accounts/{id}/initiate_authorization/:
    post:
      operationId: initiate_email_authorization
      description: Initiate email authorization
      parameters:
      - in: header
        name: X-Workspace
        schema:
          type: string
        description: Workspace unique_key
        required: true
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this delivery account.
        required: true
      tags:
      - linked_accounts
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SendEmailAccountAuthorizationOTP'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/SendEmailAccountAuthorizationOTP'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/SendEmailAccountAuthorizationOTP'
        required: true
      security:
      - SessionAuthentication: []
      responses:
        '204':
          description: No response body
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationError'
          description: ''
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthenticatedError'
          description: ''
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenError'
          description: ''
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundError'
          description: ''
  /dashboard/api/v2/linked_accounts/{id}/reconnect/:
    get:
      operationId: reconnect_account
      description: Redirects to oauth endpoint for re-connecting an account
      parameters:
      - in: header
        name: X-Workspace
        schema:
          type: string
        description: Workspace unique_key
        required: true
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this delivery account.
        required: true
      tags:
      - linked_accounts
      security:
      - SessionAuthentication: []
      responses:
        '302':
          description: No response body
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthenticatedError'
          description: ''
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenError'
          description: ''
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundError'
          description: ''
  /dashboard/api/v2/linked_accounts/{id}/sharepoint_picker_payload/:
    get:
      operationId: get_sharepoint_picker_payload
      description: Get sharepoint picker payload
      parameters:
      - in: header
        name: X-Workspace
        schema:
          type: string
        description: Workspace unique_key
        required: true
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this delivery account.
        required: true
      tags:
      - linked_accounts
      security:
      - SessionAuthentication: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SharepointPickerPayload'
          description: ''
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationError'
          description: ''
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthenticatedError'
          description: ''
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenError'
          description: ''
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundError'
          description: ''
  /dashboard/api/v2/linked_accounts/{id}/toggle_use_for_images/:
    post:
      operationId: update_delivery_accounts_use_for_images_flag
      description: Update delivery accounts use for images flag
      parameters:
      - in: header
        name: X-Workspace
        schema:
          type: string
        description: Workspace unique_key
        required: true
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this delivery account.
        required: true
      tags:
      - linked_accounts
      security:
      - SessionAuthentication: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeliveryAccount'
          description: ''
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationError'
          description: ''
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthenticatedError'
          description: ''
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenError'
          description: ''
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundError'
          description: ''
  /dashboard/api/v2/linked_accounts/{id}/verify_otp/:
    put:
      operationId: verify_email_otp
      description: Verify email otp
      parameters:
      - in: header
        name: X-Workspace
        schema:
          type: string
        description: Workspace unique_key
        required: true
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this delivery account.
        required: true
      tags:
      - linked_accounts
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/VerifyEmailAccountOTP'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/VerifyEmailAccountOTP'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/VerifyEmailAccountOTP'
        required: true
      security:
      - SessionAuthentication: []
      responses:
        '204':
          description: No response body
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationError'
          description: ''
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthenticatedError'
          description: ''
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenError'
          description: ''
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundError'
          description: ''
  /dashboard/api/v2/linked_accounts/send_test_mail/:
    post:
      operationId: Send test mail
      description: send_test_mail
      parameters:
      - in: header
        name: X-Workspace
        schema:
          type: string
        description: Workspace unique_key
        required: true
      tags:
      - linked_accounts
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SendTestSmtpMail'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/SendTestSmtpMail'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/SendTestSmtpMail'
        required: true
      security:
      - SessionAuthentication: []
      responses:
        '200':
          description: No response body
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationError'
          description: ''
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthenticatedError'
          description: ''
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenError'
          description: ''
components:
  schemas:
    UnauthenticatedError:
      type: object
      properties:
        detail:
          type: string
      required:
      - detail
      description: ''
    AccountDelivery:
      type: object
      properties:
        id:
          type: integer
          readOnly: true
        name:
          type: string
          maxLength: 255
        last_used_on:
          type: string
          format: date-time
          nullable: true
        template_info:
          $ref: '#/components/schemas/TemplateInfo'
      required:
      - id
      - name
      - template_info
      description: ''
    DocuSignFolderOwner:
      type: object
      properties:
        userName:
          type: string
        userId:
          type: string
        email:
          type: string
          format: email
      required:
      - email
      - userId
      - userName
      description: ''
    UpdateDeliveryAccount:
      type: object
      description: ''
      properties:
        id:
          type: integer
          readOnly: true
        sub_type:
          type: string
          readOnly: true
        used_by:
          type: integer
          readOnly: true
        name:
          type: string
          readOnly: true
          nullable: true
        type:
          enum:
          - docu_sign
          - sign_now
          - zoho_crm
          - dropbox
          - google_drive
          - podio
          - one_drive
          - sharepoint
          - eversign
          - box
          - zoho
          - hellosign
          - aws_s3
          - signable
          - yousign
          - email
          - sftp
          - azure_storage
          type: string
          readOnly: true
        credentials:
          type: object
          additionalProperties: {}
          writeOnly: true
        is_expired:
          type: boolean
          readOnly: true
        updated_at:
          type: string
          format: date-time
          readOnly: true
          nullable: true
        use_for_images:
          type: boolean
      required:
      - credentials
      - id
      - is_expired
      - name
      - sub_type
      - type
      - updated_at
      - used_by
    ValidationError:
      type: object
      properties:
        errors:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
        non_field_errors:
          type: array
          items:
            type: string
      required:
      - errors
      - non_field_errors
      description: ''
    ForbiddenError:
      type: object
      properties:
        detail:
          type: string
      required:
      - detail
      description: ''
    BoxDrivePickerPayload:
      type: object
      properties:
        payload:
          type: string
      required:
      - payload
      description: ''
    TemplateInfo:
      type: object
      properties:
        id:
          type: integer
          readOnly: true
        name:
          type: string
          readOnly: true
        status:
          type: string
          readOnly: true
        type:
          type: string
          readOnly: true
      required:
      - id
      - name
      - status
      - type
      description: ''
    SendTestSmtpMail:
      type: object
      properties:
        smtp_server_address:
          type: string
          maxLength: 255
        smtp_server_username:
          type: string
          maxLength: 255
        smtp_server_password:
          type: string
          maxLength: 255
        smtp_port:
          type: integer
        smtp_encryption_type:
          enum:
          - TLS
          - SSL
          type: string
        email:
          type: string
          format: email
      required:
      - email
      - smtp_encryption_type
      - smtp_port
      - smtp_server_address
      - smtp_server_password
      - smtp_server_username
      description: ''
    SharepointPickerPayload:
      type: object
      properties:
        payload:
          type: string
      required:
      - payload
      description: ''
    DocuSignFolder:
      type: object
      properties:
        name:
          type: string
        type:
          type: string
        owner:
          $ref: '#/components/schemas/DocuSignFolderOwner'
        folderId:
          type: string
        uri:
          type: string
        itemCount:
          type: string
        hasSubFolders:
          type: string
      required:
      - folderId
      - hasSubFolders
      - itemCount
      - name
      - owner
      - type
      - uri
      description: ''
    NotFoundError:
      type: object
      properties:
        detail:
          type: string
      required:
      - detail
      description: ''
    GoogleDrivePickerPayload:
      type: object
      properties:
        payload:
          type: string
      required:
      - payload
      description: ''
    VerifyEmailAccountOTP:
      type: object
      properties:
        action_name:
          enum:
          - verify
          - update
          type: string
        email:
          type: string
          format: email
          nullable: true
        otp:
          type: string
          maxLength: 6
        display_name:
          type: string
      required:
      - action_name
      - otp
      description: ''
    DeliveryAccount:
      type: object
      description: ''
      properties:
        id:
          type: integer
          readOnly: true
        sub_type:
          type: string
          readOnly: true
        used_by:
          type: integer
          readOnly: true
        name:
          type: string
          readOnly: true
          nullable: true
        type:
          enum:
          - docu_sign
          - sign_now
          - zoho_crm
          - dropbox
          - google_drive
          - podio
          - one_drive
          - sharepoint
          - eversign
          - box
          - zoho
          - hellosign
          - aws_s3
          - signable
          - yousign
          - email
          - sftp
          - azure_storage
          type: string
        credentials:
          type: object
          additionalProperties: {}
          writeOnly: true
        is_expired:
          type: boolean
          readOnly: true
        updated_at:
          type: string
          format: date-time
          readOnly: true
          nullable: true
        use_for_images:
          type: boolean
      required:
      - credentials
      - id
      - is_expired
      - name
      - sub_type
      - type
      - updated_at
      - used_by
    SendEmailAccountAuthorizationOTP:
      type: object
      properties:
        action_name:
          enum:
          - verify
          - update
          type: string
        email:
          type: string
          format: email
          nullable: true
      required:
      - action_name
      description: ''
    PaginatedAccountDeliveryList:
      type: object
      required:
      - count
      - results
      properties:
        count:
          type: integer
          example: 123
        next:
          type: string
          nullable: true
          format: uri
          example: http://api.example.org/accounts/?page=4
        previous:
          type: string
          nullable: true
          format: uri
          example: http://api.example.org/accounts/?page=2
        results:
          type: array
          items:
            $ref: '#/components/schemas/AccountDelivery'
  securitySchemes:
    OAuthAuthentication:
      type: http
      scheme: bearer
      description: OAuth2 Bearer Token Authentication
    SessionAuthentication:
      type: apiKey
      in: cookie
      name: sessionid
      description: browser based login takes care of this
externalDocs:
  description: Help docs on how to use API
  url: https://help.docupilot.app/developers/api-overview