DocuSign REST API — TemplateBulkRecipients

naftiko: 1.0.0-alpha2
info:
  label: DocuSign REST API — TemplateBulkRecipients
  description: 'DocuSign REST API — TemplateBulkRecipients. 3 operations. Lead operation: Docusign Gets the bulk recipient
    file from a template.. Self-contained Naftiko capability covering one Docusign business surface.'
  tags:
  - Docusign
  - TemplateBulkRecipients
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    DOCUSIGN_API_KEY: DOCUSIGN_API_KEY
capability:
  consumes:
  - type: http
    namespace: docusign-templatebulkrecipients
    baseUri: https://www.docusign.net/restapi
    description: DocuSign REST API — TemplateBulkRecipients business capability. Self-contained, no shared references.
    resources:
    - name: v2-accounts-accountId-templates-templateId-recipients-recipientId-bulk_recipient
      path: /v2/accounts/{accountId}/templates/{templateId}/recipients/{recipientId}/bulk_recipients
      operations:
      - name: recipientsgettemplatebulkrecipients
        method: GET
        description: Docusign Gets the bulk recipient file from a template.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: accountId
          in: path
          type: string
          description: The external account number (int) or account id GUID.
          required: true
        - name: recipientId
          in: path
          type: string
          description: A local reference that senders use to map recipients to other objects, such as specific document tabs.
            Within an envelope, each `recipientId` must be unique, bu
          required: true
        - name: templateId
          in: path
          type: string
          description: The ID of the template being accessed.
          required: true
        - name: include_tabs
          in: query
          type: string
          description: When set to **true**, the tab information associated with the recipient is included in the response.
        - name: start_position
          in: query
          type: string
          description: Reserved for DocuSign.
      - name: recipientsputtemplatebulkrecipients
        method: PUT
        description: Docusign Adds or replaces the bulk recipients list in a template.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: accountId
          in: path
          type: string
          description: The external account number (int) or account id GUID.
          required: true
        - name: recipientId
          in: path
          type: string
          description: A local reference that senders use to map recipients to other objects, such as specific document tabs.
            Within an envelope, each `recipientId` must be unique, bu
          required: true
        - name: templateId
          in: path
          type: string
          description: The ID of the template being accessed.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
      - name: recipientsdeletetemplatebulkrecipientsfile
        method: DELETE
        description: Docusign Deletes the bulk recipient list on a template.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: accountId
          in: path
          type: string
          description: The external account number (int) or account id GUID.
          required: true
        - name: recipientId
          in: path
          type: string
          description: A local reference that senders use to map recipients to other objects, such as specific document tabs.
            Within an envelope, each `recipientId` must be unique, bu
          required: true
        - name: templateId
          in: path
          type: string
          description: The ID of the template being accessed.
          required: true
  exposes:
  - type: rest
    namespace: docusign-templatebulkrecipients-rest
    port: 8080
    description: REST adapter for DocuSign REST API — TemplateBulkRecipients. One Spectral-compliant resource per consumed
      operation, prefixed with /v1.
    resources:
    - path: /v1/v2/accounts/{accountid}/templates/{templateid}/recipients/{recipientid}/bulk-recipients
      name: v2-accounts-accountid-templates-templateid-recipients-recipientid-bulk-recipient
      description: REST surface for v2-accounts-accountId-templates-templateId-recipients-recipientId-bulk_recipient.
      operations:
      - method: GET
        name: recipientsgettemplatebulkrecipients
        description: Docusign Gets the bulk recipient file from a template.
        call: docusign-templatebulkrecipients.recipientsgettemplatebulkrecipients
        with:
          accountId: rest.accountId
          recipientId: rest.recipientId
          templateId: rest.templateId
          include_tabs: rest.include_tabs
          start_position: rest.start_position
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: recipientsputtemplatebulkrecipients
        description: Docusign Adds or replaces the bulk recipients list in a template.
        call: docusign-templatebulkrecipients.recipientsputtemplatebulkrecipients
        with:
          accountId: rest.accountId
          recipientId: rest.recipientId
          templateId: rest.templateId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: recipientsdeletetemplatebulkrecipientsfile
        description: Docusign Deletes the bulk recipient list on a template.
        call: docusign-templatebulkrecipients.recipientsdeletetemplatebulkrecipientsfile
        with:
          accountId: rest.accountId
          recipientId: rest.recipientId
          templateId: rest.templateId
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: docusign-templatebulkrecipients-mcp
    port: 9090
    transport: http
    description: MCP adapter for DocuSign REST API — TemplateBulkRecipients. One tool per consumed operation, routed inline
      through this capability's consumes block.
    tools:
    - name: docusign-gets-bulk-recipient-file
      description: Docusign Gets the bulk recipient file from a template.
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: docusign-templatebulkrecipients.recipientsgettemplatebulkrecipients
      with:
        accountId: tools.accountId
        recipientId: tools.recipientId
        templateId: tools.templateId
        include_tabs: tools.include_tabs
        start_position: tools.start_position
      outputParameters:
      - type: object
        mapping: $.
    - name: docusign-adds-replaces-bulk-recipients
      description: Docusign Adds or replaces the bulk recipients list in a template.
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: docusign-templatebulkrecipients.recipientsputtemplatebulkrecipients
      with:
        accountId: tools.accountId
        recipientId: tools.recipientId
        templateId: tools.templateId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: docusign-deletes-bulk-recipient-list
      description: Docusign Deletes the bulk recipient list on a template.
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: docusign-templatebulkrecipients.recipientsdeletetemplatebulkrecipientsfile
      with:
        accountId: tools.accountId
        recipientId: tools.recipientId
        templateId: tools.templateId
      outputParameters:
      - type: object
        mapping: $.