DocuSign REST API — EnvelopeRecipients

naftiko: 1.0.0-alpha2
info:
  label: DocuSign REST API — EnvelopeRecipients
  description: 'DocuSign REST API — EnvelopeRecipients. 5 operations. Lead operation: Docusign Gets the status of recipients
    for an envelope.. Self-contained Naftiko capability covering one Docusign business surface.'
  tags:
  - Docusign
  - EnvelopeRecipients
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    DOCUSIGN_API_KEY: DOCUSIGN_API_KEY
capability:
  consumes:
  - type: http
    namespace: docusign-enveloperecipients
    baseUri: https://www.docusign.net/restapi
    description: DocuSign REST API — EnvelopeRecipients business capability. Self-contained, no shared references.
    resources:
    - name: v2-accounts-accountId-envelopes-envelopeId-recipients
      path: /v2/accounts/{accountId}/envelopes/{envelopeId}/recipients
      operations:
      - name: recipientsgetrecipients
        method: GET
        description: Docusign Gets the status of recipients for an envelope.
        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: envelopeId
          in: path
          type: string
          description: The envelope's GUID. Eg 93be49ab-afa0-4adf-933c-f752070d71ec
          required: true
        - name: include_anchor_tab_locations
          in: query
          type: string
          description: When set to **true** and `include_tabs` value is set to **true**, all tabs with anchor tab properties
            are included in the response.
        - name: include_extended
          in: query
          type: string
          description: When set to **true**, the extended properties are included in the response.
        - 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: recipientsputrecipients
        method: PUT
        description: Docusign Updates recipients in a draft envelope or corrects recipient information for an in process envelope.
        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: envelopeId
          in: path
          type: string
          description: The envelope's GUID. Eg 93be49ab-afa0-4adf-933c-f752070d71ec
          required: true
        - name: offline_signing
          in: query
          type: string
        - name: resend_envelope
          in: query
          type: string
          description: When set to **true**, resends the   envelope if the new recipient's routing order is before or the
            same as the envelope's next recipient.
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
      - name: recipientspostrecipients
        method: POST
        description: Docusign Adds one or more recipients to an envelope.
        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: envelopeId
          in: path
          type: string
          description: The envelope's GUID. Eg 93be49ab-afa0-4adf-933c-f752070d71ec
          required: true
        - name: resend_envelope
          in: query
          type: string
          description: When set to **true**, resends the   envelope if the new recipient's routing order is before or the
            same as the envelope's next recipient.
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
      - name: recipientsdeleterecipients
        method: DELETE
        description: Docusign Deletes recipients from an envelope.
        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: envelopeId
          in: path
          type: string
          description: The envelope's GUID. Eg 93be49ab-afa0-4adf-933c-f752070d71ec
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: v2-accounts-accountId-envelopes-envelopeId-recipients-recipientId
      path: /v2/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}
      operations:
      - name: recipientsdeleterecipient
        method: DELETE
        description: Docusign Deletes a recipient from an envelope.
        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: envelopeId
          in: path
          type: string
          description: The envelope's GUID. Eg 93be49ab-afa0-4adf-933c-f752070d71ec
          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
  exposes:
  - type: rest
    namespace: docusign-enveloperecipients-rest
    port: 8080
    description: REST adapter for DocuSign REST API — EnvelopeRecipients. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/v2/accounts/{accountid}/envelopes/{envelopeid}/recipients
      name: v2-accounts-accountid-envelopes-envelopeid-recipients
      description: REST surface for v2-accounts-accountId-envelopes-envelopeId-recipients.
      operations:
      - method: GET
        name: recipientsgetrecipients
        description: Docusign Gets the status of recipients for an envelope.
        call: docusign-enveloperecipients.recipientsgetrecipients
        with:
          accountId: rest.accountId
          envelopeId: rest.envelopeId
          include_anchor_tab_locations: rest.include_anchor_tab_locations
          include_extended: rest.include_extended
          include_tabs: rest.include_tabs
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: recipientsputrecipients
        description: Docusign Updates recipients in a draft envelope or corrects recipient information for an in process envelope.
        call: docusign-enveloperecipients.recipientsputrecipients
        with:
          accountId: rest.accountId
          envelopeId: rest.envelopeId
          offline_signing: rest.offline_signing
          resend_envelope: rest.resend_envelope
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: recipientspostrecipients
        description: Docusign Adds one or more recipients to an envelope.
        call: docusign-enveloperecipients.recipientspostrecipients
        with:
          accountId: rest.accountId
          envelopeId: rest.envelopeId
          resend_envelope: rest.resend_envelope
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: recipientsdeleterecipients
        description: Docusign Deletes recipients from an envelope.
        call: docusign-enveloperecipients.recipientsdeleterecipients
        with:
          accountId: rest.accountId
          envelopeId: rest.envelopeId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v2/accounts/{accountid}/envelopes/{envelopeid}/recipients/{recipientid}
      name: v2-accounts-accountid-envelopes-envelopeid-recipients-recipientid
      description: REST surface for v2-accounts-accountId-envelopes-envelopeId-recipients-recipientId.
      operations:
      - method: DELETE
        name: recipientsdeleterecipient
        description: Docusign Deletes a recipient from an envelope.
        call: docusign-enveloperecipients.recipientsdeleterecipient
        with:
          accountId: rest.accountId
          envelopeId: rest.envelopeId
          recipientId: rest.recipientId
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: docusign-enveloperecipients-mcp
    port: 9090
    transport: http
    description: MCP adapter for DocuSign REST API — EnvelopeRecipients. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: docusign-gets-status-recipients-envelope
      description: Docusign Gets the status of recipients for an envelope.
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: docusign-enveloperecipients.recipientsgetrecipients
      with:
        accountId: tools.accountId
        envelopeId: tools.envelopeId
        include_anchor_tab_locations: tools.include_anchor_tab_locations
        include_extended: tools.include_extended
        include_tabs: tools.include_tabs
      outputParameters:
      - type: object
        mapping: $.
    - name: docusign-updates-recipients-draft-envelope
      description: Docusign Updates recipients in a draft envelope or corrects recipient information for an in process envelope.
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: docusign-enveloperecipients.recipientsputrecipients
      with:
        accountId: tools.accountId
        envelopeId: tools.envelopeId
        offline_signing: tools.offline_signing
        resend_envelope: tools.resend_envelope
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: docusign-adds-one-more-recipients
      description: Docusign Adds one or more recipients to an envelope.
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: docusign-enveloperecipients.recipientspostrecipients
      with:
        accountId: tools.accountId
        envelopeId: tools.envelopeId
        resend_envelope: tools.resend_envelope
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: docusign-deletes-recipients-envelope
      description: Docusign Deletes recipients from an envelope.
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: docusign-enveloperecipients.recipientsdeleterecipients
      with:
        accountId: tools.accountId
        envelopeId: tools.envelopeId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: docusign-deletes-recipient-envelope
      description: Docusign Deletes a recipient from an envelope.
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: docusign-enveloperecipients.recipientsdeleterecipient
      with:
        accountId: tools.accountId
        envelopeId: tools.envelopeId
        recipientId: tools.recipientId
      outputParameters:
      - type: object
        mapping: $.