Docusign EnvelopeAttachments API

openapi: 3.0.1
info:
  title: DocuSign Admin AccountBrands EnvelopeAttachments API
  description: An API for an organization administrator to manage organizations, accounts and users
  termsOfService: https://www.docusign.com/company/terms-and-conditions/developers
  contact:
    name: DocuSign Developer Center
    url: https://developers.docusign.com
    email: devcenter@docusign.com
  version: v2.1
servers:
- url: https://api.docusign.net/Management
tags:
- name: EnvelopeAttachments
  description: 'The EnvelopeAttachments resource provides methods that allow you to manage attachments.

    '
paths:
  /v2/accounts/{accountId}/envelopes/{envelopeId}/attachments:
    get:
      tags:
      - EnvelopeAttachments
      summary: Docusign Returns a list of attachments associated with the specified envelope
      operationId: Attachments_GetAttachments
      parameters:
      - name: accountId
        in: path
        description: The external account number (int) or account id GUID.
        required: true
        schema:
          type: string
      - name: envelopeId
        in: path
        description: 'The envelope''s GUID. Eg 93be49ab-afa0-4adf-933c-f752070d71ec '
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful response.
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/envelopeAttachmentsResult'
        '400':
          description: Error encountered.
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/errorDetails'
      deprecated: false
      x-ds-methodname: getAttachments
      x-ds-api-status: beta
      x-ds-method: list
      x-ds-service: Envelopes
      x-ds-in-sdk: true
    put:
      tags:
      - EnvelopeAttachments
      summary: Docusign Add one or more attachments to a DRAFT or IN-PROCESS envelope.
      description: 'Supported attachment formats include: .asp, .bmp, .csv, .doc, .docm, .docx, .dot, .dotm, .dotx, .gif, .htm, .html, .jpeg, .jpg, .msg, .pdf, .png, .pot, .potx, .pps, .ppt, .pptm, .pptx, .ps, .rtf, .tif, .tiff, .txt, .wpd, .xls, .xlsm, .xlsx, .xml, and .xps. For more information on supported file formats please see [Supported File Formats](https://support.docusign.com/guides/ndse-user-guide-supported-file-formats).'
      operationId: Attachments_PutAttachments
      parameters:
      - name: accountId
        in: path
        description: The external account number (int) or account id GUID.
        required: true
        schema:
          type: string
      - name: envelopeId
        in: path
        description: 'The envelope''s GUID. Eg 93be49ab-afa0-4adf-933c-f752070d71ec '
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/envelopeAttachmentsRequest'
          application/xml:
            schema:
              $ref: '#/components/schemas/envelopeAttachmentsRequest'
        required: false
      responses:
        '200':
          description: Successful response.
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/envelopeAttachmentsResult'
        '400':
          description: Error encountered.
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/errorDetails'
      deprecated: false
      x-ds-methodname: putAttachments
      x-ds-api-status: beta
      x-ds-method: create
      x-ds-service: Envelopes
      x-ds-in-sdk: true
      x-codegen-request-body-name: envelopeAttachmentsRequest
    delete:
      tags:
      - EnvelopeAttachments
      summary: Docusign Delete one or more attachments from a DRAFT envelope.
      operationId: Attachments_DeleteAttachments
      parameters:
      - name: accountId
        in: path
        description: The external account number (int) or account id GUID.
        required: true
        schema:
          type: string
      - name: envelopeId
        in: path
        description: 'The envelope''s GUID. Eg 93be49ab-afa0-4adf-933c-f752070d71ec '
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/envelopeAttachmentsRequest'
          application/xml:
            schema:
              $ref: '#/components/schemas/envelopeAttachmentsRequest'
        required: false
      responses:
        '200':
          description: Successful response.
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/envelopeAttachmentsResult'
        '400':
          description: Error encountered.
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/errorDetails'
      deprecated: false
      x-ds-methodname: deleteAttachments
      x-ds-api-status: beta
      x-ds-method: delete
      x-ds-service: Envelopes
      x-ds-in-sdk: true
      x-codegen-request-body-name: envelopeAttachmentsRequest
  /v2/accounts/{accountId}/envelopes/{envelopeId}/attachments/{attachmentId}:
    get:
      tags:
      - EnvelopeAttachments
      summary: Docusign Retrieves an attachment from the envelope.
      operationId: Attachments_GetAttachment
      parameters:
      - name: accountId
        in: path
        description: The external account number (int) or account id GUID.
        required: true
        schema:
          type: string
      - name: attachmentId
        in: path
        required: true
        schema:
          type: string
      - name: envelopeId
        in: path
        description: 'The envelope''s GUID. Eg 93be49ab-afa0-4adf-933c-f752070d71ec '
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful response.
          content: {}
        '400':
          description: Error encountered.
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/errorDetails'
      deprecated: false
      x-ds-methodname: getAttachment
      x-ds-api-status: beta
      x-ds-method: get
      x-ds-service: Envelopes
      x-ds-in-sdk: true
    put:
      tags:
      - EnvelopeAttachments
      summary: Docusign Add an attachment to a DRAFT or IN-PROCESS envelope.
      operationId: Attachments_PutAttachment
      parameters:
      - name: accountId
        in: path
        description: The external account number (int) or account id GUID.
        required: true
        schema:
          type: string
      - name: attachmentId
        in: path
        required: true
        schema:
          type: string
      - name: envelopeId
        in: path
        description: 'The envelope''s GUID. Eg 93be49ab-afa0-4adf-933c-f752070d71ec '
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/attachment'
          application/xml:
            schema:
              $ref: '#/components/schemas/attachment'
        required: false
      responses:
        '200':
          description: Successful response.
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/envelopeAttachmentsResult'
        '400':
          description: Error encountered.
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/errorDetails'
      deprecated: false
      x-ds-methodname: putAttachment
      x-ds-api-status: beta
      x-ds-method: update
      x-ds-service: Envelopes
      x-ds-in-sdk: true
      x-codegen-request-body-name: attachment
components:
  schemas:
    envelopeAttachmentsResult:
      type: object
      properties:
        attachments:
          type: array
          description: ''
          items:
            $ref: '#/components/schemas/envelopeAttachment'
      description: ''
      x-ds-definition-name: envelopeAttachmentsResult
      x-ms-summary: ''
    envelopeAttachment:
      type: object
      properties:
        accessControl:
          type: string
          description: ''
        attachmentId:
          type: string
          description: ''
        attachmentType:
          type: string
          description: ''
        errorDetails:
          $ref: '#/components/schemas/errorDetails'
        label:
          type: string
          description: ''
        name:
          type: string
          description: ''
      description: ''
      x-ds-definition-name: envelopeAttachment
      x-ms-summary: ''
    errorDetails:
      type: object
      properties:
        errorCode:
          type: string
          description: An error code associated with the error.
        message:
          type: string
          description: A short error message.
      description: This object describes errors that occur. It is only valid for responses, and ignored in requests.
      x-ds-definition-name: errorDetails
      x-ms-summary: This object describes errors that occur. It is only valid for responses, and ignored in requests.
    envelopeAttachmentsRequest:
      type: object
      properties:
        attachments:
          type: array
          description: ''
          items:
            $ref: '#/components/schemas/attachment'
      description: ''
      x-ds-definition-name: envelopeAttachmentsRequest
      x-ms-summary: ''
    attachment:
      type: object
      properties:
        accessControl:
          type: string
          description: ''
        attachmentId:
          type: string
          description: ''
        attachmentType:
          type: string
          description: Specifies the type of the attachment for the recipient.
        data:
          type: string
          description: ''
        label:
          type: string
          description: ''
        name:
          type: string
          description: ''
        remoteUrl:
          type: string
          description: ''
      description: Contains information about an attachment.
      x-ds-definition-name: attachment
      x-ms-summary: Contains information about an attachment.
  securitySchemes:
    accessCode:
      type: oauth2
      description: OAuth2 Access code Grant
      flows:
        authorizationCode:
          authorizationUrl: https://account.docusign.com/oauth/auth
          tokenUrl: https://account.docusign.com/oauth/auth
          scopes:
            organization_read: ''
            permission_read: ''
            group_read: ''
            user_read: ''
            account_read: ''
            account_write: ''
            user_write: ''
            identity_provider_read: ''
            domain_read: ''
x-ds-categories:
- name: UserManagement
  summary: Methods to manage users in an account.
  description: Methods to manage users in an account.
- name: BulkOperations
  summary: Methods to import and export users and accounts.
  description: Methods to import and export users and accounts.
- name: IdentityProviders
  summary: Methods to get a list of identity providers.
  description: Methods to get a list of identity providers.
- name: ReservedDomains
  summary: Methods to get a list of reserved domains.
  description: Methods to get a list of reserved domains.
- name: Organization
  summary: Methods for working with organizations.
  description: Methods for working with organizations.
x-original-swagger-version: '2.0'