DocuSign REST API — EnvelopeCustomFields

naftiko: 1.0.0-alpha2
info:
  label: DocuSign REST API — EnvelopeCustomFields
  description: 'DocuSign REST API — EnvelopeCustomFields. 4 operations. Lead operation: Docusign Gets the custom field information
    for the specified envelope.. Self-contained Naftiko capability covering one Docusign business surface.'
  tags:
  - Docusign
  - EnvelopeCustomFields
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    DOCUSIGN_API_KEY: DOCUSIGN_API_KEY
capability:
  consumes:
  - type: http
    namespace: docusign-envelopecustomfields
    baseUri: https://www.docusign.net/restapi
    description: DocuSign REST API — EnvelopeCustomFields business capability. Self-contained, no shared references.
    resources:
    - name: v2-accounts-accountId-envelopes-envelopeId-custom_fields
      path: /v2/accounts/{accountId}/envelopes/{envelopeId}/custom_fields
      operations:
      - name: customfieldsgetcustomfields
        method: GET
        description: Docusign Gets the custom field information for the specified 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: customfieldsputcustomfields
        method: PUT
        description: Docusign Updates envelope custom fields in 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: customfieldspostcustomfields
        method: POST
        description: Docusign Updates envelope custom fields 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: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
      - name: customfieldsdeletecustomfields
        method: DELETE
        description: Docusign Deletes envelope custom fields for draft and in-process envelopes.
        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
  exposes:
  - type: rest
    namespace: docusign-envelopecustomfields-rest
    port: 8080
    description: REST adapter for DocuSign REST API — EnvelopeCustomFields. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/v2/accounts/{accountid}/envelopes/{envelopeid}/custom-fields
      name: v2-accounts-accountid-envelopes-envelopeid-custom-fields
      description: REST surface for v2-accounts-accountId-envelopes-envelopeId-custom_fields.
      operations:
      - method: GET
        name: customfieldsgetcustomfields
        description: Docusign Gets the custom field information for the specified envelope.
        call: docusign-envelopecustomfields.customfieldsgetcustomfields
        with:
          accountId: rest.accountId
          envelopeId: rest.envelopeId
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: customfieldsputcustomfields
        description: Docusign Updates envelope custom fields in an envelope.
        call: docusign-envelopecustomfields.customfieldsputcustomfields
        with:
          accountId: rest.accountId
          envelopeId: rest.envelopeId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: customfieldspostcustomfields
        description: Docusign Updates envelope custom fields for an envelope.
        call: docusign-envelopecustomfields.customfieldspostcustomfields
        with:
          accountId: rest.accountId
          envelopeId: rest.envelopeId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: customfieldsdeletecustomfields
        description: Docusign Deletes envelope custom fields for draft and in-process envelopes.
        call: docusign-envelopecustomfields.customfieldsdeletecustomfields
        with:
          accountId: rest.accountId
          envelopeId: rest.envelopeId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: docusign-envelopecustomfields-mcp
    port: 9090
    transport: http
    description: MCP adapter for DocuSign REST API — EnvelopeCustomFields. One tool per consumed operation, routed inline
      through this capability's consumes block.
    tools:
    - name: docusign-gets-custom-field-information
      description: Docusign Gets the custom field information for the specified envelope.
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: docusign-envelopecustomfields.customfieldsgetcustomfields
      with:
        accountId: tools.accountId
        envelopeId: tools.envelopeId
      outputParameters:
      - type: object
        mapping: $.
    - name: docusign-updates-envelope-custom-fields
      description: Docusign Updates envelope custom fields in an envelope.
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: docusign-envelopecustomfields.customfieldsputcustomfields
      with:
        accountId: tools.accountId
        envelopeId: tools.envelopeId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: docusign-updates-envelope-custom-fields-2
      description: Docusign Updates envelope custom fields for an envelope.
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: docusign-envelopecustomfields.customfieldspostcustomfields
      with:
        accountId: tools.accountId
        envelopeId: tools.envelopeId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: docusign-deletes-envelope-custom-fields
      description: Docusign Deletes envelope custom fields for draft and in-process envelopes.
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: docusign-envelopecustomfields.customfieldsdeletecustomfields
      with:
        accountId: tools.accountId
        envelopeId: tools.envelopeId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.