Files
a2a-platform 81e94a55c6 deploy
2026-06-27 01:02:44 +00:00

434 lines
986 KiB
Python

from __future__ import annotations
import base64
import json
import re
from pathlib import Path
from typing import Any
import httpx
from a2a_pack.deepagents import create_a2a_deep_agent
from langchain_core.messages import BaseMessage
from langchain_core.tools import StructuredTool
from pydantic import BaseModel, Field
from a2a_pack import (
A2AAgent,
ConsumerSetup,
ConsumerSetupField,
ConsumerSetupMissing,
EgressPolicy,
LLMProvisioning,
Pricing,
Resources,
RunContext,
skill,
)
DEFAULT_BASE_URL = "https://www.docusign.net/restapi"
OPERATIONS = json.loads("{\n \"account_custom_fields_delete_account_custom_fields\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"This method deletes an existing account custom field.\",\n \"destructive\": true,\n \"method\": \"DELETE\",\n \"operation_id\": \"account_custom_fields_delete_account_custom_fields\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The ID of the custom field.\",\n \"in\": \"path\",\n \"name\": \"customFieldId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"\",\n \"in\": \"query\",\n \"name\": \"apply_to_templates\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/custom_fields/{customFieldId}\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"account_custom_fields_delete_account_custom_fields\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Deletes an account custom field.\",\n \"tags\": [\n \"AccountCustomFields\"\n ]\n },\n \"account_custom_fields_get_account_custom_fields\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"This method returns a list of the envelope and document custom fields associated with an account.\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"account_custom_fields_get_account_custom_fields\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/custom_fields\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"account_custom_fields_get_account_custom_fields\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Gets a list of custom fields.\",\n \"tags\": [\n \"AccountCustomFields\"\n ]\n },\n \"account_custom_fields_post_account_custom_fields\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"This method creates a custom field and makes it available for all new envelopes associated with an account.\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"account_custom_fields_post_account_custom_fields\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"(Optional) When **true,** the new custom field is applied to all of the templates on the account.\",\n \"in\": \"query\",\n \"name\": \"apply_to_templates\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/custom_fields\",\n \"request_body\": {\n \"$ref\": \"#/definitions/customField\"\n },\n \"security\": null,\n \"skill_name\": \"account_custom_fields_post_account_custom_fields\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Creates an account custom field.\",\n \"tags\": [\n \"AccountCustomFields\"\n ]\n },\n \"account_custom_fields_put_account_custom_fields\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"This method updates an existing account custom field.\",\n \"destructive\": true,\n \"method\": \"PUT\",\n \"operation_id\": \"account_custom_fields_put_account_custom_fields\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The ID of the custom field.\",\n \"in\": \"path\",\n \"name\": \"customFieldId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"\",\n \"in\": \"query\",\n \"name\": \"apply_to_templates\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/custom_fields/{customFieldId}\",\n \"request_body\": {\n \"$ref\": \"#/definitions/customField\"\n },\n \"security\": null,\n \"skill_name\": \"account_custom_fields_put_account_custom_fields\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Updates an account custom field.\",\n \"tags\": [\n \"AccountCustomFields\"\n ]\n },\n \"account_identity_verification_get_account_identity_verification\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"This method returns a list of Identity Verification workflows that are available to an account.\\n\\n**Note:** To use this method, you must either be an account administrator or a sender.\\n\\n### Related topics\\n\\n- [How to require ID Verification (IDV) for a recipient](/docs/esign-rest-api/how-to/id-verification/)\\n\\n\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"account_identity_verification_get_account_identity_verification\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Filters the workflows returned according to status. Valid values:\\n\\n- `active`: Only active workflows are returned. This is the default.\\n- `deactivated`: Only deactivated workflows are returned.\\n- `all`: All workflows are returned.\\n\",\n \"in\": \"query\",\n \"name\": \"identity_verification_workflow_status\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/identity_verification\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"account_identity_verification_get_account_identity_verification\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Retrieves the Identity Verification workflows available to an account.\",\n \"tags\": [\n \"IdentityVerifications\"\n ]\n },\n \"account_password_rules_get_account_password_rules\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"This method retrieves the password rules for an account.\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"account_password_rules_get_account_password_rules\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/settings/password_rules\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"account_password_rules_get_account_password_rules\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Gets the password rules for an account.\",\n \"tags\": [\n \"AccountPasswordRules\"\n ]\n },\n \"account_password_rules_put_account_password_rules\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"This method updates the password rules for an account.\\n\\n**Note:** To update the password rules for an account, you must be an account administrator.\",\n \"destructive\": true,\n \"method\": \"PUT\",\n \"operation_id\": \"account_password_rules_put_account_password_rules\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/settings/password_rules\",\n \"request_body\": {\n \"$ref\": \"#/definitions/accountPasswordRules\"\n },\n \"security\": null,\n \"skill_name\": \"account_password_rules_put_account_password_rules\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Updates the password rules for an account.\",\n \"tags\": [\n \"AccountPasswordRules\"\n ]\n },\n \"account_signature_providers_get_seal_providers\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Returns available seals for specified account.\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"account_signature_providers_get_seal_providers\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/seals\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"account_signature_providers_get_seal_providers\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Returns available seals for specified account.\",\n \"tags\": [\n \"AccountSealProviders\"\n ]\n },\n \"account_signature_providers_get_signature_providers\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Returns a list of signature providers that the specified account can use.\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"account_signature_providers_get_signature_providers\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/signatureProviders\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"account_signature_providers_get_signature_providers\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Gets the available signature providers for an account.\",\n \"tags\": [\n \"AccountSignatureProviders\"\n ]\n },\n \"account_signatures_delete_account_signature\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Deletes a stamp specified by `signatureId`.\\n\",\n \"destructive\": true,\n \"method\": \"DELETE\",\n \"operation_id\": \"account_signatures_delete_account_signature\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The ID of the account stamp.\",\n \"in\": \"path\",\n \"name\": \"signatureId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/signatures/{signatureId}\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"account_signatures_delete_account_signature\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Deletes an account stamp.\",\n \"tags\": [\n \"AccountSignatures\"\n ]\n },\n \"account_signatures_delete_account_signature_image\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Deletes the image for a stamp specified by `signatureId`.\",\n \"destructive\": true,\n \"method\": \"DELETE\",\n \"operation_id\": \"account_signatures_delete_account_signature_image\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Specificies the type of image. Valid values:\\n\\n- `stamp_image`\\n- `signature_image`\\n- `initials_image`\",\n \"in\": \"path\",\n \"name\": \"imageType\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The ID of the account stamp.\",\n \"in\": \"path\",\n \"name\": \"signatureId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/signatures/{signatureId}/{imageType}\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"account_signatures_delete_account_signature_image\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Deletes the image for a stamp.\",\n \"tags\": [\n \"AccountSignatures\"\n ]\n },\n \"account_signatures_get_account_signature\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Returns information about the specified stamp.\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"account_signatures_get_account_signature\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The ID of the account stamp.\",\n \"in\": \"path\",\n \"name\": \"signatureId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/signatures/{signatureId}\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"account_signatures_get_account_signature\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Returns information about the specified stamp.\",\n \"tags\": [\n \"AccountSignatures\"\n ]\n },\n \"account_signatures_get_account_signature_image\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Returns the image for an account stamp.\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"account_signatures_get_account_signature_image\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Specificies the type of image. Valid values:\\n\\n- `stamp_image`\\n- `signature_image`\\n- `initials_image`\",\n \"in\": \"path\",\n \"name\": \"imageType\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The ID of the account stamp.\",\n \"in\": \"path\",\n \"name\": \"signatureId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"When **true,** the chrome (or frame containing the added line and identifier) is included with the signature image.\",\n \"in\": \"query\",\n \"name\": \"include_chrome\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/signatures/{signatureId}/{imageType}\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"account_signatures_get_account_signature_image\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Returns the image for an account stamp.\",\n \"tags\": [\n \"AccountSignatures\"\n ]\n },\n \"account_signatures_get_account_signatures\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Returns a list of stamps available in the account.\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"account_signatures_get_account_signatures\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The format of the stamp to return. Valid values:\\n- `NameDateHanko`\\n- `NameHanko`\\n- `PlaceholderHanko`\",\n \"in\": \"query\",\n \"name\": \"stamp_format\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The name associated with the stamps to return. This value can be a Japanese surname (up to 5 characters) or a purchase order ID.\",\n \"in\": \"query\",\n \"name\": \"stamp_name\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The type of the stamps to return. Valid values:\\n- `name_stamp`\\n- `stamp`\\n- `signature`\",\n \"in\": \"query\",\n \"name\": \"stamp_type\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/signatures\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"account_signatures_get_account_signatures\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Returns a list of stamps available in the account.\",\n \"tags\": [\n \"AccountSignatures\"\n ]\n },\n \"account_signatures_post_account_signatures\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Adds or updates one or more account stamps.\\n\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"account_signatures_post_account_signatures\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"\",\n \"in\": \"query\",\n \"name\": \"decode_only\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/signatures\",\n \"request_body\": {\n \"$ref\": \"#/definitions/accountSignaturesInformation\"\n },\n \"security\": null,\n \"skill_name\": \"account_signatures_post_account_signatures\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Adds or updates one or more account stamps.\",\n \"tags\": [\n \"AccountSignatures\"\n ]\n },\n \"account_signatures_put_account_signature\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Adds or updates one or more account stamps. This request may include images in multi-part format.\",\n \"destructive\": true,\n \"method\": \"PUT\",\n \"operation_id\": \"account_signatures_put_account_signature\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/signatures\",\n \"request_body\": {\n \"$ref\": \"#/definitions/accountSignaturesInformation\"\n },\n \"security\": null,\n \"skill_name\": \"account_signatures_put_account_signature\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Updates an account stamp.\",\n \"tags\": [\n \"AccountSignatures\"\n ]\n },\n \"account_signatures_put_account_signature_by_id\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Updates an account stamp specified by the `signatureId` query parameter.\",\n \"destructive\": true,\n \"method\": \"PUT\",\n \"operation_id\": \"account_signatures_put_account_signature_by_id\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The ID of the account stamp.\",\n \"in\": \"path\",\n \"name\": \"signatureId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"When **true,** closes the current signature.\",\n \"in\": \"query\",\n \"name\": \"close_existing_signature\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/signatures/{signatureId}\",\n \"request_body\": {\n \"$ref\": \"#/definitions/accountSignatureDefinition\"\n },\n \"security\": null,\n \"skill_name\": \"account_signatures_put_account_signature_by_id\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Updates an account stamp by ID.\",\n \"tags\": [\n \"AccountSignatures\"\n ]\n },\n \"account_signatures_put_account_signature_image\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Sets a signature image, initials, or stamp.\",\n \"destructive\": true,\n \"method\": \"PUT\",\n \"operation_id\": \"account_signatures_put_account_signature_image\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Specificies the type of image. Valid values:\\n\\n- `stamp_image`\\n- `signature_image`\\n- `initials_image`\",\n \"in\": \"path\",\n \"name\": \"imageType\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The ID of the account stamp.\",\n \"in\": \"path\",\n \"name\": \"signatureId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"\",\n \"in\": \"query\",\n \"name\": \"transparent_png\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/signatures/{signatureId}/{imageType}\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"account_signatures_put_account_signature_image\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Sets a signature image, initials, or stamp.\",\n \"tags\": [\n \"AccountSignatures\"\n ]\n },\n \"accounts_delete_account\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"This closes the specified account. You must be an account admin to close your account. Once closed, an account must be reopened by Docusign.\",\n \"destructive\": true,\n \"method\": \"DELETE\",\n \"operation_id\": \"accounts_delete_account\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"\",\n \"in\": \"query\",\n \"name\": \"redact_user_data\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"accounts_delete_account\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Deletes the specified account.\",\n \"tags\": [\n \"Accounts\"\n ]\n },\n \"accounts_get_account\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Retrieves the account information for the specified account.\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"accounts_get_account\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"When **true,** includes account settings in the response. The default value is **false.**\",\n \"in\": \"query\",\n \"name\": \"include_account_settings\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"\",\n \"in\": \"query\",\n \"name\": \"include_trial_eligibility\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"accounts_get_account\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Retrieves the account information for the specified account.\",\n \"tags\": [\n \"Accounts\"\n ]\n },\n \"accounts_get_provisioning\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Retrieves the account provisioning information for the account.\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"accounts_get_provisioning\",\n \"parameters\": [],\n \"path\": \"/v2.1/accounts/provisioning\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"accounts_get_provisioning\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Retrieves the account provisioning information for the account.\",\n \"tags\": [\n \"Accounts\"\n ]\n },\n \"accounts_post_accounts\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Creates new Docusign accounts.\\nYou can use this method to create\\na single account\\nor up to 100 accounts at a time.\\n\\n**Note:** This method is restricted to partner integrations.\\nYou must work with Docusign Professional Services\\nor Docusign Business Development,\\nwho will provide you with the Distributor Code\\nand Distributor Password\\nthat you need to include in the request body.\\n\\n\\nWhen creating a single account,\\nthe body of the request is a\\n[`newAccountRequest`][newAccountRequest]\\nobject.\\n\\nExample:\\n\\n```\\n{\\n \\\"newAccountRequest\\\": [\\n {\\n \\\"accountName\\\":\\\"Test Account\\\",\\n \\\"distributorCode\\\":\\\"MY_DIST_CODE\\\",\\n \\\"distributorPassword\\\":\\\"MY_DIST_PWD\\\",\\n \\\"initialUser\\\":{\\n \\\"email\\\":\\\"user@emaildomain.com\\\",\\n \\\"firstName\\\":\\\"John\\\",\\n \\\"middleName\\\": \\\"Harry\\\",\\n \\\"lastName\\\":\\\"Doe\\\",\\n \\\"suffixName\\\": \\\"\\\",\\n \\\"userName\\\": \\\"John Doe\\\",\\n \\\"jobTitle\\\": \\\"Engineer\\\",\\n \\\"company\\\": \\\"Test Company\\\"\\n },\\n \\\"addressInformation\\\":{\\n \\\"address1\\\": \\\"1234 Main Street\\\",\\n \\\"address2\\\": \\\"Suite 100\\\",\\n \\\"city\\\": \\\"Seattle\\\",\\n \\\"state\\\": \\\"WA\\\",\\n \\\"postalCode\\\": \\\"98101\\\",\\n \\\"country\\\": \\\"US\\\",\\n \\\"phone\\\": \\\"1234567890\\\",\\n \\\"fax\\\": \\\"1234567891\\\"\\n },\\n \\\"planInformation\\\":{\\n \\\"planId\\\":\\\"37085696-xxxx-xxxx-xxxx-7ea067752959\\\"\\n },\\n \\\"referralInformation\\\":{\\n \\\"includedSeats\\\": \\\"1\\\",\\n \\\"referralCode\\\": \\\"code\\\",\\n \\\"referrerName\\\": \\\"name\\\"\\n }\\n }\\n ]\\n}\\n\\n```\\nIf the request succeeds,\\nit returns a\\n201 (Created) HTTP response code.\\nThe response returns the new account ID, password, and the default user\\ninformation for each newly created account.\\n\\n\\nWhen creating multiple accounts,\\nthe body of the request is a\\n`newAccountRequests`\\nobject,\\nwhich contains one or more\\n[`newAccountDefinition`][newAccountDefinition]\\nobjects.\\nYou can create up to 100 new accounts\\nat a time this way.\\n\\nThe body for a multi-account\\ncreation request\\nlooks like this in JSON:\\n\\n```\\n{\\n \\\"newAccountRequests\\\": [\\n {\\n \\\"accountName\\\": \\\"accountone\\\",\\n . . .\\n },\\n {\\n \\\"accountName\\\": \\\"accounttwo\\\",\\n . . .\\n }\\n ]\\n}\\n```\\n\\nA multi-account request\\nlooks like this in XML:\\n\\n```\\n<newAccountsDefinition xmlns:i=\\\"http://www.w3.org/2001/XMLSchema-instance\\\" xmlns=\\\"http://www.docusign.com/restapi\\\">\\n <newAccountRequests>\\n <newAccountDefinition>\\n . . .\\n </newAccountDefinition>\\n <newAccountDefinition>\\n . . .\\n </newAccountDefinition>\\n </newAccountRequests>\\n</newAccountsDefinition>\\n```\\n\\nA multi-account creation request\\nmay succeed (report a 201 code)\\neven if some accounts could not be created.\\nIn this case, the `errorDetails` property\\nin the response contains specific information\\nabout the failure.\\n\\n\\n\\n[newAccountDefinition]: #/definitions/newAccountDefinition\\n[nameValue]: #/definitions/nameValue\\n[newAccountRequest]: #/definitions/newAccountRequest\\n\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"accounts_post_accounts\",\n \"parameters\": [],\n \"path\": \"/v2.1/accounts\",\n \"request_body\": {\n \"$ref\": \"#/definitions/newAccountDefinition\"\n },\n \"security\": null,\n \"skill_name\": \"accounts_post_accounts\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Creates new accounts.\",\n \"tags\": [\n \"Accounts\"\n ]\n },\n \"api_request_log_delete_request_logs\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Deletes the request log files.\",\n \"destructive\": true,\n \"method\": \"DELETE\",\n \"operation_id\": \"api_request_log_delete_request_logs\",\n \"parameters\": [],\n \"path\": \"/v2.1/diagnostics/request_logs\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"api_request_log_delete_request_logs\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Deletes the request log files.\",\n \"tags\": [\n \"RequestLogs\"\n ]\n },\n \"api_request_log_get_request_log\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Retrieves information for a single log entry.\\n\\n**Request**\\nThe `requestLogId` property can be retrieved by getting the list of log entries. The Content-Transfer-Encoding header can be set to base64 to retrieve the API request/response as base 64 string. Otherwise the bytes of the request/response are returned.\\n\\n**Response**\\nIf the Content-Transfer-Encoding header was set to base64, the log is returned as a base64 string.\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"api_request_log_get_request_log\",\n \"parameters\": [\n {\n \"description\": \"The ID of the log entry.\",\n \"in\": \"path\",\n \"name\": \"requestLogId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/diagnostics/request_logs/{requestLogId}\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"api_request_log_get_request_log\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Gets a request logging log file.\",\n \"tags\": [\n \"RequestLogs\"\n ]\n },\n \"api_request_log_get_request_log_settings\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Retrieves the current API request logging setting for the user and remaining log entries.\\n\\n**Response**\\nThe response includes the current API request logging setting for the user, along with the maximum log entries and remaining log entries.\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"api_request_log_get_request_log_settings\",\n \"parameters\": [],\n \"path\": \"/v2.1/diagnostics/settings\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"api_request_log_get_request_log_settings\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Gets the API request logging settings.\",\n \"tags\": [\n \"RequestLogs\"\n ]\n },\n \"api_request_log_get_request_logs\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Retrieves a list of log entries as a JSON or XML object or as a zip file containing the entries.\\n\\nIf the Accept header is set to `application/zip`, the response is a zip file containing individual text files, each representing an API request.\\n\\nIf the Accept header is set to `application/json` or `application/xml`, the response returns list of log entries in either JSON or XML. An example JSON response body is shown below. \",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"api_request_log_get_request_logs\",\n \"parameters\": [\n {\n \"description\": \"Reserved for Docusign.\",\n \"in\": \"query\",\n \"name\": \"encoding\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/diagnostics/request_logs\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"api_request_log_get_request_logs\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Gets the API request logging log files.\",\n \"tags\": [\n \"RequestLogs\"\n ]\n },\n \"api_request_log_put_request_log_settings\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Enables or disables API request logging for troubleshooting.\\n\\nWhen enabled (`apiRequestLogging` is **true**),\\nREST API requests and responses for the user are added to a log.\\nA log can have up to 50 requests/responses\\nand the current number of log entries can be determined\\nby getting the settings.\\nLogging is automatically disabled when the log limit of 50 is reached.\\n\\nYou can call\\n[Diagnostics: getRequestLog](/docs/esign-rest-api/reference/diagnostics/requestlogs/get/)\\nor\\n[Diagnostics: listRequestLogs](/docs/esign-rest-api/reference/diagnostics/requestlogs/list/)\\nto download the log files (individually or as a zip file).\\nCall [Diagnostics: deleteRequestLogs](/docs/esign-rest-api/reference/diagnostics/requestlogs/delete/)\\nto clear the log by deleting current entries.\\n\\nPrivate information, such as passwords and integration key information,\\nwhich is normally located in the call header is omitted from the request/response log.\\n\\nAPI request logging only captures requests from the authenticated user.\\nAny call that does not authenticate the user and resolve a userId is not logged.\\n\",\n \"destructive\": true,\n \"method\": \"PUT\",\n \"operation_id\": \"api_request_log_put_request_log_settings\",\n \"parameters\": [],\n \"path\": \"/v2.1/diagnostics/settings\",\n \"request_body\": {\n \"$ref\": \"#/definitions/diagnosticsSettingsInformation\"\n },\n \"security\": null,\n \"skill_name\": \"api_request_log_put_request_log_settings\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Enables or disables API request logging for troubleshooting.\",\n \"tags\": [\n \"RequestLogs\"\n ]\n },\n \"attachments_delete_attachments\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Deletes one or more envelope attachments from a draft envelope.\\n\\n<!-- std notice DEVDOCS-114911 -->\\n<ds-inlinemessage kind=\\\"information\\\" markdown=\\\"1\\\">\\n\\nIt's easy to confuse envelope attachments,\\nwhich are developer-only files associated with an envelope,\\nwith signer attachments.\\n\\nTo learn about the different types of attachments, see [Attachments](/docs/esign-rest-api/esign101/concepts/documents/attachments/) in the concept guide.\\n\\n</ds-inlinemessage>\\n<!-- end notice DEVDOCS-114911 -->\\n\",\n \"destructive\": true,\n \"method\": \"DELETE\",\n \"operation_id\": \"attachments_delete_attachments\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The envelope's GUID. \\n\\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\\n\",\n \"in\": \"path\",\n \"name\": \"envelopeId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/envelopes/{envelopeId}/attachments\",\n \"request_body\": {\n \"$ref\": \"#/definitions/envelopeAttachmentsRequest\"\n },\n \"security\": null,\n \"skill_name\": \"attachments_delete_attachments\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Deletes one or more envelope attachments from a draft envelope.\",\n \"tags\": [\n \"EnvelopeAttachments\"\n ]\n },\n \"attachments_get_attachment\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Retrieves an envelope attachment from an envelope.\\n\\n<!-- std notice DEVDOCS-114911 -->\\n<ds-inlinemessage kind=\\\"information\\\" markdown=\\\"1\\\">\\n\\nIt's easy to confuse envelope attachments,\\nwhich are developer-only files associated with an envelope,\\nwith signer attachments.\\n\\nTo learn about the different types of attachments, see [Attachments](/docs/esign-rest-api/esign101/concepts/documents/attachments/) in the concept guide.\\n\\n</ds-inlinemessage>\\n<!-- end notice DEVDOCS-114911 -->\\n\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"attachments_get_attachment\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The unique identifier for the attachment.\",\n \"in\": \"path\",\n \"name\": \"attachmentId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The envelope's GUID. \\n\\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\\n\",\n \"in\": \"path\",\n \"name\": \"envelopeId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/envelopes/{envelopeId}/attachments/{attachmentId}\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"attachments_get_attachment\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Retrieves an envelope attachment from an envelope.\",\n \"tags\": [\n \"EnvelopeAttachments\"\n ]\n },\n \"attachments_get_attachments\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Returns a list of envelope attachments associated with a specified envelope.\\n\\n<!-- std notice DEVDOCS-114911 -->\\n<ds-inlinemessage kind=\\\"information\\\" markdown=\\\"1\\\">\\n\\nIt's easy to confuse envelope attachments,\\nwhich are developer-only files associated with an envelope,\\nwith signer attachments.\\n\\nTo get a list of user-visible attachments,\\nuse [EnvelopeDocuments: get](/docs/esign-rest-api/reference/envelopes/envelopedocuments/get/).\\n\\nTo learn about the different types of attachments, see [Attachments](/docs/esign-rest-api/esign101/concepts/documents/attachments/) in the concept guide.\\n\\n</ds-inlinemessage>\\n<!-- end notice DEVDOCS-114911 -->\\n\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"attachments_get_attachments\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The envelope's GUID. \\n\\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\\n\",\n \"in\": \"path\",\n \"name\": \"envelopeId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/envelopes/{envelopeId}/attachments\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"attachments_get_attachments\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Returns a list of envelope attachments associated with a specified envelope.\",\n \"tags\": [\n \"EnvelopeAttachments\"\n ]\n },\n \"attachments_put_attachment\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Updates an envelope attachment to a draft or in-process envelope.\\n\\n<!-- std notice DEVDOCS-114911 -->\\n<ds-inlinemessage kind=\\\"information\\\" markdown=\\\"1\\\">\\n\\nIt's easy to confuse envelope attachments,\\nwhich are developer-only files associated with an envelope,\\nwith signer attachments.\\n\\nTo learn about the different types of attachments, see [Attachments](/docs/esign-rest-api/esign101/concepts/documents/attachments/) in the concept guide.\\n\\n</ds-inlinemessage>\\n<!-- end notice DEVDOCS-114911 -->\\n\",\n \"destructive\": true,\n \"method\": \"PUT\",\n \"operation_id\": \"attachments_put_attachment\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The unique identifier for the attachment.\",\n \"in\": \"path\",\n \"name\": \"attachmentId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The envelope's GUID. \\n\\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\\n\",\n \"in\": \"path\",\n \"name\": \"envelopeId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/envelopes/{envelopeId}/attachments/{attachmentId}\",\n \"request_body\": {\n \"$ref\": \"#/definitions/attachment\"\n },\n \"security\": null,\n \"skill_name\": \"attachments_put_attachment\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Updates an envelope attachment in a draft or in-process envelope.\",\n \"tags\": [\n \"EnvelopeAttachments\"\n ]\n },\n \"attachments_put_attachments\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Adds one or more envelope attachments to a draft or in-process envelope.\\nEach envelope can have a maximum of 12 attachments.\\n\\nEnvelope attachments are files that an application can include in an envelope. They are not converted to PDF. Envelope attachments are available only through the API. There is no user interface in the Docusign web application for them.\\n\\nFor a list of supported file formats, see [Supported File Formats](https://support.docusign.com/s/document-item?bundleId=gbo1643332197980&topicId=xln1578456261162.html).\\n\\n<!-- std notice DEVDOCS-114911 -->\\n<ds-inlinemessage kind=\\\"information\\\" markdown=\\\"1\\\">\\n\\nIt's easy to confuse envelope attachments,\\nwhich are developer-only files associated with an envelope,\\nwith signer attachments.\\n\\nTo learn about the different types of attachments, see [Attachments](/docs/esign-rest-api/esign101/concepts/documents/attachments/) in the concept guide.\\n\\n</ds-inlinemessage>\\n<!-- end notice DEVDOCS-114911 -->\\n\\n\\n\",\n \"destructive\": true,\n \"method\": \"PUT\",\n \"operation_id\": \"attachments_put_attachments\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The envelope's GUID. \\n\\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\\n\",\n \"in\": \"path\",\n \"name\": \"envelopeId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/envelopes/{envelopeId}/attachments\",\n \"request_body\": {\n \"$ref\": \"#/definitions/envelopeAttachmentsRequest\"\n },\n \"security\": null,\n \"skill_name\": \"attachments_put_attachments\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Adds one or more envelope attachments to a draft or in-process envelope.\",\n \"tags\": [\n \"EnvelopeAttachments\"\n ]\n },\n \"audit_events_get_audit_events\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Gets the envelope audit events for the specified envelope.\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"audit_events_get_audit_events\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The envelope's GUID. \\n\\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\\n\",\n \"in\": \"path\",\n \"name\": \"envelopeId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The user's locale code. Valid values are:\\n- `zh_CN`\\n- `zh_TW`\\n- `nl`\\n- `en`\\n- `fr`\\n- `de`\\n- `it`\\n- `ja`\\n- `ko`\\n- `pt`\\n- `pt_BR`\\n- `ru`\\n- `es`\",\n \"in\": \"query\",\n \"name\": \"locale\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/envelopes/{envelopeId}/audit_events\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"audit_events_get_audit_events\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Gets the envelope audit events for an envelope.\",\n \"tags\": [\n \"Envelopes\"\n ]\n },\n \"bcc_email_archive_delete_bcc_email_archive\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"This method deletes a BCC email archive configuration from an account.\\n\\nWhen you use this method, the status of the BCC email archive configuration switches to `closed` and the BCC email address is no longer used to archive Docusign-generated email messages.\\n\",\n \"destructive\": true,\n \"method\": \"DELETE\",\n \"operation_id\": \"bcc_email_archive_delete_bcc_email_archive\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The ID of the BCC email archive configuration.\",\n \"in\": \"path\",\n \"name\": \"bccEmailArchiveId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/settings/bcc_email_archives/{bccEmailArchiveId}\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"bcc_email_archive_delete_bcc_email_archive\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Deletes a BCC email archive configuration.\",\n \"tags\": [\n \"BCCEmailArchive\"\n ]\n },\n \"bcc_email_archive_get_bcc_email_archive_history_list\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"This method returns a specific BCC email archive configuration for an account, as well as the history of changes to the email address.\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"bcc_email_archive_get_bcc_email_archive_history_list\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The ID of the BCC email archive configuration.\",\n \"in\": \"path\",\n \"name\": \"bccEmailArchiveId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The maximum number of results to return.\\n\\nUse `start_position` to specify the number of items to skip.\\n\",\n \"in\": \"query\",\n \"name\": \"count\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The zero-based index of the\\nresult from which to start returning results.\\n\\nUse with `count` to limit the number\\nof results.\\n\\nThe default value is `0`.\\n\",\n \"in\": \"query\",\n \"name\": \"start_position\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/settings/bcc_email_archives/{bccEmailArchiveId}\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"bcc_email_archive_get_bcc_email_archive_history_list\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Gets a BCC email archive configuration and its history.\",\n \"tags\": [\n \"BCCEmailArchive\"\n ]\n },\n \"bcc_email_archive_get_bcc_email_archive_list\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"This method retrieves all of the BCC email archive configurations associated with an account.\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"bcc_email_archive_get_bcc_email_archive_list\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The maximum number of results to return.\\n\\nUse `start_position` to specify the number of results to skip.\\n\",\n \"in\": \"query\",\n \"name\": \"count\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The zero-based index of the\\nresult from which to start returning results.\\n\\nUse with `count` to limit the number\\nof results.\\n\\nThe default value is `0`.\\n\",\n \"in\": \"query\",\n \"name\": \"start_position\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/settings/bcc_email_archives\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"bcc_email_archive_get_bcc_email_archive_list\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Gets the BCC email archive configurations for an account.\",\n \"tags\": [\n \"BCCEmailArchive\"\n ]\n },\n \"bcc_email_archive_post_bcc_email_archive\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"This method creates a BCC email archive configuration for an account (adds a BCC email address to the account for archiving the emails that Docusign generates).\\n\\nThe only property that you must set in the request body is the BCC email address that you want to use.\\n\\n**Note:** An account can have up to five active and pending email archive addresses combined, but you must use this method to add them to the account one at a time. Each email address is considered a separate BCC email archive configuration.\\n\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"bcc_email_archive_post_bcc_email_archive\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/settings/bcc_email_archives\",\n \"request_body\": {\n \"$ref\": \"#/definitions/bccEmailArchive\"\n },\n \"security\": null,\n \"skill_name\": \"bcc_email_archive_post_bcc_email_archive\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Creates a BCC email archive configuration.\",\n \"tags\": [\n \"BCCEmailArchive\"\n ]\n },\n \"billing_charges_get_account_billing_charges\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Retrieves the list of recurring and usage charges for the account. This can be used to determine the charge structure and usage of charge plan items. \\n\\nPrivileges required: account administrator \",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"billing_charges_get_account_billing_charges\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Specifies which billing charges to return.\\nValid values are:\\n\\n* envelopes\\n* seats\\n\",\n \"in\": \"query\",\n \"name\": \"include_charges\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/billing_charges\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"billing_charges_get_account_billing_charges\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Gets list of recurring and usage charges for the account.\",\n \"tags\": [\n \"Accounts\"\n ]\n },\n \"billing_invoices_get_billing_invoice\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Retrieves the specified invoice.\\n\\n**Note:** If the `pdfAvailable` property in the response is set to *true*, you can download a PDF version of the invoice. To download the PDF, make the call again and change the value of the `Accept` property in the header to `Accept: application/pdf`.\\n\\nPrivileges required: account administrator\\n\\nThe response returns a list of charges and information about the charges. Quantities are usually shown as 'unlimited' or an integer. Amounts are shown in the currency set for the account.\\n\\n**Response**\\nThe following table provides a description of the different `chargeName` property values. The information will grow as more chargeable items are added to the system.\\n\\n| chargeName | Description |\\n| --- | --- |\\n| id_check | ID Check Charge |\\n| in_person_signing | In Person Signing charge |\\n| envelopes Included | Sent Envelopes for the account |\\n| age_verify | Age verification check |\\n| ofac | OFAC Check |\\n| id_confirm | ID confirmation check |\\n| student_authentication | STAN PIN authentication check |\\n| wet_sign_fax | Pages for returning signed documents by fax |\\n| attachment_fax | Pages for returning attachments by fax |\\n| phone_authentication | Phone authentication charge |\\n| powerforms | PowerForm envelopes sent |\\n| signer_payments | Payment processing charge |\\n| outbound_fax | Send by fax charge |\\n| bulk_recipient_envelopes | Bulk Recipient Envelopes sent |\\n| sms_authentications | SMS authentication charge |\\n| saml_authentications | SAML authentication charge |\\n| express_signer_certificate | Docusign Express Certificate charge |\\n| personal_signer_certificate | Personal Signer Certificate charge |\\n| safe_certificate | SAFE BioPharma Signer Certificate charge |\\n| seats | Included active seats charge |\\n| open_trust_certificate | OpenTrust Signer Certificate charge |\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"billing_invoices_get_billing_invoice\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The ID of the invoice.\",\n \"in\": \"path\",\n \"name\": \"invoiceId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/billing_invoices/{invoiceId}\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"billing_invoices_get_billing_invoice\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Retrieves a billing invoice.\",\n \"tags\": [\n \"Invoices\"\n ]\n },\n \"billing_invoices_get_billing_invoices\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Retrieves a list of invoices for the account. If the from date or to date queries are not specified, the response returns invoices for the last 365 days.\\n\\nPrivileges required: account administrator \",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"billing_invoices_get_billing_invoices\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Specifies the date/time of the earliest invoice in the account to retrieve.\",\n \"in\": \"query\",\n \"name\": \"from_date\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Specifies the date/time of the latest invoice in the account to retrieve.\",\n \"in\": \"query\",\n \"name\": \"to_date\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/billing_invoices\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"billing_invoices_get_billing_invoices\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Get a List of Billing Invoices\",\n \"tags\": [\n \"Invoices\"\n ]\n },\n \"billing_invoices_get_billing_invoices_past_due\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Returns a list past due invoices for the account and notes if payment can be made through the REST API. \\n\\nPrivileges Required: account administrator\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"billing_invoices_get_billing_invoices_past_due\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/billing_invoices_past_due\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"billing_invoices_get_billing_invoices_past_due\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Get a list of past due invoices.\",\n \"tags\": [\n \"Invoices\"\n ]\n },\n \"billing_payments_get_payment\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Retrieves the information for a specified payment. \\n\\nPrivileges required: account administrator \",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"billing_payments_get_payment\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The ID of the payment.\",\n \"in\": \"path\",\n \"name\": \"paymentId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/billing_payments/{paymentId}\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"billing_payments_get_payment\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Gets billing payment information for a specific payment.\",\n \"tags\": [\n \"Payments\"\n ]\n },\n \"billing_payments_get_payment_list\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Retrieves a list containing information about one or more payments. If the from date or to date queries are not used, the response returns payment information for the last 365 days. \\n\\nPrivileges required: account administrator \",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"billing_payments_get_payment_list\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Specifies the date/time of the earliest payment in the account to retrieve.\",\n \"in\": \"query\",\n \"name\": \"from_date\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Specifies the date/time of the latest payment in the account to retrieve.\",\n \"in\": \"query\",\n \"name\": \"to_date\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/billing_payments\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"billing_payments_get_payment_list\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Gets payment information for one or more payments.\",\n \"tags\": [\n \"Payments\"\n ]\n },\n \"billing_payments_post_payment\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Posts a payment to a past due invoice.\\n\\nThis method can only be used if the `paymentAllowed` value for a past due invoice is true. This can be determined calling [Billing::listInvoicesPastDue](/docs/esign-rest-api/reference/billing/invoices/listpastdue/).\\n\\nThe response returns information for a single payment\\nif a payment ID was used in the endpoint, or a list of payments.\\nIf the from date or to date queries or payment ID are not used,\\nthe response returns payment information for the last 365 days.\\n\\nIf the request was for a single payment ID, the `nextUri` and `previousUri` properties are not returned.\\n\\nPrivileges required: account administrator\\n\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"billing_payments_post_payment\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/billing_payments\",\n \"request_body\": {\n \"$ref\": \"#/definitions/billingPaymentRequest\"\n },\n \"security\": null,\n \"skill_name\": \"billing_payments_post_payment\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Posts a payment to a past due invoice.\",\n \"tags\": [\n \"Payments\"\n ]\n },\n \"billing_plan_get_billing_plan\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Retrieves the billing plan information for the specified account, including the current billing plan, successor plans, billing address, and billing credit card.\\n\\nBy default the successor plan and credit card information is included in the response. You can exclude this information from the response by adding the appropriate optional query string and setting it to **false.**\\n\\nResponse\\n\\nThe response returns the billing plan information, including the currency code, for the plan. The `billingPlan` and `succesorPlans` property values are the same as those shown in the [Billing: getBillingPlan](/docs/esign-rest-api/reference/billing/billingplans/get/) reference. the `billingAddress` and `creditCardInformation` property values are the same as those shown in the [Billing: updatePlan](/docs/esign-rest-api/reference/billing/billingplans/update/) reference.\\n\\n**Note:** When credit card number information displays, a mask is applied to the response so that only the last 4 digits of the card number are visible.\\n\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"billing_plan_get_billing_plan\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"When **true,** payment information including credit card information will show in the return.\",\n \"in\": \"query\",\n \"name\": \"include_credit_card_information\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"\",\n \"in\": \"query\",\n \"name\": \"include_downgrade_information\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"When **true,** the `canUpgrade` and `renewalStatus` properties are included the response and an array of `supportedCountries` is added to the `billingAddress` information. \",\n \"in\": \"query\",\n \"name\": \"include_metadata\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"When **true,** excludes successor information from the response.\",\n \"in\": \"query\",\n \"name\": \"include_successor_plans\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"\",\n \"in\": \"query\",\n \"name\": \"include_tax_exempt_id\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/billing_plan\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"billing_plan_get_billing_plan\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Get Account Billing Plan\",\n \"tags\": [\n \"BillingPlans\"\n ]\n },\n \"billing_plan_get_credit_card_info\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"This method returns information about a credit card associated with an account.\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"billing_plan_get_credit_card_info\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/billing_plan/credit_card\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"billing_plan_get_credit_card_info\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Get credit card information\",\n \"tags\": [\n \"BillingPlans\"\n ]\n },\n \"billing_plan_get_downgrade_request_billing_info\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Returns downgrade plan information for the specified account.\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"billing_plan_get_downgrade_request_billing_info\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/billing_plan/downgrade\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"billing_plan_get_downgrade_request_billing_info\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Returns downgrade plan information for the specified account.\",\n \"tags\": [\n \"BillingPlans\"\n ]\n },\n \"billing_plan_put_billing_plan\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Updates the billing plan information, billing address, and credit card information for the specified account.\",\n \"destructive\": true,\n \"method\": \"PUT\",\n \"operation_id\": \"billing_plan_put_billing_plan\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"When **true,** updates the account using a preview billing plan.\",\n \"in\": \"query\",\n \"name\": \"preview_billing_plan\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/billing_plan\",\n \"request_body\": {\n \"$ref\": \"#/definitions/billingPlanInformation\"\n },\n \"security\": null,\n \"skill_name\": \"billing_plan_put_billing_plan\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Updates an account billing plan.\",\n \"tags\": [\n \"BillingPlans\"\n ]\n },\n \"billing_plan_put_downgrade_account_billing_plan\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Queues downgrade billing plan request for an account.\",\n \"destructive\": true,\n \"method\": \"PUT\",\n \"operation_id\": \"billing_plan_put_downgrade_account_billing_plan\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/billing_plan/downgrade\",\n \"request_body\": {\n \"$ref\": \"#/definitions/downgradeBillingPlanInformation\"\n },\n \"security\": null,\n \"skill_name\": \"billing_plan_put_downgrade_account_billing_plan\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Queues downgrade billing plan request for an account.\",\n \"tags\": [\n \"BillingPlans\"\n ]\n },\n \"billing_plans_get_billing_plan\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Retrieves the billing plan details for the specified billing plan ID.\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"billing_plans_get_billing_plan\",\n \"parameters\": [\n {\n \"description\": \"The ID of the billing plan being accessed.\",\n \"in\": \"path\",\n \"name\": \"billingPlanId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/billing_plans/{billingPlanId}\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"billing_plans_get_billing_plan\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Gets billing plan details.\",\n \"tags\": [\n \"BillingPlans\"\n ]\n },\n \"billing_plans_get_billing_plans\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Retrieves a list of the billing plans associated with a distributor.\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"billing_plans_get_billing_plans\",\n \"parameters\": [],\n \"path\": \"/v2.1/billing_plans\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"billing_plans_get_billing_plans\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Gets a list of available billing plans.\",\n \"tags\": [\n \"BillingPlans\"\n ]\n },\n \"brand_delete_brand\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"This method deletes a [brand](/docs/esign-rest-api/esign101/concepts/branding/) from an account.\\n\\n**Note:** Branding for either signing or sending must be enabled for the account (`canSelfBrandSend` , `canSelfBrandSign`, or both of these account settings must be **true**).\",\n \"destructive\": true,\n \"method\": \"DELETE\",\n \"operation_id\": \"brand_delete_brand\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The ID of the brand.\",\n \"in\": \"path\",\n \"name\": \"brandId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/brands/{brandId}\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"brand_delete_brand\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Deletes a brand.\",\n \"tags\": [\n \"AccountBrands\"\n ]\n },\n \"brand_export_get_brand_export_file\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"This method exports information about a brand to an XML file.\\n\\n**Note:** Branding for either signing or sending must be enabled for the account (`canSelfBrandSend` , `canSelfBrandSign`, or both of these account settings must be **true**).\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"brand_export_get_brand_export_file\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The ID of the brand.\",\n \"in\": \"path\",\n \"name\": \"brandId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/brands/{brandId}/file\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"brand_export_get_brand_export_file\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Exports a brand.\",\n \"tags\": [\n \"AccountBrands\"\n ]\n },\n \"brand_get_brand\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"This method returns details about an account [brand](/docs/esign-rest-api/esign101/concepts/branding/).\\n\\n**Note:** Branding for either signing or sending must be enabled for the account (`canSelfBrandSend` , `canSelfBrandSign`, or both of these account settings must be **true**).\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"brand_get_brand\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The ID of the brand.\",\n \"in\": \"path\",\n \"name\": \"brandId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"When **true,** the landing pages and links associated with the brand are included in the response.\",\n \"in\": \"query\",\n \"name\": \"include_external_references\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"When **true,** the URIs for the logos associated with the brand are included in the response.\",\n \"in\": \"query\",\n \"name\": \"include_logos\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/brands/{brandId}\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"brand_get_brand\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Gets information about a brand.\",\n \"tags\": [\n \"AccountBrands\"\n ]\n },\n \"brand_logo_delete_brand_logo\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"This method deletes a single logo from an account brand.\\n\\n**Note:** Branding for either signing or sending must be enabled for the account (`canSelfBrandSend` , `canSelfBrandSign`, or both of these account settings must be **true**).\",\n \"destructive\": true,\n \"method\": \"DELETE\",\n \"operation_id\": \"brand_logo_delete_brand_logo\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The ID of the brand.\",\n \"in\": \"path\",\n \"name\": \"brandId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The type of logo. Valid values are:\\n\\n- `primary` \\n- `secondary` \\n- `email`\",\n \"in\": \"path\",\n \"name\": \"logoType\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/brands/{brandId}/logos/{logoType}\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"brand_logo_delete_brand_logo\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Deletes a brand logo.\",\n \"tags\": [\n \"AccountBrands\"\n ]\n },\n \"brand_logo_get_brand_logo\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"This method returns a specific logo that is used in a brand.\\n\\n**Note:** Branding for either signing or sending must be enabled for the account (`canSelfBrandSend` , `canSelfBrandSign`, or both of these account settings must be **true**).\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"brand_logo_get_brand_logo\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The ID of the brand.\",\n \"in\": \"path\",\n \"name\": \"brandId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The type of logo. Valid values are:\\n\\n- `primary` \\n- `secondary` \\n- `email`\",\n \"in\": \"path\",\n \"name\": \"logoType\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/brands/{brandId}/logos/{logoType}\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"brand_logo_get_brand_logo\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Gets a brand logo.\",\n \"tags\": [\n \"AccountBrands\"\n ]\n },\n \"brand_logo_put_brand_logo\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"This method updates a single brand logo.\\n\\nYou pass in the new version of the resource in the `Content-Disposition` header. Example:\\n\\n`Content-Disposition: form-data; name=\\\"file\\\"; filename=\\\"logo.jpg\\\"`\\n\\n**Note:** Branding for either signing or sending must be enabled for the account (`canSelfBrandSend` , `canSelfBrandSign`, or both of these account settings must be **true**).\",\n \"destructive\": true,\n \"method\": \"PUT\",\n \"operation_id\": \"brand_logo_put_brand_logo\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The ID of the brand.\",\n \"in\": \"path\",\n \"name\": \"brandId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The type of logo. Valid values are:\\n\\n- `primary` \\n- `secondary` \\n- `email`\",\n \"in\": \"path\",\n \"name\": \"logoType\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/brands/{brandId}/logos/{logoType}\",\n \"request_body\": {\n \"format\": \"binary\",\n \"type\": \"string\"\n },\n \"security\": null,\n \"skill_name\": \"brand_logo_put_brand_logo\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Updates a brand logo.\",\n \"tags\": [\n \"AccountBrands\"\n ]\n },\n \"brand_put_brand\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"This method updates an account brand. \\n\\n**Note:** Branding for either signing or sending must be enabled for the account (`canSelfBrandSend` , `canSelfBrandSign`, or both of these account settings must be **true**).\",\n \"destructive\": true,\n \"method\": \"PUT\",\n \"operation_id\": \"brand_put_brand\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The ID of the brand.\",\n \"in\": \"path\",\n \"name\": \"brandId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"When **true,** replaces the brand instead of updating it. The only unchanged value is the brand ID. The request body must be XML. The default value is **false.**\",\n \"in\": \"query\",\n \"name\": \"replace_brand\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/brands/{brandId}\",\n \"request_body\": {\n \"$ref\": \"#/definitions/brand\"\n },\n \"security\": null,\n \"skill_name\": \"brand_put_brand\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Updates an existing brand.\",\n \"tags\": [\n \"AccountBrands\"\n ]\n },\n \"brand_resources_get_brand_resources\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"This method returns a specific branding resource file.\\n\\nA brand uses a set of brand resource files to control the sending, signing, email message, and captive (embedded) signing experiences. You can modify the default email messages and formats in these files and upload them to your brand to customize the user experience.\\n\\n**Important:** When you upload a modified resource file, only the elements that differ from the master resource file are saved as your resource file. Similarly, when you download your resource files, only the modified elements are included in the file. \\n\\n**Note:** Branding for either signing or sending must be enabled for the account (`canSelfBrandSend` , `canSelfBrandSign`, or both of these account settings must be **true**).\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"brand_resources_get_brand_resources\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The ID of the brand.\",\n \"in\": \"path\",\n \"name\": \"brandId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The type of brand resource file to return. Valid values are:\\n\\n- `sending`\\n- `signing`\\n- `email`\\n- `signing_captive`\",\n \"in\": \"path\",\n \"name\": \"resourceContentType\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The ISO 3166-1 alpha-2 codes for the languages that the brand supports.\",\n \"in\": \"query\",\n \"name\": \"langcode\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Specifies which resource file data to return. When **true,** only the master resource file is returned. When **false,** only the elements that you modified are returned.\",\n \"in\": \"query\",\n \"name\": \"return_master\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/brands/{brandId}/resources/{resourceContentType}\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"brand_resources_get_brand_resources\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Returns a branding resource file.\",\n \"tags\": [\n \"AccountBrands\"\n ]\n },\n \"brand_resources_get_brand_resources_list\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"This method returns metadata about the branding resources that are associated with an account.\\n\\n**Note:** Branding for either signing or sending must be enabled for the account (`canSelfBrandSend` , `canSelfBrandSign`, or both of these account settings must be **true**).\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"brand_resources_get_brand_resources_list\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The ID of the brand.\",\n \"in\": \"path\",\n \"name\": \"brandId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/brands/{brandId}/resources\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"brand_resources_get_brand_resources_list\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Returns metadata about the branding resources for an account.\",\n \"tags\": [\n \"AccountBrands\"\n ]\n },\n \"brand_resources_put_brand_resources\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"This method updates a branding resource file.\\n\\nYou pass in the new version of the resource file in the `Content-Disposition` header. Example:\\n\\n`Content-Disposition: form-data; name=\\\"file\\\"; filename=\\\"DocuSign_SigningResource_4328673.xml\\\"`\\n\\n**Note:** Branding for either signing or sending must be enabled for the account (`canSelfBrandSend` , `canSelfBrandSign`, or both of these account settings must be **true**).\\n\\n**Important:** Customizing resource files is an advanced branding configuration option which can significantly impact your account, and should be done only by someone with expertise in XML and HTML. The master resource files are subject to change without notice. If you customize your resource files, after each release, Docusign recommends you review any changes and update your custom files as needed.\\n\\nWhen you upload a modified resource file, only the elements that differ from the master resource file are saved as your resource file. Similarly, when you download your resource files, only the modified elements are included in the file.\",\n \"destructive\": true,\n \"method\": \"PUT\",\n \"operation_id\": \"brand_resources_put_brand_resources\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The ID of the brand.\",\n \"in\": \"path\",\n \"name\": \"brandId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The type of brand resource file that you are updating. Valid values are:\\n\\n- `sending`\\n- `signing`\\n- `email`\\n- `signing_captive`\",\n \"in\": \"path\",\n \"name\": \"resourceContentType\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/brands/{brandId}/resources/{resourceContentType}\",\n \"request_body\": {\n \"properties\": {\n \"file.xml\": {\n \"type\": \"file\"\n }\n },\n \"required\": [\n \"file.xml\"\n ],\n \"type\": \"object\"\n },\n \"security\": null,\n \"skill_name\": \"brand_resources_put_brand_resources\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Updates a branding resource file.\",\n \"tags\": [\n \"AccountBrands\"\n ]\n },\n \"brands_delete_brands\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"This method deletes one or more brand profiles from an account, based on the brand IDs that you include in the `brandsRequest`.\\n\\nEither or both of the following settings must be enabled for the account to use this method:\\n\\n- `canSelfBrandSign`\\n- `canSelfBrandSend`\\n\\n### Related topics\\n\\n- [How to create a brand](/docs/esign-rest-api/how-to/create-brand/)\\n\",\n \"destructive\": true,\n \"method\": \"DELETE\",\n \"operation_id\": \"brands_delete_brands\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/brands\",\n \"request_body\": {\n \"$ref\": \"#/definitions/brandsRequest\"\n },\n \"security\": null,\n \"skill_name\": \"brands_delete_brands\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Deletes one or more brand profiles.\",\n \"tags\": [\n \"AccountBrands\"\n ]\n },\n \"brands_delete_group_brands\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"This method deletes one or more brands from a group.\",\n \"destructive\": true,\n \"method\": \"DELETE\",\n \"operation_id\": \"brands_delete_group_brands\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The ID of the group.\",\n \"in\": \"path\",\n \"name\": \"groupId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/groups/{groupId}/brands\",\n \"request_body\": {\n \"$ref\": \"#/definitions/brandsRequest\"\n },\n \"security\": null,\n \"skill_name\": \"brands_delete_group_brands\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Deletes brand information from a group.\",\n \"tags\": [\n \"GroupBrands\"\n ]\n },\n \"brands_get_brands\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"This method returns details about all of the [brands](/docs/esign-rest-api/esign101/concepts/branding/) associated with an account,\\nincluding the default brand profiles.\\n\\nEither or both of the following settings must be enabled for the account to use this method:\\n\\n- `canSelfBrandSign`\\n- `canSelfBrandSend`\\n\\n### Related topics\\n\\n- [How to create a brand](/docs/esign-rest-api/how-to/create-brand/)\\n- [How to apply a brand to an envelope](/docs/esign-rest-api/how-to/apply-brand-to-envelope/)\\n\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"brands_get_brands\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"When **true,** excludes distributor brand information from the response set.\",\n \"in\": \"query\",\n \"name\": \"exclude_distributor_brand\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"When **true,** returns the logos associated with the brand.\",\n \"in\": \"query\",\n \"name\": \"include_logos\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/brands\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"brands_get_brands\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Gets a list of brands.\",\n \"tags\": [\n \"AccountBrands\"\n ]\n },\n \"brands_get_group_brands\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"This method returns information about the brands associated with a group.\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"brands_get_group_brands\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The ID of the group.\",\n \"in\": \"path\",\n \"name\": \"groupId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/groups/{groupId}/brands\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"brands_get_group_brands\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Gets the brand information for a group.\",\n \"tags\": [\n \"GroupBrands\"\n ]\n },\n \"brands_post_brands\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"This method creates one or more brand profile files for an account.\\n\\nTo specify logos for the brand,\\nuse the\\n[AccountBrands: updateLogo](/docs/esign-rest-api/reference/accounts/accountbrands/updatelogo/)\\nmethod\\nafter you create the brand.\\n\\n\\nEither or both of the following settings must be enabled for the account to use this method:\\n\\n- `canSelfBrandSign`\\n- `canSelfBrandSend`\\n\\n### Related topics\\n\\n- [How to create a brand](/docs/esign-rest-api/how-to/create-brand/)\\n\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"brands_post_brands\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/brands\",\n \"request_body\": {\n \"$ref\": \"#/definitions/brand\"\n },\n \"security\": null,\n \"skill_name\": \"brands_post_brands\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Creates one or more brand profiles for an account.\",\n \"tags\": [\n \"AccountBrands\"\n ]\n },\n \"brands_put_group_brands\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"This method adds one or more existing brands to a group based on the `groupId`.\",\n \"destructive\": true,\n \"method\": \"PUT\",\n \"operation_id\": \"brands_put_group_brands\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The ID of the group being accessed.\",\n \"in\": \"path\",\n \"name\": \"groupId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/groups/{groupId}/brands\",\n \"request_body\": {\n \"$ref\": \"#/definitions/brandsRequest\"\n },\n \"security\": null,\n \"skill_name\": \"brands_put_group_brands\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Adds an existing brand to a group.\",\n \"tags\": [\n \"GroupBrands\"\n ]\n },\n \"bulk_send_v2_batch_get_bulk_send_batch_status\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Gets the general status of a specific bulk send batch such as:\\n\\n- number of successes\\n- number pending\\n- number of errors\\n\\nThe `bulkErrors` property of the response object contains more information about the errors.\\n\\n### Related topics\\n\\n- [How to bulk send envelopes](/docs/esign-rest-api/how-to/bulk-send-envelopes/)\\n\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"bulk_send_v2_batch_get_bulk_send_batch_status\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The batch ID.\",\n \"in\": \"path\",\n \"name\": \"bulkSendBatchId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/bulk_send_batch/{bulkSendBatchId}\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"bulk_send_v2_batch_get_bulk_send_batch_status\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Gets the status of a specific bulk send batch.\",\n \"tags\": [\n \"BulkSend\"\n ]\n },\n \"bulk_send_v2_batch_get_bulk_send_batches\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Returns a summary of bulk send batches.\\n\\nUse the `batch_ids` query parameter to narrow the list of batches.\\n\\nYou must specify exactly one of the following query parameters to get back a list of batch summaries:\\n\\n| Parameter | Description |\\n| :---------------- | :------------------------------------------------------------------------------- |\\n| `from_date` | A valid UTC DateTime: `2016-01-01` |\\n| `batch_ids` | A comma-separated list of batch IDs to query. |\\n\\nIf neither query parameter is provided, a high-level, account-wide, overall bulk send status report is returned.\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"bulk_send_v2_batch_get_bulk_send_batches\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"A comma-separated list of batch IDs to query.\",\n \"in\": \"query\",\n \"name\": \"batch_ids\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The maximum number of results to return.\\n\\nUse `start_position` to specify the number of results to skip.\\n\\nValid values: `1` to `100`<br>\\nDefault: `100`\",\n \"in\": \"query\",\n \"name\": \"count\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The start date for a date range in UTC DateTime format.\",\n \"in\": \"query\",\n \"name\": \"from_date\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Use this parameter to search for specific text.\",\n \"in\": \"query\",\n \"name\": \"search_text\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The zero-based index of the\\nresult from which to start returning results.\\n\\nUse with `count` to limit the number\\nof results.\\n\\nThe default value is `0`.\\n\",\n \"in\": \"query\",\n \"name\": \"start_position\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The kind of results to collect. Must be one of:\\n\\n- all\\n- failed\\n- sent\\n- queued\",\n \"in\": \"query\",\n \"name\": \"status\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The end of a search date range in UTC DateTime format. When you use this parameter, only templates created up to this date and time are returned.\\n\\n**Note:** If this property is null, the value defaults to the current date.\",\n \"in\": \"query\",\n \"name\": \"to_date\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"\",\n \"in\": \"query\",\n \"name\": \"user_id\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/bulk_send_batch\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"bulk_send_v2_batch_get_bulk_send_batches\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Returns a list of bulk send batch summaries. \",\n \"tags\": [\n \"BulkSend\"\n ]\n },\n \"bulk_send_v2_batch_put_bulk_send_batch_action\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Use this endpoint to resend, correct, or void all envelopes from a specified bulk send.\",\n \"destructive\": true,\n \"method\": \"PUT\",\n \"operation_id\": \"bulk_send_v2_batch_put_bulk_send_batch_action\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The action to apply. Valid values:\\n* `resend`\\n* `correct`\\n* `void`\\n\",\n \"in\": \"path\",\n \"name\": \"bulkAction\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The batch ID.\",\n \"in\": \"path\",\n \"name\": \"bulkSendBatchId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/bulk_send_batch/{bulkSendBatchId}/{bulkAction}\",\n \"request_body\": {\n \"$ref\": \"#/definitions/bulkSendBatchActionRequest\"\n },\n \"security\": null,\n \"skill_name\": \"bulk_send_v2_batch_put_bulk_send_batch_action\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Applies a bulk action to all envelopes from a specified bulk send.\",\n \"tags\": [\n \"BulkSend\"\n ]\n },\n \"bulk_send_v2_batch_put_bulk_send_batch_status\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Updates the name of a bulk send batch.\",\n \"destructive\": true,\n \"method\": \"PUT\",\n \"operation_id\": \"bulk_send_v2_batch_put_bulk_send_batch_status\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The batch ID.\",\n \"in\": \"path\",\n \"name\": \"bulkSendBatchId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/bulk_send_batch/{bulkSendBatchId}\",\n \"request_body\": {\n \"$ref\": \"#/definitions/bulkSendBatchRequest\"\n },\n \"security\": null,\n \"skill_name\": \"bulk_send_v2_batch_put_bulk_send_batch_status\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Updates the name of a bulk send batch.\",\n \"tags\": [\n \"BulkSend\"\n ]\n },\n \"bulk_send_v2_crud_delete_bulk_send_list\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"This method deletes a bulk send list.\",\n \"destructive\": true,\n \"method\": \"DELETE\",\n \"operation_id\": \"bulk_send_v2_crud_delete_bulk_send_list\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The GUID of the bulk send list. This property is created after you post a new bulk send list.\",\n \"in\": \"path\",\n \"name\": \"bulkSendListId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/bulk_send_lists/{bulkSendListId}\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"bulk_send_v2_crud_delete_bulk_send_list\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Deletes a bulk send list.\",\n \"tags\": [\n \"BulkSend\"\n ]\n },\n \"bulk_send_v2_crud_get_bulk_send_list\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"This method returns all of the details associated with a specific bulk send list that belongs to the current user.\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"bulk_send_v2_crud_get_bulk_send_list\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The GUID of the bulk send list. This property is created after you post a new bulk send list.\",\n \"in\": \"path\",\n \"name\": \"bulkSendListId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/bulk_send_lists/{bulkSendListId}\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"bulk_send_v2_crud_get_bulk_send_list\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Gets a specific bulk send list.\",\n \"tags\": [\n \"BulkSend\"\n ]\n },\n \"bulk_send_v2_crud_get_bulk_send_lists\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"This method returns a list of bulk send lists belonging to the current user, as well as basic information about each list.\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"bulk_send_v2_crud_get_bulk_send_lists\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/bulk_send_lists\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"bulk_send_v2_crud_get_bulk_send_lists\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Gets bulk send lists.\",\n \"tags\": [\n \"BulkSend\"\n ]\n },\n \"bulk_send_v2_crud_post_bulk_send_list\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"This method creates a bulk send list that you can use to send an envelope to up to 1,000 recipients at once.\\n\\n### Related topics\\n\\n- [How to bulk send envelopes](/docs/esign-rest-api/how-to/bulk-send-envelopes/)\\n\\n### Errors\\n\\n| Error code | Description |\\n| :------------------------------------------------------ | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\\n| BULK_SEND_MAX_COPIES_EXCEEDED | A bulk sending list cannot specify more than XXX copies in the mailing list. Call the settings API endpoint to find the maximum number of copies in a batch allowed for your account. In almost all cases, the default limit is 1000. |\\n| BULK_SEND_RECIPIENT_IDS_MUST_BE_UNIQUE | No two recipientIds can be same within a bulkCopy. Same restriction as a regular envelope applies. Specify unique recipient IDs for each recipient within a bulkCopy (model for envelope in mailing list). |\\n| BULK_SEND_RECIPIENT_ID_REQUIRED | If no RoleName is present, recipientID is required in mailing list's bulkCopy. Add a roleName (that coalesces with template/envelope) or a recipientID. |\\n| BULK_SEND_RECIPIENT_NAME_REQUIRED | Recipient {0} has no name. Specify a name for the recipient. |\\n| BULK_SEND_EMAIL_ADDRESS_REQUIRED_FOR_EMAIL_RECIPIENT | Recipient {0} is an email recipient with no email address. Specify an email for the email recipient. |\\n| BULK_SEND_FAX_NUMBER_REQUIRED_FOR_FAX_RECIPIENT | Recipient {0} is a fax recipient with no fax number. Specify a fax number for the fax recipient. |\\n| BULK_SEND_FAX_NUMBER_NOT_VALID | Recipient {0} specifies fax number {1}, which is not valid. Specify a valid fax number for the fax recipient. |\\n| BULK_SEND_EMAIL_ADDRESS_NOT_VALID | Recipient {0} specifies email address {1}, which is not a valid email address. Specify a valid email address for the recipient. |\\n| BULK_SEND_PHONE_NUMBER_REQURED_FOR_SMS_AUTH | Recipient {0} specifies SMS auth, but no number was provided. Specify a phone number for the SMS auth recipient. |\\n| BULK_SEND_PHONE_NUMBER_INVALID_FOR_SMS_AUTH | Recipient {0} specifies phone number {1} for SMS auth, which is not valid. Specify a valid phone number for the SMS auth recipient. |\\n| BULK_SEND_ROLE_NAMES_MUST_BE_UNIQUE | Recipient role names cannot be duplicated; role {duplicateRecipientRole} appears multiple times. Use unique roleNames for recipients. |\\n| BULK_SEND_CANNOT_USE_BOTH_ROLE_AND_ID_ON_SAME_RECIPIENT | Recipients cannot have both ID and Role; {0} has both. Specify a roleName or recipientId, but not both for the same recipient. |\\n| BULK_SEND_CANNOT_USE_BOTH_ROLE_AND_ID_IN_SAME_LIST | Cannot use both recipient role and ID in the same list. Specify a roleName or recipientId, but not both in the same list. |\\n| BULK_SEND_INVALID_ID_CHECK_CONFIGURATION | Recipient {0} specified SMS authentication, but no SMS auth settings were provided. Provide an SMS auth setting (proper ID configuration) if SMS auth is specified. |\\n| BULK_SEND_INVALID_SBS_INPUT_CONFIGURATION | Recipient {0} has more than one signature provider specified. Or signingProviderName is not specified. Or Signature provider : {0} is either unknown or not an available pen for this account. One or more SBS configuration is missing or invalid. The error details provide specifics. |\\n| BULK_SEND_TAB_LABELS_MUST_BE_UNIQUE | Tab label {0} is duplicated. Needs to be unique. Use a unique tab label. |\\n| BULK_SEND_TAB_LABEL_REQUIRED | Tab label is required. Specify a tab label. |\\n| BULK_SEND_TAB_VALUE_REQUIRED | Tab Label value is required. Specify a value for the tab label. |\\n| BULK_SEND_ENVELOPE_CUSTOM_FIELD_NAME_MUST_BE_UNIQUE | Custom fields must have distinct names. The field {0} appears more than once in a copy. Use unique names for custom fields. |\\n| BULK_SEND_ENVELOPE_CUSTOM_FIELD_NAME_REQUIRED | All custom fields must have names. Specify a name for the custom field. |\\n| BULK_SEND_ENVELOPE_CUSTOM_FIELD_VALUE_REQUIRED | Custom field {0} has no value. A custom field can have an empty value, but it cannot have a null value. Specify a value for the custom field. |\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"bulk_send_v2_crud_post_bulk_send_list\",\n \"parameters\": [\n {\n \"description\": \"The ID of the account.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/bulk_send_lists\",\n \"request_body\": {\n \"$ref\": \"#/definitions/bulkSendingList\"\n },\n \"security\": null,\n \"skill_name\": \"bulk_send_v2_crud_post_bulk_send_list\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Creates a bulk send list.\",\n \"tags\": [\n \"BulkSend\"\n ]\n },\n \"bulk_send_v2_crud_put_bulk_send_list\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"This method replaces the definition of an existing bulk send list.\",\n \"destructive\": true,\n \"method\": \"PUT\",\n \"operation_id\": \"bulk_send_v2_crud_put_bulk_send_list\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The GUID of the bulk send list. This property is created after you post a new bulk send list.\",\n \"in\": \"path\",\n \"name\": \"bulkSendListId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/bulk_send_lists/{bulkSendListId}\",\n \"request_body\": {\n \"$ref\": \"#/definitions/bulkSendingList\"\n },\n \"security\": null,\n \"skill_name\": \"bulk_send_v2_crud_put_bulk_send_list\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Updates a bulk send list.\",\n \"tags\": [\n \"BulkSend\"\n ]\n },\n \"bulk_send_v2_envelopes_get_bulk_send_batch_envelopes\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"This method returns a list of envelopes in a specified bulk batch. Use the query parameters to filter and sort the envelopes by different attributes.\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"bulk_send_v2_envelopes_get_bulk_send_batch_envelopes\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The batch ID.\",\n \"in\": \"path\",\n \"name\": \"bulkSendBatchId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The maximum number of results to return.\\n\\nUse `start_position` to specify the number of results to skip.\\n\\nValid values: `1` to `1000`\\n\",\n \"in\": \"query\",\n \"name\": \"count\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"When `recipients`, only envelopes with recipient nodes will be included in the response.\",\n \"in\": \"query\",\n \"name\": \"include\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The order in which to sort the results. Valid values are:\\n\\n- Descending order: `desc` (default)\\n- Ascending order: `asc`\",\n \"in\": \"query\",\n \"name\": \"order\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The envelope attribute used to sort the results. Valid values are:\\n\\n- `created` (default)\\n- `completed`\\n- `last_modified`\\n- `sent`\\n- `status`\\n- `subject`\\n- `status_changed`\",\n \"in\": \"query\",\n \"name\": \"order_by\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Use this parameter to search for specific text.\",\n \"in\": \"query\",\n \"name\": \"search_text\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The zero-based index of the\\nresult from which to start returning results.\\n\\nUse with `count` to limit the number\\nof results.\\n\\nThe default value is `0`.\\n\",\n \"in\": \"query\",\n \"name\": \"start_position\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Comma-separated list of envelope statuses.\\n\\nNote that `any` should not be included with other statuses. In other words, `any` is a valid parameter value, but `any,sent` is not.\\n\\nUse the value `deliveryfailure` to get all envelopes with `AuthFailed` and `AutoResponded` status. This value is specific to bulk sending.\",\n \"in\": \"query\",\n \"name\": \"status\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/bulk_send_batch/{bulkSendBatchId}/envelopes\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"bulk_send_v2_envelopes_get_bulk_send_batch_envelopes\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Gets envelopes from a specific bulk send batch.\",\n \"tags\": [\n \"BulkSend\"\n ]\n },\n \"bulk_send_v2_send_post_bulk_send_request\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"This method initiates the bulk send process. It generates a bulk send request based on an [existing bulk send list][create_list] and an envelope or template.\\n\\nConsider using the [BulkSend::createBulkSendTestRequest][create_test] method to test your bulk send list for compatibility with the envelope or template that you want to send first. To learn about the complete bulk send flow, see the [Bulk Send overview][BulkSendOverview].\\n\\nIf the envelopes were successfully queued for asynchronous processing, the response contains a `batchId` that you can use to get the status of the batch. If a failure occurs, the API returns an error message.\\n\\n**Note:** Partial success or failure generally does not occur. Only the entire batch is queued for asynchronous processing.\\n\\n### Related topics\\n\\n- [How to bulk send envelopes](/docs/esign-rest-api/how-to/bulk-send-envelopes/)\\n\\n\\n### Errors\\n\\nThis method returns the following errors:\\n\\n| Error code | Description |\\n| :--------------------------------------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\\n| BULK_SEND_ENVELOPE_NOT_IN_SENDABLE_STATE | Envelope {0} is not in a sendable state. The envelope is not complete. Make sure it has a sendable status, such as `created`. |\\n| BULK_SEND_ENVELOPE_LIST_CONTAINS_NO_COPIES | Cannot send an envelope with a bulk sending list which contains no copies. The list you're trying to bulk send is empty. Make sure the bulk sending list you're using contains recipients. |\\n| BULK_SEND_ENVELOPE_LIST_CONTAINS_TOO_MANY_COPIES | Bulk sending list contains more than {0} copies. The list you're trying to bulk send will cause your account to exceed the 1,000-copy limit imposed for all accounts. Try sending two or more separate lists. |\\n| BULK_SEND_ENVELOPE_CANNOT_BE_NULL | Cannot send a bulk list without an envelope. Specify the envelope ID or template ID for the envelope you want to bulk send. |\\n| BULK_SEND_BLOB_STORE_ERROR | Could not save copy of bulk sending list. An error writing to the database occurred. Try again. If the error persists, contact Docusign Support. |\\n| BULK_SEND_ACCOUNT_HAS_TOO_MANY_QUEUED_ENVELOPES | Cannot send this bulk sending list because doing so would exceed the maximum of {maxCopies} in-flight envelopes. This account currently has {unprocessedEnvelopes} envelopes waiting to be processed. Please try again later.\\\" .Try again later, or contact Docusign Support to request a higher tier. |\\n| BULK_SEND_ENVELOPE_NOT_FOUND | Envelope {envelopeOrTemplateId} does not exist or you do not have permission to access it. The envelopeId or templateId specified could not be found. Specify a valid value. |\\n| BULK_SEND_LIST_NOT_FOUND | Bulk Sending list {listId} does not exist or you do not have permission to access it. The mailingListId specified could not be found. Specify a valid value. |\\n| BULK_SEND_ENVELOPE_HAS_NO_RECIPIENTS | Bulk sending copy contains recipients, but the specified envelope does not. The recipients on the envelope and the bulk send list do not match. Make sure the envelope and list are compatible for sending. |\\n| BULK_SEND_RECIPIENT_ID_DOES_NOT_EXIST_IN_ENVELOPE | Recipient {0} does not exist in the envelope. Add the missing recipient to the envelope. |\\n| BULK_SEND_RECIPIENT_ID_DOES_NOT_MATCH | Recipient ID {envelopeMember.ID} does not match. Make sure the recipient information in the list and the envelope match up. |\\n| BULK_SEND_ENVELOPE_HAS_BULK_RECIPIENT | Recipient {0} is a bulk recipient. This is not supported. No legacy 'bulk recipient' allowed. In v2.1 of the eSignature API, you must use a bulk send list instead of a bulk recipient. See the API documentation for details. |\\n| BULK_SEND_RECIPIENT_ROLE_DOES_NOT_MATCH | Recipient Role {envelopeMember.RoleName} does not match. Make sure the recipient information in the list and the envelope is compatible. |\\n| BULK_SEND_DUPLICATE_RECIPIENT_DETECTED | Duplicate recipients ({0}) not allowed, unless recipients have unique routing order specified on envelope. |\\n| BULK_SEND_ENVELOPE_HAS_NO_TABS | Bulk sending copy contains tabs, but the specified envelope does not. List and envelope tabs cannot be coalesced. Make sure they are compatible for sending. |\\n| BULK_SEND_TAB_LABEL_DOES_NOT_EXIST_IN_ENVELOPE | Tab with label {0} does not exist in envelope. Add the tab label to the envelope, remove the label from the list, or make sure you're specifying the correct list and envelope. |\\n| BULK_SEND_TAB_DOES_NOT_MATCH | Tab {0} does not match {0} in envelope. A tab exists on the list that does not match or is missing on the envelope. Make sure the tabs on the list and the envelope match. |\\n| BULK_SEND_ENVELOPE_HAS_NO_ENVELOPE_CUSTOM_FIELDS | Bulk sending copy contains custom fields, but the specified envelope does not. There are custom fields on the list that the envelope does not have. Make sure that any custom fields on the list and the envelope match. |\\n| BULK_SEND_ENVELOPE_CUSTOM_FIELD_DOES_NOT_EXIST_IN_ENVELOPE | Custom field {0} does not exist in the envelope. Either add the custom field on the list to the envelope, remove the custom field from the list, or make sure you're specifying the correct list and envelope. |\\n| BULK_SEND_ENVELOPE_CUSTOM_FIELD_NAME_DOES_NOT_MATCH | Custom field names must match. {0} and {1} do not match. The custom field names on the list and the envelope do not match. Use identical names for both. |\\n\\n[create_list]: /docs/esign-rest-api/reference/bulkenvelopes/bulksend/createbulksendlist/\\n[create_test]: /docs/esign-rest-api/reference/bulkenvelopes/bulksend/createbulksendtestrequest/\\n[BulkSendOverview]: /docs/esign-rest-api/reference/bulkenvelopes/bulksend/\\n\\n\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"bulk_send_v2_send_post_bulk_send_request\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The GUID of the bulk send list. This property is created after you post a new bulk send list.\",\n \"in\": \"path\",\n \"name\": \"bulkSendListId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/bulk_send_lists/{bulkSendListId}/send\",\n \"request_body\": {\n \"$ref\": \"#/definitions/bulkSendRequest\"\n },\n \"security\": null,\n \"skill_name\": \"bulk_send_v2_send_post_bulk_send_request\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Creates a bulk send request.\",\n \"tags\": [\n \"BulkSend\"\n ]\n },\n \"bulk_send_v2_test_post_bulk_send_test_request\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"This method tests a bulk send list for compatibility with the envelope or template that you want to send. For example, a template that has three roles is not compatible with a bulk send list that has only two recipients. For this reason, you might want to test compatibility first.\\n\\nA successful test result returns `true` for the `canBeSent` property. An unsuccessful test returns a JSON response that contains information about the errors that occurred.\\n\\nIf the test is successful, you can then send the envelope or template by using the [BulkSend::createBulkSendRequest][BulkSendRequest] method.\\n\\n## Envelope Compatibility Checks\\n\\nThis section describes the envelope compatibility checks that the system performs.\\n\\n**Top-Level Issues**\\n\\n- Envelopes must be in a sendable state.\\n- The bulk send list must contain at least one copy (instance of an envelope), and no more than the maximum number of copies allowed for the account.\\n- The envelope must not be null and must be visible to the current user.\\n- The account cannot have more queued envelopes than the maximum number configured for the account.\\n- The bulk send list must exist.\\n\\n**Recipients**\\n\\n- The envelope must have recipients.\\n- If you are using an envelope, all of the recipients defined in the bulk send list must have corresponding recipient IDs in the envelope definition. If you are using a template, you must either match the recipient IDs or role IDs.\\n- The envelope cannot contain a bulk recipient (an artifact of the legacy version of Docusign's bulk send\\n functionality).\\n\\n**Recipient Tabs**\\n\\n- Every `recipient ID, tab label` pair in the bulk send list must correspond to a tab in the envelope.\\n\\n**Custom Fields**\\n\\n- Each envelope-level custom field in the bulk send list must correspond to the name of a `customField` in the\\n envelope definition. You do not have to match the recipient-level custom fields.\\n\\n[BulkSendRequest]: /docs/esign-rest-api/reference/bulkenvelopes/bulksend/createbulksendrequest/\\n\\n\\n\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"bulk_send_v2_test_post_bulk_send_test_request\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The GUID of the bulk send list. This property is created after you post a new bulk send list.\",\n \"in\": \"path\",\n \"name\": \"bulkSendListId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/bulk_send_lists/{bulkSendListId}/test\",\n \"request_body\": {\n \"$ref\": \"#/definitions/bulkSendRequest\"\n },\n \"security\": null,\n \"skill_name\": \"bulk_send_v2_test_post_bulk_send_test_request\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Creates a bulk send test.\",\n \"tags\": [\n \"BulkSend\"\n ]\n },\n \"captive_recipients_delete_captive_recipients_part\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"This method deletes the signature for one or more captive recipient records. It is primarily used for testing. This functionality provides a way to reset the signature associated with a client user ID so that a new signature can be created the next time the client user ID is used.\",\n \"destructive\": true,\n \"method\": \"DELETE\",\n \"operation_id\": \"captive_recipients_delete_captive_recipients_part\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Signature is the only supported value. \",\n \"in\": \"path\",\n \"name\": \"recipientPart\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/captive_recipients/{recipientPart}\",\n \"request_body\": {\n \"$ref\": \"#/definitions/captiveRecipientInformation\"\n },\n \"security\": null,\n \"skill_name\": \"captive_recipients_delete_captive_recipients_part\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Deletes the signature for one or more captive recipient records.\",\n \"tags\": [\n \"Accounts\"\n ]\n },\n \"chunked_uploads_delete_chunked_upload\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Deletes a chunked upload that has been committed but not yet consumed.\\n\\nThis method cannot be used to delete the following types of chunked uploads, which the system deletes automatically:\\n\\n\\n- Chunked uploads that have been consumed by use in another API call.\\n- Expired chunked uploads.\\n\\n**Note:** If you are aware of a chunked upload that can be discarded, the best practice is to explicitly delete it. If you wait for the system to automatically delete it after it expires, the chunked upload will continue to count against your quota.\",\n \"destructive\": true,\n \"method\": \"DELETE\",\n \"operation_id\": \"chunked_uploads_delete_chunked_upload\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The ID of the chunked upload. \",\n \"in\": \"path\",\n \"name\": \"chunkedUploadId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/chunked_uploads/{chunkedUploadId}\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"chunked_uploads_delete_chunked_upload\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Deletes a chunked upload.\",\n \"tags\": [\n \"ChunkedUploads\"\n ]\n },\n \"chunked_uploads_get_chunked_upload\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Returns the details (but not the content) about a chunked upload.\\n\\n**Note:** You cannot obtain details about a chunked upload that has expired, been deleted, or consumed by other actions.\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"chunked_uploads_get_chunked_upload\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The ID of the chunked upload. \",\n \"in\": \"path\",\n \"name\": \"chunkedUploadId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"(Optional) This parameter enables you to include additional attribute data in the response. The valid value for this method is `checksum`, which returns an SHA256 checksum of the content of the chunked upload in the response. You can use compare this checksum against your own checksum of the original content to verify that there are no missing parts before you attempt to commit the chunked upload.\",\n \"in\": \"query\",\n \"name\": \"include\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/chunked_uploads/{chunkedUploadId}\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"chunked_uploads_get_chunked_upload\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Retrieves metadata about a chunked upload.\",\n \"tags\": [\n \"ChunkedUploads\"\n ]\n },\n \"chunked_uploads_post_chunked_uploads\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"This method initiates a new chunked upload with the first part of the content.\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"chunked_uploads_post_chunked_uploads\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/chunked_uploads\",\n \"request_body\": {\n \"$ref\": \"#/definitions/chunkedUploadRequest\"\n },\n \"security\": null,\n \"skill_name\": \"chunked_uploads_post_chunked_uploads\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Initiate a new chunked upload.\",\n \"tags\": [\n \"ChunkedUploads\"\n ]\n },\n \"chunked_uploads_put_chunked_upload_part\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Adds a chunk or part to an existing chunked upload. After you use the Create method to initiate a new chunked upload and upload the first part, \\nuse this method to upload subsequent parts.\\n\\nFor simplicity, Docusign recommends that you upload the parts in their sequential order ( 1,2, 3, 4, etc.). The Create method adds the first part and assigns it the `sequence` value `0`. As a result, Docusign recommends that you start with a `sequence` value of `1` when you use this method, and continue uploading parts contiguously until you have uploaded the entirety of the original content to Docusign.\\n\\nExample:\\n\\n\\n```\\nPUT /v2.1/accounts/{accountId}/chunked_uploads/{chunkedUploadId}/1\\nPUT /v2.1/accounts/{accountId}/chunked_uploads/{chunkedUploadId}/2\\nPUT /v2.1/accounts/{accountId}/chunked_uploads/{chunkedUploadId}/3\\n```\\n\\n**Note:** You cannot replace a part that Docusign has already received, or add parts to a chunked upload that is already successfully committed.\",\n \"destructive\": true,\n \"method\": \"PUT\",\n \"operation_id\": \"chunked_uploads_put_chunked_upload_part\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The ID of the chunked upload. \",\n \"in\": \"path\",\n \"name\": \"chunkedUploadId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The sequence or order of the part in the chunked upload. By default, the sequence of the first part that is uploaded as part of the Create request is `0`.\\n\\n**Note:** You can add parts out of order. However, the chunked upload must consist of a contiguous series of one or more parts before you can successfully commit it.\",\n \"in\": \"path\",\n \"name\": \"chunkedUploadPartSeq\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/chunked_uploads/{chunkedUploadId}/{chunkedUploadPartSeq}\",\n \"request_body\": {\n \"$ref\": \"#/definitions/chunkedUploadRequest\"\n },\n \"security\": null,\n \"skill_name\": \"chunked_uploads_put_chunked_upload_part\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Add a chunk to an existing chunked upload.\",\n \"tags\": [\n \"ChunkedUploads\"\n ]\n },\n \"chunked_uploads_put_chunked_uploads\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"This method checks the integrity of a chunked upload and then commits it. When this request is successful, the chunked upload is then ready to be referenced in other API calls.\\n\\nIf the request is unsuccessful, ensure that you have uploaded all of the parts by using the Update method.\\n\\n**Note:** After you commit a chunked upload, it no longer accepts additional parts.\",\n \"destructive\": true,\n \"method\": \"PUT\",\n \"operation_id\": \"chunked_uploads_put_chunked_uploads\",\n \"parameters\": [\n {\n \"description\": \"(Required) The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"(Required) The ID of the chunked upload to commit.\",\n \"in\": \"path\",\n \"name\": \"chunkedUploadId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"(Required) You must use this query parameter with the value `commit`, which affirms the request to validate and prepare the chunked upload for use with other API calls.\",\n \"in\": \"query\",\n \"name\": \"action\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/chunked_uploads/{chunkedUploadId}\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"chunked_uploads_put_chunked_uploads\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Commit a chunked upload.\",\n \"tags\": [\n \"ChunkedUploads\"\n ]\n },\n \"cloud_storage_delete_cloud_storage\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Deletes the user authentication information for the specified cloud storage provider. The next time the user tries to access the cloud storage provider, they must pass normal authentication for this cloud storage provider.\",\n \"destructive\": true,\n \"method\": \"DELETE\",\n \"operation_id\": \"cloud_storage_delete_cloud_storage\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The ID of the service to access. \\n\\nValid values are the service name (\\\"Box\\\") or the numerical serviceId (\\\"4136\\\").\",\n \"in\": \"path\",\n \"name\": \"serviceId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The ID of the user to access.\\n\\n**Note:** Users can only access their own information. A user, even one with Admin rights, cannot access another user's settings.\",\n \"in\": \"path\",\n \"name\": \"userId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/users/{userId}/cloud_storage/{serviceId}\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"cloud_storage_delete_cloud_storage\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Deletes the user authentication information for the specified cloud storage provider.\",\n \"tags\": [\n \"CloudStorageProviders\"\n ]\n },\n \"cloud_storage_delete_cloud_storage_providers\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Deletes the user authentication information for one or more cloud storage providers. The next time the user tries to access the cloud storage provider, they must pass normal authentication.\",\n \"destructive\": true,\n \"method\": \"DELETE\",\n \"operation_id\": \"cloud_storage_delete_cloud_storage_providers\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The ID of the user to access.\\n\\n**Note:** Users can only access their own information. A user, even one with Admin rights, cannot access another user's settings.\",\n \"in\": \"path\",\n \"name\": \"userId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/users/{userId}/cloud_storage\",\n \"request_body\": {\n \"$ref\": \"#/definitions/cloudStorageProviders\"\n },\n \"security\": null,\n \"skill_name\": \"cloud_storage_delete_cloud_storage_providers\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Deletes the user authentication information for one or more cloud storage providers.\",\n \"tags\": [\n \"CloudStorageProviders\"\n ]\n },\n \"cloud_storage_folder_get_cloud_storage_folder\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Retrieves a list of the user's items from the specified cloud storage provider. \\n\\nTo limit the scope of the items returned, provide a comma-separated list of folder IDs in the request.\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"cloud_storage_folder_get_cloud_storage_folder\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The ID of the folder.\",\n \"in\": \"path\",\n \"name\": \"folderId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The ID of the service to access. \\n\\nValid values are the service name (\\\"Box\\\") or the numerical serviceId (\\\"4136\\\").\",\n \"in\": \"path\",\n \"name\": \"serviceId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The ID of the user to access.\\n\\n**Note:** Users can only access their own information. A user, even one with Admin rights, cannot access another user's settings.\",\n \"in\": \"path\",\n \"name\": \"userId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The file path to a cloud storage folder.\",\n \"in\": \"query\",\n \"name\": \"cloud_storage_folder_path\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"A plain-text folder ID that you can use as an alternative to the existing folder id. This property is mainly used for rooms. Enter multiple folder IDs as a comma-separated list.\",\n \"in\": \"query\",\n \"name\": \"cloud_storage_folderid_plain\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The maximum number of results to return.\\n\\nUse `start_position` to specify the number of results to skip.\\n\\nDefault: `25`\\n\",\n \"in\": \"query\",\n \"name\": \"count\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The order in which to sort the results.\\n\\nValid values are: \\n\\n\\n* `asc`: Ascending order.\\n* `desc`: Descending order. \",\n \"in\": \"query\",\n \"name\": \"order\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The file attribute to use to sort the results.\\n\\nValid values are: \\n\\n* `modified`\\n* `name`\",\n \"in\": \"query\",\n \"name\": \"order_by\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Use this parameter to search for specific text.\",\n \"in\": \"query\",\n \"name\": \"search_text\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"\",\n \"in\": \"query\",\n \"name\": \"sky_drive_skip_token\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The zero-based index of the\\nresult from which to start returning results.\\n\\nUse with `count` to limit the number\\nof results.\\n\\nThe default value is `0`.\\n\",\n \"in\": \"query\",\n \"name\": \"start_position\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/users/{userId}/cloud_storage/{serviceId}/folders/{folderId}\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"cloud_storage_folder_get_cloud_storage_folder\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Gets a list of items from a cloud storage provider.\",\n \"tags\": [\n \"CloudStorage\"\n ]\n },\n \"cloud_storage_folder_get_cloud_storage_folder_all\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Retrieves a list of all the items in a specified folder from the specified cloud storage provider. \",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"cloud_storage_folder_get_cloud_storage_folder_all\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The ID of the service to access. \\n\\nValid values are the service name (\\\"Box\\\") or the numerical serviceId (\\\"4136\\\").\",\n \"in\": \"path\",\n \"name\": \"serviceId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The ID of the user to access.\\n\\n**Note:** Users can only access their own information. A user, even one with Admin rights, cannot access another user's settings.\",\n \"in\": \"path\",\n \"name\": \"userId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"A comma separated list of folder IDs included in the request. \",\n \"in\": \"query\",\n \"name\": \"cloud_storage_folder_path\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The maximum number of results to return.\\n\\nUse `start_position` to specify the number of results to skip.\\n\\nDefault: `25`\\n\",\n \"in\": \"query\",\n \"name\": \"count\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The order in which to sort the results.\\n\\nValid values are: \\n\\n\\n* `asc`: Ascending order.\\n* `desc`: Descending order. \",\n \"in\": \"query\",\n \"name\": \"order\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The file attribute to use to sort the results.\\n\\nValid values are: \\n\\n* `modified`\\n* `name`\",\n \"in\": \"query\",\n \"name\": \"order_by\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Use this parameter to search for specific text.\",\n \"in\": \"query\",\n \"name\": \"search_text\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The zero-based index of the\\nresult from which to start returning results.\\n\\nUse with `count` to limit the number\\nof results.\\n\\nThe default value is `0`.\\n\",\n \"in\": \"query\",\n \"name\": \"start_position\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/users/{userId}/cloud_storage/{serviceId}/folders\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"cloud_storage_folder_get_cloud_storage_folder_all\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Retrieves a list of all the items in a specified folder from the specified cloud storage provider.\",\n \"tags\": [\n \"CloudStorage\"\n ]\n },\n \"cloud_storage_get_cloud_storage\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Retrieves the list of cloud storage providers enabled for the account and the configuration information for the user.\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"cloud_storage_get_cloud_storage\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The ID of the service to access. \\n\\nValid values are the service name (\\\"Box\\\") or the numerical serviceId (\\\"4136\\\").\",\n \"in\": \"path\",\n \"name\": \"serviceId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The ID of the user to access.\\n\\n**Note:** Users can only access their own information. A user, even one with Admin rights, cannot access another user's settings.\",\n \"in\": \"path\",\n \"name\": \"userId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \" The URL the user is redirected to after the cloud storage provider authenticates the user. Using this will append the redirectUrl to the authenticationUrl.\\n\\nThe redirectUrl is restricted to URLs in the docusign.com or docusign.net domains.\\n \",\n \"in\": \"query\",\n \"name\": \"redirectUrl\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/users/{userId}/cloud_storage/{serviceId}\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"cloud_storage_get_cloud_storage\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Gets the specified Cloud Storage Provider configuration for the User.\",\n \"tags\": [\n \"CloudStorageProviders\"\n ]\n },\n \"cloud_storage_get_cloud_storage_providers\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Retrieves the list of cloud storage providers enabled for the account and the configuration information for the user.\\n\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"cloud_storage_get_cloud_storage_providers\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The ID of the user to access.\\n\\n**Note:** Users can only access their own information. A user, even one with Admin rights, cannot access another user's settings.\",\n \"in\": \"path\",\n \"name\": \"userId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \" The URL the user is redirected to after the cloud storage provider authenticates the user. Using this will append the redirectUrl to the authenticationUrl.\\n\\nThe redirectUrl is restricted to URLs in the docusign.com or docusign.net domains.\\n \",\n \"in\": \"query\",\n \"name\": \"redirectUrl\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/users/{userId}/cloud_storage\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"cloud_storage_get_cloud_storage_providers\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Get the Cloud Storage Provider configuration for the specified user.\",\n \"tags\": [\n \"CloudStorageProviders\"\n ]\n },\n \"cloud_storage_post_cloud_storage\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Configures the redirect URL information for one or more cloud storage providers for the specified user. The redirect URL is added to the authentication URL to complete the return route.\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"cloud_storage_post_cloud_storage\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The ID of the user to access.\\n\\n**Note:** Users can only access their own information. A user, even one with Admin rights, cannot access another user's settings.\",\n \"in\": \"path\",\n \"name\": \"userId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/users/{userId}/cloud_storage\",\n \"request_body\": {\n \"$ref\": \"#/definitions/cloudStorageProviders\"\n },\n \"security\": null,\n \"skill_name\": \"cloud_storage_post_cloud_storage\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Configures the redirect URL information for one or more cloud storage providers for the specified user.\",\n \"tags\": [\n \"CloudStorageProviders\"\n ]\n },\n \"comments_get_comments_transcript\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Retrieves a PDF file containing all of the comments that senders and recipients have added to the documents in an envelope.\\n\\nThe response body of this method is the PDF file as a byte\\nstream.\\n\\n\\n**Note:** Comments are disabled by default. To use the comments feature, an account administrator must enable comments on the account (in the `accountSettingsInformation` object, set the `enableSigningExtensionComments` property to **true**). \",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"comments_get_comments_transcript\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The envelope's GUID. \\n\\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\\n\",\n \"in\": \"path\",\n \"name\": \"envelopeId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"(Optional) The encoding to use for the file.\",\n \"in\": \"query\",\n \"name\": \"encoding\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/envelopes/{envelopeId}/comments/transcript\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"comments_get_comments_transcript\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Gets a PDF transcript of all of the comments in an envelope.\",\n \"tags\": [\n \"Comments\"\n ]\n },\n \"connect_delete_connect_config\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Deletes the specified Docusign Connect configuration.\\n\\n<ds-inlinemessage>\\nTo use this method, you must be an account administrator\\nand Connect must be enabled on your account.\\n</ds-inlinemessage>\\n\\n\\n\",\n \"destructive\": true,\n \"method\": \"DELETE\",\n \"operation_id\": \"connect_delete_connect_config\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The ID of the custom Connect configuration being accessed.\",\n \"in\": \"path\",\n \"name\": \"connectId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/connect/{connectId}\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"connect_delete_connect_config\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Deletes the specified Connect configuration.\",\n \"tags\": [\n \"ConnectConfigurations\"\n ]\n },\n \"connect_failures_delete_connect_failure_log\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Deletes a Connect failure log entry.\\n\\nTo delete all the Connect failure log entries,\\nspecify `all` for the `failureId` path parameter.\\n\\n<ds-inlinemessage>\\nTo use this method, you must be an account administrator\\nand Connect must be enabled on your account.\\n</ds-inlinemessage>\",\n \"destructive\": true,\n \"method\": \"DELETE\",\n \"operation_id\": \"connect_failures_delete_connect_failure_log\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The ID of the Connect post failure. Use `all` to delete all failures for the account.\",\n \"in\": \"path\",\n \"name\": \"failureId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/connect/failures/{failureId}\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"connect_failures_delete_connect_failure_log\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Deletes a Connect failure log entry.\",\n \"tags\": [\n \"ConnectEvents\"\n ]\n },\n \"connect_failures_get_connect_logs\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Retrieves the Connect failure log information.\\n\\n<ds-inlinemessage>\\nTo use this method, you must be an account administrator\\nand Connect must be enabled on your account.\\n</ds-inlinemessage>\\n\\nUse this method to determine which envelopes failed to post.\\nYou can then use\\n[ConnectEvents: retryForEnvelopes][retry]\\nto create a republish request.\\n\\n[retry]: /docs/esign-rest-api/reference/connect/connectevents/retryforenvelopes/\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"connect_failures_get_connect_logs\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The start date for a date range in UTC DateTime format.\\n\\n**Note:** If this property is null, no date filtering is applied.\",\n \"in\": \"query\",\n \"name\": \"from_date\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The end of a search date range in UTC DateTime format. When you use this parameter, only templates created up to this date and time are returned.\\n\\n**Note:** If this property is null, the value defaults to the current date.\",\n \"in\": \"query\",\n \"name\": \"to_date\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/connect/failures\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"connect_failures_get_connect_logs\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Gets the Connect failure log information.\",\n \"tags\": [\n \"ConnectEvents\"\n ]\n },\n \"connect_get_connect_all_users\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Returns all users from the configured Connect service.\\n\\n<ds-inlinemessage>\\nTo use this method, you must be an account administrator\\nand Connect must be enabled on your account.\\n</ds-inlinemessage>\\n\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"connect_get_connect_all_users\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The ID of the custom Connect configuration being accessed.\",\n \"in\": \"path\",\n \"name\": \"connectId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The maximum number of results to return.\",\n \"in\": \"query\",\n \"name\": \"count\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"\",\n \"in\": \"query\",\n \"name\": \"domain_users_only\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Filters returned user records by full email address or a substring of email address.\",\n \"in\": \"query\",\n \"name\": \"email_substring\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The position within the total result set from which to start returning values. The value **thumbnail** may be used to return the page image.\",\n \"in\": \"query\",\n \"name\": \"start_position\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The status of the item.\",\n \"in\": \"query\",\n \"name\": \"status\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Filters results based on a full or partial user name.\\n\\n**Note:** When you enter a partial user name, you do not use a wildcard character.\",\n \"in\": \"query\",\n \"name\": \"user_name_substring\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/connect/{connectId}/all/users\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"connect_get_connect_all_users\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Returns all users from the configured Connect service.\",\n \"tags\": [\n \"ConnectConfigurations\"\n ]\n },\n \"connect_get_connect_config\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Retrieves the information for the specified Docusign Connect configuration.\\n\\n<ds-inlinemessage>\\nTo use this method, you must be an account administrator\\nand Connect must be enabled on your account.\\n</ds-inlinemessage>\\n\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"connect_get_connect_config\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The ID of the custom Connect configuration being accessed.\",\n \"in\": \"path\",\n \"name\": \"connectId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/connect/{connectId}\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"connect_get_connect_config\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Gets the details about a Connect configuration.\",\n \"tags\": [\n \"ConnectConfigurations\"\n ]\n },\n \"connect_get_connect_configs\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Retrieves all the Docusign Custom Connect definitions for the specified account.\\n\\n<ds-inlinemessage>\\nTo use this method, you must be an account administrator\\nand Connect must be enabled on your account.\\n</ds-inlinemessage>\\n\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"connect_get_connect_configs\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/connect\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"connect_get_connect_configs\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Get Connect configuration information.\",\n \"tags\": [\n \"ConnectConfigurations\"\n ]\n },\n \"connect_get_connect_users\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Returns users from the configured Connect service.\\n\\n<ds-inlinemessage>\\nTo use this method, you must be an account administrator\\nand Connect must be enabled on your account.\\n</ds-inlinemessage>\\n\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"connect_get_connect_users\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The ID of the custom Connect configuration being accessed.\",\n \"in\": \"path\",\n \"name\": \"connectId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The maximum number of results to return.\\n\\nUse `start_position` to specify the number of results to skip.\\n\\n\",\n \"in\": \"query\",\n \"name\": \"count\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Filters returned user records by full email address or a substring of email address.\",\n \"in\": \"query\",\n \"name\": \"email_substring\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"\",\n \"in\": \"query\",\n \"name\": \"list_included_users\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The zero-based index of the\\nresult from which to start returning results.\\n\\nUse with `count` to limit the number\\nof results.\\n\\nThe default value is `0`.\\n\",\n \"in\": \"query\",\n \"name\": \"start_position\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Filters the results by user status.\\nYou can specify a comma-separated\\nlist of the following statuses:\\n\\n* ActivationRequired \\n* ActivationSent \\n* Active\\n* Closed \\n* Disabled\\n\",\n \"in\": \"query\",\n \"name\": \"status\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Filters results based on a full or partial user name.\\n\\n**Note:** When you enter a partial user name, you do not use a wildcard character.\",\n \"in\": \"query\",\n \"name\": \"user_name_substring\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/connect/{connectId}/users\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"connect_get_connect_users\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Returns users from the configured Connect service.\",\n \"tags\": [\n \"ConnectConfigurations\"\n ]\n },\n \"connect_hmac_create_connect_secret\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Generates a new connect HMAC Secret.\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"connect_hmac_create_connect_secret\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/connect/secret\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"connect_hmac_create_connect_secret\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Generates a new connect HMAC Secret.\",\n \"tags\": [\n \"ConnectConfigurations\"\n ]\n },\n \"connect_hmac_delete_connect_secret\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Deletes the connect HMAC Secret for specified account.\",\n \"destructive\": true,\n \"method\": \"DELETE\",\n \"operation_id\": \"connect_hmac_delete_connect_secret\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"\",\n \"in\": \"path\",\n \"name\": \"keyId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/connect/secret/{keyId}\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"connect_hmac_delete_connect_secret\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Deletes the connect HMAC Secret for specified account.\",\n \"tags\": [\n \"ConnectConfigurations\"\n ]\n },\n \"connect_hmac_get_connect_secret\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"ConnectHMAC_GetConnectSecret\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"connect_hmac_get_connect_secret\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/connect/secret\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"connect_hmac_get_connect_secret\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"ConnectHMAC_GetConnectSecret\",\n \"tags\": [\n \"ConnectConfigurations\"\n ]\n },\n \"connect_log_delete_connect_log\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Deletes a specified entry from the Connect Log.\\n\\n<ds-inlinemessage>\\nTo use this method, you must be an account administrator\\nand Connect must be enabled on your account.\\n</ds-inlinemessage>\",\n \"destructive\": true,\n \"method\": \"DELETE\",\n \"operation_id\": \"connect_log_delete_connect_log\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The ID of the Connect log entry. Use `all` to delete all entries for the account.\",\n \"in\": \"path\",\n \"name\": \"logId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/connect/logs/{logId}\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"connect_log_delete_connect_log\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Deletes a specified Connect log entry.\",\n \"tags\": [\n \"ConnectEvents\"\n ]\n },\n \"connect_log_delete_connect_logs\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Deletes a list of Connect log entries for your account.\\n\\n<ds-inlinemessage>\\nTo use this method, you must be an account administrator\\nand Connect must be enabled on your account.\\n</ds-inlinemessage>\",\n \"destructive\": true,\n \"method\": \"DELETE\",\n \"operation_id\": \"connect_log_delete_connect_logs\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/connect/logs\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"connect_log_delete_connect_logs\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Deletes a list of Connect log entries.\",\n \"tags\": [\n \"ConnectEvents\"\n ]\n },\n \"connect_log_get_connect_log\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Retrieves the specified Connect log entry for your account.\\n\\n<ds-inlinemessage>\\nTo use this method, you must be an account administrator\\nand Connect must be enabled on your account.\\n</ds-inlinemessage>\\n\\nThe `enableLog` setting in the Connect configuration must be set to **true** to enable logging.\\nIf logging is not enabled, then no log entries are recorded.\\n\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"connect_log_get_connect_log\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The ID of the Connect log entry.\",\n \"in\": \"path\",\n \"name\": \"logId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"When **true,** the response includes the `connectDebugLog` information.\",\n \"in\": \"query\",\n \"name\": \"additional_info\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/connect/logs/{logId}\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"connect_log_get_connect_log\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Gets a Connect log entry.\",\n \"tags\": [\n \"ConnectEvents\"\n ]\n },\n \"connect_log_get_connect_logs\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Retrieves a list of the 100 most recent Connect log entries for your account.\\n\\n<ds-inlinemessage>\\nTo use this method, you must be an account administrator\\nand Connect must be enabled on your account.\\n</ds-inlinemessage>\\n\\nThe `enableLog` setting in the Connect configuration must be set to **true** to enable logging. Log entries are deleted after 15 days.\\n\\n\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"connect_log_get_connect_logs\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The start date for a date range in UTC DateTime format.\\n\\n**Note:** If this property is null, no date filtering is applied.\",\n \"in\": \"query\",\n \"name\": \"from_date\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The end of a search date range in UTC DateTime format. When you use this parameter, only templates created up to this date and time are returned.\\n\\n**Note:** If this property is null, the value defaults to the current date.\",\n \"in\": \"query\",\n \"name\": \"to_date\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/connect/logs\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"connect_log_get_connect_logs\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Gets the Connect log.\",\n \"tags\": [\n \"ConnectEvents\"\n ]\n },\n \"connect_o_auth_config_delete_connect_o_auth_config\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Deletes the Connect OAuth configuration for the specified account.\\n\\n<ds-inlinemessage>\\nTo use this method, you must be an account administrator\\nand Connect must be enabled on your account.\\n</ds-inlinemessage>\\n\\n## Related topics:\\n- [OAuth for Docusign Connect](/platform/webhooks/connect/validation-and-security/oauth-connect/)\\n\",\n \"destructive\": true,\n \"method\": \"DELETE\",\n \"operation_id\": \"connect_o_auth_config_delete_connect_o_auth_config\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/connect/oauth\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"connect_o_auth_config_delete_connect_o_auth_config\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Delete the Connect OAuth configuration.\",\n \"tags\": [\n \"ConnectConfigurations\"\n ]\n },\n \"connect_o_auth_config_get_connect_o_auth_config\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Gets the Connect OAuth configuration for the specified account.\\n\\n<ds-inlinemessage>\\nTo use this method, you must be an account administrator\\nand Connect must be enabled on your account.\\n</ds-inlinemessage>\\n\\n## Related topics:\\n- [OAuth for Docusign Connect](/platform/webhooks/connect/validation-and-security/oauth-connect/)\\n\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"connect_o_auth_config_get_connect_o_auth_config\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/connect/oauth\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"connect_o_auth_config_get_connect_o_auth_config\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Retrieves the Connect OAuth information for the account.\",\n \"tags\": [\n \"ConnectConfigurations\"\n ]\n },\n \"connect_o_auth_config_post_connect_o_auth_config\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Sets up Connect OAuth for the specified account using an authorization server of your choice. To use this endpoint, get the client ID and client secret from your authorization server.\\n\\nWhen you call this endpoint, Docusign requests an access token from your authorization server. Docusign will use that token in the Authorization HTTP header of your account's Connect messages. Finally, your listener will be responsible for validating the token by calling the authorization server.\\n\\n<ds-inlinemessage>\\nTo use this method, you must be an account administrator\\nand Connect must be enabled on your account.\\n</ds-inlinemessage>\\n\\n\\n## Related topics:\\n- [OAuth for Docusign Connect](/platform/webhooks/connect/validation-and-security/oauth-connect/)\\n\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"connect_o_auth_config_post_connect_o_auth_config\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/connect/oauth\",\n \"request_body\": {\n \"$ref\": \"#/definitions/connectOAuthConfig\"\n },\n \"security\": null,\n \"skill_name\": \"connect_o_auth_config_post_connect_o_auth_config\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Set up Connect OAuth for the specified account.\",\n \"tags\": [\n \"ConnectConfigurations\"\n ]\n },\n \"connect_o_auth_config_put_connect_o_auth_config\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Updates the existing Connect OAuth configuration for the account.\\n\",\n \"destructive\": true,\n \"method\": \"PUT\",\n \"operation_id\": \"connect_o_auth_config_put_connect_o_auth_config\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/connect/oauth\",\n \"request_body\": {\n \"$ref\": \"#/definitions/connectOAuthConfig\"\n },\n \"security\": null,\n \"skill_name\": \"connect_o_auth_config_put_connect_o_auth_config\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Updates the existing Connect OAuth configuration for the account.\\n\",\n \"tags\": [\n \"ConnectConfigurations\"\n ]\n },\n \"connect_post_connect_configuration\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Creates a custom Connect configuration for the specified account.\\n\\n<ds-inlinemessage>\\nTo use this method, you must be an account administrator\\nand Connect must be enabled on your account.\\n</ds-inlinemessage>\\n\\n\\nConnect is a webhook service that provides updates when certain events occur in your eSignature workflows. You can use this endpoint to create:\\n* Account-level Connect configurations to listen for events related to any envelopes sent by one or more account users\\n* Recipient Connect configurations that are triggered when one or more of your account users receive an envelope\\n\\nTo set an account-level configuration, set `configurationType` to **custom.**\\nTo set a Recipient Connect configuration, set `configurationType` to **customrecipient.**\\n\\nIf you want to listen for events on only one envelope, use the [eventNotification](/docs/esign-rest-api/reference/envelopes/envelopes/create/#schema__envelopedefinition_eventnotification) object instead.\\n\\n## Data models\\n\\nThere are four possible data models for your Connect configuration. Consider:\\n* Do you want the data in JSON or XML?\\n* Do you want events sent individually (SIM) or in aggregate?\\n\\nDocusign recommends using the [JSON SIM event model](/platform/webhooks/connect/json-sim-event-model/).\\n\\n<ds-column>\\n\\n<ds-step open=\\\"false\\\" hideIcon=\\\"true\\\">\\n<h3>JSON SIM (Recommended)</h3>\\n<div>\\n\\nSet `deliveryMode` to **SIM** and `eventData.version` to **restv2.1.** Use the `events` property to set the event statuses that will trigger your configuration.\\n\\nThe following sample request shows how to create an envelope-level configuration using JSON SIM:\\n```\\n{\\n \\\"configurationType\\\": \\\"custom\\\",\\n \\\"urlToPublishTo\\\": \\\"YOUR-WEBHOOK-URL\\\",\\n \\\"allUsers\\\": \\\"true\\\",\\n \\\"name\\\": \\\"jsonSimTest\\\",\\n \\\"deliveryMode\\\": \\\"SIM\\\",\\n \\\"allowEnvelopePublish\\\": \\\"true\\\",\\n \\\"enableLog\\\": \\\"true\\\",\\n \\\"eventData\\\": {\\n \\\"version\\\": \\\"restv2.1\\\"\\n },\\n \\\"events\\\": [\\n \\\"envelope-sent\\\",\\n \\\"envelope-delivered\\\",\\n \\\"envelope-completed\\\"\\n ]\\n}\\n```\\n\\nThe following sample request shows how to create a Recipient Connect configuration using JSON SIM:\\n```\\n{\\n \\\"configurationType\\\": \\\"customrecipient\\\",\\n \\\"urlToPublishTo\\\": \\\"YOUR-WEBHOOK-URL\\\",\\n \\\"allUsers\\\": \\\"true\\\",\\n \\\"name\\\": \\\"jsonSimTest\\\",\\n \\\"deliveryMode\\\": \\\"SIM\\\",\\n \\\"allowEnvelopePublish\\\": \\\"true\\\",\\n \\\"enableLog\\\": \\\"true\\\",\\n \\\"eventData\\\": {\\n \\\"version\\\": \\\"restv2.1\\\"\\n },\\n \\\"events\\\": [\\n \\\"recipient-sent\\\",\\n \\\"recipient-completed\\\"\\n ]\\n}\\n```\\n\\n</div></ds-step>\\n\\n<ds-step open=\\\"false\\\" hideIcon=\\\"true\\\">\\n<h3>JSON Aggregate</h3>\\n<div>\\n\\nSet `deliveryMode` to **aggregate** and `eventData.version` to **restv2.1.** Use the `envelopeEvents` or `recipientEvents` property to set the event statuses that will trigger your configuration.\\n\\n</div></ds-step>\\n\\n<ds-step open=\\\"false\\\" hideIcon=\\\"true\\\">\\n<h3>XML Aggregate</h3>\\n<div>\\n\\nSet `deliveryMode` to **aggregate.** Use the `envelopeEvents` or `recipientEvents` property to set the event statuses that will trigger your configuration.\\n\\n</div></ds-step>\\n\\n<ds-step open=\\\"false\\\" hideIcon=\\\"true\\\">\\n<h3>XML SIM (Legacy apps only)</h3>\\n<div>\\n\\n**Note:** This model [is deprecated](https://www.docusign.com/blog/developers/docusign-connect-xml-sim-messaging-format-deprecated).\\n\\nSet `deliveryMode` to **SIM.** Use the `envelopeEvents` or `recipientEvents` property to set the event statuses that will trigger your configuration.\\n\\n</div></ds-step>\\n</ds-column>\\n\\n## Troubleshooting\\n\\nIf your configuration is not working, check the following.\\n\\n* Connect must be enabled for your account to use this function.\\n* If you are using `envelopeEvents` or `recipientEvents`, make sure that the event values are sentence case, not lowercase.\\n* Make sure you have either set `allUsers` to **true** or set `userIds` to a non-empty array of IDs.\\n* By default, this endpoint creates a disabled configuration. To enable the configuration immediately, set the body parameter `allowEnvelopePublish` to **true.** You can also enable the configuration in the UI.\\n* To check if events are being emitted, set `enableLog` to **true** to view event logs in the Connect console.\\n\\n## Related topics\\n\\n* For more information about Connect, see the [Docusign Connect guide](/platform/webhooks/connect/).\\n* Use the MyAPICalls sample app to see an [example of this endpoint](https://myapicalls.sampleapps.docusign.com/scenario/6) using the JSON SIM model.\\n\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"connect_post_connect_configuration\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/connect\",\n \"request_body\": {\n \"$ref\": \"#/definitions/connectCustomConfiguration\"\n },\n \"security\": null,\n \"skill_name\": \"connect_post_connect_configuration\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Creates a Connect configuration.\",\n \"tags\": [\n \"ConnectConfigurations\"\n ]\n },\n \"connect_publish_put_connect_retry\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Republishes Connect information for the specified set of envelopes.\\n\\n<ds-inlinemessage>\\nTo use this method, you must be an account administrator\\nand Connect must be enabled on your account.\\n</ds-inlinemessage>\\n\\n\\nThe primary use is to republish Connect post failures by including envelope IDs for the envelopes that failed to post in the request. The list of envelope IDs that failed to post correctly can be retrieved by calling to [Connect::listEventLogs](/docs/esign-rest-api/reference/connect/connectevents/list/) retrieve the failure log.\\n\\n\",\n \"destructive\": true,\n \"method\": \"PUT\",\n \"operation_id\": \"connect_publish_put_connect_retry\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/connect/envelopes/retry_queue\",\n \"request_body\": {\n \"$ref\": \"#/definitions/connectFailureFilter\"\n },\n \"security\": null,\n \"skill_name\": \"connect_publish_put_connect_retry\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Republishes Connect information for multiple envelopes.\",\n \"tags\": [\n \"ConnectEvents\"\n ]\n },\n \"connect_publish_put_connect_retry_by_envelope\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Republishes Connect information for the specified envelope.\\n\\n<ds-inlinemessage>\\nTo use this method, you must be an account administrator\\nand Connect must be enabled on your account.\\n</ds-inlinemessage>\\n\",\n \"destructive\": true,\n \"method\": \"PUT\",\n \"operation_id\": \"connect_publish_put_connect_retry_by_envelope\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The envelope's GUID. \\n\\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\\n\",\n \"in\": \"path\",\n \"name\": \"envelopeId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/connect/envelopes/{envelopeId}/retry_queue\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"connect_publish_put_connect_retry_by_envelope\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Republishes Connect information for the specified envelope.\",\n \"tags\": [\n \"ConnectEvents\"\n ]\n },\n \"connect_put_connect_configuration\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Updates the specified Docusign Connect configuration in your account. To enable the configuration, set the `allowEnvelopePublish` property to **true.**\\n\\nAfter any updates, test your configuration to make sure it works as expected.\\n\\n<ds-inlinemessage>\\nTo use this method, you must be an account administrator\\nand Connect must be enabled on your account.\\n</ds-inlinemessage>\\n\",\n \"destructive\": true,\n \"method\": \"PUT\",\n \"operation_id\": \"connect_put_connect_configuration\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/connect\",\n \"request_body\": {\n \"$ref\": \"#/definitions/connectCustomConfiguration\"\n },\n \"security\": null,\n \"skill_name\": \"connect_put_connect_configuration\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Updates a specified Connect configuration.\",\n \"tags\": [\n \"ConnectConfigurations\"\n ]\n },\n \"consumer_disclosure_get_consumer_disclosure\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Retrieves the default, HTML-formatted Electronic Record and Signature Disclosure (ERSD) associated with the account. \\n\\nThis is the default ERSD disclosure that Docusign provides for the convenience of U.S.-based customers only. This default disclosure is only valid for transactions between U.S.-based parties.\\n\\nTo set the language of the disclosure that you want to retrieve, use the optional `langCode` query parameter.\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"consumer_disclosure_get_consumer_disclosure\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The code for the signer language version of the disclosure that you want to retrieve. The following languages are supported:\\n\\n- Arabic (`ar`)\\n- Bulgarian (`bg`)\\n- Czech (`cs`)\\n- Chinese Simplified (`zh_CN`)\\n- Chinese Traditional (`zh_TW`)\\n- Croatian (`hr`)\\n- Danish (`da`)\\n- Dutch (`nl`)\\n- English US (`en`)\\n- English UK (`en_GB`)\\n- Estonian (`et`)\\n- Farsi (`fa`)\\n- Finnish (`fi`)\\n- French (`fr`)\\n- French Canadian (`fr_CA`)\\n- German (`de`)\\n- Greek (`el`)\\n- Hebrew (`he`)\\n- Hindi (`hi`)\\n- Hungarian (`hu`)\\n- Bahasa Indonesian (`id`)\\n- Italian (`it`)\\n- Japanese (`ja`)\\n- Korean (`ko`)\\n- Latvian (`lv`)\\n- Lithuanian (`lt`)\\n- Bahasa Melayu (`ms`)\\n- Norwegian (`no`)\\n- Polish (`pl`)\\n- Portuguese (`pt`)\\n- Portuguese Brazil (`pt_BR`)\\n- Romanian (`ro`)\\n- Russian (`ru`)\\n- Serbian (`sr`)\\n- Slovak (`sk`)\\n- Slovenian (`sl`)\\n- Spanish (`es`)\\n- Spanish Latin America (`es_MX`)\\n- Swedish (`sv`)\\n- Thai (`th`)\\n- Turkish (`tr`)\\n- Ukrainian (`uk`)\\n- Vietnamese (`vi`)\\n\\nAdditionally, you can automatically detect the browser language being used by the viewer and display the disclosure in that language by setting the value to `browser`.\",\n \"in\": \"query\",\n \"name\": \"langCode\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/consumer_disclosure\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"consumer_disclosure_get_consumer_disclosure\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Gets the default Electronic Record and Signature Disclosure for an account.\",\n \"tags\": [\n \"AccountConsumerDisclosures\"\n ]\n },\n \"consumer_disclosure_get_consumer_disclosure_envelope_id_recipient_id\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Retrieves the default, HTML-formatted Electronic Record and Signature Disclosure (ERSD) for the envelope that you specify. \\n\\nThis is the default ERSD disclosure that Docusign provides for the convenience of U.S.-based customers only. This default disclosure is only valid for transactions between U.S.-based parties.\\n\\nTo set the language of the disclosure that you want to retrieve, use the optional `langCode` query parameter.\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"consumer_disclosure_get_consumer_disclosure_envelope_id_recipient_id\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The envelope's GUID. \\n\\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\\n\",\n \"in\": \"path\",\n \"name\": \"envelopeId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"A local reference used to map\\nrecipients to other objects, such as specific\\ndocument tabs.\\n\\nA `recipientId` must be\\neither an integer or a GUID,\\nand the `recipientId` must be\\nunique within an envelope.\\n\\nFor example, many envelopes assign the first recipient\\na `recipientId` of `1`.\\n\",\n \"in\": \"path\",\n \"name\": \"recipientId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"(Optional) The code for the signer language version of the disclosure that you want to retrieve. The following languages are supported:\\n\\n- Arabic (`ar`)\\n- Bulgarian (`bg`)\\n- Czech (`cs`)\\n- Chinese Simplified (`zh_CN`)\\n- Chinese Traditional (`zh_TW`)\\n- Croatian (`hr`)\\n- Danish (`da`)\\n- Dutch (`nl`)\\n- English US (`en`)\\n- English UK (`en_GB`)\\n- Estonian (`et`)\\n- Farsi (`fa`)\\n- Finnish (`fi`)\\n- French (`fr`)\\n- French Canadian (`fr_CA`)\\n- German (`de`)\\n- Greek (`el`)\\n- Hebrew (`he`)\\n- Hindi (`hi`)\\n- Hungarian (`hu`)\\n- Bahasa Indonesian (`id`)\\n- Italian (`it`)\\n- Japanese (`ja`)\\n- Korean (`ko`)\\n- Latvian (`lv`)\\n- Lithuanian (`lt`)\\n- Bahasa Melayu (`ms`)\\n- Norwegian (`no`)\\n- Polish (`pl`)\\n- Portuguese (`pt`)\\n- Portuguese Brazil (`pt_BR`)\\n- Romanian (`ro`)\\n- Russian (`ru`)\\n- Serbian (`sr`)\\n- Slovak (`sk`)\\n- Slovenian (`sl`)\\n- Spanish (`es`)\\n- Spanish Latin America (`es_MX`)\\n- Swedish (`sv`)\\n- Thai (`th`)\\n- Turkish (`tr`)\\n- Ukrainian (`uk`) \\n- Vietnamese (`vi`)\\n\\nAdditionally, you can automatically detect the browser language being used by the viewer and display the disclosure in that language by setting the value to `browser`.\",\n \"in\": \"query\",\n \"name\": \"langCode\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/consumer_disclosure\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"consumer_disclosure_get_consumer_disclosure_envelope_id_recipient_id\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Gets the default Electronic Record and Signature Disclosure for an envelope.\",\n \"tags\": [\n \"EnvelopeConsumerDisclosures\"\n ]\n },\n \"consumer_disclosure_get_consumer_disclosure_envelope_id_recipient_id_lang_code\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Retrieves the HTML-formatted Electronic Record and Signature Disclosure (ERSD) for the envelope recipient that you specify. This disclosure might differ from the account-level disclosure, based on the signing brand applied to the envelope and the recipient's language settings.\\n\\nTo set the language of the disclosure that you want to retrieve, specify the `langCode` as either a path or query parameter.\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"consumer_disclosure_get_consumer_disclosure_envelope_id_recipient_id_lang_code\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The envelope's GUID. \\n\\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\\n\",\n \"in\": \"path\",\n \"name\": \"envelopeId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"(Optional) The code for the signer language version of the disclosure that you want to retrieve, as a path parameter. The following languages are supported:\\n\\n- Arabic (`ar`)\\n- Bulgarian (`bg`)\\n- Czech (`cs`)\\n- Chinese Simplified (`zh_CN`)\\n- Chinese Traditional (`zh_TW`)\\n- Croatian (`hr`)\\n- Danish (`da`)\\n- Dutch (`nl`)\\n- English US (`en`)\\n- English UK (`en_GB`)\\n- Estonian (`et`)\\n- Farsi (`fa`)\\n- Finnish (`fi`)\\n- French (`fr`)\\n- French Canadian (`fr_CA`)\\n- German (`de`)\\n- Greek (`el`)\\n- Hebrew (`he`)\\n- Hindi (`hi`)\\n- Hungarian (`hu`)\\n- Bahasa Indonesian (`id`)\\n- Italian (`it`)\\n- Japanese (`ja`)\\n- Korean (`ko`)\\n- Latvian (`lv`)\\n- Lithuanian (`lt`)\\n- Bahasa Melayu (`ms`)\\n- Norwegian (`no`)\\n- Polish (`pl`)\\n- Portuguese (`pt`)\\n- Portuguese Brazil (`pt_BR`)\\n- Romanian (`ro`)\\n- Russian (`ru`)\\n- Serbian (`sr`)\\n- Slovak (`sk`)\\n- Slovenian (`sl`)\\n- Spanish (`es`)\\n- Spanish Latin America (`es_MX`)\\n- Swedish (`sv`)\\n- Thai (`th`)\\n- Turkish (`tr`)\\n- Ukrainian (`uk`) \\n- Vietnamese (`vi`)\\n\\nAdditionally, you can automatically detect the browser language being used by the viewer and display the disclosure in that language by setting the value to `browser`.\",\n \"in\": \"path\",\n \"name\": \"langCode\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"A local reference used to map\\nrecipients to other objects, such as specific\\ndocument tabs.\\n\\nA `recipientId` must be\\neither an integer or a GUID,\\nand the `recipientId` must be\\nunique within an envelope.\\n\\nFor example, many envelopes assign the first recipient\\na `recipientId` of `1`.\\n\",\n \"in\": \"path\",\n \"name\": \"recipientId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"(Optional) The code for the signer language version of the disclosure that you want to retrieve, as a query parameter. The following languages are supported:\\n\\n- Arabic (`ar`)\\n- Bulgarian (`bg`)\\n- Czech (`cs`)\\n- Chinese Simplified (`zh_CN`)\\n- Chinese Traditional (`zh_TW`)\\n- Croatian (`hr`)\\n- Danish (`da`)\\n- Dutch (`nl`)\\n- English US (`en`)\\n- English UK (`en_GB`)\\n- Estonian (`et`)\\n- Farsi (`fa`)\\n- Finnish (`fi`)\\n- French (`fr`)\\n- French Canadian (`fr_CA`)\\n- German (`de`)\\n- Greek (`el`)\\n- Hebrew (`he`)\\n- Hindi (`hi`)\\n- Hungarian (`hu`)\\n- Bahasa Indonesian (`id`)\\n- Italian (`it`)\\n- Japanese (`ja`)\\n- Korean (`ko`)\\n- Latvian (`lv`)\\n- Lithuanian (`lt`)\\n- Bahasa Melayu (`ms`)\\n- Norwegian (`no`)\\n- Polish (`pl`)\\n- Portuguese (`pt`)\\n- Portuguese Brazil (`pt_BR`)\\n- Romanian (`ro`)\\n- Russian (`ru`)\\n- Serbian (`sr`)\\n- Slovak (`sk`)\\n- Slovenian (`sl`)\\n- Spanish (`es`)\\n- Spanish Latin America (`es_MX`)\\n- Swedish (`sv`)\\n- Thai (`th`)\\n- Turkish (`tr`)\\n- Ukrainian (`uk`) \\n- Vietnamese (`vi`)\\n\\nAdditionally, you can automatically detect the browser language being used by the viewer and display the disclosure in that language by setting the value to `browser`.\",\n \"in\": \"query\",\n \"name\": \"langCode\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/consumer_disclosure/{langCode}\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"consumer_disclosure_get_consumer_disclosure_envelope_id_recipient_id_lang_code\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Gets the Electronic Record and Signature Disclosure for a specific envelope recipient.\",\n \"tags\": [\n \"EnvelopeConsumerDisclosures\"\n ]\n },\n \"consumer_disclosure_get_consumer_disclosure_lang_code\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Retrieves the HTML-formatted Electronic Record and Signature Disclosure (ERSD) associated with the account. \\n\\nTo set the language of the disclosure that you want to retrieve, use the optional `langCode` query parameter.\\n\\n**Note:** The text of the default disclosure is always in English, but if you are using a custom disclosure and have created versions of it in different signer languages, you can use the `langCode` parameter to specify the signer language version that you want to retrieve. \",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"consumer_disclosure_get_consumer_disclosure_lang_code\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The code for the signer language version of the disclosure that you want to retrieve. The following languages are supported:\\n\\n- Arabic (`ar`)\\n- Bulgarian (`bg`)\\n- Czech (`cs`)\\n- Chinese Simplified (`zh_CN`)\\n- Chinese Traditional (`zh_TW`)\\n- Croatian (`hr`)\\n- Danish (`da`)\\n- Dutch (`nl`)\\n- English US (`en`)\\n- English UK (`en_GB`)\\n- Estonian (`et`)\\n- Farsi (`fa`)\\n- Finnish (`fi`)\\n- French (`fr`)\\n- French Canadian (`fr_CA`)\\n- German (`de`)\\n- Greek (`el`)\\n- Hebrew (`he`)\\n- Hindi (`hi`)\\n- Hungarian (`hu`)\\n- Bahasa Indonesian (`id`)\\n- Italian (`it`)\\n- Japanese (`ja`)\\n- Korean (`ko`)\\n- Latvian (`lv`)\\n- Lithuanian (`lt`)\\n- Bahasa Melayu (`ms`)\\n- Norwegian (`no`)\\n- Polish (`pl`)\\n- Portuguese (`pt`)\\n- Portuguese Brazil (`pt_BR`)\\n- Romanian (`ro`)\\n- Russian (`ru`)\\n- Serbian (`sr`)\\n- Slovak (`sk`)\\n- Slovenian (`sl`)\\n- Spanish (`es`)\\n- Spanish Latin America (`es_MX`)\\n- Swedish (`sv`)\\n- Thai (`th`)\\n- Turkish (`tr`)\\n- Ukrainian (`uk`)\\n- Vietnamese (`vi`)\\n\\nAdditionally, you can automatically detect the browser language being used by the viewer and display the disclosure in that language by setting the value to `browser`.\",\n \"in\": \"path\",\n \"name\": \"langCode\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/consumer_disclosure/{langCode}\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"consumer_disclosure_get_consumer_disclosure_lang_code\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Gets the Electronic Record and Signature Disclosure for an account.\",\n \"tags\": [\n \"AccountConsumerDisclosures\"\n ]\n },\n \"consumer_disclosure_put_consumer_disclosure\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Account administrators can use this method to perform the following tasks:\\n\\n- Customize values in the default disclosure.\\n- Switch to a custom disclosure that uses your own text and HTML formatting.\\n- Change values in your existing consumer disclosure. \\n\\nTo specify the signer language version of the disclosure that you are updating, use the optional `langCode` query parameter.\\n\\n**Note:** Only account administrators can use this method. Each time you change the disclosure content, all unsigned recipients of outstanding documents will be required to accept a new version. \\n\\n## Updating the default disclosure\\n\\nWhen you update the default disclosure, you can edit all properties except for the following ones:\\n\\n- `accountEsignId`: This property is read-only.\\n- `custom`: The default value is **false.** Editing this property causes the default disclosure to switch to a custom disclosure.\\n- `esignAgreement`: This property is read-only.\\n- `esignText`: You cannot edit this property when `custom` is set to **false.** The API returns a 200 OK HTTP response, but does not update the `esignText`.\\n- Metadata properties: These properties are read-only.\\n\\n**Note:** The text of the default disclosure is always in English.\\n\\n## Switching to a custom disclosure\\n\\nTo switch to a custom disclosure, set the `custom` property to **true** and customize the value for the `eSignText` property. \\n\\nYou can also edit all of the other properties except for the following ones:\\n\\n- `accountEsignId`: This property is read-only.\\n- `esignAgreement`: This property is read-only.\\n- Metadata properties: These properties are read-only.\\n\\n**Note:** When you use a custom disclosure, you can create versions of it in different signer languages and se the `langCode` parameter to specify the signer language version that you are updating.\\n\\n**Important:** When you switch from a default to a custom disclosure, note the following information:\\n\\n- You will not be able to return to using the default disclosure.\\n- Only the disclosure for the currently selected signer language is saved. Docusign will not automatically translate your custom disclosure. You must create a disclosure for each language that your signers use.\\n\\n## Updating a custom disclosure\\n\\nWhen you update a custom disclosure, you can update all of the properties except for the following ones:\\n\\n- `accountEsignId`: This property is read-only. \\n- `esignAgreement`: This property is read-only.\\n- Metadata properties: These properties are read-only.\\n\\n**Important:** Only the disclosure for the currently selected signer language is saved. Docusign will not automatically translate your custom disclosure. You must create a disclosure for each language that your signers use.\\n\\n\",\n \"destructive\": true,\n \"method\": \"PUT\",\n \"operation_id\": \"consumer_disclosure_put_consumer_disclosure\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The code for the signer language version of the disclosure that you want to update. The following languages are supported:\\n\\n- Arabic (`ar`)\\n- Bulgarian (`bg`)\\n- Czech (`cs`)\\n- Chinese Simplified (`zh_CN`)\\n- Chinese Traditional (`zh_TW`)\\n- Croatian (`hr`)\\n- Danish (`da`)\\n- Dutch (`nl`)\\n- English US (`en`)\\n- English UK (`en_GB`)\\n- Estonian (`et`)\\n- Farsi (`fa`)\\n- Finnish (`fi`)\\n- French (`fr`)\\n- French Canadian (`fr_CA`)\\n- German (`de`)\\n- Greek (`el`)\\n- Hebrew (`he`)\\n- Hindi (`hi`)\\n- Hungarian (`hu`)\\n- Bahasa Indonesian (`id`)\\n- Italian (`it`)\\n- Japanese (`ja`)\\n- Korean (`ko`)\\n- Latvian (`lv`)\\n- Lithuanian (`lt`)\\n- Bahasa Melayu (`ms`)\\n- Norwegian (`no`)\\n- Polish (`pl`)\\n- Portuguese (`pt`)\\n- Portuguese Brazil (`pt_BR`)\\n- Romanian (`ro`)\\n- Russian (`ru`)\\n- Serbian (`sr`)\\n- Slovak (`sk`)\\n- Slovenian (`sl`)\\n- Spanish (`es`)\\n- Spanish Latin America (`es_MX`)\\n- Swedish (`sv`)\\n- Thai (`th`)\\n- Turkish (`tr`)\\n- Ukrainian (`uk`)\\n- Vietnamese (`vi`)\\n\\nAdditionally, you can automatically detect the browser language being used by the viewer and display the disclosure in that language by setting the value to `browser`.\",\n \"in\": \"path\",\n \"name\": \"langCode\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"(Optional) When true, the response includes metadata indicating which properties are editable.\",\n \"in\": \"query\",\n \"name\": \"include_metadata\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/consumer_disclosure/{langCode}\",\n \"request_body\": {\n \"$ref\": \"#/definitions/consumerDisclosure\"\n },\n \"security\": null,\n \"skill_name\": \"consumer_disclosure_put_consumer_disclosure\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Updates the Electronic Record and Signature Disclosure for an account.\",\n \"tags\": [\n \"AccountConsumerDisclosures\"\n ]\n },\n \"contacts_delete_contact_with_id\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"This method deletes a contact associated with an account.\",\n \"destructive\": true,\n \"method\": \"DELETE\",\n \"operation_id\": \"contacts_delete_contact_with_id\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The ID of a contact person in the account's address book.\",\n \"in\": \"path\",\n \"name\": \"contactId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/contacts/{contactId}\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"contacts_delete_contact_with_id\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Deletes a contact.\",\n \"tags\": [\n \"Contacts\"\n ]\n },\n \"contacts_delete_contacts\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"This method deletes multiple contacts associated with an account.\",\n \"destructive\": true,\n \"method\": \"DELETE\",\n \"operation_id\": \"contacts_delete_contacts\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/contacts\",\n \"request_body\": {\n \"$ref\": \"#/definitions/contactModRequest\"\n },\n \"security\": null,\n \"skill_name\": \"contacts_delete_contacts\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Deletes multiple contacts from an account.\",\n \"tags\": [\n \"Contacts\"\n ]\n },\n \"contacts_get_contact_by_id\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"This method returns one or more contacts\\nassociated with a Docusign account. You can also\\nretrieve contacts from connected [cloud storage][CloudStorage] providers by using the\\n`cloud_provider` query parameter. By default,\\ncontacts are retrieved from the Docusign account's\\ndefault address book.\\n\\nTo return a specific contact, use the `contactId`\\nquery parameter. To return all contacts associated\\nwith an account, omit this parameter.\\n\\n[CloudStorage]: /docs/esign-rest-api/reference/cloudstorage/\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"contacts_get_contact_by_id\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The ID of a contact person in the account's address book.\\n\\n**Note:** To return all contacts, omit this parameter. It is not required.\",\n \"in\": \"path\",\n \"name\": \"contactId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"(Optional) The cloud provider from which to retrieve the contacts. Valid values are:\\n\\n- `rooms`\\n- `docusignCore` (default)\",\n \"in\": \"query\",\n \"name\": \"cloud_provider\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/contacts/{contactId}\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"contacts_get_contact_by_id\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Gets one or more contacts.\",\n \"tags\": [\n \"Contacts\"\n ]\n },\n \"contacts_post_contacts\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"This method adds multiple contacts into a contacts list.\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"contacts_post_contacts\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/contacts\",\n \"request_body\": {\n \"$ref\": \"#/definitions/contactModRequest\"\n },\n \"security\": null,\n \"skill_name\": \"contacts_post_contacts\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Add contacts to a contacts list.\",\n \"tags\": [\n \"Contacts\"\n ]\n },\n \"contacts_put_contacts\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"This method updates one or more contacts associated with an account.\",\n \"destructive\": true,\n \"method\": \"PUT\",\n \"operation_id\": \"contacts_put_contacts\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/contacts\",\n \"request_body\": {\n \"$ref\": \"#/definitions/contactModRequest\"\n },\n \"security\": null,\n \"skill_name\": \"contacts_put_contacts\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Updates one or more contacts.\",\n \"tags\": [\n \"Contacts\"\n ]\n },\n \"custom_fields_delete_custom_fields\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Deletes envelope custom fields for draft and in-process envelopes.\",\n \"destructive\": true,\n \"method\": \"DELETE\",\n \"operation_id\": \"custom_fields_delete_custom_fields\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The envelope's GUID. \\n\\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\\n\",\n \"in\": \"path\",\n \"name\": \"envelopeId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/envelopes/{envelopeId}/custom_fields\",\n \"request_body\": {\n \"$ref\": \"#/definitions/EnvelopeCustomFields\"\n },\n \"security\": null,\n \"skill_name\": \"custom_fields_delete_custom_fields\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Deletes envelope custom fields for draft and in-process envelopes.\",\n \"tags\": [\n \"EnvelopeCustomFields\"\n ]\n },\n \"custom_fields_delete_template_custom_fields\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Deletes envelope custom fields in a template.\",\n \"destructive\": true,\n \"method\": \"DELETE\",\n \"operation_id\": \"custom_fields_delete_template_custom_fields\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The ID of the template.\",\n \"in\": \"path\",\n \"name\": \"templateId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/templates/{templateId}/custom_fields\",\n \"request_body\": {\n \"$ref\": \"#/definitions/templateCustomFields\"\n },\n \"security\": null,\n \"skill_name\": \"custom_fields_delete_template_custom_fields\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Deletes envelope custom fields in a template.\",\n \"tags\": [\n \"TemplateCustomFields\"\n ]\n },\n \"custom_fields_get_custom_fields\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Retrieves the custom field information for the specified envelope. You can use these fields in the envelopes for your account to record information about the envelope, help search for envelopes, and track information. The envelope custom fields are shown in the Envelope Settings section when a user is creating an envelope in the Docusign member console. The envelope custom fields are not seen by the envelope recipients.\\n\\nThere are two types of envelope custom fields, text, and list. A text custom field lets the sender enter the value for the field. With a list custom field, the sender selects the value of the field from a pre-made list.\\n\\n\\n### Related topics\\n\\n- [How to get envelope custom tab values](/docs/esign-rest-api/how-to/get-envelope-custom-tab-values/)\\n\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"custom_fields_get_custom_fields\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The envelope's GUID. \\n\\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\\n\",\n \"in\": \"path\",\n \"name\": \"envelopeId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/envelopes/{envelopeId}/custom_fields\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"custom_fields_get_custom_fields\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Gets the custom field information for the specified envelope.\",\n \"tags\": [\n \"EnvelopeCustomFields\"\n ]\n },\n \"custom_fields_get_template_custom_fields\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Retrieves the custom document field information from an existing template.\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"custom_fields_get_template_custom_fields\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The ID of the template.\",\n \"in\": \"path\",\n \"name\": \"templateId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/templates/{templateId}/custom_fields\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"custom_fields_get_template_custom_fields\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Gets the custom document fields from a template.\",\n \"tags\": [\n \"TemplateCustomFields\"\n ]\n },\n \"custom_fields_post_custom_fields\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Updates the envelope custom fields for draft and in-process envelopes.\\n\\n### Related topics\\n\\n- [How to bulk send envelopes](/docs/esign-rest-api/how-to/bulk-send-envelopes/)\\n\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"custom_fields_post_custom_fields\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The envelope's GUID. \\n\\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\\n\",\n \"in\": \"path\",\n \"name\": \"envelopeId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/envelopes/{envelopeId}/custom_fields\",\n \"request_body\": {\n \"$ref\": \"#/definitions/EnvelopeCustomFields\"\n },\n \"security\": null,\n \"skill_name\": \"custom_fields_post_custom_fields\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Creates envelope custom fields for an envelope.\",\n \"tags\": [\n \"EnvelopeCustomFields\"\n ]\n },\n \"custom_fields_post_template_custom_fields\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Creates custom document fields in an existing template document.\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"custom_fields_post_template_custom_fields\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The ID of the template.\",\n \"in\": \"path\",\n \"name\": \"templateId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/templates/{templateId}/custom_fields\",\n \"request_body\": {\n \"$ref\": \"#/definitions/templateCustomFields\"\n },\n \"security\": null,\n \"skill_name\": \"custom_fields_post_template_custom_fields\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Creates custom document fields in an existing template document.\",\n \"tags\": [\n \"TemplateCustomFields\"\n ]\n },\n \"custom_fields_put_custom_fields\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Updates the envelope custom fields in draft and in-process envelopes.\\n\\nEach custom field used in an envelope must have a unique name.\\n\",\n \"destructive\": true,\n \"method\": \"PUT\",\n \"operation_id\": \"custom_fields_put_custom_fields\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The envelope's GUID. \\n\\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\\n\",\n \"in\": \"path\",\n \"name\": \"envelopeId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/envelopes/{envelopeId}/custom_fields\",\n \"request_body\": {\n \"$ref\": \"#/definitions/EnvelopeCustomFields\"\n },\n \"security\": null,\n \"skill_name\": \"custom_fields_put_custom_fields\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Updates envelope custom fields in an envelope.\",\n \"tags\": [\n \"EnvelopeCustomFields\"\n ]\n },\n \"custom_fields_put_template_custom_fields\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Updates the custom fields in a template.\\n\\nEach custom field used in a template must have a unique name.\",\n \"destructive\": true,\n \"method\": \"PUT\",\n \"operation_id\": \"custom_fields_put_template_custom_fields\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The ID of the template.\",\n \"in\": \"path\",\n \"name\": \"templateId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/templates/{templateId}/custom_fields\",\n \"request_body\": {\n \"$ref\": \"#/definitions/templateCustomFields\"\n },\n \"security\": null,\n \"skill_name\": \"custom_fields_put_template_custom_fields\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Updates envelope custom fields in a template.\",\n \"tags\": [\n \"TemplateCustomFields\"\n ]\n },\n \"doc_gen_form_fields_get_envelope_doc_gen_form_fields\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Given an `envelopeId`, this method returns the sender fields found in that envelope's documents. After you retrieve the sender fields, use the [DocumentGeneration::updateEnvelopeDocGenFormFields](/docs/esign-rest-api/reference/envelopes/documentgeneration/updateenvelopedocgenformfields/) method to populate the fields.\\n\\nIf the specified envelope does not contain a document with sender fields, the method will return success (`200`) and an empty object (`{}`) in the response.\\n\\n### Next steps\\n\\n- [Learn about document generation in the eSignature concepts guide.](/docs/esign-rest-api/esign101/concepts/documents/document-generation/)\\n- [Learn how to send an envelope with document generation in your preferred coding language](/docs/esign-rest-api/how-to/request-signature-email-document-generation/).\\n\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"doc_gen_form_fields_get_envelope_doc_gen_form_fields\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The envelope's GUID. \\n\\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\\n\",\n \"in\": \"path\",\n \"name\": \"envelopeId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/envelopes/{envelopeId}/docGenFormFields\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"doc_gen_form_fields_get_envelope_doc_gen_form_fields\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Returns sender fields for an envelope.\",\n \"tags\": [\n \"DocumentGeneration\"\n ]\n },\n \"doc_gen_form_fields_put_envelope_doc_gen_form_fields\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"This method dynamically generates an envelope's documents by populating its sender fields. The envelope must be in a draft state.\\n\\nUse the [DocumentGeneration::getEnvelopeDocGenFormFields](/docs/esign-rest-api/reference/envelopes/documentgeneration/getenvelopedocgenformfields/) response to retrieve the list of sender fields for your envelope. Use that list to build the request for this method. For each field, specify the field name and the value to populate.\\n\\nFor example, your request body might look like this:\\n\\n```json\\n{\\n \\\"docGenFormFields\\\": [\\n {\\n \\\"documentId\\\": \\\"bf3202e1-xxxx-xxxx-xxxx-af4f41366879\\\",\\n \\\"docGenFormFieldList\\\": [\\n {\\n \\\"name\\\": \\\"Candidate_Name\\\",\\n \\\"value\\\": \\\"Peggy Olson\\\"\\n },\\n {\\n \\\"name\\\": \\\"Job_Title\\\",\\n \\\"value\\\": \\\"Technical Writer\\\"\\n },\\n {\\n \\\"name\\\": \\\"Manager_Name\\\",\\n \\\"value\\\": \\\"Donald Draper\\\"\\n },\\n {\\n \\\"name\\\": \\\"Start_Date\\\",\\n \\\"value\\\": \\\"1960-02-28\\\"\\n },\\n {\\n \\\"name\\\": \\\"Salary\\\",\\n \\\"value\\\": \\\"3380\\\"\\n }\\n ]\\n }\\n ]\\n}\\n```\\n\\n### Important notes\\n\\n* If `update_docgen_formfields_only` is false (the default), the `documentId` changes after the update.\\n* This endpoint does not validate number, date, or select data field values. The request can succeed even if a number or date field value is not a valid number or date, or if a select field value is not one of the allowed values.\\n\\n### Related topics\\n\\n- [Learn about document generation in the eSignature concepts guide.](/docs/esign-rest-api/esign101/concepts/documents/document-generation/)\\n- [See this method in use in your preferred coding language](/docs/esign-rest-api/how-to/request-signature-email-document-generation/).\\n\",\n \"destructive\": true,\n \"method\": \"PUT\",\n \"operation_id\": \"doc_gen_form_fields_put_envelope_doc_gen_form_fields\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The envelope's GUID. \\n\\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\\n\",\n \"in\": \"path\",\n \"name\": \"envelopeId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"When **false** or omitted,\\nthe documents are updated.\\n\\nWhen **true,** only the form fields are updated. The documents are unchanged.\\n\\n\",\n \"in\": \"query\",\n \"name\": \"update_docgen_formfields_only\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/envelopes/{envelopeId}/docGenFormFields\",\n \"request_body\": {\n \"$ref\": \"#/definitions/docGenFormFieldRequest\"\n },\n \"security\": null,\n \"skill_name\": \"doc_gen_form_fields_put_envelope_doc_gen_form_fields\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Updates sender fields for an envelope.\",\n \"tags\": [\n \"DocumentGeneration\"\n ]\n },\n \"document_fields_delete_document_fields\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Deletes custom document fields from an existing envelope document.\",\n \"destructive\": true,\n \"method\": \"DELETE\",\n \"operation_id\": \"document_fields_delete_document_fields\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The unique ID of the document within the envelope.\\n\\nUnlike other IDs in the eSignature API,\\nyou specify the `documentId` yourself.\\nTypically the first document has the ID\\n`1`, the second document `2`, and so on,\\nbut you can use any numbering scheme\\nthat fits within a 32-bit signed integer\\n(1 through 2147483647).\\n\\n\\nTab objects have a `documentId` property\\nthat specifies the document on which to place\\nthe tab.\\n\",\n \"in\": \"path\",\n \"name\": \"documentId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The envelope's GUID. \\n\\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\\n\",\n \"in\": \"path\",\n \"name\": \"envelopeId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/fields\",\n \"request_body\": {\n \"$ref\": \"#/definitions/EnvelopeDocumentFields\"\n },\n \"security\": null,\n \"skill_name\": \"document_fields_delete_document_fields\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Deletes custom document fields from an existing envelope document.\",\n \"tags\": [\n \"EnvelopeDocumentFields\"\n ]\n },\n \"document_fields_delete_template_document_fields\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Deletes custom document fields from an existing template document.\",\n \"destructive\": true,\n \"method\": \"DELETE\",\n \"operation_id\": \"document_fields_delete_template_document_fields\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The unique ID of the document within the envelope.\\n\\nUnlike other IDs in the eSignature API,\\nyou specify the `documentId` yourself.\\nTypically the first document has the ID\\n`1`, the second document `2`, and so on,\\nbut you can use any numbering scheme\\nthat fits within a 32-bit signed integer\\n(1 through 2147483647).\\n\\n\\nTab objects have a `documentId` property\\nthat specifies the document on which to place\\nthe tab.\\n\",\n \"in\": \"path\",\n \"name\": \"documentId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The ID of the template.\",\n \"in\": \"path\",\n \"name\": \"templateId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/templates/{templateId}/documents/{documentId}/fields\",\n \"request_body\": {\n \"$ref\": \"#/definitions/documentFieldsInformation\"\n },\n \"security\": null,\n \"skill_name\": \"document_fields_delete_template_document_fields\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Deletes custom document fields from an existing template document.\",\n \"tags\": [\n \"TemplateDocumentFields\"\n ]\n },\n \"document_fields_get_document_fields\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Retrieves the custom document field information from an existing envelope document.\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"document_fields_get_document_fields\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The unique ID of the document within the envelope.\\n\\nUnlike other IDs in the eSignature API,\\nyou specify the `documentId` yourself.\\nTypically the first document has the ID\\n`1`, the second document `2`, and so on,\\nbut you can use any numbering scheme\\nthat fits within a 32-bit signed integer\\n(1 through 2147483647).\\n\\n\\nTab objects have a `documentId` property\\nthat specifies the document on which to place\\nthe tab.\\n\",\n \"in\": \"path\",\n \"name\": \"documentId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The envelope's GUID. \\n\\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\\n\",\n \"in\": \"path\",\n \"name\": \"envelopeId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/fields\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"document_fields_get_document_fields\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Gets the custom document fields from an existing envelope document.\",\n \"tags\": [\n \"EnvelopeDocumentFields\"\n ]\n },\n \"document_fields_get_template_document_fields\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"This method retrieves the custom document fields for an existing template document.\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"document_fields_get_template_document_fields\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The unique ID of the document within the envelope.\\n\\nUnlike other IDs in the eSignature API,\\nyou specify the `documentId` yourself.\\nTypically the first document has the ID\\n`1`, the second document `2`, and so on,\\nbut you can use any numbering scheme\\nthat fits within a 32-bit signed integer\\n(1 through 2147483647).\\n\\n\\nTab objects have a `documentId` property\\nthat specifies the document on which to place\\nthe tab.\\n\",\n \"in\": \"path\",\n \"name\": \"documentId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The ID of the template.\",\n \"in\": \"path\",\n \"name\": \"templateId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/templates/{templateId}/documents/{documentId}/fields\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"document_fields_get_template_document_fields\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Gets the custom document fields for a an existing template document.\",\n \"tags\": [\n \"TemplateDocumentFields\"\n ]\n },\n \"document_fields_post_document_fields\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Creates custom document fields in an existing envelope document.\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"document_fields_post_document_fields\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The unique ID of the document within the envelope.\\n\\nUnlike other IDs in the eSignature API,\\nyou specify the `documentId` yourself.\\nTypically the first document has the ID\\n`1`, the second document `2`, and so on,\\nbut you can use any numbering scheme\\nthat fits within a 32-bit signed integer\\n(1 through 2147483647).\\n\\n\\nTab objects have a `documentId` property\\nthat specifies the document on which to place\\nthe tab.\\n\",\n \"in\": \"path\",\n \"name\": \"documentId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The envelope's GUID. \\n\\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\\n\",\n \"in\": \"path\",\n \"name\": \"envelopeId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/fields\",\n \"request_body\": {\n \"$ref\": \"#/definitions/EnvelopeDocumentFields\"\n },\n \"security\": null,\n \"skill_name\": \"document_fields_post_document_fields\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Creates custom document fields in an existing envelope document.\",\n \"tags\": [\n \"EnvelopeDocumentFields\"\n ]\n },\n \"document_fields_post_template_document_fields\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Creates custom document fields in an existing template document.\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"document_fields_post_template_document_fields\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The unique ID of the document within the envelope.\\n\\nUnlike other IDs in the eSignature API,\\nyou specify the `documentId` yourself.\\nTypically the first document has the ID\\n`1`, the second document `2`, and so on,\\nbut you can use any numbering scheme\\nthat fits within a 32-bit signed integer\\n(1 through 2147483647).\\n\\n\\nTab objects have a `documentId` property\\nthat specifies the document on which to place\\nthe tab.\\n\",\n \"in\": \"path\",\n \"name\": \"documentId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The ID of the template.\",\n \"in\": \"path\",\n \"name\": \"templateId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/templates/{templateId}/documents/{documentId}/fields\",\n \"request_body\": {\n \"$ref\": \"#/definitions/documentFieldsInformation\"\n },\n \"security\": null,\n \"skill_name\": \"document_fields_post_template_document_fields\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Creates custom document fields in an existing template document.\",\n \"tags\": [\n \"TemplateDocumentFields\"\n ]\n },\n \"document_fields_put_document_fields\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Updates existing custom document fields in an existing envelope document.\",\n \"destructive\": true,\n \"method\": \"PUT\",\n \"operation_id\": \"document_fields_put_document_fields\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The unique ID of the document within the envelope.\\n\\nUnlike other IDs in the eSignature API,\\nyou specify the `documentId` yourself.\\nTypically the first document has the ID\\n`1`, the second document `2`, and so on,\\nbut you can use any numbering scheme\\nthat fits within a 32-bit signed integer\\n(1 through 2147483647).\\n\\n\\nTab objects have a `documentId` property\\nthat specifies the document on which to place\\nthe tab.\\n\",\n \"in\": \"path\",\n \"name\": \"documentId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The envelope's GUID. \\n\\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\\n\",\n \"in\": \"path\",\n \"name\": \"envelopeId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/fields\",\n \"request_body\": {\n \"$ref\": \"#/definitions/EnvelopeDocumentFields\"\n },\n \"security\": null,\n \"skill_name\": \"document_fields_put_document_fields\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Updates existing custom document fields in an existing envelope document.\",\n \"tags\": [\n \"EnvelopeDocumentFields\"\n ]\n },\n \"document_fields_put_template_document_fields\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Updates existing custom document fields in an existing template document.\",\n \"destructive\": true,\n \"method\": \"PUT\",\n \"operation_id\": \"document_fields_put_template_document_fields\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The unique ID of the document within the envelope.\\n\\nUnlike other IDs in the eSignature API,\\nyou specify the `documentId` yourself.\\nTypically the first document has the ID\\n`1`, the second document `2`, and so on,\\nbut you can use any numbering scheme\\nthat fits within a 32-bit signed integer\\n(1 through 2147483647).\\n\\n\\nTab objects have a `documentId` property\\nthat specifies the document on which to place\\nthe tab.\\n\",\n \"in\": \"path\",\n \"name\": \"documentId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The ID of the template.\",\n \"in\": \"path\",\n \"name\": \"templateId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/templates/{templateId}/documents/{documentId}/fields\",\n \"request_body\": {\n \"$ref\": \"#/definitions/documentFieldsInformation\"\n },\n \"security\": null,\n \"skill_name\": \"document_fields_put_template_document_fields\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Updates existing custom document fields in an existing template document.\",\n \"tags\": [\n \"TemplateDocumentFields\"\n ]\n },\n \"documents_delete_documents\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Deletes one or more documents from an existing envelope that has not yet been completed.\\n\\nTo delete a document, use only the relevant parts of the [`envelopeDefinition`](#envelopeDefinition).\\nFor example, this request body specifies that you want to delete the document whose `documentId` is \\\"1\\\".\\n\\n\\n```text\\n{\\n \\\"documents\\\": [\\n {\\n \\\"documentId\\\": \\\"1\\\"\\n }\\n ]\\n}\\n```\\n\\nThe envelope status must be one of:\\n\\n- `created`\\n- `sent`\\n- `delivered`\\n\\n\\n\",\n \"destructive\": true,\n \"method\": \"DELETE\",\n \"operation_id\": \"documents_delete_documents\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The envelope's GUID. \\n\\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\\n\",\n \"in\": \"path\",\n \"name\": \"envelopeId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents\",\n \"request_body\": {\n \"$ref\": \"#/definitions/envelopeDefinition\"\n },\n \"security\": null,\n \"skill_name\": \"documents_delete_documents\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Deletes documents from a draft envelope.\",\n \"tags\": [\n \"EnvelopeDocuments\"\n ]\n },\n \"documents_delete_template_documents\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"This method deletes one or more documents from an existing template.\\n\\nTo delete a document, use only the relevant parts of the [`envelopeDefinition`](#envelopeDefinition).\\nFor example, this request body specifies that you want to delete the document whose `documentId` is \\\"1\\\".\\n\\n\\n```text\\n{\\n \\\"documents\\\": [\\n {\\n \\\"documentId\\\": \\\"1\\\"\\n }\\n ]\\n}\\n```\",\n \"destructive\": true,\n \"method\": \"DELETE\",\n \"operation_id\": \"documents_delete_template_documents\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The ID of the template.\",\n \"in\": \"path\",\n \"name\": \"templateId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/templates/{templateId}/documents\",\n \"request_body\": {\n \"$ref\": \"#/definitions/envelopeDefinition\"\n },\n \"security\": null,\n \"skill_name\": \"documents_delete_template_documents\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Deletes documents from a template.\",\n \"tags\": [\n \"TemplateDocuments\"\n ]\n },\n \"documents_get_document\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Retrieves a single document or all documents from an envelope.\\n\\nTo retrieve a single document, provide the ID of the document in the `documentId` path parameter.\\nAlternatively, by setting the `documentId` parameter to special keyword values,\\nyou can retrieve all the documents (as a combined PDF, portfolio PDF, or ZIP archive)\\nor just the certificate of completion. See the `documentId` description for how to retrieve each format.\\n\\n\\nThe response body of this method\\nis a file. If you request multiple documents,\\nthe result is a ZIP archive\\nthat contains all of the documents.\\n\\nIn all other cases, the response is a PDF\\nfile or PDF portfolio.\\n\\n\\nYou can get the file name and document ID from the response's `Content-Disposition` header:\\n\\n```\\nContent-Disposition: file; filename=\\\"NDA.pdf\\\"; documentid=\\\"1\\n```\\n\\nBy default, the response is the PDF file\\nas a byte stream.\\nFor example a request/response in `curl` looks like this:\\n\\n```\\n$ curl --request GET 'https://demo.docusign.net/restapi/v2/accounts/0cdb3ff3-xxxx-xxxx-xxxx-e43af011006d/envelopes/ea4cc25b-xxxx-xxxx-xxxx-a67a0a2a4f6c/documents/1/' \\\\\\n --header 'Authorization: Bearer eyJ...bqg'\\n\\n\\nHTTP/1.1 200 OK\\nContent-Length: 167539\\nContent-Type: application/pdf\\n. . .\\nContent-Disposition: file; filename=\\\"Lorem_Ipsum.pdf\\\"; documentid=\\\"1\\\"\\nDate: Tue, 23 Aug 2022 01:13:15 GMT\\n\\n%PDF-1.4\\n%\\u02da\\u00b8\\u02dd\\u02db\\n6 0 obj\\n<</Length 14>>stream\\n. . .\\n```\\n\\nBy using the `Content-Transfer-Encoding`\\nheader in the request, you can obtain the PDF file\\nencoded in base64. The same `curl` request with\\nthe base64 header would look like this:\\n\\n```\\n$ curl --request GET 'https://demo.docusign.net/restapi/v2/accounts/0cdb3ff3-xxxx-xxxx-xxxx-e43af011006d/envelopes/ea4cc25b-xxxx-xxxx-xxxx-a67a0a2a4f6c/documents/1/' \\\\\\n --header 'Authorization: Bearer eyJ...bqg' \\\\\\n --header 'Content-Transfer-Encoding: base64'\\n\\n\\nHTTP/1.1 200 OK\\nContent-Length: 223384\\nContent-Type: application/pdf\\n. . .\\nContent-Disposition: file; filename=\\\"Lorem_Ipsum.pdf\\\"; documentid=\\\"1\\\"\\nContent-Transfer-Encoding: base64\\nDate: Tue, 23 Aug 2022 01:12:30 GMT\\n\\nJVBERi0xLjQKJfv8/f4KNiAwIG9iago8PC9MZW. . .==\\n```\\n\\n\\n(In an actual `curl` request you would use the `--output` switch to\\nsave the byte stream into a file.)\\n\\n### Related topics\\n\\n- [How to download envelope documents](/docs/esign-rest-api/how-to/download-envelope-documents/)\\n\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"documents_get_document\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The ID of the document to retrieve. Alternatively, you can use one of the following special keywords:\\n\\n- `combined`: Retrieves all of the documents as a single PDF file.\\n When the query parameter `certificate` is **true,** the certificate of completion is included in the PDF file.\\n When the query parameter `certificate` is **false,** the certificate of completion is not included in the PDF file.\\n- `archive`: Retrieves a ZIP archive that contains all of the PDF documents and the certificate of completion.\\n- `certificate`: Retrieves only the certificate of completion as a PDF file.\\n- `portfolio`: Retrieves the envelope documents as a [PDF portfolio](https://helpx.adobe.com/acrobat/using/overview-pdf-portfolios.html).\",\n \"in\": \"path\",\n \"name\": \"documentId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The envelope's GUID. \\n\\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\\n\",\n \"in\": \"path\",\n \"name\": \"envelopeId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Used only when the `documentId` parameter is the special keyword `combined`.\\n\\nWhen **true,** the certificate of completion is included in the combined PDF file.\\nWhen **false,** (the default) the certificate of completion is not included in the combined PDF file.\\n\\n\",\n \"in\": \"query\",\n \"name\": \"certificate\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"When **true,** allows recipients to get documents by their user id. For example, if a user is included in two different routing orders with different visibilities, using this parameter returns all of the documents from both routing orders.\",\n \"in\": \"query\",\n \"name\": \"documents_by_userid\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Reserved for Docusign.\",\n \"in\": \"query\",\n \"name\": \"encoding\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"When **true,** the PDF bytes returned in the response are encrypted for all the key managers configured on your Docusign account. You can decrypt the documents by using the Key Manager DecryptDocument API method. For more information about Key Manager, see the Docusign Security Appliance Installation Guide that your organization received from Docusign.\",\n \"in\": \"query\",\n \"name\": \"encrypt\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Specifies the language for the Certificate of Completion in the response. The supported languages are: Chinese Simplified (zh_CN), Chinese Traditional (zh_TW), Dutch (nl), English US (en), French (fr), German (de), Italian (it), Japanese (ja), Korean (ko), Portuguese (pt), Portuguese (Brazil) (pt_BR), Russian (ru), Spanish (es). \",\n \"in\": \"query\",\n \"name\": \"language\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Allows the sender to retrieve the documents as one of the recipients that they control. The `documents_by_userid` parameter must be set to **false** for this functionality to work.\",\n \"in\": \"query\",\n \"name\": \"recipient_id\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The ID of a shared user that you want to impersonate in order to\\nretrieve their view of the list of documents. This parameter is\\nused in the context of a shared inbox (i.e., when you share\\nenvelopes from one user to another through the Docusign Admin console).\",\n \"in\": \"query\",\n \"name\": \"shared_user_id\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"When **true,** any changed fields for the returned PDF are highlighted in yellow and optional signatures or initials outlined in red. The account must have the **Highlight Data Changes** feature enabled.\",\n \"in\": \"query\",\n \"name\": \"show_changes\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"When **true,** the account has the watermark feature enabled, and the envelope is not complete, then the watermark for the account is added to the PDF documents. This option can remove the watermark. \",\n \"in\": \"query\",\n \"name\": \"watermark\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"documents_get_document\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Retrieves a single document or all documents from an envelope.\",\n \"tags\": [\n \"EnvelopeDocuments\"\n ]\n },\n \"documents_get_documents\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Retrieves a list of documents associated with the specified envelope.\\n\\n### Related topics\\n\\n- [How to list envelope documents](/docs/esign-rest-api/how-to/list-envelope-documents/)\\n\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"documents_get_documents\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The envelope's GUID. \\n\\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\\n\",\n \"in\": \"path\",\n \"name\": \"envelopeId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"When **true,** allows recipients to get documents by their user id. For example, if a user is included in two different routing orders with different visibilities, using this parameter returns all of the documents from both routing orders.\",\n \"in\": \"query\",\n \"name\": \"documents_by_userid\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"\",\n \"in\": \"query\",\n \"name\": \"include_agreement_type\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Reserved for Docusign.\",\n \"in\": \"query\",\n \"name\": \"include_docgen_formfields\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"\",\n \"in\": \"query\",\n \"name\": \"include_is_edited\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"When **true,** the response includes metadata that indicates which properties the sender can edit.\",\n \"in\": \"query\",\n \"name\": \"include_metadata\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Reserved for Docusign.\",\n \"in\": \"query\",\n \"name\": \"include_tabs\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Allows the sender to retrieve the documents as one of the recipients that they control. The `documents_by_userid` parameter must be set to **false** for this to work.\",\n \"in\": \"query\",\n \"name\": \"recipient_id\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The ID of a shared user that you want to impersonate in order to\\nretrieve their view of the list of documents. This parameter is\\nused in the context of a shared inbox (i.e., when you share\\nenvelopes from one user to another through the Docusign Admin console).\",\n \"in\": \"query\",\n \"name\": \"shared_user_id\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"documents_get_documents\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Gets a list of documents in an envelope.\",\n \"tags\": [\n \"EnvelopeDocuments\"\n ]\n },\n \"documents_get_template_document\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"This method retrieves one or more PDF documents from the template that you specify.\\n\\nYou can specify the ID of the document to retrieve, or pass in the value `combined` to retrieve all documents in the template as a single PDF file.\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"documents_get_template_document\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The unique ID of the document within the envelope.\\n\\nUnlike other IDs in the eSignature API,\\nyou specify the `documentId` yourself.\\nTypically the first document has the ID\\n`1`, the second document `2`, and so on,\\nbut you can use any numbering scheme\\nthat fits within a 32-bit signed integer\\n(1 through 2147483647).\\n\\n\\nTab objects have a `documentId` property\\nthat specifies the document on which to place\\nthe tab.\\n\",\n \"in\": \"path\",\n \"name\": \"documentId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The ID of the template.\",\n \"in\": \"path\",\n \"name\": \"templateId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"When **true,** the PDF bytes returned in the response are encrypted for all the key managers configured on your Docusign account. You can decrypt the documents by using the Key Manager DecryptDocument API method. For more information about Key Manager, see the Docusign Security Appliance Installation Guide that your organization received from Docusign.\",\n \"in\": \"query\",\n \"name\": \"encrypt\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"\",\n \"in\": \"query\",\n \"name\": \"file_type\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"When **true,** any document fields that a recipient changed are highlighted in yellow in the returned PDF document, and optional signatures or initials are outlined in red.\",\n \"in\": \"query\",\n \"name\": \"show_changes\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/templates/{templateId}/documents/{documentId}\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"documents_get_template_document\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Gets PDF documents from a template.\",\n \"tags\": [\n \"TemplateDocuments\"\n ]\n },\n \"documents_get_template_documents\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Retrieves a list of documents associated with the specified template.\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"documents_get_template_documents\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The ID of the template.\",\n \"in\": \"path\",\n \"name\": \"templateId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"\",\n \"in\": \"query\",\n \"name\": \"include_agreement_type\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"\",\n \"in\": \"query\",\n \"name\": \"include_is_edited\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Reserved for Docusign.\",\n \"in\": \"query\",\n \"name\": \"include_tabs\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/templates/{templateId}/documents\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"documents_get_template_documents\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Gets a list of documents associated with a template.\",\n \"tags\": [\n \"TemplateDocuments\"\n ]\n },\n \"documents_put_document\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Adds or replaces a document in an existing draft or in-process envelope.\\nAn in-process envelope is one that has been sent but not yet completed or voided.\\n\\n\\n**Note:** When adding or modifying documents for an in-process envelope,\\nDocusign recommends\\n[locking the envelope](/docs/esign-rest-api/reference/envelopes/envelopelocks/create/)\\nprior to making any changes.\\n\\nTo add a new document, set the `documentId` path parameter to a new document ID.\\n\\nTo replace a document, set the `documentId` path parameter to the document ID of the existing document.\\nThe tabs of the original document will be applied to the new document.\\nFor example, a request in cURL looks like this:\\n\\n```\\n$ curl --location --request PUT 'https://demo.docusign.net/restapi/v2.1/accounts/0cdb3ff3-xxxx-xxxx-xxxx-e43af011006d/envelopes/ea4cc25b-xxxx-xxxx-xxxx-a67a0a2a4f6c/documents/1' \\\\\\n --header 'Authorization: Bearer eyJ...bqg' \\\\\\n --header 'Content-Disposition: filename=\\\"newDocument\\\"' \\\\\\n --header 'Content-Type: application/pdf' \\\\\\n --data-binary '@/location/of/document.pdf'\\n```\\n\\n\\n<ds-inlinemessage kind=\\\"warning\\\">\\nIf HTML document files contain <code>&lt;img&gt;</code> elements with the <code>src</code> attribute set to a path or URL, those images will not be displayed. Images in HTML files must be encoded in Base64 format, like this:<br/>\\n<code>&lt;img src=\\\"data:image/gif;base64,R0lGODlh...IQAAOw==\\\" alt=\\\"Base64 encoded image\\\" width=\\\"150\\\" height=\\\"150\\\"/&gt;</code>\\n</ds-inlinemessage>\",\n \"destructive\": true,\n \"method\": \"PUT\",\n \"operation_id\": \"documents_put_document\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The unique ID of the document within the envelope.\\n\\nUnlike other IDs in the eSignature API,\\nyou specify the `documentId` yourself.\\nTypically the first document has the ID\\n`1`, the second document `2`, and so on,\\nbut you can use any numbering scheme\\nthat fits within a 32-bit signed integer\\n(1 through 2147483647).\\n\\n\\nTab objects have a `documentId` property\\nthat specifies the document on which to place\\nthe tab.\\n\",\n \"in\": \"path\",\n \"name\": \"documentId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The envelope's GUID. \\n\\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\\n\",\n \"in\": \"path\",\n \"name\": \"envelopeId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}\",\n \"request_body\": {\n \"format\": \"binary\",\n \"type\": \"string\"\n },\n \"security\": null,\n \"skill_name\": \"documents_put_document\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Adds or replaces a document in an existing envelope.\",\n \"tags\": [\n \"EnvelopeDocuments\"\n ]\n },\n \"documents_put_documents\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Adds one or more documents to an existing envelope.\\nThe tabs of the original document will be applied to the new document.\\n\\n\\n**Note:** When adding or modifying documents for an in-process envelope,\\nDocusign recommends\\n[locking the envelope](/docs/esign-rest-api/reference/envelopes/envelopelocks/create/)\\nprior to making any changes.\\n\\nIf the file name of a document contains Unicode characters, you need to include a `Content-Disposition` header. Example:\\n\\n\\n**Header:** `Content-Disposition`\\n\\n\\n**Value:** `file; filename=\\\\\\\"name\\\\\\\";fileExtension=ext;documentId=1`\\n\\n**Note:** This method works on documents only.\\nTo add recipient or document tabs,\\nuse methods from the [EnvelopeRecipientTabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/) resource.\\n\\n<ds-inlinemessage kind=\\\"warning\\\">\\nIf HTML document files contain <code>&lt;img&gt;</code> elements with the <code>src</code> attribute set to a path or URL, those images will not be displayed. Images in HTML files must be encoded in Base64 format, like this:<br/>\\n<code>&lt;img src=\\\"data:image/gif;base64,R0lGODlh...IQAAOw==\\\" alt=\\\"Base64 encoded image\\\" width=\\\"150\\\" height=\\\"150\\\"/&gt;</code>\\n</ds-inlinemessage>\\n\\n\",\n \"destructive\": true,\n \"method\": \"PUT\",\n \"operation_id\": \"documents_put_documents\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The envelope's GUID. \\n\\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\\n\",\n \"in\": \"path\",\n \"name\": \"envelopeId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents\",\n \"request_body\": {\n \"$ref\": \"#/definitions/envelopeDefinition\"\n },\n \"security\": null,\n \"skill_name\": \"documents_put_documents\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Adds one or more documents to an existing envelope.\",\n \"tags\": [\n \"EnvelopeDocuments\"\n ]\n },\n \"documents_put_template_document\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"This methods updates an existing template document.\",\n \"destructive\": true,\n \"method\": \"PUT\",\n \"operation_id\": \"documents_put_template_document\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The unique ID of the document within the envelope.\\n\\nUnlike other IDs in the eSignature API,\\nyou specify the `documentId` yourself.\\nTypically the first document has the ID\\n`1`, the second document `2`, and so on,\\nbut you can use any numbering scheme\\nthat fits within a 32-bit signed integer\\n(1 through 2147483647).\\n\\n\\nTab objects have a `documentId` property\\nthat specifies the document on which to place\\nthe tab.\\n\",\n \"in\": \"path\",\n \"name\": \"documentId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The ID of the template.\",\n \"in\": \"path\",\n \"name\": \"templateId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"\",\n \"in\": \"query\",\n \"name\": \"is_envelope_definition\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/templates/{templateId}/documents/{documentId}\",\n \"request_body\": {\n \"$ref\": \"#/definitions/envelopeDefinition\"\n },\n \"security\": null,\n \"skill_name\": \"documents_put_template_document\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Updates a template document.\",\n \"tags\": [\n \"TemplateDocuments\"\n ]\n },\n \"documents_put_template_documents\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Adds one or more documents to an existing template document.\",\n \"destructive\": true,\n \"method\": \"PUT\",\n \"operation_id\": \"documents_put_template_documents\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The ID of the template.\",\n \"in\": \"path\",\n \"name\": \"templateId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/templates/{templateId}/documents\",\n \"request_body\": {\n \"$ref\": \"#/definitions/envelopeDefinition\"\n },\n \"security\": null,\n \"skill_name\": \"documents_put_template_documents\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Adds documents to a template document.\",\n \"tags\": [\n \"TemplateDocuments\"\n ]\n },\n \"e_note_configuration_delete_e_note_configuration\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Deletes configuration information for the eNote eOriginal integration.\",\n \"destructive\": true,\n \"method\": \"DELETE\",\n \"operation_id\": \"e_note_configuration_delete_e_note_configuration\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/settings/enote_configuration\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"e_note_configuration_delete_e_note_configuration\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Deletes configuration information for the eNote eOriginal integration.\",\n \"tags\": [\n \"ENoteConfigurations\"\n ]\n },\n \"e_note_configuration_get_e_note_configuration\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Returns the configuration information for the eNote eOriginal integration.\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"e_note_configuration_get_e_note_configuration\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/settings/enote_configuration\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"e_note_configuration_get_e_note_configuration\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Returns the configuration information for the eNote eOriginal integration.\",\n \"tags\": [\n \"ENoteConfigurations\"\n ]\n },\n \"e_note_configuration_put_e_note_configuration\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Updates configuration information for the eNote eOriginal integration.\",\n \"destructive\": true,\n \"method\": \"PUT\",\n \"operation_id\": \"e_note_configuration_put_e_note_configuration\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/settings/enote_configuration\",\n \"request_body\": {\n \"$ref\": \"#/definitions/eNoteConfiguration\"\n },\n \"security\": null,\n \"skill_name\": \"e_note_configuration_put_e_note_configuration\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Updates configuration information for the eNote eOriginal integration.\",\n \"tags\": [\n \"ENoteConfigurations\"\n ]\n },\n \"email_settings_delete_email_settings\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Deletes all existing email override settings for the envelope. If you want to delete an individual email override setting, use the PUT and set the value to an empty string. Note that deleting email settings will only affect email communications that occur after the deletion and the normal account email settings are used for future email communications.\",\n \"destructive\": true,\n \"method\": \"DELETE\",\n \"operation_id\": \"email_settings_delete_email_settings\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The envelope's GUID. \\n\\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\\n\",\n \"in\": \"path\",\n \"name\": \"envelopeId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/envelopes/{envelopeId}/email_settings\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"email_settings_delete_email_settings\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Deletes the email setting overrides for an envelope.\",\n \"tags\": [\n \"EnvelopeEmailSettings\"\n ]\n },\n \"email_settings_get_email_settings\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Retrieves the email override settings for the specified envelope.\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"email_settings_get_email_settings\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The envelope's GUID. \\n\\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\\n\",\n \"in\": \"path\",\n \"name\": \"envelopeId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/envelopes/{envelopeId}/email_settings\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"email_settings_get_email_settings\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Gets the email setting overrides for an envelope.\",\n \"tags\": [\n \"EnvelopeEmailSettings\"\n ]\n },\n \"email_settings_post_email_settings\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Adds email override settings, changing the email address to reply to an email address, name, or the BCC for email archive information, for the envelope. Note that adding email settings will only affect email communications that occur after the addition was made.\\n\\nThe BCC Email address feature is designed to provide a copy of all email communications for external archiving purposes.\\nTo send a copy of the envelope to a recipient who does not need to sign, use a Carbon Copy or Certified Delivery recipient type.\\n\\n**Note:** Docusign recommends that envelopes sent using the BCC for Email Archive feature, including the BCC Email Override option, include additional signer authentication options. \",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"email_settings_post_email_settings\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The envelope's GUID. \\n\\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\\n\",\n \"in\": \"path\",\n \"name\": \"envelopeId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/envelopes/{envelopeId}/email_settings\",\n \"request_body\": {\n \"$ref\": \"#/definitions/emailSettings\"\n },\n \"security\": null,\n \"skill_name\": \"email_settings_post_email_settings\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Adds email setting overrides to an envelope.\",\n \"tags\": [\n \"EnvelopeEmailSettings\"\n ]\n },\n \"email_settings_put_email_settings\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Updates the existing email override settings for the specified envelope. Note that modifying email settings will only affect email communications that occur after the modification was made.\\n\\nThis can also be used to delete an individual email override setting by using an empty string for the value to be deleted.\",\n \"destructive\": true,\n \"method\": \"PUT\",\n \"operation_id\": \"email_settings_put_email_settings\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The envelope's GUID. \\n\\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\\n\",\n \"in\": \"path\",\n \"name\": \"envelopeId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/envelopes/{envelopeId}/email_settings\",\n \"request_body\": {\n \"$ref\": \"#/definitions/emailSettings\"\n },\n \"security\": null,\n \"skill_name\": \"email_settings_put_email_settings\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Updates the email setting overrides for an envelope.\",\n \"tags\": [\n \"EnvelopeEmailSettings\"\n ]\n },\n \"envelope_purge_configuration_get_envelope_purge_configuration\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"An envelope purge configuration enables account administrators to permanently remove documents and their field data from completed and voided envelopes after a specified retention period (`retentionDays`). This method retrieves the current envelope purge configuration for your account.\\n\\n**Note:** To use this method, you must be an account administrator.\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"envelope_purge_configuration_get_envelope_purge_configuration\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/settings/envelope_purge_configuration\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"envelope_purge_configuration_get_envelope_purge_configuration\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Gets the envelope purge configuration for an account.\",\n \"tags\": [\n \"Accounts\"\n ]\n },\n \"envelope_purge_configuration_put_envelope_purge_configuration\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"An envelope purge configuration enables account administrators to permanently remove documents and their field data from completed and voided envelopes after a specified retention period (`retentionDays`). This method sets the envelope purge configuration for your account.\\n\\n**Note:** To use this method, you must be an account administrator.\\n\\nFor more information, see [Purge Envelopes](https://support.docusign.com/s/document-item?bundleId=oeq1643226594604&topicId=edo1578456348066.html).\",\n \"destructive\": true,\n \"method\": \"PUT\",\n \"operation_id\": \"envelope_purge_configuration_put_envelope_purge_configuration\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/settings/envelope_purge_configuration\",\n \"request_body\": {\n \"$ref\": \"#/definitions/envelopePurgeConfiguration\"\n },\n \"security\": null,\n \"skill_name\": \"envelope_purge_configuration_put_envelope_purge_configuration\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Sets the envelope purge configuration for an account.\",\n \"tags\": [\n \"Accounts\"\n ]\n },\n \"envelope_transfer_rules_delete_envelope_transfer_rules\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"This method deletes an envelope transfer rule.\\n\\n**Note:** Only Administrators can delete envelope transfer rules. In addition, to use envelope transfer rules, the **Transfer Custody** feature must be enabled for your account.\",\n \"destructive\": true,\n \"method\": \"DELETE\",\n \"operation_id\": \"envelope_transfer_rules_delete_envelope_transfer_rules\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The ID of the envelope transfer rule. The system generates this ID when the rule is first created.\",\n \"in\": \"path\",\n \"name\": \"envelopeTransferRuleId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/envelopes/transfer_rules/{envelopeTransferRuleId}\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"envelope_transfer_rules_delete_envelope_transfer_rules\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Deletes an envelope transfer rule.\",\n \"tags\": [\n \"EnvelopeTransferRules\"\n ]\n },\n \"envelope_transfer_rules_get_envelope_transfer_rules\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"This method retrieves a list of envelope transfer rules associated with an account.\\n\\n**Note:** Only Administrators can create and use envelope transfer rules. In addition, to use envelope transfer rules, the **Transfer Custody** feature must be enabled for your account.\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"envelope_transfer_rules_get_envelope_transfer_rules\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The maximum number of results to return.\\n\\nUse `start_position` to specify the number of results to skip.\\n\",\n \"in\": \"query\",\n \"name\": \"count\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The zero-based index of the\\nresult from which to start returning results.\\n\\nUse with `count` to limit the number\\nof results.\\n\\nThe default value is `0`.\\n\",\n \"in\": \"query\",\n \"name\": \"start_position\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/envelopes/transfer_rules\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"envelope_transfer_rules_get_envelope_transfer_rules\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Gets envelope transfer rules.\",\n \"tags\": [\n \"EnvelopeTransferRules\"\n ]\n },\n \"envelope_transfer_rules_post_envelope_transfer_rules\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"This method creates an envelope transfer rule.\\n\\nWhen you create an envelope transfer rule, you specify the following properties: \\n\\n- `eventType`\\n- `fromGroups`\\n- `toUser`\\n- `toFolder`\\n- `carbonCopyOriginalOwner`\\n- `enabled`\\n\\n**Note:** Only Administrators can create envelope transfer rules. In addition, to use envelope transfer rules, the **Transfer Custody** feature must be enabled for your account.\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"envelope_transfer_rules_post_envelope_transfer_rules\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/envelopes/transfer_rules\",\n \"request_body\": {\n \"$ref\": \"#/definitions/envelopeTransferRuleRequest\"\n },\n \"security\": null,\n \"skill_name\": \"envelope_transfer_rules_post_envelope_transfer_rules\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Creates an envelope transfer rule.\",\n \"tags\": [\n \"EnvelopeTransferRules\"\n ]\n },\n \"envelope_transfer_rules_put_envelope_transfer_rule\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"This method changes the status of an envelope transfer rule. You use this method to change whether or not the rule is enabled.\\n\\nYou must include the `envelopeTransferRuleId` both as a query parameter, and in the request body.\\n\\n**Note:** You cannot change any other information about the envelope transfer rule. Only Administrators can update an envelope transfer rule. In addition, to use envelope transfer rules, the **Transfer Custody** feature must be enabled for your account.\",\n \"destructive\": true,\n \"method\": \"PUT\",\n \"operation_id\": \"envelope_transfer_rules_put_envelope_transfer_rule\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The ID of the envelope transfer rule. The system generates this ID when the rule is first created.\",\n \"in\": \"path\",\n \"name\": \"envelopeTransferRuleId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/envelopes/transfer_rules/{envelopeTransferRuleId}\",\n \"request_body\": {\n \"$ref\": \"#/definitions/envelopeTransferRule\"\n },\n \"security\": null,\n \"skill_name\": \"envelope_transfer_rules_put_envelope_transfer_rule\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Changes the status of an envelope transfer rule.\",\n \"tags\": [\n \"EnvelopeTransferRules\"\n ]\n },\n \"envelope_transfer_rules_put_envelope_transfer_rules\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"This method changes the status for one or more envelope transfer rules based on the `envelopeTransferRuleId`s in the request body. You use this method to change whether or not the rules are enabled.\\n\\n**Note:** You cannot change any other information about the envelope transfer rule. Only Administrators can update envelope transfer rules. In addition, to use envelope transfer rules, the **Transfer Custody** feature must be enabled for your account.\",\n \"destructive\": true,\n \"method\": \"PUT\",\n \"operation_id\": \"envelope_transfer_rules_put_envelope_transfer_rules\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/envelopes/transfer_rules\",\n \"request_body\": {\n \"$ref\": \"#/definitions/envelopeTransferRuleInformation\"\n },\n \"security\": null,\n \"skill_name\": \"envelope_transfer_rules_put_envelope_transfer_rules\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Changes the status of multiple envelope transfer rules.\",\n \"tags\": [\n \"EnvelopeTransferRules\"\n ]\n },\n \"envelope_workflow_definition_v2_delete_envelope_workflow_definition\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Deletes the specified envelope's workflow definition if it has one.\\n\\n**Note:** If the envelope was scheduled to be sent, this endpoint will cancel the scheduled send and the envelope status will be reset to \\n`created`. To resend the envelope, call the update the status to `sent` with the [Envelopes::Update](/docs/esign-rest-api/reference/envelopes/envelopes/update/) method.\\n\",\n \"destructive\": true,\n \"method\": \"DELETE\",\n \"operation_id\": \"envelope_workflow_definition_v2_delete_envelope_workflow_definition\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The envelope's GUID. \\n\\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\\n\",\n \"in\": \"path\",\n \"name\": \"envelopeId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/envelopes/{envelopeId}/workflow\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"envelope_workflow_definition_v2_delete_envelope_workflow_definition\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Delete the workflow definition for an envelope.\",\n \"tags\": [\n \"EnvelopeWorkflowDefinition\"\n ]\n },\n \"envelope_workflow_definition_v2_get_envelope_workflow_definition\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Returns the workflow definition for the envelope specified by `envelopeId`. If the envelope does not have a workflow object, this method returns a 404.\\n\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"envelope_workflow_definition_v2_get_envelope_workflow_definition\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The envelope's GUID. \\n\\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\\n\",\n \"in\": \"path\",\n \"name\": \"envelopeId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/envelopes/{envelopeId}/workflow\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"envelope_workflow_definition_v2_get_envelope_workflow_definition\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Returns the workflow definition for an envelope.\",\n \"tags\": [\n \"EnvelopeWorkflowDefinition\"\n ]\n },\n \"envelope_workflow_definition_v2_put_envelope_workflow_definition\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Updates the specified envelope's workflow.\\n\\nYou can use this endpoint to add scheduled sending to a draft envelope. You can also update the scheduled sending for a sent envelope if the scheduled sending countdown is in progress. In that case, the envelope will be reset to a draft state.\\n\\nYou can also add delayed routing to a draft envelope or a sent envelope that has not started workflow processing.\",\n \"destructive\": true,\n \"method\": \"PUT\",\n \"operation_id\": \"envelope_workflow_definition_v2_put_envelope_workflow_definition\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The envelope's GUID. \\n\\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\\n\",\n \"in\": \"path\",\n \"name\": \"envelopeId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/envelopes/{envelopeId}/workflow\",\n \"request_body\": {\n \"$ref\": \"#/definitions/workflow\"\n },\n \"security\": null,\n \"skill_name\": \"envelope_workflow_definition_v2_put_envelope_workflow_definition\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Updates the workflow definition for an envelope.\",\n \"tags\": [\n \"EnvelopeWorkflowDefinition\"\n ]\n },\n \"envelope_workflow_delayed_routing_delete_envelope_delayed_routing_definition\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Delete the delayed routing object for an envelope's workflow step. You cannot call this endpoint once the delay is in progress. As a workaround, you can update the delay or send time to one minute in the future using the [updateEnvelopeDelayedRoutingDefinition](/docs/esign-rest-api/reference/envelopes/envelopeworkflowdefinition/updateEnvelopeDelayedRoutingDefinition/) endpoint. \\n\\n**Note:** After deleting the delayed routing object, the workflow step still contains the `pause_before` action. Once the workflow step is reached, you will need to [unpause the envelope](/docs/esign-rest-api/how-to/unpause-workflow/). If you want to delete the step entirely, use [deleteEnvelopeWorkflowStepDefinition](/docs/esign-rest-api/reference/envelopes/envelopeworkflowdefinition/deleteenvelopeworkflowstepdefinition/) instead.\\n\",\n \"destructive\": true,\n \"method\": \"DELETE\",\n \"operation_id\": \"envelope_workflow_delayed_routing_delete_envelope_delayed_routing_definition\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The envelope's GUID. \\n\\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\\n\",\n \"in\": \"path\",\n \"name\": \"envelopeId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The ID of the workflow step.\",\n \"in\": \"path\",\n \"name\": \"workflowStepId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/envelopes/{envelopeId}/workflow/steps/{workflowStepId}/delayedRouting\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"envelope_workflow_delayed_routing_delete_envelope_delayed_routing_definition\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Deletes the delayed routing rules for the specified envelope workflow step.\",\n \"tags\": [\n \"EnvelopeWorkflowDefinition\"\n ]\n },\n \"envelope_workflow_delayed_routing_get_envelope_delayed_routing_definition\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Given an envelope and a workflow step, returns the delayed routing rules for that workflow step.\\n\\n**Note:** If the workflow step does not have a delayed routing object, this method returns a 404.\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"envelope_workflow_delayed_routing_get_envelope_delayed_routing_definition\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The envelope's GUID. \\n\\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\\n\",\n \"in\": \"path\",\n \"name\": \"envelopeId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The ID of the workflow step.\",\n \"in\": \"path\",\n \"name\": \"workflowStepId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/envelopes/{envelopeId}/workflow/steps/{workflowStepId}/delayedRouting\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"envelope_workflow_delayed_routing_get_envelope_delayed_routing_definition\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Returns the delayed routing rules for an envelope's workflow step definition.\",\n \"tags\": [\n \"EnvelopeWorkflowDefinition\"\n ]\n },\n \"envelope_workflow_delayed_routing_put_envelope_delayed_routing_definition\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Updates the delayed routing rules for an envelope's workflow step definition.\\n\\nYou can use this endpoint to add delayed routing to a draft envelope or a sent envelope (as long as the previous workflow step has not yet been completed). You can also update the delayed routing rule for an envelope, as long as the delay is not yet complete. If you update the delayed routing rule while the delay is already in progress, the countdown will reset.\",\n \"destructive\": true,\n \"method\": \"PUT\",\n \"operation_id\": \"envelope_workflow_delayed_routing_put_envelope_delayed_routing_definition\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The envelope's GUID. \\n\\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\\n\",\n \"in\": \"path\",\n \"name\": \"envelopeId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The ID of the workflow step.\",\n \"in\": \"path\",\n \"name\": \"workflowStepId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/envelopes/{envelopeId}/workflow/steps/{workflowStepId}/delayedRouting\",\n \"request_body\": {\n \"$ref\": \"#/definitions/delayedRouting\"\n },\n \"security\": null,\n \"skill_name\": \"envelope_workflow_delayed_routing_put_envelope_delayed_routing_definition\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Updates the delayed routing rules for an envelope's workflow step definition.\",\n \"tags\": [\n \"EnvelopeWorkflowDefinition\"\n ]\n },\n \"envelope_workflow_scheduled_sending_delete_envelope_scheduled_sending_definition\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Deletes the scheduled sending rules for an envelope's workflow. You cannot call this endpoint once the scheduled sending countdown has begun.\",\n \"destructive\": true,\n \"method\": \"DELETE\",\n \"operation_id\": \"envelope_workflow_scheduled_sending_delete_envelope_scheduled_sending_definition\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The envelope's GUID. \\n\\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\\n\",\n \"in\": \"path\",\n \"name\": \"envelopeId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/envelopes/{envelopeId}/workflow/scheduledSending\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"envelope_workflow_scheduled_sending_delete_envelope_scheduled_sending_definition\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Deletes the scheduled sending rules for the envelope's workflow.\",\n \"tags\": [\n \"EnvelopeWorkflowDefinition\"\n ]\n },\n \"envelope_workflow_scheduled_sending_get_envelope_scheduled_sending_definition\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Given a template and a workflow step, returns the scheduled sending rules for that workflow step.\\n\\n**Note:** If the workflow step does not have a scheduled sending object, this method returns a 404.\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"envelope_workflow_scheduled_sending_get_envelope_scheduled_sending_definition\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The envelope's GUID. \\n\\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\\n\",\n \"in\": \"path\",\n \"name\": \"envelopeId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/envelopes/{envelopeId}/workflow/scheduledSending\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"envelope_workflow_scheduled_sending_get_envelope_scheduled_sending_definition\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Returns the scheduled sending rules for an envelope's workflow definition.\",\n \"tags\": [\n \"EnvelopeWorkflowDefinition\"\n ]\n },\n \"envelope_workflow_scheduled_sending_put_envelope_scheduled_sending_definition\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Updates the scheduled sending rules for an envelope's workflow. The envelope must have an existing workflow object.\",\n \"destructive\": true,\n \"method\": \"PUT\",\n \"operation_id\": \"envelope_workflow_scheduled_sending_put_envelope_scheduled_sending_definition\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The envelope's GUID. \\n\\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\\n\",\n \"in\": \"path\",\n \"name\": \"envelopeId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/envelopes/{envelopeId}/workflow/scheduledSending\",\n \"request_body\": {\n \"$ref\": \"#/definitions/scheduledSending\"\n },\n \"security\": null,\n \"skill_name\": \"envelope_workflow_scheduled_sending_put_envelope_scheduled_sending_definition\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Updates the scheduled sending rules for an envelope's workflow.\",\n \"tags\": [\n \"EnvelopeWorkflowDefinition\"\n ]\n },\n \"envelope_workflow_step_delete_envelope_workflow_step_definition\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Deletes the workflow step specified by `workflowStepId` from an envelope specified by `envelopeId`.\",\n \"destructive\": true,\n \"method\": \"DELETE\",\n \"operation_id\": \"envelope_workflow_step_delete_envelope_workflow_step_definition\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The envelope's GUID. \\n\\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\\n\",\n \"in\": \"path\",\n \"name\": \"envelopeId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The ID of the workflow step.\",\n \"in\": \"path\",\n \"name\": \"workflowStepId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/envelopes/{envelopeId}/workflow/steps/{workflowStepId}\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"envelope_workflow_step_delete_envelope_workflow_step_definition\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Deletes a workflow step from an envelope's workflow definition.\",\n \"tags\": [\n \"EnvelopeWorkflowDefinition\"\n ]\n },\n \"envelope_workflow_step_get_envelope_workflow_step_definition\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Returns a workflow step specified by `workflowStepId` for an envelope specified by `envelopeId`.\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"envelope_workflow_step_get_envelope_workflow_step_definition\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The envelope's GUID. \\n\\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\\n\",\n \"in\": \"path\",\n \"name\": \"envelopeId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The ID of the workflow step.\",\n \"in\": \"path\",\n \"name\": \"workflowStepId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/envelopes/{envelopeId}/workflow/steps/{workflowStepId}\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"envelope_workflow_step_get_envelope_workflow_step_definition\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Returns a specified workflow step for a specified template.\",\n \"tags\": [\n \"EnvelopeWorkflowDefinition\"\n ]\n },\n \"envelope_workflow_step_post_envelope_workflow_step_definition\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Adds a new step to an envelope's workflow.\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"envelope_workflow_step_post_envelope_workflow_step_definition\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The envelope's GUID. \\n\\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\\n\",\n \"in\": \"path\",\n \"name\": \"envelopeId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/envelopes/{envelopeId}/workflow/steps\",\n \"request_body\": {\n \"$ref\": \"#/definitions/workflowStep\"\n },\n \"security\": null,\n \"skill_name\": \"envelope_workflow_step_post_envelope_workflow_step_definition\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Adds a new step to an envelope's workflow.\",\n \"tags\": [\n \"EnvelopeWorkflowDefinition\"\n ]\n },\n \"envelope_workflow_step_put_envelope_workflow_step_definition\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Updates the workflow step specified by `workflowStepId` for an envelope.\\n\\nYou can use this endpoint to add or update delayed routing for a draft envelope. You can add or update delayed routing for a sent envelope as long as the previous workflow step has not been completed.\",\n \"destructive\": true,\n \"method\": \"PUT\",\n \"operation_id\": \"envelope_workflow_step_put_envelope_workflow_step_definition\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The envelope's GUID. \\n\\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\\n\",\n \"in\": \"path\",\n \"name\": \"envelopeId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The ID of the workflow step.\",\n \"in\": \"path\",\n \"name\": \"workflowStepId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/envelopes/{envelopeId}/workflow/steps/{workflowStepId}\",\n \"request_body\": {\n \"$ref\": \"#/definitions/workflowStep\"\n },\n \"security\": null,\n \"skill_name\": \"envelope_workflow_step_put_envelope_workflow_step_definition\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Updates the specified workflow step for an envelope.\",\n \"tags\": [\n \"EnvelopeWorkflowDefinition\"\n ]\n },\n \"envelopes_get_envelope\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Retrieves the overall status for the specified envelope.\\nTo get the status of a list of envelopes, use\\n[Envelope: listStatusChanges ](/docs/esign-rest-api/reference/envelopes/envelopes/liststatuschanges/).\\n\\n### Related topics\\n\\n- [How to get envelope information](/docs/esign-rest-api/how-to/get-envelope-information/)\\n\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"envelopes_get_envelope\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The envelope's GUID. \\n\\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\\n\",\n \"in\": \"path\",\n \"name\": \"envelopeId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"When **true,** envelope information can be added or modified.\",\n \"in\": \"query\",\n \"name\": \"advanced_update\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Specifies additional information about the envelope to return. Enter a comma-separated list, such as `tabs,recipients`. Valid values are:\\n\\n- `custom_fields`: The custom fields associated with the envelope.\\n- `documents`: The documents associated with the envelope.\\n- `attachments`: The attachments associated with the envelope.\\n- `extensions`: The email settings associated with the envelope.\\n- `folders`: The folder where the envelope exists.\\n- `recipients`: The recipients associated with the envelope.\\n- `powerform`: The PowerForms associated with the envelope.\\n- `prefill_tabs`: The pre-filled tabs associated with the envelope.\\n- `tabs`: The tabs associated with the envelope.\\n- `payment_tabs`: The payment tabs associated with the envelope.\\n- `workflow`: The workflow definition associated with the envelope.\\n\",\n \"in\": \"query\",\n \"name\": \"include\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"When **true,** all tabs with anchor tab properties are included in the response. The default value is **false.**\",\n \"in\": \"query\",\n \"name\": \"include_anchor_tab_locations\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"\",\n \"in\": \"query\",\n \"name\": \"user_id\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/envelopes/{envelopeId}\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"envelopes_get_envelope\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Gets the status of a single envelope.\",\n \"tags\": [\n \"Envelopes\"\n ]\n },\n \"envelopes_get_envelopes\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"This method lets you [search for envelopes](/docs/esign-rest-api/esign101/concepts/envelopes/search/) in your accounts. A large set of filters let you narrow the scope of your search by date, by envelope ID, or by status codes. Your request must include one or more of the following parameters:\\n\\n* `from_date`\\n* `envelope_ids`\\n* `transaction_ids`\\n\\n### Restrictions\\n\\nThe number of envelopes returned is limited to 1,000 per call. To retrieve the next or previous set of envelopes, use the `nextUri` and `previousUri` parameters returned in the original call's response.\\n\\nIf no `from_date` query parameter is specified, envelopes from more than two years ago will not be returned. To fetch older envelopes, set the specific date range using the `from_date` and `to_date` parameters.\\n\\nTo avoid unnecessary database queries, the Docusign signature platform first checks requests to ensure that the filter set supplied does not result in a zero-size response before querying the database.\\n\\n### Envelope statuses\\n\\nThis table shows the valid current envelope statuses (`status` parameter) for the different status qualifiers (`from_to_status` parameter) in the request. If the status and status qualifiers in the API request do not contain any of the values shown in the Valid Current Statuses column, then an empty list is returned.\\n\\nClient applications should check that the statuses (`status` parameter) they are requesting make sense for a given `from_to_status` parameter value.\\n\\n| Status Qualifier<br>(`from_to_status`) | Effective Status Qualifier | Valid Current Statuses |\\n| :------------------------------------- | :------------------------- | :-------------------------------------------------------------------------- |\\n| any (changed) | StatusChanged | any, created, sent, delivered, signed, completed, declined, voided, deleted |\\n| created | Created | any, created, sent, delivered, signed, completed, declined, voided, deleted |\\n| sent | Sent | any, sent, delivered, signed, completed, declined, voided, deleted |\\n| delivered | StatusChanged | any, delivered, signed, completed, declined, voided, deleted |\\n| signed | StatusChanged | any, signed, completed, declined, voided, deleted |\\n| completed | Completed | any, completed, declined, voided, deleted |\\n| declined | StatusChanged | any, declined, voided, deleted |\\n| timedout<br>always return zero results | StatusChanged | any, voided, deleted |\\n| voided | Voided | any, voided, deleted |\\n| deleted | StatusChanged | any, deleted |\\n\\n### Extraneous results\\n\\nIn some cases, a request for a specific envelope status will\\ninclude envelopes with additional statuses. For example, in\\na request with a `from_date` of 2017-01-01, a `to_date` of\\n2017-01-07 and the status qualifier (`from_to_status`) set\\nto `delivered`, the response set might contain envelopes\\nthat were created during that time period, but not delivered\\nduring the time period. As a workaround, check the envelope\\nstatus values in the result set as needed.\\n\\n\\n### Related topics\\n\\n- [Searching for envelopes](/docs/esign-rest-api/esign101/concepts/envelopes/search/)\\n- [How to list envelope status changes](/docs/esign-rest-api/how-to/list-envelope-status-changes/)\\n\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"envelopes_get_envelopes\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Specifies the authoritative copy status for the envelopes. Valid values: \\n* `Unknown`\\n* `Original`\\n* `Transferred`\\n* `AuthoritativeCopy`\\n* `AuthoritativeCopyExportPending`\\n* `AuthoritativeCopyExported`\\n* `DepositPending`\\n* `Deposited`\\n* `DepositedEO`\\n* `DepositFailed`\",\n \"in\": \"query\",\n \"name\": \"ac_status\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Reserved for Docusign.\\n\",\n \"in\": \"query\",\n \"name\": \"block\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Reserved for Docusign.\\n\",\n \"in\": \"query\",\n \"name\": \"cdse_mode\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Reserved for Docusign.\",\n \"in\": \"query\",\n \"name\": \"continuation_token\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The maximum number of results to return.\\n\\nThe maximum value is 1000. To get the next or previous set of envelopes, use `nextUri` or `previousUri` from the response.\\n\",\n \"in\": \"query\",\n \"name\": \"count\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Optional. Specifies an envelope custom field name and value searched for in the envelopes. Format: `custom_envelope_field_name=desired_value`\\n\\nExample: If you have an envelope custom field named \\\"Region\\\" and you want to search for all envelopes where the value is \\\"West\\\" you would use set this parameter to `Region=West`. \\n \\n\",\n \"in\": \"query\",\n \"name\": \"custom_field\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Limit results to envelopes\\nsent by the account user\\nwith this email address.\\n\\n`user_name` must be given as well,\\nand both `email` and `user_name`\\nmust refer to an existing account user.\\n\",\n \"in\": \"query\",\n \"name\": \"email\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Comma separated list of `envelopeId` values.\",\n \"in\": \"query\",\n \"name\": \"envelope_ids\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Excludes information from the response. Enter as a comma-separated list (e.g., `folders,powerforms`). \\n\\nValid values:\\n\\n- `recipients`\\n- `powerforms`\\n- `folders`\\n\",\n \"in\": \"query\",\n \"name\": \"exclude\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Returns the envelopes from specific folders. Enter as a comma-separated list of either valid folder GUIDs or the following values: \\n\\n- `awaiting_my_signature`\\n- `completed`\\n- `draft`\\n- `drafts`\\n- `expiring_soon`\\n- `inbox`\\n- `out_for_signature`\\n- `recyclebin`\\n- `sentitems`\\n- `waiting_for_others`\",\n \"in\": \"query\",\n \"name\": \"folder_ids\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Returns the envelopes from folders of a specific type. Enter as a comma-separated list of the following values:\\n\\n- `normal`\\n- `inbox`\\n- `sentitems`\\n- `draft`\\n- `templates`\",\n \"in\": \"query\",\n \"name\": \"folder_types\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Specifies the date and time to start looking for status changes. This parameter is required unless `envelopeIds` or `transactionIds` are set.\\n\\nAlthough you can use any date format supported by the .NET system library's [`DateTime.Parse()`][msoft] function, Docusign recommends using [ISO 8601][] format dates with an explicit time zone offset. If you do not provide a time zone offset, the method uses the server's time zone.\\n\\nFor example, the following dates and times refer to the same instant:\\n\\n* `2017-05-02T01:44Z`\\n* `2017-05-01T21:44-04:00`\\n* `2017-05-01T18:44-07:00`\\n\\nIf this property is not included, envelopes from the last two years will be returned.\\n\\n[msoft]: https://docs.microsoft.com/en-us/dotnet/api/system.datetime.parse?redirectedfrom=MSDN&view=net-5.0#overloads\\n[ISO 8601]: https://en.wikipedia.org/wiki/ISO_8601\\n\",\n \"in\": \"query\",\n \"name\": \"from_date\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"This is the status type checked for in the `from_date`/`to_date` period. For example, if `Created` is specified, then envelopes created during the period are found. If `Changed` is specified, then envelopes that changed status during the period are returned. The default value is `Changed`.\\n\\nValid values:\\n* `Changed`\\n* `Voided`\\n* `Created`\\n* `Deleted`\\n* `Sent`\\n* `Delivered`\\n* `Signed`\\n* `Completed`\\n* `Declined`\\n* `TimedOut`\\n* `Processing`\\n\",\n \"in\": \"query\",\n \"name\": \"from_to_status\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Specifies additional information to return about the envelopes.\\nUse a comma-separated list, such as `folders, recipients` to specify information.\\nValid values are:\\n\\n- `custom_fields`: The custom fields associated with the envelope.\\n- `documents`: The documents associated with the envelope.\\n- `attachments`: The attachments associated with the envelope.\\n- `extensions`: Information about the email settings associated with the envelope.\\n- `folders`: The folders where the envelope exists.\\n- `recipients`: The recipients associated with the envelope.\\n- `payment_tabs`: The payment tabs associated with the envelope.\\n\",\n \"in\": \"query\",\n \"name\": \"include\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"When **true,** information about envelopes that have been deleted is included in the response.\",\n \"in\": \"query\",\n \"name\": \"include_purge_information\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"A comma-separated list of folders from which you want to get envelopes. Valid values: \\n\\n- `normal`\\n- `inbox`\\n- `sentitems`\\n- `draft`\\n- `templates`\\n\",\n \"in\": \"query\",\n \"name\": \"intersecting_folder_ids\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Returns envelopes that were modified prior to the specified date and time. \\n\\nExample: `2020-05-09T21:56:12.2500000Z`\",\n \"in\": \"query\",\n \"name\": \"last_queried_date\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Returns envelopes in either ascending (`asc`) or descending (`desc`) order.\",\n \"in\": \"query\",\n \"name\": \"order\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Sorts results according to a specific property. Valid values:\\n\\n- `last_modified`\\n- `action_required`\\n- `created`\\n- `completed`\\n- `envelope_name`\\n- `expire`\\n- `sent`\\n- `signer_list`\\n- `status`\\n- `subject`\\n- `user_name`\\n- `status_changed`\\n- `last_modified`\",\n \"in\": \"query\",\n \"name\": \"order_by\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"A comma-separated list of `PowerFormId` values.\",\n \"in\": \"query\",\n \"name\": \"powerformids\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The time in seconds that the query should run before returning data.\",\n \"in\": \"query\",\n \"name\": \"query_budget\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"\",\n \"in\": \"query\",\n \"name\": \"requester_date_format\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"\",\n \"in\": \"query\",\n \"name\": \"search_mode\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Free text search criteria that you can use to filter the list of envelopes that is returned.\",\n \"in\": \"query\",\n \"name\": \"search_text\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The zero-based index of the\\nresult from which to start returning results.\\n\\nUse with `count` to limit the number\\nof results.\\n\\nThe default value is `0`.\\n\",\n \"in\": \"query\",\n \"name\": \"start_position\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"A comma-separated list of current envelope statuses to be included in the response. Valid values:\\n\\n* `completed`\\n* `created`\\n* `declined`\\n* `deleted`\\n* `delivered`\\n* `processing`\\n* `sent`\\n* `signed`\\n* `timedout`\\n* `voided`\\n\\nThe `any` value is equivalent to any status.\\n\",\n \"in\": \"query\",\n \"name\": \"status\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Specifies the date and time\\nto stop looking for status changes.\\nThe default is the current date and time.\\n\\nAlthough you can use any date format\\nsupported by the .NET system library's\\n[`DateTime.Parse()`][msoft] function,\\nDocusign recommends\\nusing [ISO 8601][] format dates\\nwith an explicit time zone offset\\nIf you do not provide\\na time zone offset,\\nthe method uses the server's time zone.\\n\\nFor example, the following dates and times refer to the same instant:\\n\\n* `2017-05-02T01:44Z`\\n* `2017-05-01T21:44-04:00`\\n* `2017-05-01T18:44-07:00`\\n\\n\\n[msoft]: https://docs.microsoft.com/en-us/dotnet/api/system.datetime.parse?redirectedfrom=MSDN&view=net-5.0#overloads\\n[ISO 8601]: https://en.wikipedia.org/wiki/ISO_8601\\n\",\n \"in\": \"query\",\n \"name\": \"to_date\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"A comma-separated list of envelope transaction IDs.\\n\\nGetting envelope status by transaction IDs is useful for offline signing situations to determine if an envelope was created or not. It can be used for the cases where a network connection was lost before the envelope status could be returned.\\n\\n**Note:** Transaction IDs are only valid in the Docusign system for seven days.\\n\",\n \"in\": \"query\",\n \"name\": \"transaction_ids\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Returns envelopes where the current user is the recipient, the sender, or the recipient only. (For example, `user_filter=sender`.) Valid values are:\\n\\n- `sender`\\n- `recipient`\\n- `recipient_only`\",\n \"in\": \"query\",\n \"name\": \"user_filter\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The ID of the user who created the envelopes to be retrieved. Note that an account can have multiple users, and any user with account access can retrieve envelopes by user_id from the account.\",\n \"in\": \"query\",\n \"name\": \"user_id\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Limit results to envelopes\\nsent by the account user\\nwith this user name.\\n\\n`email` must be given as well,\\nand both `email` and `user_name`\\nmust refer to an existing account user.\\n\",\n \"in\": \"query\",\n \"name\": \"user_name\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/envelopes\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"envelopes_get_envelopes\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Search for specific sets of envelopes by using search filters.\",\n \"tags\": [\n \"Envelopes\"\n ]\n },\n \"envelopes_post_envelopes\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Creates and sends an envelope or creates a draft envelope.\\nEnvelopes are fundamental resources in the Docusign platform.\\n\\n\\nWith this method you can:\\n\\n* Create and send an envelope\\n with [documents][], [recipients][], and [tabs][].\\n* [Create and send an envelope from a template](/docs/esign-rest-api/esign101/concepts/templates/).\\n* [Create and send an envelope from\\n a combination of documents and templates](/docs/esign-rest-api/esign101/concepts/templates/composite/).\\n* Create a draft envelope.\\n\\n\\nWhen you use this method\\nto create and send an envelope\\nin a single request,\\nthe following parameters in the request body (an [`envelopeDefinition`][envelopeDefinition] object) are required:\\n\\n| Parameter | Description |\\n| :-------- | :---------- |\\n| `status` | Set to `sent` to send the envelope to recipients.<br>Set to `created` (or don't set at all) to save the envelope as a draft. |\\n| `emailSubject` | The subject of the email used to send the envelope. |\\n| `documents` | The [documents][] to be signed. |\\n| `recipients` | The email addresses of the envelope [recipients][]. |\\n\\n\\nWhen you create an envelope by using a\\n[composite template](/docs/esign-rest-api/esign101/concepts/templates/composite/),\\nyou should specify the envelope custom fields in the inline template.\\nAny custom fields that you specify at the root level are ignored.\\n\\nIf the envelope has a workflow definition\\nand the `workflowStatus` is `paused`,\\nthe envelope will not be sent immediately,\\neven if the envelope's `status` is `sent`.\\n\\n\\n### Related topics\\n\\n[Envelope][envelopes] and [template][templates]\\nobjects along with [documents][documents],\\n[recipients][recipients], and [tabs][tabs]\\nare the five object models at the core of the eSignature API.\\nThe [eSignature concepts guide](/docs/esign-rest-api/esign101/concepts/)\\ndescribes how the five object models work together.\\n\\nThe following how-to articles contain\\npractical examples that show you how to\\nto\\nconfigure this method's\\n[`envelopeDefinition`][envelopeDefinition] request body\\nto perform common tasks.\\n\\nRequesting a signature\\n\\n- [How to request a signature by email](/docs/esign-rest-api/how-to/request-signature-email-remote/)\\n- [How to request a signature through your app](/docs/esign-rest-api/how-to/request-signature-in-app-embedded/)\\n- [How to request a signature by email using a template](/docs/esign-rest-api/how-to/request-signature-template-remote/)\\n- [How to request a signature using a composite template](/docs/esign-rest-api/how-to/request-signature-composite-template-embedded/)\\n- [How to request a signature by SMS or WhatsApp delivery](/docs/esign-rest-api/how-to/request-signature-sms-whatsapp/)\\n- [How to send a request for payment](/docs/esign-rest-api/how-to/request-a-payment/)\\n- [How to send an envelope to an In Person Signer](/docs/esign-rest-api/how-to/send-envelope-to-in-person-signer/)\\n- [How to request a signature by email using CORS](/docs/esign-rest-api/how-to/request-signature-email-browser-cors/)\\n- [How to request a signature through your CORS-enabled browser app](/docs/esign-rest-api/how-to/request-signature-in-cors-app-embedded/)\\n- [How to request a signature through your app (embedded signing) with a CFR Part 11 account](/docs/esign-rest-api/how-to/request-signature-in-app-embedded-cfrpart11/)\\n\\nWorking with envelopes and templates\\n\\n- [How to get envelope information](/docs/esign-rest-api/how-to/get-envelope-information/)\\n- [How to list envelope recipients](/docs/esign-rest-api/how-to/get-envelope-recipients/)\\n- [How to list envelope status changes](/docs/esign-rest-api/how-to/list-envelope-status-changes/)\\n- [How to create a template](/docs/esign-rest-api/how-to/create-template/)\\n- [How to send an envelope via your app](/docs/esign-rest-api/how-to/embedded-sending/)\\n- [How to bulk send envelopes](/docs/esign-rest-api/how-to/bulk-send-envelopes/)\\n\\nWorking with advanced recipient routing\\n\\n- [How to pause a signature workflow](/docs/esign-rest-api/how-to/pause-workflow/)\\n- [How to unpause a signature workflow](/docs/esign-rest-api/how-to/unpause-workflow/)\\n- [How to use conditional recipients](/docs/esign-rest-api/how-to/use-conditional-recipients/)\\n- [How to schedule an envelope](/docs/esign-rest-api/how-to/schedule-an-envelope/)\\n- [How to send an envelope with delayed routing](/docs/esign-rest-api/how-to/send-envelope-with-delayed-routing/)\\n\\nWorking with documents\\n\\n- [How to list envelope documents](/docs/esign-rest-api/how-to/list-envelope-documents/)\\n- [How to download envelope documents](/docs/esign-rest-api/how-to/download-envelope-documents/)\\n- [How to attach documents via binary transfer](/docs/esign-rest-api/how-to/send-binary/)\\n- [How to create a signable HTML document](/docs/esign-rest-api/how-to/creating-signable-html/)\\n- [How to convert a PDF file into a signable HTML document](/docs/esign-rest-api/how-to/converting-pdf/)\\n- [How to set document visibility for envelope recipients](/docs/esign-rest-api/how-to/set-document-visibility/)\\n- [How to request a signature by email with document generation](/docs/esign-rest-api/how-to/request-signature-email-document-generation/)\\n\\nWorking with tabs\\n\\n- [How to get envelope tab values](/docs/esign-rest-api/how-to/get-envelope-tab-values/)\\n- [How to get envelope custom tab values](/docs/esign-rest-api/how-to/get-envelope-custom-tab-values/)\\n- [How to set envelope tab values](/docs/esign-rest-api/how-to/set-envelope-tab-values/)\\n- [How to set tab values in a template](/docs/esign-rest-api/how-to/set-template-tab-values/)\\n\\nWorking with brands\\n\\n- [How to create a brand](/docs/esign-rest-api/how-to/create-brand/)\\n- [How to apply a brand to an envelope](/docs/esign-rest-api/how-to/apply-brand-to-envelope/)\\n- [How to apply a brand and template to an envelope](/docs/esign-rest-api/how-to/apply-brand-and-template-to-envelope/)\\n\\nWorking with permissions\\n\\n- [How to create a permission profile](/docs/esign-rest-api/how-to/permission-profile-creating/)\\n- [How to update individual permission settings](/docs/esign-rest-api/how-to/permission-profile-updating/)\\n- [How to set a permission profile](/docs/esign-rest-api/how-to/permission-profile-setting/)\\n- [How to delete a permission profile](/docs/esign-rest-api/how-to/permission-profile-deleting/)\\n\\nImplementing multi-factor recipient (signer) authentication\\n\\n- [How to require ID verification (IDV) for a recipient](/docs/esign-rest-api/how-to/id-verification/)\\n- [How to require knowledge-based authentication (KBA) for a recipient](/docs/esign-rest-api/how-to/knowledge-based-authentication/)\\n- [How to require phone authentication for a recipient](/docs/esign-rest-api/how-to/phone-auth/)\\n- [How to require access code authentication for a recipient](/docs/esign-rest-api/how-to/require-access-code-recipient/)\\n\\n<!-- this should mirror /docs/esign-rest-api/how-to/ -->\\n\\n\\n\\n[addingdocs]: /docs/esign-rest-api/esign101/concepts/envelopes/\\n[attachments]: /docs/esign-rest-api/esign101/concepts/documents/attachments/\\n[authcopies]: /docs/esign-rest-api/esign101/concepts/documents/authoritative-copies/\\n[conoverview]: /docs/esign-rest-api/esign101/concepts/overview/\\n[deleting]: /docs/esign-rest-api/esign101/concepts/envelopes/\\n[documents]: /docs/esign-rest-api/esign101/concepts/documents/\\n[envelopeDefinition]: /docs/esign-rest-api/reference/envelopes/envelopes/create/#schema__envelopedefinition\\n[envelopes]: /docs/esign-rest-api/esign101/concepts/envelopes/\\n[locking]: /docs/esign-rest-api/esign101/concepts/envelopes/lock/\\n[payments]: /docs/esign-rest-api/esign101/concepts/tabs/payment/\\n[purging]: /docs/esign-rest-api/esign101/concepts/documents/purging/\\n[recipients]: /docs/esign-rest-api/esign101/concepts/recipients/\\n[recipstatus]: /docs/esign-rest-api/esign101/concepts/recipients/#recipient-status\\n[reciptypes]: /docs/esign-rest-api/esign101/concepts/recipients/#recipient-types\\n[supdocs]: /docs/esign-rest-api/esign101/concepts/documents/supplemental/\\n[tabanchor]: /docs/esign-rest-api/esign101/concepts/tabs/auto-place/\\n[tabcustom]: /docs/esign-rest-api/esign101/concepts/tabs/custom-tabs/\\n[tabs]: /docs/esign-rest-api/esign101/concepts/tabs/\\n[tabtypes]: /docs/esign-rest-api/esign101/concepts/tabs/\\n[templates]: /docs/esign-rest-api/esign101/concepts/templates/\\n[tracking]: /docs/esign-rest-api/esign101/concepts/envelopes/\\n\\n\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"envelopes_post_envelopes\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Reserved for Docusign.\\n\",\n \"in\": \"query\",\n \"name\": \"cdse_mode\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"When true, users can define the routing order of recipients while sending documents for signature.\",\n \"in\": \"query\",\n \"name\": \"change_routing_order\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Reserved for Docusign.\\n\",\n \"in\": \"query\",\n \"name\": \"completed_documents_only\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"When **true,** template roles will be merged, and empty recipients will be removed. This parameter applies when you create a draft envelope with multiple templates. (To create a draft envelope, the `status` field is set to `created`.)\\n\\n**Note:** Docusign recommends that this parameter should be set to **true** whenever you create a draft envelope with multiple templates.\",\n \"in\": \"query\",\n \"name\": \"merge_roles_on_draft\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/envelopes\",\n \"request_body\": {\n \"$ref\": \"#/definitions/envelopeDefinition\"\n },\n \"security\": null,\n \"skill_name\": \"envelopes_post_envelopes\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Creates an envelope.\",\n \"tags\": [\n \"Envelopes\"\n ]\n },\n \"envelopes_put_envelope\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"This method enables you to make changes to an envelope.\\nYou can use it to:\\n\\n* [Send a draft envelope](#sending-a-draft-envelope)\\n* [Void an in-process envelope](#voiding-an-in-process-envelope)\\n* [Modify a draft envelope](#modifying-envelope-email-information)\\n* [Purge documents and envelope metadata from the Docusign platform](#purging-documents-from-docusign)\\n\\nAlthough the request body for this method\\nis a complete envelope definition,\\nyou only need to provide\\nthe properties that\\nyou're updating.\\n\\n## Sending a draft envelope\\n\\nTo send a draft envelope, include the following code in the request body:\\n\\n```json\\n{\\n \\\"status\\\": \\\"sent\\\"\\n}\\n```\\n\\nYou can attach a workflow before sending the envelope:\\n\\n```json\\n{\\n \\\"status\\\": \\\"sent\\\",\\n \\\"workflow\\\": {\\n \\\"workflowSteps\\\": [\\n {\\n \\\"action\\\": \\\"pause_before\\\",\\n \\\"description\\\": \\\"pause_before routing order 2\\\",\\n \\\"itemId\\\": 2,\\n \\\"triggerOnItem\\\": \\\"routing_order\\\"\\n }\\n ]\\n }\\n}\\n```\\n\\n## Working with workflows\\n\\nTo unpause a workflow, the request body should include this:\\n\\n```json\\n{\\n \\\"workflow\\\": {\\n \\\"workflowStatus\\\": \\\"in_progress\\\"\\n }\\n}\\n```\\n\\n## Voiding an in-process envelope\\n\\nTo void an in-process envelope, include the following code in the request body:\\n\\n```json\\n{\\n \\\"status\\\": \\\"voided\\\",\\n \\\"voidedReason\\\": \\\"The reason for voiding the envelope\\\"\\n}\\n```\\n\\n## Modifying envelope email information\\n\\nTo change the email subject and message of a draft envelope,\\ninclude the following code in the request body:\\n\\n```json\\n{\\n \\\"emailSubject\\\": \\\"new email subject\\\",\\n \\\"emailBlurb\\\": \\\"new email message\\\"\\n}\\n```\\n\\n## Purging documents from Docusign\\n\\nTo place only the documents\\nin the purge queue,\\nleaving any\\ncorresponding attachments\\nand tabs in the Docusign platform,\\nset the `purgeState` property\\nto `documents_queued`.\\n\\n```json\\n{\\n \\\"envelopeId\\\": \\\"222e6847-xxxx-xxxx-xxxx-72a3c9c16fca\\\",\\n \\\"purgeState\\\": \\\"documents_queued\\\"\\n}\\n```\\n\\nTo place documents,\\nattachments,\\nand tabs\\nin the purge queue,\\nset the `purgeState` property\\nto `documents_and_metadata_queued`.\\n\\n```json\\n{\\n \\\"envelopeId\\\": \\\"222e6847-xxxx-xxxx-xxxx-72a3c9c16fca\\\",\\n \\\"purgeState\\\": \\\"documents_and_metadata_queued\\\"\\n}\\n```\\n\\nTo place documents,\\nattachments,\\nand tabs\\nin the purge queue\\nand to redact personal information,\\nset the `purgeState` property\\nto `documents_and_metadata_and_redact_queued`.\\n\\n```json\\n{\\n \\\"envelopeId\\\": \\\"222e6847-xxxx-xxxx-xxxx-72a3c9c16fca\\\",\\n \\\"purgeState\\\": \\\"documents_and_metadata_and_redact_queued\\\"\\n}\\n```\\n\\nYou can purge documents\\nonly from completed envelopes\\nthat are not marked as the authoritative copy.\\nThe user requesting the purge\\nmust have permission to purge documents\\nand\\nmust be the sender or be acting on behalf of the sender.\\n\\nWhen the purge request is initiated\\nthe items to be purged\\nare placed in the purge queue\\nfor deletion in 14 days.\\nThe sender\\nand\\nall recipients with Docusign accounts\\nassociated with the envelope\\nget an email notification\\nthe documents will be deleted in 14 days.\\nThe notification contains a link\\nto the documents.\\nA second email notification\\nis sent 7 days later.\\nAt the end of the 14-day period\\nthe documents are deleted from the system.\\nRecipients without Docusign accounts\\ndo not receive email notifications.\\n\\nIf your account has a Document Retention policy,\\nenvelope documents\\nare automatically placed\\nin the purge queue,\\nand notification emails are sent\\nat the end of the retention period.\\nSetting a Document Retention policy is the same as setting a\\nschedule for purging documents.\\n\\n## Removing documents from the purge queue\\n\\nTo remove documents from the purge queue, include the following code in the request body:\\n\\n```json\\n{\\n \\\"envelopeId\\\": \\\"222e6847-xxxx-xxxx-xxxx-72a3c9c16fca\\\",\\n \\\"purgeState\\\": \\\"documents_dequeued\\\"\\n}\\n```\\n\\n### Related topics\\n\\n- [Void an envelope](https://www.docusign.com/blog/dsdev-common-api-tasks-void-an-envelope) ([Common API Tasks](https://www.docusign.com/blog/tags/common-api-tasks))\\n- [Purging documents (eSignature Concepts)](/docs/esign-rest-api/esign101/concepts/documents/purging/)\\n- [Purging documents in an envelope (blog post)](https://www.docusign.com/blog/developers/purging-documents-envelope)\\n- [How to unpause a signature workflow](/docs/esign-rest-api/how-to/unpause-workflow/)\\n\",\n \"destructive\": true,\n \"method\": \"PUT\",\n \"operation_id\": \"envelopes_put_envelope\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The envelope's GUID. \\n\\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\\n\",\n \"in\": \"path\",\n \"name\": \"envelopeId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"When **true,** allows the caller to update recipients, tabs, custom fields, notification, email settings and other envelope attributes.\",\n \"in\": \"query\",\n \"name\": \"advanced_update\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"\",\n \"in\": \"query\",\n \"name\": \"recycle_on_void\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"When **true,**\\nsends the specified envelope again.\",\n \"in\": \"query\",\n \"name\": \"resend_envelope\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/envelopes/{envelopeId}\",\n \"request_body\": {\n \"$ref\": \"#/definitions/envelope\"\n },\n \"security\": null,\n \"skill_name\": \"envelopes_put_envelope\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Send, void, or modify a draft envelope. Purge documents from a completed envelope.\",\n \"tags\": [\n \"Envelopes\"\n ]\n },\n \"envelopes_put_status\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Retrieves envelope statuses for a set of envelopes. `Envelopes: listStatus` has both a `GET` and a `PUT` implementation:\\n* `PUT /restapi/v2.1/accounts/{accountId}/envelopes/status` is passed a set of envelope IDs in the request body. This version of the method returns a smaller subset of envelope information.\\n* `GET /restapi/v2.1/accounts/{accountId}/envelopes/status` is passed a list of envelope IDs in a query string.\\n\\n<ds-inlinemessage>\\nTo search for envelopes using a broad range of filters, use\\n<a href=\\\"/docs/esign-rest-api/reference/envelopes/envelopes/liststatuschanges/\\\">Envelopes: listStatusChanges</a>\\ninstead of this method.\\n</ds-inlinemessage>\\n\\nYou must specify exactly one of the following query parameters:\\n\\n| Parameter | Description |\\n| :---------------- | :------------------------------------------------------------------------------- |\\n| `from_date` | a valid UTC DateTime: `2016-01-01` |\\n| `envelope_ids` | <ul><li>For the <code>GET</code> implementation of this method, include the envelope IDs in a comma-separated list. </li><li>For the <code>PUT</code> version of this method, you should use the <code>request_body</code> value for this parameter and include the list of envelope IDs in the request body.</li></ul> |\\n| `transaction_ids` | A comma-separated list of transaction IDs<br>or the special value <code>request_body</code> |\\n\\nWhen you use the special value `request_body`, the request body looks like this:\\n\\n```\\n{\\n \\\"envelopeIds\\\": [\\n \\\"44c5ad6c-xxxx-xxxx-xxxx-ebda5e2dfe15\\\",\\n \\\"8e26040d-xxxx-xxxx-xxxx-1e29b924d237\\\",\\n \\\"c8b40a2d-xxxx-xxxx-xxxx-4fe56fe10f95\\\"\\n ]\\n}\\n```\\n\\n<ds-inlinemessage kind=\\\"warning\\\">\\nOmitting the request body altogether causes the endpoint to return an error.\\nThe request body must be at least <code>{}</code>.\\n</ds-inlinemessage>\\n\\n### Related topics\\n\\n- [Searching for envelopes](/docs/esign-rest-api/esign101/concepts/envelopes/search/)\\n- [How to list envelope status changes](/docs/esign-rest-api/how-to/list-envelope-status-changes/)\\n\",\n \"destructive\": true,\n \"method\": \"PUT\",\n \"operation_id\": \"envelopes_put_status\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Specifies the Authoritative Copy Status for the envelopes. Valid values: \\n\\n- `Unknown`\\n- `Original`\\n- `Transferred`\\n- `AuthoritativeCopy`\\n- `AuthoritativeCopyExportPending`\\n- `AuthoritativeCopyExported`\\n- `DepositPending`\\n- `Deposited`\\n- `DepositedEO`\\n- `DepositFailed`\",\n \"in\": \"query\",\n \"name\": \"ac_status\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"When **true,** removes any results that match one of the provided `transaction_ids`.\",\n \"in\": \"query\",\n \"name\": \"block\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The maximum number of results to return.\\n\\nUse `start_position` to specify the number of results to skip.\\n\\n\",\n \"in\": \"query\",\n \"name\": \"count\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The email address of the sender.\",\n \"in\": \"query\",\n \"name\": \"email\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The envelope IDs to include in the results.\\n\\nThe value of this property can be:\\n* For the `GET` implementation of this method, use a comma-separated list of envelope IDs.\\n* For the `PUT` implementation of this method, use the `request_body` value, and include the envelope IDs in the request body. \\n\",\n \"in\": \"query\",\n \"name\": \"envelope_ids\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The date/time setting that specifies when the request begins checking for status changes for envelopes in the account. This is required unless parameters `envelope_ids` and/or `transaction_Ids` are provided.\\n\\n**Note:** This parameter must be set to a valid `DateTime`, or `envelope_ids` and/or `transaction_ids` must be specified.\",\n \"in\": \"query\",\n \"name\": \"from_date\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The envelope status that you are checking for. Possible values are:\\n\\n\\n- `Changed` (default)\\n- `Completed`\\n- `Created`\\n- `Declined`\\n- `Deleted`\\n- `Delivered`\\n- `Processing`\\n- `Sent`\\n- `Signed`\\n- `TimedOut`\\n- `Voided`\\n\\nFor example, if you specify `Changed`, this method\\nreturns a list of envelopes that changed status\\nduring the `from_date` to `to_date` time period. \\n\",\n \"in\": \"query\",\n \"name\": \"from_to_status\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The zero-based index of the\\nresult from which to start returning results.\\n\\nUse with `count` to limit the number\\nof results.\\n\\nThe default value is `0`.\\n\",\n \"in\": \"query\",\n \"name\": \"start_position\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"A comma-separated list of envelope status to search for. Possible values are:\\n\\n- `completed`\\n- `created`\\n- `declined`\\n- `deleted`\\n- `delivered`\\n- `processing`\\n- `sent`\\n- `signed`\\n- `template`\\n- `voided`\\n\",\n \"in\": \"query\",\n \"name\": \"status\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Optional date/time setting\\nthat specifies the last date/time \\nor envelope status changes in the result set. \\n\\nThe default value is the time that you call the method. \\n\",\n \"in\": \"query\",\n \"name\": \"to_date\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The transaction IDs to include in the results. Note that transaction IDs are valid for seven days.\\n\\nThe value of this property can be:\\n- A list of comma-separated transaction IDs\\n- The special value `request_body`. In this case, this method uses the transaction IDs in the request body.\",\n \"in\": \"query\",\n \"name\": \"transaction_ids\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Limits results to envelopes\\nsent by the account user\\nwith this user name.\\n\\n`email` must be given as well,\\nand both `email` and `user_name`\\nmust refer to an existing account user.\\n\",\n \"in\": \"query\",\n \"name\": \"user_name\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/envelopes/status\",\n \"request_body\": {\n \"$ref\": \"#/definitions/envelopeIdsRequest\"\n },\n \"security\": null,\n \"skill_name\": \"envelopes_put_status\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Gets envelope statuses for a set of envelopes.\",\n \"tags\": [\n \"Envelopes\"\n ]\n },\n \"envelopes_shares_delete_envelopes_share\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"EnvelopesShares_DeleteEnvelopesShare\",\n \"destructive\": true,\n \"method\": \"DELETE\",\n \"operation_id\": \"envelopes_shares_delete_envelopes_share\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The envelope's GUID. \\n\\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\\n\",\n \"in\": \"path\",\n \"name\": \"envelopeId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"\",\n \"in\": \"path\",\n \"name\": \"shareId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/envelopes/{envelopeId}/shares/{shareId}\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"envelopes_shares_delete_envelopes_share\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"EnvelopesShares_DeleteEnvelopesShare\",\n \"tags\": [\n \"EnvelopeShares\"\n ]\n },\n \"envelopes_shares_delete_envelopes_shares\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"EnvelopesShares_DeleteEnvelopesShares\",\n \"destructive\": true,\n \"method\": \"DELETE\",\n \"operation_id\": \"envelopes_shares_delete_envelopes_shares\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The envelope's GUID. \\n\\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\\n\",\n \"in\": \"path\",\n \"name\": \"envelopeId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/envelopes/{envelopeId}/shares\",\n \"request_body\": {\n \"$ref\": \"#/definitions/envelopesSharesRequest\"\n },\n \"security\": null,\n \"skill_name\": \"envelopes_shares_delete_envelopes_shares\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"EnvelopesShares_DeleteEnvelopesShares\",\n \"tags\": [\n \"EnvelopeShares\"\n ]\n },\n \"envelopes_shares_get_envelopes_share\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"EnvelopesShares_GetEnvelopesShare\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"envelopes_shares_get_envelopes_share\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The envelope's GUID. \\n\\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\\n\",\n \"in\": \"path\",\n \"name\": \"envelopeId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"\",\n \"in\": \"path\",\n \"name\": \"shareId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/envelopes/{envelopeId}/shares/{shareId}\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"envelopes_shares_get_envelopes_share\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"EnvelopesShares_GetEnvelopesShare\",\n \"tags\": [\n \"EnvelopeShares\"\n ]\n },\n \"envelopes_shares_get_envelopes_shares\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"EnvelopesShares_GetEnvelopesShares\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"envelopes_shares_get_envelopes_shares\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The envelope's GUID. \\n\\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\\n\",\n \"in\": \"path\",\n \"name\": \"envelopeId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/envelopes/{envelopeId}/shares\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"envelopes_shares_get_envelopes_shares\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"EnvelopesShares_GetEnvelopesShares\",\n \"tags\": [\n \"EnvelopeShares\"\n ]\n },\n \"envelopes_shares_post_envelopes_shares\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"EnvelopesShares_PostEnvelopesShares\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"envelopes_shares_post_envelopes_shares\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The envelope's GUID. \\n\\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\\n\",\n \"in\": \"path\",\n \"name\": \"envelopeId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/envelopes/{envelopeId}/shares\",\n \"request_body\": {\n \"$ref\": \"#/definitions/envelopesSharesRequest\"\n },\n \"security\": null,\n \"skill_name\": \"envelopes_shares_post_envelopes_shares\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"EnvelopesShares_PostEnvelopesShares\",\n \"tags\": [\n \"EnvelopeShares\"\n ]\n },\n \"envelopes_shares_put_envelopes_share\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"EnvelopesShares_PutEnvelopesShare\",\n \"destructive\": true,\n \"method\": \"PUT\",\n \"operation_id\": \"envelopes_shares_put_envelopes_share\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The envelope's GUID. \\n\\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\\n\",\n \"in\": \"path\",\n \"name\": \"envelopeId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"\",\n \"in\": \"path\",\n \"name\": \"shareId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/envelopes/{envelopeId}/shares/{shareId}\",\n \"request_body\": {\n \"$ref\": \"#/definitions/envelopesSharePermissionRequest\"\n },\n \"security\": null,\n \"skill_name\": \"envelopes_shares_put_envelopes_share\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"EnvelopesShares_PutEnvelopesShare\",\n \"tags\": [\n \"EnvelopeShares\"\n ]\n },\n \"envelopes_shares_put_envelopes_shares\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"EnvelopesShares_PutEnvelopesShares\",\n \"destructive\": true,\n \"method\": \"PUT\",\n \"operation_id\": \"envelopes_shares_put_envelopes_shares\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The envelope's GUID. \\n\\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\\n\",\n \"in\": \"path\",\n \"name\": \"envelopeId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/envelopes/{envelopeId}/shares\",\n \"request_body\": {\n \"$ref\": \"#/definitions/envelopesSharesRequest\"\n },\n \"security\": null,\n \"skill_name\": \"envelopes_shares_put_envelopes_shares\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"EnvelopesShares_PutEnvelopesShares\",\n \"tags\": [\n \"EnvelopeShares\"\n ]\n },\n \"favorite_templates_get_favorite_templates\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Retrieves the list of favorite templates for the account.\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"favorite_templates_get_favorite_templates\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/favorite_templates\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"favorite_templates_get_favorite_templates\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Retrieves the list of favorite templates for the account.\",\n \"tags\": [\n \"FavoriteTemplates\"\n ]\n },\n \"favorite_templates_put_favorite_template\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Set one or more templates as account favorites.\\n\\nYour request should include each template as a separate `favoriteTemplatesContentItem` JSON object, like this:\\n```\\n{\\n \\\"favoriteTemplates\\\": [\\n {\\n \\\"templateId\\\": \\\"6bc0584f-xxxx-xxxx-xxxx-35ab28cc44e1\\\"\\n },\\n {\\n \\\"templateId\\\": \\\"8ae9b3452-xxxx-xxxx-xxx-ac0de23fa57f\\\"\\n }\\n ]\\n}\\n```\\n\",\n \"destructive\": true,\n \"method\": \"PUT\",\n \"operation_id\": \"favorite_templates_put_favorite_template\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/favorite_templates\",\n \"request_body\": {\n \"$ref\": \"#/definitions/favoriteTemplatesInfo\"\n },\n \"security\": null,\n \"skill_name\": \"favorite_templates_put_favorite_template\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Set one or more templates as account favorites.\",\n \"tags\": [\n \"FavoriteTemplates\"\n ]\n },\n \"favorite_templates_un_favorite_template\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Remove one or more templates from the account favorites. \\n\\nYour request should include each template to remove as a separate `favoriteTemplatesContentItem` JSON object, like this:\\n```\\n{\\n \\\"favoriteTemplates\\\": [\\n {\\n \\\"templateId\\\": \\\"6bc0584f-xxxx-xxxx-xxxx-35ab28cc44e1\\\"\\n },\\n {\\n \\\"templateId\\\": \\\"8ae9b3452-xxxx-xxxx-xxx-ac0de23fa57f\\\"\\n }\\n ]\\n}\\n```\\n\\nThe response includes the IDs of the templates that were successfully removed from your favorites. To get the account's remaining favorite templates, use the [getFavoriteTemplates](/docs/esign-rest-api/reference/accounts/favoritetemplates/getfavoritetemplates/) endpoint.\",\n \"destructive\": true,\n \"method\": \"DELETE\",\n \"operation_id\": \"favorite_templates_un_favorite_template\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/favorite_templates\",\n \"request_body\": {\n \"$ref\": \"#/definitions/favoriteTemplatesInfo\"\n },\n \"security\": null,\n \"skill_name\": \"favorite_templates_un_favorite_template\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Remove one or more templates from the account favorites.\",\n \"tags\": [\n \"FavoriteTemplates\"\n ]\n },\n \"folders_get_folder_items\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Gets information about items in the specified folder. \\n\\nTo include a list of the items in the folder, set the `include_items` query parameter to **true.**\\n\\n### Related topics\\n\\n- [Searching for envelopes](/docs/esign-rest-api/esign101/concepts/envelopes/search/)\\n- [Sharing templates](/docs/esign-rest-api/esign101/concepts/templates/sharing/)\\n\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"folders_get_folder_items\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The ID of the folder.\",\n \"in\": \"path\",\n \"name\": \"folderId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Reserved for Docusign.\",\n \"in\": \"query\",\n \"name\": \"from_date\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Indicates whether folder items are included in the response. If this parameter is omitted, the default is false.\",\n \"in\": \"query\",\n \"name\": \"include_items\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Reserved for Docusign.\",\n \"in\": \"query\",\n \"name\": \"owner_email\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Reserved for Docusign.\",\n \"in\": \"query\",\n \"name\": \"owner_name\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Reserved for Docusign.\",\n \"in\": \"query\",\n \"name\": \"search_text\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Reserved for Docusign.\",\n \"in\": \"query\",\n \"name\": \"start_position\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Reserved for Docusign.\",\n \"in\": \"query\",\n \"name\": \"status\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Reserved for Docusign.\",\n \"in\": \"query\",\n \"name\": \"to_date\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/folders/{folderId}\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"folders_get_folder_items\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Gets information about items in a specified folder. \",\n \"tags\": [\n \"Folders\"\n ]\n },\n \"folders_get_folders\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Returns a list of the account's folders.\\n\\nUse the `include` query parameter to specify the kinds of folders to return.\\n\\nBy default, only the first level of subfolders is shown.\\nSet the `sub_folder_depth` query parameter to `-1` to return the entire folder hierarchy.\\n\\n\\n<ds-column>\\n\\n<ds-step open=\\\"false\\\" hideIcon=\\\"true\\\">\\n\\nDefault returns only top-level folders. Click to show.\\n\\n<div>\\n\\n`GET 'https://demo.docusign.net/restapi/v2.1/accounts/624e3e00-xxxx-xxxx-xxxx-43918c520dab/folders'`\\n\\n\\n```json\\n{\\n \\\"resultSetSize\\\": \\\"5\\\",\\n \\\"startPosition\\\": \\\"0\\\",\\n \\\"endPosition\\\": \\\"4\\\",\\n \\\"totalSetSize\\\": \\\"5\\\",\\n \\\"folders\\\": [\\n {\\n \\\"name\\\": \\\"Draft\\\",\\n \\\"type\\\": \\\"draft\\\",\\n \\\"itemCount\\\": \\\"1\\\",\\n \\\"subFolderCount\\\": \\\"0\\\",\\n \\\"hasSubFolders\\\": \\\"false\\\"\\n },\\n {\\n \\\"name\\\": \\\"Inbox\\\",\\n \\\"type\\\": \\\"inbox\\\",\\n \\\"itemCount\\\": \\\"0\\\",\\n \\\"subFolderCount\\\": \\\"1\\\",\\n \\\"hasSubFolders\\\": \\\"true\\\",\\n \\\"folders\\\": [\\n {\\n \\\"name\\\": \\\"Project Fair\\\",\\n \\\"type\\\": \\\"normal\\\",\\n \\\"hasSubFolders\\\": \\\"false\\\",\\n \\\"parentFolderId\\\": \\\"3ed02ee3-xxxx-xxxx-xxxx-e6795f96a840\\\",\\n \\\"parentFolderUri\\\": \\\"/folders/3ed02ee3-xxxx-xxxx-xxxx-e6795f96a840\\\"\\n }\\n ]\\n },\\n {\\n \\\"name\\\": \\\"Deleted Items\\\",\\n \\\"type\\\": \\\"recyclebin\\\",\\n \\\"itemCount\\\": \\\"0\\\",\\n \\\"subFolderCount\\\": \\\"0\\\",\\n \\\"hasSubFolders\\\": \\\"false\\\"\\n },\\n {\\n \\\"name\\\": \\\"Sent Items\\\",\\n \\\"type\\\": \\\"sentitems\\\",\\n \\\"itemCount\\\": \\\"3\\\",\\n \\\"subFolderCount\\\": \\\"0\\\",\\n \\\"hasSubFolders\\\": \\\"false\\\"\\n }\\n ]\\n}\\n\\n```\\n\\n</div></ds-step>\\n\\n\\n<ds-step open=\\\"false\\\" hideIcon=\\\"true\\\">\\n\\nSetting `sub_folder_depth` to `-1` returns the entire folder hierarchy.\\nClick to show.\\n\\n\\n<div>\\n\\n`GET 'https://demo.docusign.net/restapi/v2.1/accounts/624e3e00-xxxx-xxxx-xxxx-43918c520dab/folders?sub_folder_depth=-1'`\\n\\nOne envelope has been moved from the `Inbox` folder to the\\n`Project Fair/Phase 1` folder, and the endpoint is invoked\\nwith `sub_folder_depth=-1`.\\n\\n\\n```json\\n{\\n \\\"resultSetSize\\\": \\\"5\\\",\\n \\\"startPosition\\\": \\\"0\\\",\\n \\\"endPosition\\\": \\\"4\\\",\\n \\\"totalSetSize\\\": \\\"4\\\",\\n \\\"folders\\\": [\\n {\\n \\\"name\\\": \\\"Draft\\\",\\n \\\"type\\\": \\\"draft\\\",\\n \\\"itemCount\\\": \\\"1\\\",\\n \\\"hasSubFolders\\\": \\\"false\\\"\\n },\\n {\\n \\\"name\\\": \\\"Inbox\\\",\\n \\\"type\\\": \\\"inbox\\\",\\n \\\"itemCount\\\": \\\"0\\\",\\n \\\"hasSubFolders\\\": \\\"true\\\",\\n \\\"folders\\\": [\\n {\\n \\\"name\\\": \\\"Project Fair\\\",\\n \\\"type\\\": \\\"normal\\\",\\n \\\"itemCount\\\": \\\"0\\\",\\n \\\"hasSubFolders\\\": \\\"true\\\",\\n \\\"parentFolderId\\\": \\\"3ed02ee3-xxxx-xxxx-xxxx-e6795f96a840\\\",\\n \\\"parentFolderUri\\\": \\\"/folders/3ed02ee3-xxxx-xxxx-xxxx-e6795f96a840\\\",\\n \\\"folders\\\": [\\n {\\n \\\"name\\\": \\\"NDAs\\\",\\n \\\"type\\\": \\\"normal\\\",\\n \\\"itemCount\\\": \\\"0\\\",\\n \\\"hasSubFolders\\\": \\\"false\\\",\\n \\\"parentFolderId\\\": \\\"12882f2f-xxxx-xxxx-xxxx-e04a714f8e2d\\\",\\n \\\"parentFolderUri\\\": \\\"/folders/12882f2f-xxxx-xxxx-xxxx-e04a714f8e2d\\\"\\n },\\n {\\n \\\"name\\\": \\\"Phase 1\\\",\\n \\\"type\\\": \\\"normal\\\",\\n \\\"itemCount\\\": \\\"1\\\",\\n \\\"hasSubFolders\\\": \\\"false\\\",\\n \\\"parentFolderId\\\": \\\"12882f2f-xxxx-xxxx-xxxx-e04a714f8e2d\\\",\\n \\\"parentFolderUri\\\": \\\"/folders/12882f2f-xxxx-xxxx-xxxx-e04a714f8e2d\\\"\\n }\\n ]\\n }\\n ]\\n },\\n {\\n \\\"name\\\": \\\"Deleted Items\\\",\\n \\\"type\\\": \\\"recyclebin\\\",\\n \\\"itemCount\\\": \\\"0\\\",\\n \\\"hasSubFolders\\\": \\\"false\\\"\\n },\\n {\\n \\\"name\\\": \\\"Sent Items\\\",\\n \\\"type\\\": \\\"sentitems\\\",\\n \\\"itemCount\\\": \\\"1\\\",\\n \\\"hasSubFolders\\\": \\\"false\\\"\\n }\\n ]\\n}\\n```\\n\\n</div></ds-step>\\n</ds-column>\\n\\n\\n### Related topics\\n\\n- [Searching for envelopes](/docs/esign-rest-api/esign101/concepts/envelopes/search/)\\n- [Sharing templates](/docs/esign-rest-api/esign101/concepts/templates/sharing/)\\n\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"folders_get_folders\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The maximum number of results to return.\",\n \"in\": \"query\",\n \"name\": \"count\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"A comma-separated list of folder types to include in the response.\\nValid values are:\\n\\n- `envelope_folders`: Returns a list of envelope folders. (Default)\\n- `template_folders`: Returns a list of template folders. \\n- `shared_template_folders`: Returns a list of shared template folders.\\n\",\n \"in\": \"query\",\n \"name\": \"include\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Indicates whether folder items are included in the response. If this parameter is omitted, the default is false.\",\n \"in\": \"query\",\n \"name\": \"include_items\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The zero-based index of the\\nresult from which to start returning results.\\n\\nThe default value is `0`.\\n\",\n \"in\": \"query\",\n \"name\": \"start_position\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"If missing or any value other than `-1`, the returned list contains only the top-level folders.\\nA value of `-1` returns the complete folder hierarchy.\\n\",\n \"in\": \"query\",\n \"name\": \"sub_folder_depth\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"This parameter is deprecated as of version 2.1. Use `include` instead.\",\n \"in\": \"query\",\n \"name\": \"template\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Narrows down the resulting folder list by the following values:\\n\\n- `all`: Returns all templates owned or shared with the user. (default)\\n- `owned_by_me`: Returns only templates the user owns.\\n- `shared_with_me`: Returns only templates that are shared with the user.\\n\",\n \"in\": \"query\",\n \"name\": \"user_filter\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/folders\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"folders_get_folders\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Returns a list of the account's folders.\",\n \"tags\": [\n \"Folders\"\n ]\n },\n \"folders_put_folder_by_id\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Moves a set of envelopes from their current folder to another folder.\\n\\nThe `folderId` path parameter is the destination folder.\\nThe request body has an array of envelope IDs and the\\nID of the source folder.\\n\\n<ds-inlinemessage kind=\\\"warning\\\" markdown=\\\"1\\\">\\nDo not use the <code>folders</code> property in the request body.\\n\\n</ds-inlinemessage>\\n\\nIf `folderId` is the special value **`recyclebin`**\\nthe envelopes are moved to the Deleted folder.\\nMoving an in-process envelope\\n(envelope status of `sent` or `delivered`)\\nto the **`recyclebin`**\\nvoids the envelope.\\n\\n\\n### Related topics\\n\\n- [Searching for envelopes](/docs/esign-rest-api/esign101/concepts/envelopes/search/)\\n- [Sharing templates](/docs/esign-rest-api/esign101/concepts/templates/sharing/)\\n\",\n \"destructive\": true,\n \"method\": \"PUT\",\n \"operation_id\": \"folders_put_folder_by_id\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The ID of the folder.\",\n \"in\": \"path\",\n \"name\": \"folderId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/folders/{folderId}\",\n \"request_body\": {\n \"$ref\": \"#/definitions/foldersRequest\"\n },\n \"security\": null,\n \"skill_name\": \"folders_put_folder_by_id\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Moves a set of envelopes from their current folder to another folder.\",\n \"tags\": [\n \"Folders\"\n ]\n },\n \"form_data_get_form_data\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"This method downloads the envelope and tab data (also called form data) from any in-process, completed, or canceled envelope that you sent or that is shared with you. Recipients who are also full administrators on an account can view form data for any envelopes that another user on the account has sent to them.\\n\\n**Note:** To use this feature, the Sending Setting \\\"Allow sender to download form data\\\" must be enabled for the account.\\n\\n### Related topics\\n\\n- [How to get envelope tab values](/docs/esign-rest-api/how-to/get-envelope-tab-values/)\\n\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"form_data_get_form_data\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The envelope's GUID. \\n\\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\\n\",\n \"in\": \"path\",\n \"name\": \"envelopeId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/envelopes/{envelopeId}/form_data\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"form_data_get_form_data\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Returns envelope tab data for an existing envelope.\",\n \"tags\": [\n \"EnvelopeFormData\"\n ]\n },\n \"groups_delete_group_users\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Deletes one or more users from a group. This request takes a `userInfoList` that contains the users that you want to delete.\\n\",\n \"destructive\": true,\n \"method\": \"DELETE\",\n \"operation_id\": \"groups_delete_group_users\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The ID of the group being accessed.\",\n \"in\": \"path\",\n \"name\": \"groupId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/groups/{groupId}/users\",\n \"request_body\": {\n \"$ref\": \"#/definitions/userInfoList\"\n },\n \"security\": null,\n \"skill_name\": \"groups_delete_group_users\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Deletes one or more users from a group\",\n \"tags\": [\n \"GroupUsers\"\n ]\n },\n \"groups_delete_groups\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Deletes an existing user group.\\n\\nWhen you delete a group, you include only the `groupId` in the request body.\\n\\nExample:\\n\\n```\\n{\\n \\\"groups\\\": [\\n {\\n \\\"groupId\\\": \\\"12345\\\"\\n }\\n}\\n```\\n\",\n \"destructive\": true,\n \"method\": \"DELETE\",\n \"operation_id\": \"groups_delete_groups\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/groups\",\n \"request_body\": {\n \"$ref\": \"#/definitions/groupInformation\"\n },\n \"security\": null,\n \"skill_name\": \"groups_delete_groups\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Deletes an existing user group.\",\n \"tags\": [\n \"Groups\"\n ]\n },\n \"groups_get_group_users\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Retrieves a list of users in a group.\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"groups_get_group_users\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The ID of the group being accessed.\",\n \"in\": \"path\",\n \"name\": \"groupId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The maximum number of results to return.\\n\\nUse `start_position` to specify the number of results to skip.\\n\\nValid values: `1` to `100`<br>\\nDefault: `50`\\n\",\n \"in\": \"query\",\n \"name\": \"count\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The zero-based index of the\\nresult from which to start returning results.\\n\\nUse with `count` to limit the number\\nof results.\\n\\nThe default value is `0`.\\n\",\n \"in\": \"query\",\n \"name\": \"start_position\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/groups/{groupId}/users\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"groups_get_group_users\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Gets a list of users in a group.\",\n \"tags\": [\n \"GroupUsers\"\n ]\n },\n \"groups_get_groups\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Gets information about groups associated with the account.\\n\\n\\n<ds-inlinemessage kind=\\\"information\\\" markdown=\\\"1\\\">\\nTo get the users in a group:\\n\\n1. Use this endpoint to get the group ID.\\n2. Use [listGroupUsers](/docs/esign-rest-api/reference/usergroups/groupusers/list/)\\n to get the list of users.\\n</ds-inlinemessage>\\n\\n### Related topics\\n\\n- [How to set a permission profile](/docs/esign-rest-api/how-to/permission-profile-setting/)\\n\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"groups_get_groups\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The maximum number of results to return.\\n\\nUse `start_position` to specify the number of results to skip.\\n\\nValid values: `1` to `100`\",\n \"in\": \"query\",\n \"name\": \"count\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The type of group to return. Valid values:\\n\\n* `AdminGroup`\\n* `CustomGroup`\\n* `EveryoneGroup`\",\n \"in\": \"query\",\n \"name\": \"group_type\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"When **true,** every group returned in the response includes a `userCount` property that contains the total number of users in the group. The default is **true.**\",\n \"in\": \"query\",\n \"name\": \"include_usercount\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Filters the results of a GET request based on the text that you specify.\",\n \"in\": \"query\",\n \"name\": \"search_text\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The zero-based index of the\\nresult from which to start returning results.\\n\\nUse with `count` to limit the number\\nof results.\\n\\nThe default value is `0`.\\n\",\n \"in\": \"query\",\n \"name\": \"start_position\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/groups\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"groups_get_groups\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Gets information about groups associated with the account.\",\n \"tags\": [\n \"Groups\"\n ]\n },\n \"groups_post_groups\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Creates one or more groups for the account.\\n\\nGroups help you manage users.\\nFor example, you can use groups\\nto limit user access to templates.\\n\\nYou can associate a group with a\\n[permission profile](/docs/esign-rest-api/esign101/concepts/permissions/),\\nwhich sets the user permissions for users in that group\\nwithout having to set the `userSettings` property for each user.\\nYou are not required to set permission profiles for a group,\\nbut it makes it easier to manage user permissions\\nfor a large number of users.\\n\\n\\n<ds-inlinemessage kind=\\\"warning\\\" markdown=\\\"1\\\">\\nThis endpoint uses only\\nthe <code>groupName</code> and\\n<code>permissionProfileId</code>\\nproperties in the request body.\\nAll other properties are ignored.\\n</ds-inlinemessage>\\n\\n\\nExample request:\\n```json\\n{\\n \\\"groups\\\": [\\n { \\\"groupName\\\": \\\"montagues\\\" },\\n { \\\"groupName\\\": \\\"capulets\\\" },\\n { \\\"groupName\\\": \\\"nobles\\\",\\n \\\"permissionProfileId\\\": 1597 }\\n ]\\n}\\n```\\n\\nUse [AccountPermissionProfiles: list](/docs/esign-rest-api/reference/accounts/accountpermissionprofiles/list/)\\nto get a list of permission profiles and their IDs.\\nIt is an error if the `permissionProfileId` does not exist.\\n\\n\\n### Related topics\\n\\n- [How-To Set Up a Permission Profile](/docs/esign-rest-api/how-to/permission-profile-setting/)\\n\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"groups_post_groups\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/groups\",\n \"request_body\": {\n \"$ref\": \"#/definitions/groupInformation\"\n },\n \"security\": null,\n \"skill_name\": \"groups_post_groups\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Creates one or more groups for the account.\",\n \"tags\": [\n \"Groups\"\n ]\n },\n \"groups_put_group_users\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Adds one or more existing Docusign users to an existing group.\",\n \"destructive\": true,\n \"method\": \"PUT\",\n \"operation_id\": \"groups_put_group_users\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The ID of the group being accessed.\",\n \"in\": \"path\",\n \"name\": \"groupId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/groups/{groupId}/users\",\n \"request_body\": {\n \"$ref\": \"#/definitions/userInfoList\"\n },\n \"security\": null,\n \"skill_name\": \"groups_put_group_users\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Adds one or more users to an existing group.\",\n \"tags\": [\n \"GroupUsers\"\n ]\n },\n \"groups_put_groups\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Updates the group name and modifies, or sets, the permission profile for the group.\\n\\n### Related topics\\n\\n- [How-To Set Up a Permission Profile](/docs/esign-rest-api/how-to/permission-profile-setting/)\",\n \"destructive\": true,\n \"method\": \"PUT\",\n \"operation_id\": \"groups_put_groups\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/groups\",\n \"request_body\": {\n \"$ref\": \"#/definitions/groupInformation\"\n },\n \"security\": null,\n \"skill_name\": \"groups_put_groups\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Updates the group information for a group.\",\n \"tags\": [\n \"Groups\"\n ]\n },\n \"historical_envelope_publish_post_historical_envelope_publish_transaction\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"This endpoint submits a batch of existing envelopes to a webhook of your choice. Set the webhook address with the `urlToPublishTo` request body parameter.\\n\\nThis endpoint does not call an existing Connect configuration or create a new Connect listener to monitor new activity. It simply uses an ad hoc configuration to submit existing envelopes. You must include all the configuration data in the request body.\\n\\nThe envelope data will always be transmitted in JSON format. XML, Salesforce, and eOriginal configuration types are not supported.\\n\\nYour request should match the following format:\\n\\n```\\n{\\n \\\"envelopes\\\": [\\\"4280f274-xxxx-xxxx-xxxx-b218b7eeda08\\\", \\\"8373a938-xxxx-xxxx-xxxx-e992a2abae01\\\"],\\n \\\"config\\\": {\\n \\\"configurationType\\\":\\\"custom\\\",\\n \\\"name\\\": \\\"Test\\\",\\n \\\"urlToPublishTo\\\":\\\"YOUR-WEBHOOK-URL\\\",\\n \\\"allowEnvelopePublish\\\": \\\"true\\\",\\n \\\"enableLog\\\": \\\"true\\\",\\n \\\"requiresAcknowledgement\\\": \\\"true\\\",\\n \\\"IncludeHMAC\\\": \\\"true\\\",\\n \\\"SignMessageWithX509Cert\\\": \\\"true\\\",\\n \\\"deliveryMode\\\": \\\"SIM\\\",\\n \\\"eventData\\\": {\\n \\\"version\\\": \\\"restv2.1\\\",\\n \\\"format\\\": \\\"json\\\",\\n \\\"includedata\\\": [\\\"tabs\\\",\\\"payment_tabs\\\",\\\"custom_fields\\\",\\\"powerform\\\",\\\"recipients\\\",\\\"folders\\\",\\\"extensions\\\",\\\"attachments\\\", \\\"prefill_tabs\\\", \\\"documents\\\"]\\n }\\n }\\n}\\n```\\n\\nIf the request succeeds, it returns a 201 (Created) HTTP response code and the response body property `processingStatus` will be set to `processing`. You can then view the status of each historical republish request in the [Bulk Actions Log](https://support.docusign.com/s/document-item?bundleId=pik1583277475390&topicId=nvf1648497452396.html).\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"historical_envelope_publish_post_historical_envelope_publish_transaction\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/connect/envelopes/publish/historical\",\n \"request_body\": {\n \"$ref\": \"#/definitions/connectHistoricalEnvelopeRepublish\"\n },\n \"security\": null,\n \"skill_name\": \"historical_envelope_publish_post_historical_envelope_publish_transaction\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Submits a batch of historical envelopes for republish to a webhook.\",\n \"tags\": [\n \"EnvelopePublish\"\n ]\n },\n \"lock_delete_envelope_lock\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Deletes the lock from the specified envelope.\\nThe user deleting the lock must be the same user\\nwho locked the envelope.\\n\\nYou must include the `X-DocuSign-Edit` header\\nas described in\\n[EnvelopeLocks: create](/docs/esign-rest-api/reference/envelopes/envelopelocks/create/).\\n\\nThis method takes an optional query parameter\\nthat lets you specify whether\\nchanges made while the envelope was locked\\nare kept or discarded.\\n\\n\\n| Query Parameter | Description |\\n| :-------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\\n| `save_changes` | When **true** (the default), any changes made while the lock was active are saved. When **false,** any changes made while the envelope was locked are discarded. |\\n\\n### Related topics\\n\\n- [Common API Tasks: Locking and unlocking envelopes](https://www.docusign.com/blog/dsdev-common-api-tasks-locking-and-unlocking-envelopes)\\n\\n\",\n \"destructive\": true,\n \"method\": \"DELETE\",\n \"operation_id\": \"lock_delete_envelope_lock\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The envelope's GUID. \\n\\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\\n\",\n \"in\": \"path\",\n \"name\": \"envelopeId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/envelopes/{envelopeId}/lock\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"lock_delete_envelope_lock\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Deletes an envelope lock.\",\n \"tags\": [\n \"EnvelopeLocks\"\n ]\n },\n \"lock_delete_template_lock\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Deletes the lock from the specified template.\\nThe user deleting the lock must be the same user\\nwho locked the template.\\n\\nYou must include the `X-DocuSign-Edit` header\\nas described in\\n[TemplateLocks: create](/docs/esign-rest-api/reference/templates/templatelocks/create/).\\n\\nThis method takes an optional query parameter\\nthat lets you specify whether\\nchanges made while the template was locked\\nare kept or discarded.\\n\\n\\n| Query Parameter | Description |\\n| :-------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\\n| `save_changes` | When **true** (the default), any changes made while the lock was active are saved. When **false,** any changes made while the template was locked are discarded. |\\n\\n\\n### Related topics\\n\\n- [Common API Tasks: Locking and unlocking envelopes](https://www.docusign.com/blog/dsdev-common-api-tasks-locking-and-unlocking-envelopes)\\n\\n\",\n \"destructive\": true,\n \"method\": \"DELETE\",\n \"operation_id\": \"lock_delete_template_lock\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The ID of the template.\",\n \"in\": \"path\",\n \"name\": \"templateId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/templates/{templateId}/lock\",\n \"request_body\": {\n \"$ref\": \"#/definitions/lockRequest\"\n },\n \"security\": null,\n \"skill_name\": \"lock_delete_template_lock\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Deletes a template lock.\",\n \"tags\": [\n \"TemplateLocks\"\n ]\n },\n \"lock_get_envelope_lock\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Retrieves general information about an envelope lock.\\n\\nThe user requesting the information must be the same user\\nwho locked the envelope.\\n\\nYou can use this method to recover the lock information,\\nincluding the `lockToken`,\\nfor a locked envelope.\\nThe `X-DocuSign-Edit` header is included in the response.\\n\\nSee [EnvelopeLocks: create](/docs/esign-rest-api/reference/envelopes/envelopelocks/create/)\\nfor a description of the `X-DocuSign-Edit` header.\\n\\n### Related topics\\n\\n- [Common API Tasks: Locking and unlocking envelopes](https://www.docusign.com/blog/dsdev-common-api-tasks-locking-and-unlocking-envelopes)\\n\\n\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"lock_get_envelope_lock\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The envelope's GUID. \\n\\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\\n\",\n \"in\": \"path\",\n \"name\": \"envelopeId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/envelopes/{envelopeId}/lock\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"lock_get_envelope_lock\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Gets envelope lock information.\",\n \"tags\": [\n \"EnvelopeLocks\"\n ]\n },\n \"lock_get_template_lock\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Retrieves general information about a template lock.\\n\\nThe user requesting the information must be the same user\\nwho locked the template.\\n\\nYou can use this method to recover the lock information,\\nincluding the `lockToken`,\\nfor a locked template.\\nThe `X-DocuSign-Edit` header is included in the response.\\n\\nSee\\n[TemplateLocks: create](/docs/esign-rest-api/reference/templates/templatelocks/create/)\\nfor a description of the `X-DocuSign-Edit` header.\\n\\n### Related topics\\n\\n- [Common API Tasks: Locking and unlocking envelopes](https://www.docusign.com/blog/dsdev-common-api-tasks-locking-and-unlocking-envelopes)\\n\\n\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"lock_get_template_lock\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The ID of the template.\",\n \"in\": \"path\",\n \"name\": \"templateId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/templates/{templateId}/lock\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"lock_get_template_lock\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Gets template lock information.\",\n \"tags\": [\n \"TemplateLocks\"\n ]\n },\n \"lock_post_envelope_lock\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"This method locks the specified envelope and sets the time until\\nthe lock expires to prevent other users or recipients from\\nchanging the envelope.\\n\\nThe response to this request includes a `lockToken` parameter\\nthat you must use in the `X-DocuSign-Edit` header for\\nevery PUT method (typically a method that updates an envelope)\\nwhile the envelope is locked.\\n\\n\\nIf you do not provide the `lockToken` when accessing\\na locked envelope, you will get the following\\nerror:\\n\\n```\\n{\\n \\\"errorCode\\\": \\\"EDIT_LOCK_NOT_LOCK_OWNER\\\",\\n \\\"message\\\": \\\"The user is not the owner of the lock. The template is locked by another user or in another application\\\"\\n}\\n```\\n\\n\\n### The X-DocuSign-Edit header\\n\\nThe `X-DocuSign-Edit` header looks like this\\nand can be specified in either JSON or XML.\\n\\n**JSON**\\n```\\n{\\n \\\"LockToken\\\": \\\"token-from-response\\\",\\n \\\"LockDurationInSeconds\\\": \\\"600\\\"\\n}\\n```\\n\\n**XML**\\n```\\n<DocuSignEdit>\\n <LockToken>token-from-response</LockToken>\\n <LockDurationInSeconds>600</LockDurationInSeconds>\\n</DocuSignEdit>\\n```\\n\\nIn the actual HTTP header, you would remove the linebreaks:\\n\\n```\\nX-DocuSign-Edit: {\\\"LockToken\\\": \\\"token-from-response\\\", \\\"LockDurationInSeconds\\\": \\\"600\\\" }\\n or\\nX-DocuSign-Edit:<DocuSignEdit><LockToken>token-from-response</LockToken><LockDurationInSeconds>600</LockDurationInSeconds></DocuSignEdit>\\n```\\n\\n\\n### Related topics\\n\\n- [Common API Tasks: Locking and unlocking envelopes](https://www.docusign.com/blog/dsdev-common-api-tasks-locking-and-unlocking-envelopes)\\n\\n\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"lock_post_envelope_lock\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The envelope's GUID. \\n\\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\\n\",\n \"in\": \"path\",\n \"name\": \"envelopeId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/envelopes/{envelopeId}/lock\",\n \"request_body\": {\n \"$ref\": \"#/definitions/lockRequest\"\n },\n \"security\": null,\n \"skill_name\": \"lock_post_envelope_lock\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Locks an envelope.\",\n \"tags\": [\n \"EnvelopeLocks\"\n ]\n },\n \"lock_post_template_lock\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"This method locks the specified template and sets the time until\\nthe lock expires to prevent other users or recipients from\\nchanging the template.\\n\\nThe response to this request includes a `lockToken` parameter\\nthat you must use in the `X-DocuSign-Edit` header for\\nevery PUT method (typically a method that updates a template)\\nwhile the template is locked.\\n\\n\\nIf you do not provide the `lockToken` when accessing\\na locked template, you will get the following\\nerror:\\n\\n```\\n{\\n \\\"errorCode\\\": \\\"EDIT_LOCK_NOT_LOCK_OWNER\\\",\\n \\\"message\\\": \\\"The user is not the owner of the lock. The template is locked by another user or in another application\\\"\\n}\\n```\\n\\n\\n### The X-DocuSign-Edit header\\n\\nThe `X-DocuSign-Edit` header looks like this\\nand can be specified in either JSON or XML.\\n\\n**JSON**\\n```\\n{\\n \\\"LockToken\\\": \\\"token-from-response\\\",\\n \\\"LockDurationInSeconds\\\": \\\"600\\\"\\n}\\n```\\n\\n**XML**\\n```\\n<DocuSignEdit>\\n <LockToken>token-from-response</LockToken>\\n <LockDurationInSeconds>600</LockDurationInSeconds>\\n</DocuSignEdit>\\n```\\n\\nIn the actual HTTP header, you would remove the linebreaks:\\n\\n```\\nX-DocuSign-Edit: {\\\"LockToken\\\": \\\"token-from-response\\\", \\\"LockDurationInSeconds\\\": \\\"600\\\" }\\n or\\nX-DocuSign-Edit:<DocuSignEdit><LockToken>token-from-response</LockToken><LockDurationInSeconds>600</LockDurationInSeconds></DocuSignEdit>\\n```\\n\\n\\n### Related topics\\n\\n- [Common API Tasks: Locking and unlocking envelopes](https://www.docusign.com/blog/dsdev-common-api-tasks-locking-and-unlocking-envelopes)\\n\\n\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"lock_post_template_lock\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The ID of the template.\",\n \"in\": \"path\",\n \"name\": \"templateId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/templates/{templateId}/lock\",\n \"request_body\": {\n \"$ref\": \"#/definitions/lockRequest\"\n },\n \"security\": null,\n \"skill_name\": \"lock_post_template_lock\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Locks a template.\",\n \"tags\": [\n \"TemplateLocks\"\n ]\n },\n \"lock_put_envelope_lock\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Updates the lock information for a locked envelope.\\n\\nYou must include the `X-DocuSign-Edit` header\\nas described in\\n[EnvelopeLocks: create](/docs/esign-rest-api/reference/envelopes/envelopelocks/create/).\\n\\n\\nUse this method to change the duration\\nof the lock (`lockDurationInSeconds`)\\nor the `lockedByApp` string.\\n\\nThe request body is a full `lockRequest` object,\\nbut you only need to specify the\\nproperties that you are updating. For example:\\n\\n```\\n{\\n \\\"lockDurationInSeconds\\\": \\\"3600\\\",\\n \\\"lockedByApp\\\": \\\"My Application\\\"\\n}\\n```\\n\\n\",\n \"destructive\": true,\n \"method\": \"PUT\",\n \"operation_id\": \"lock_put_envelope_lock\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The envelope's GUID. \\n\\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\\n\",\n \"in\": \"path\",\n \"name\": \"envelopeId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/envelopes/{envelopeId}/lock\",\n \"request_body\": {\n \"$ref\": \"#/definitions/lockRequest\"\n },\n \"security\": null,\n \"skill_name\": \"lock_put_envelope_lock\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Updates an envelope lock.\",\n \"tags\": [\n \"EnvelopeLocks\"\n ]\n },\n \"lock_put_template_lock\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Updates the lock information for a locked template.\\n\\nYou must include the `X-DocuSign-Edit` header\\nas described in\\n[TemplateLocks: create](/docs/esign-rest-api/reference/templates/templatelocks/create/).\\n\\n\\nUse this method to change the duration\\nof the lock (`lockDurationInSeconds`)\\nor the `lockedByApp` string.\\n\\nThe request body is a full `lockRequest` object,\\nbut you only need to specify the\\nproperties that you are updating. For example:\\n\\n```\\n{\\n \\\"lockDurationInSeconds\\\": \\\"3600\\\",\\n \\\"lockedByApp\\\": \\\"My Application\\\"\\n}\\n```\\n\\n\",\n \"destructive\": true,\n \"method\": \"PUT\",\n \"operation_id\": \"lock_put_template_lock\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The ID of the template.\",\n \"in\": \"path\",\n \"name\": \"templateId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/templates/{templateId}/lock\",\n \"request_body\": {\n \"$ref\": \"#/definitions/lockRequest\"\n },\n \"security\": null,\n \"skill_name\": \"lock_put_template_lock\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Updates a template lock.\",\n \"tags\": [\n \"TemplateLocks\"\n ]\n },\n \"notary_get_notary\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Gets settings for a notary user.\\nThe current user must be a notary.\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"notary_get_notary\",\n \"parameters\": [\n {\n \"description\": \"When **true,** the response will include a `jurisdiction` property that contains an array of all supported jurisdictions for the current user.\",\n \"in\": \"query\",\n \"name\": \"include_jurisdictions\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/current_user/notary\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"notary_get_notary\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Gets settings for a notary user.\",\n \"tags\": [\n \"Notary\"\n ]\n },\n \"notary_journals_get_notary_journals\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Gets notary jurisdictions for a user.\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"notary_journals_get_notary_journals\",\n \"parameters\": [\n {\n \"description\": \"The maximum number of results to return.\",\n \"in\": \"query\",\n \"name\": \"count\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Use this parameter to search for specific text.\",\n \"in\": \"query\",\n \"name\": \"search_text\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The position within the total result set from which to start returning values. The value **thumbnail** may be used to return the page image.\",\n \"in\": \"query\",\n \"name\": \"start_position\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/current_user/notary/journals\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"notary_journals_get_notary_journals\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Gets notary jurisdictions for a user.\",\n \"tags\": [\n \"NotaryJournals\"\n ]\n },\n \"notary_jurisdictions_delete_notary_jurisdiction\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Deletes the specified jurisdiction.\",\n \"destructive\": true,\n \"method\": \"DELETE\",\n \"operation_id\": \"notary_jurisdictions_delete_notary_jurisdiction\",\n \"parameters\": [\n {\n \"description\": \"The ID of the jurisdiction.\\nThe following jurisdictions\\nare supported:\\n\\n- `5 - California`\\n- `6 - Colorado`\\n- `9 - Florida`\\n- `10 - Georgia`\\n- `12 - Idaho`\\n- `13 - Illinois`\\n- `14 - Indiana`\\n- `15 - Iowa`\\n- `17 - Kentucky`\\n- `23 - Minnesota`\\n- `25 - Missouri`\\n- `30 - New Jersey`\\n- `32 - New York`\\n- `33 - North Carolina`\\n- `35 - Ohio`\\n- `37 - Oregon`\\n- `38 - Pennsylvania`\\n- `40 - South Carolina`\\n- `43 - Texas`\\n- `44 - Utah`\\n- `47 - Washington`\\n- `48 - West Virginia`\\n- `49 - Wisconsin`\\n- `62 - Florida Commissioner of Deeds`\\n\",\n \"in\": \"path\",\n \"name\": \"jurisdictionId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/current_user/notary/jurisdictions/{jurisdictionId}\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"notary_jurisdictions_delete_notary_jurisdiction\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Deletes the specified jurisdiction.\",\n \"tags\": [\n \"NotaryJurisdiction\"\n ]\n },\n \"notary_jurisdictions_get_notary_jurisdiction\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Gets a jurisdiction object for the current user. The following restrictions apply:\\n\\n- The current user must be a notary.\\n- The `jurisdictionId` must be a jurisdiction that the notary is registered for.\\n\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"notary_jurisdictions_get_notary_jurisdiction\",\n \"parameters\": [\n {\n \"description\": \"The ID of the jurisdiction.\\nThe following jurisdictions\\nare supported:\\n\\n- `5 - California`\\n- `6 - Colorado`\\n- `9 - Florida`\\n- `10 - Georgia`\\n- `12 - Idaho`\\n- `13 - Illinois`\\n- `14 - Indiana`\\n- `15 - Iowa`\\n- `17 - Kentucky`\\n- `23 - Minnesota`\\n- `25 - Missouri`\\n- `30 - New Jersey`\\n- `32 - New York`\\n- `33 - North Carolina`\\n- `35 - Ohio`\\n- `37 - Oregon`\\n- `38 - Pennsylvania`\\n- `40 - South Carolina`\\n- `43 - Texas`\\n- `44 - Utah`\\n- `47 - Washington`\\n- `48 - West Virginia`\\n- `49 - Wisconsin`\\n- `62 - Florida Commissioner of Deeds`\\n\",\n \"in\": \"path\",\n \"name\": \"jurisdictionId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/current_user/notary/jurisdictions/{jurisdictionId}\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"notary_jurisdictions_get_notary_jurisdiction\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Gets a jurisdiction object for the current user. The user must be a notary.\",\n \"tags\": [\n \"NotaryJurisdiction\"\n ]\n },\n \"notary_jurisdictions_get_notary_jurisdictions\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Returns a list of jurisdictions that the notary is registered in.\\nThe current user must be a notary.\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"notary_jurisdictions_get_notary_jurisdictions\",\n \"parameters\": [],\n \"path\": \"/v2.1/current_user/notary/jurisdictions\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"notary_jurisdictions_get_notary_jurisdictions\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Returns a list of jurisdictions that the notary is registered in.\",\n \"tags\": [\n \"NotaryJurisdiction\"\n ]\n },\n \"notary_jurisdictions_post_notary_jurisdictions\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Creates a jurisdiction object.\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"notary_jurisdictions_post_notary_jurisdictions\",\n \"parameters\": [],\n \"path\": \"/v2.1/current_user/notary/jurisdictions\",\n \"request_body\": {\n \"$ref\": \"#/definitions/notaryJurisdiction\"\n },\n \"security\": null,\n \"skill_name\": \"notary_jurisdictions_post_notary_jurisdictions\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Creates a jurisdiction object.\",\n \"tags\": [\n \"NotaryJurisdiction\"\n ]\n },\n \"notary_jurisdictions_put_notary_jurisdiction\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Updates the jurisdiction information about a notary.\\n\\nThe following restrictions apply:\\n\\n- The current user must be a notary.\\n- The `jurisdictionId` path parameter must be a jurisdiction that the notary is registered for.\\n- The `jurisdictionId` path parameter must match the request body's `jurisdiction.jurisdictionId`.\\n\\nThe request body must have a full `jurisdiction` object for the jurisdiction property.\\nThe best way to do this is to use `getNotaryJurisdiction` to obtain the current values and update the properties you want to change.\\n\\nFor example, assume `getNotaryJurisdiction` returns this:\\n\\n```\\n{\\n \\\"jurisdiction\\\": {\\n \\\"jurisdictionId\\\": \\\"15\\\",\\n \\\"name\\\": \\\"Iowa\\\",\\n \\\"county\\\": \\\"\\\",\\n \\\"enabled\\\": \\\"true\\\",\\n \\\"countyInSeal\\\": \\\"false\\\",\\n \\\"commissionIdInSeal\\\": \\\"true\\\",\\n \\\"stateNameInSeal\\\": \\\"true\\\",\\n \\\"notaryPublicInSeal\\\": \\\"true\\\",\\n \\\"allowSystemCreatedSeal\\\": \\\"true\\\",\\n \\\"allowUserUploadedSeal\\\": \\\"false\\\"\\n },\\n \\\"commissionId\\\": \\\"123456\\\",\\n \\\"commissionExpiration\\\": \\\"2020-08-31T07:00:00.0000000Z\\\",\\n \\\"registeredName\\\": \\\"Bob Notary\\\",\\n \\\"county\\\": \\\"Adams\\\",\\n \\\"sealType\\\": \\\"system_created\\\"\\n}\\n```\\n\\nIf you want to change the name of the notary from \\\"Bob Notary\\\" to \\\"Robert Notary\\\", your request body would be:\\n\\n```\\n{\\n \\\"jurisdiction\\\": {\\n \\\"jurisdictionId\\\": \\\"15\\\",\\n \\\"name\\\": \\\"Iowa\\\",\\n \\\"county\\\": \\\"\\\",\\n \\\"enabled\\\": \\\"true\\\",\\n \\\"countyInSeal\\\": \\\"false\\\",\\n \\\"commissionIdInSeal\\\": \\\"true\\\",\\n \\\"stateNameInSeal\\\": \\\"true\\\",\\n \\\"notaryPublicInSeal\\\": \\\"true\\\",\\n \\\"allowSystemCreatedSeal\\\": \\\"true\\\",\\n \\\"allowUserUploadedSeal\\\": \\\"false\\\"\\n },\\n \\\"commissionId\\\": \\\"123456\\\",\\n \\\"commissionExpiration\\\": \\\"2020-08-31T07:00:00.0000000Z\\\",\\n \\\"registeredName\\\": \\\"Robert Notary\\\",\\n \\\"county\\\": \\\"Adams\\\",\\n \\\"sealType\\\": \\\"system_created\\\"\\n}\\n```\\n\",\n \"destructive\": true,\n \"method\": \"PUT\",\n \"operation_id\": \"notary_jurisdictions_put_notary_jurisdiction\",\n \"parameters\": [\n {\n \"description\": \"The ID of the jurisdiction.\\nThe following jurisdictions\\nare supported:\\n\\n- `5 - California`\\n- `6 - Colorado`\\n- `9 - Florida`\\n- `10 - Georgia`\\n- `12 - Idaho`\\n- `13 - Illinois`\\n- `14 - Indiana`\\n- `15 - Iowa`\\n- `17 - Kentucky`\\n- `23 - Minnesota`\\n- `25 - Missouri`\\n- `30 - New Jersey`\\n- `32 - New York`\\n- `33 - North Carolina`\\n- `35 - Ohio`\\n- `37 - Oregon`\\n- `38 - Pennsylvania`\\n- `40 - South Carolina`\\n- `43 - Texas`\\n- `44 - Utah`\\n- `47 - Washington`\\n- `48 - West Virginia`\\n- `49 - Wisconsin`\\n- `62 - Florida Commissioner of Deeds`\\n\",\n \"in\": \"path\",\n \"name\": \"jurisdictionId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/current_user/notary/jurisdictions/{jurisdictionId}\",\n \"request_body\": {\n \"$ref\": \"#/definitions/notaryJurisdiction\"\n },\n \"security\": null,\n \"skill_name\": \"notary_jurisdictions_put_notary_jurisdiction\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Updates the jurisdiction information about a notary.\",\n \"tags\": [\n \"NotaryJurisdiction\"\n ]\n },\n \"notary_post_notary\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Registers the current user as a notary.\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"notary_post_notary\",\n \"parameters\": [],\n \"path\": \"/v2.1/current_user/notary\",\n \"request_body\": {\n \"$ref\": \"#/definitions/notary\"\n },\n \"security\": null,\n \"skill_name\": \"notary_post_notary\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Registers the current user as a notary.\",\n \"tags\": [\n \"Notary\"\n ]\n },\n \"notary_put_notary\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Updates notary information for the current user.\",\n \"destructive\": true,\n \"method\": \"PUT\",\n \"operation_id\": \"notary_put_notary\",\n \"parameters\": [],\n \"path\": \"/v2.1/current_user/notary\",\n \"request_body\": {\n \"$ref\": \"#/definitions/notary\"\n },\n \"security\": null,\n \"skill_name\": \"notary_put_notary\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Updates notary information for the current user.\",\n \"tags\": [\n \"Notary\"\n ]\n },\n \"notification_defaults_get_notification_defaults\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"This method returns the default settings for the email notifications that signers and senders receive about envelopes.\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"notification_defaults_get_notification_defaults\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/settings/notification_defaults\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"notification_defaults_get_notification_defaults\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Gets envelope notification defaults.\",\n \"tags\": [\n \"Accounts\"\n ]\n },\n \"notification_defaults_put_notification_defaults\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"This method changes the default settings for the email notifications that signers and senders receive about envelopes.\",\n \"destructive\": true,\n \"method\": \"PUT\",\n \"operation_id\": \"notification_defaults_put_notification_defaults\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/settings/notification_defaults\",\n \"request_body\": {\n \"$ref\": \"#/definitions/notificationDefaults\"\n },\n \"security\": null,\n \"skill_name\": \"notification_defaults_put_notification_defaults\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Updates envelope notification default settings.\",\n \"tags\": [\n \"Accounts\"\n ]\n },\n \"notification_get_envelopes_envelope_id_notification\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Retrieves the envelope notification, reminders and expirations, information for an existing envelope.\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"notification_get_envelopes_envelope_id_notification\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The envelope's GUID. \\n\\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\\n\",\n \"in\": \"path\",\n \"name\": \"envelopeId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/envelopes/{envelopeId}/notification\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"notification_get_envelopes_envelope_id_notification\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Gets envelope notification information.\",\n \"tags\": [\n \"Envelopes\"\n ]\n },\n \"notification_get_templates_template_id_notification\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Retrieves the envelope notification, reminders and expirations, information for an existing template.\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"notification_get_templates_template_id_notification\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The ID of the template.\",\n \"in\": \"path\",\n \"name\": \"templateId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/templates/{templateId}/notification\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"notification_get_templates_template_id_notification\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Gets template notification information.\",\n \"tags\": [\n \"Templates\"\n ]\n },\n \"notification_put_envelopes_envelope_id_notification\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"This method sets the notifications (reminders and expirations) for an existing envelope. The request body sends a structure containing reminders and expirations settings. It also specifies whether to use the settings specified in the request, or the account default notification settings for the envelope.\\n\\nNote that this request only specifies when notifications are sent; it does not initiate sending of email messages.\",\n \"destructive\": true,\n \"method\": \"PUT\",\n \"operation_id\": \"notification_put_envelopes_envelope_id_notification\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The envelope's GUID. \\n\\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\\n\",\n \"in\": \"path\",\n \"name\": \"envelopeId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/envelopes/{envelopeId}/notification\",\n \"request_body\": {\n \"$ref\": \"#/definitions/envelopeNotificationRequest\"\n },\n \"security\": null,\n \"skill_name\": \"notification_put_envelopes_envelope_id_notification\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Sets envelope notifications for an existing envelope.\",\n \"tags\": [\n \"Envelopes\"\n ]\n },\n \"notification_put_templates_template_id_notification\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Updates the notification structure for an existing template. Use this endpoint to set reminder and expiration notifications.\",\n \"destructive\": true,\n \"method\": \"PUT\",\n \"operation_id\": \"notification_put_templates_template_id_notification\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The ID of the template.\",\n \"in\": \"path\",\n \"name\": \"templateId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/templates/{templateId}/notification\",\n \"request_body\": {\n \"$ref\": \"#/definitions/templateNotificationRequest\"\n },\n \"security\": null,\n \"skill_name\": \"notification_put_templates_template_id_notification\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Updates the notification structure for an existing template.\",\n \"tags\": [\n \"Templates\"\n ]\n },\n \"pages_delete_page\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Deletes a page from a document in an envelope based on the page number.\",\n \"destructive\": true,\n \"method\": \"DELETE\",\n \"operation_id\": \"pages_delete_page\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The unique ID of the document within the envelope.\\n\\nUnlike other IDs in the eSignature API,\\nyou specify the `documentId` yourself.\\nTypically the first document has the ID\\n`1`, the second document `2`, and so on,\\nbut you can use any numbering scheme\\nthat fits within a 32-bit signed integer\\n(1 through 2147483647).\\n\\n\\nTab objects have a `documentId` property\\nthat specifies the document on which to place\\nthe tab.\\n\",\n \"in\": \"path\",\n \"name\": \"documentId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The envelope's GUID. \\n\\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\\n\",\n \"in\": \"path\",\n \"name\": \"envelopeId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The page number being accessed.\",\n \"in\": \"path\",\n \"name\": \"pageNumber\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/pages/{pageNumber}\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"pages_delete_page\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Deletes a page from a document in an envelope.\",\n \"tags\": [\n \"Envelopes\"\n ]\n },\n \"pages_delete_template_page\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Deletes a page from a document in a template based on the page number.\",\n \"destructive\": true,\n \"method\": \"DELETE\",\n \"operation_id\": \"pages_delete_template_page\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The unique ID of the document within the envelope.\\n\\nUnlike other IDs in the eSignature API,\\nyou specify the `documentId` yourself.\\nTypically the first document has the ID\\n`1`, the second document `2`, and so on,\\nbut you can use any numbering scheme\\nthat fits within a 32-bit signed integer\\n(1 through 2147483647).\\n\\n\\nTab objects have a `documentId` property\\nthat specifies the document on which to place\\nthe tab.\\n\",\n \"in\": \"path\",\n \"name\": \"documentId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The page number being accessed.\",\n \"in\": \"path\",\n \"name\": \"pageNumber\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The ID of the template.\",\n \"in\": \"path\",\n \"name\": \"templateId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/templates/{templateId}/documents/{documentId}/pages/{pageNumber}\",\n \"request_body\": {\n \"$ref\": \"#/definitions/pageRequest\"\n },\n \"security\": null,\n \"skill_name\": \"pages_delete_template_page\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Deletes a page from a document in an template.\",\n \"tags\": [\n \"Templates\"\n ]\n },\n \"pages_get_page_image\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Returns an image of a page in a document for display.\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"pages_get_page_image\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The unique ID of the document within the envelope.\\n\\nUnlike other IDs in the eSignature API,\\nyou specify the `documentId` yourself.\\nTypically the first document has the ID\\n`1`, the second document `2`, and so on,\\nbut you can use any numbering scheme\\nthat fits within a 32-bit signed integer\\n(1 through 2147483647).\\n\\n\\nTab objects have a `documentId` property\\nthat specifies the document on which to place\\nthe tab.\\n\",\n \"in\": \"path\",\n \"name\": \"documentId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The envelope's GUID. \\n\\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\\n\",\n \"in\": \"path\",\n \"name\": \"envelopeId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The page number being accessed.\",\n \"in\": \"path\",\n \"name\": \"pageNumber\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Sets the dots per inch (DPI) for the returned image.\",\n \"in\": \"query\",\n \"name\": \"dpi\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Sets the maximum height for the page image in pixels. The DPI is recalculated based on this setting.\",\n \"in\": \"query\",\n \"name\": \"max_height\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Sets the maximum width for the page image in pixels. The DPI is recalculated based on this setting.\",\n \"in\": \"query\",\n \"name\": \"max_width\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"When **true,** changes display in the user interface.\",\n \"in\": \"query\",\n \"name\": \"show_changes\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/pages/{pageNumber}/page_image\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"pages_get_page_image\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Gets a page image from an envelope for display.\",\n \"tags\": [\n \"Envelopes\"\n ]\n },\n \"pages_get_page_images\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Returns images of the pages in a document for display based on the parameters that you specify.\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"pages_get_page_images\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The unique ID of the document within the envelope.\\n\\nUnlike other IDs in the eSignature API,\\nyou specify the `documentId` yourself.\\nTypically the first document has the ID\\n`1`, the second document `2`, and so on,\\nbut you can use any numbering scheme\\nthat fits within a 32-bit signed integer\\n(1 through 2147483647).\\n\\n\\nTab objects have a `documentId` property\\nthat specifies the document on which to place\\nthe tab.\\n\",\n \"in\": \"path\",\n \"name\": \"documentId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The envelope's GUID. \\n\\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\\n\",\n \"in\": \"path\",\n \"name\": \"envelopeId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The maximum number of results to return.\",\n \"in\": \"query\",\n \"name\": \"count\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The number of dots per inch (DPI) for the resulting images. Valid values are 1-310 DPI. The default value is 94.\",\n \"in\": \"query\",\n \"name\": \"dpi\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Sets the maximum height of the returned images in pixels.\",\n \"in\": \"query\",\n \"name\": \"max_height\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Sets the maximum width of the returned images in pixels.\",\n \"in\": \"query\",\n \"name\": \"max_width\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"When **true,** using cache is disabled and image information is retrieved from a database. **True** is the default value. \",\n \"in\": \"query\",\n \"name\": \"nocache\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"When **true,** changes display in the user interface.\",\n \"in\": \"query\",\n \"name\": \"show_changes\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The position within the total result set from which to start returning values. The value **thumbnail** may be used to return the page image.\",\n \"in\": \"query\",\n \"name\": \"start_position\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/pages\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"pages_get_page_images\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Returns document page images based on input.\",\n \"tags\": [\n \"Envelopes\"\n ]\n },\n \"pages_get_template_page_image\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Retrieves a page image for display from the specified template.\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"pages_get_template_page_image\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The unique ID of the document within the envelope.\\n\\nUnlike other IDs in the eSignature API,\\nyou specify the `documentId` yourself.\\nTypically the first document has the ID\\n`1`, the second document `2`, and so on,\\nbut you can use any numbering scheme\\nthat fits within a 32-bit signed integer\\n(1 through 2147483647).\\n\\n\\nTab objects have a `documentId` property\\nthat specifies the document on which to place\\nthe tab.\\n\",\n \"in\": \"path\",\n \"name\": \"documentId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The page number being accessed.\",\n \"in\": \"path\",\n \"name\": \"pageNumber\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The ID of the template.\",\n \"in\": \"path\",\n \"name\": \"templateId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The number of dots per inch (DPI) for the resulting images. Valid values are 1-310 DPI. The default value is 94.\",\n \"in\": \"query\",\n \"name\": \"dpi\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Sets the maximum height of the returned images in pixels.\",\n \"in\": \"query\",\n \"name\": \"max_height\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Sets the maximum width of the returned images in pixels.\",\n \"in\": \"query\",\n \"name\": \"max_width\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"\",\n \"in\": \"query\",\n \"name\": \"show_changes\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/templates/{templateId}/documents/{documentId}/pages/{pageNumber}/page_image\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"pages_get_template_page_image\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Gets a page image from a template for display.\",\n \"tags\": [\n \"Templates\"\n ]\n },\n \"pages_get_template_page_images\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Returns images of the pages in a template document for display based on the parameters that you specify.\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"pages_get_template_page_images\",\n \"parameters\": [\n {\n \"description\": \"(Required) The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"(Required) The ID of the document.\",\n \"in\": \"path\",\n \"name\": \"documentId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"(Required) The ID of the template.\",\n \"in\": \"path\",\n \"name\": \"templateId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The maximum number of results to return.\",\n \"in\": \"query\",\n \"name\": \"count\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The number of dots per inch (DPI) for the resulting images. Valid values are 1-310 DPI. The default value is 94.\",\n \"in\": \"query\",\n \"name\": \"dpi\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Sets the maximum height of the returned images in pixels.\",\n \"in\": \"query\",\n \"name\": \"max_height\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Sets the maximum width of the returned images in pixels.\",\n \"in\": \"query\",\n \"name\": \"max_width\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"When **true,** using cache is disabled and image information is retrieved from a database. **True** is the default value. \",\n \"in\": \"query\",\n \"name\": \"nocache\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"When **true,** changes display in the user interface.\",\n \"in\": \"query\",\n \"name\": \"show_changes\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The position within the total result set from which to start returning values. The value **thumbnail** may be used to return the page image.\",\n \"in\": \"query\",\n \"name\": \"start_position\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/templates/{templateId}/documents/{documentId}/pages\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"pages_get_template_page_images\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Returns document page images based on input.\",\n \"tags\": [\n \"Templates\"\n ]\n },\n \"pages_put_page_image\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Rotates page image from an envelope for display. The page image can be rotated to the left or right.\",\n \"destructive\": true,\n \"method\": \"PUT\",\n \"operation_id\": \"pages_put_page_image\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The unique ID of the document within the envelope.\\n\\nUnlike other IDs in the eSignature API,\\nyou specify the `documentId` yourself.\\nTypically the first document has the ID\\n`1`, the second document `2`, and so on,\\nbut you can use any numbering scheme\\nthat fits within a 32-bit signed integer\\n(1 through 2147483647).\\n\\n\\nTab objects have a `documentId` property\\nthat specifies the document on which to place\\nthe tab.\\n\",\n \"in\": \"path\",\n \"name\": \"documentId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The envelope's GUID. \\n\\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\\n\",\n \"in\": \"path\",\n \"name\": \"envelopeId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The page number being accessed.\",\n \"in\": \"path\",\n \"name\": \"pageNumber\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/pages/{pageNumber}/page_image\",\n \"request_body\": {\n \"$ref\": \"#/definitions/pageRequest\"\n },\n \"security\": null,\n \"skill_name\": \"pages_put_page_image\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Rotates page image from an envelope for display.\",\n \"tags\": [\n \"Envelopes\"\n ]\n },\n \"pages_put_template_page_image\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Rotates page image from a template for display. The page image can be rotated to the left or right.\",\n \"destructive\": true,\n \"method\": \"PUT\",\n \"operation_id\": \"pages_put_template_page_image\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The unique ID of the document within the envelope.\\n\\nUnlike other IDs in the eSignature API,\\nyou specify the `documentId` yourself.\\nTypically the first document has the ID\\n`1`, the second document `2`, and so on,\\nbut you can use any numbering scheme\\nthat fits within a 32-bit signed integer\\n(1 through 2147483647).\\n\\n\\nTab objects have a `documentId` property\\nthat specifies the document on which to place\\nthe tab.\\n\",\n \"in\": \"path\",\n \"name\": \"documentId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The page number being accessed.\",\n \"in\": \"path\",\n \"name\": \"pageNumber\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The ID of the template.\",\n \"in\": \"path\",\n \"name\": \"templateId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/templates/{templateId}/documents/{documentId}/pages/{pageNumber}/page_image\",\n \"request_body\": {\n \"$ref\": \"#/definitions/pageRequest\"\n },\n \"security\": null,\n \"skill_name\": \"pages_put_template_page_image\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Rotates page image from a template for display.\",\n \"tags\": [\n \"Templates\"\n ]\n },\n \"password_rules_get_password_rules\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Gets membership account password rules.\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"password_rules_get_password_rules\",\n \"parameters\": [],\n \"path\": \"/v2.1/current_user/password_rules\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"password_rules_get_password_rules\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Gets membership account password rules.\",\n \"tags\": [\n \"AccountPasswordRules\"\n ]\n },\n \"payment_gateway_accounts_get_all_payment_gateway_accounts\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"This method returns a list of payment gateway accounts and basic information about them.\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"payment_gateway_accounts_get_all_payment_gateway_accounts\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/payment_gateway_accounts\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"payment_gateway_accounts_get_all_payment_gateway_accounts\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"List payment gateway accounts\",\n \"tags\": [\n \"PaymentGatewayAccounts\"\n ]\n },\n \"permission_profiles_delete_permission_profiles\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"This method deletes a permission profile from an account.\\n\\nTo delete a permission profile, it must not have any users associated with it. When you use this method to delete a permission profile, you can reassign the users associated with it to a new permission profile at the same time by using the `move_users_to` query parameter.\\n\\n\\n### Related topics\\n\\n- [How to delete a permission profile](/docs/esign-rest-api/how-to/permission-profile-deleting/)\",\n \"destructive\": true,\n \"method\": \"DELETE\",\n \"operation_id\": \"permission_profiles_delete_permission_profiles\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The ID of the permission profile.\\n\\nUse [AccountPermissionProfiles: list](/docs/esign-rest-api/reference/accounts/accountpermissionprofiles/list/)\\nto get a list of permission profiles and their IDs.\\n\\nYou can also download a CSV file of all permission profiles\\nand their IDs from the **Settings > Permission Profiles** page\\nof your eSignature account page.\\n\",\n \"in\": \"path\",\n \"name\": \"permissionProfileId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"\",\n \"in\": \"query\",\n \"name\": \"move_users_to\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/permission_profiles/{permissionProfileId}\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"permission_profiles_delete_permission_profiles\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Deletes a permission profile from an account.\",\n \"tags\": [\n \"AccountPermissionProfiles\"\n ]\n },\n \"permission_profiles_get_permission_profile\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"This method returns information about a specific permission profile that is associated with an account.\\n\\n### Related topics\\n\\n- [How to set a permission profile](/docs/esign-rest-api/how-to/permission-profile-setting/)\\n\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"permission_profiles_get_permission_profile\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The ID of the permission profile.\\n\\nUse [AccountPermissionProfiles: list](/docs/esign-rest-api/reference/accounts/accountpermissionprofiles/list/)\\nto get a list of permission profiles and their IDs.\\n\\nYou can also download a CSV file of all permission profiles\\nand their IDs from the **Settings > Permission Profiles** page\\nof your eSignature account page.\\n\",\n \"in\": \"path\",\n \"name\": \"permissionProfileId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"A comma-separated list of additional properties to return in the response. The only valid value for this request is `metadata`, which returns metadata indicating whether the properties associated with the account permission profile are editable.\",\n \"in\": \"query\",\n \"name\": \"include\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/permission_profiles/{permissionProfileId}\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"permission_profiles_get_permission_profile\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Returns a permission profile for an account.\",\n \"tags\": [\n \"AccountPermissionProfiles\"\n ]\n },\n \"permission_profiles_get_permission_profiles\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"This method returns a list of permission profiles that are associated with an account.\\n\\nExample:\\n\\n```json\\n{\\n \\\"permissionProfiles\\\": [\\n {\\n \\\"permissionProfileId\\\": \\\"1665536\\\",\\n \\\"permissionProfileName\\\": \\\"Account Administrator\\\",\\n \\\"modifiedDateTime\\\": \\\"2018-03-26T03:54:40.4470000Z\\\",\\n \\\"modifiedByUsername\\\": \\\"\\\"\\n },\\n {\\n \\\"permissionProfileId\\\": \\\"1665537\\\",\\n \\\"permissionProfileName\\\": \\\"DocuSign Sender\\\",\\n \\\"modifiedDateTime\\\": \\\"2018-03-26T03:54:40.4470000Z\\\",\\n \\\"modifiedByUsername\\\": \\\"\\\"\\n },\\n {\\n \\\"permissionProfileId\\\": \\\"1665538\\\",\\n \\\"permissionProfileName\\\": \\\"DocuSign Viewer\\\",\\n \\\"modifiedDateTime\\\": \\\"2016-06-02T01:53:15.6830000Z\\\",\\n \\\"modifiedByUsername\\\": \\\"\\\"\\n },\\n {\\n \\\"permissionProfileId\\\": \\\"10325926\\\",\\n \\\"permissionProfileName\\\": \\\"DS Manage Company Member Accounts\\\",\\n \\\"modifiedDateTime\\\": \\\"2020-05-15T00:28:36.8230000Z\\\",\\n \\\"modifiedByUsername\\\": \\\"Nat Irving\\\"\\n }\\n ]\\n}\\n```\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"permission_profiles_get_permission_profiles\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"A comma-separated list of additional properties to return in the response. Valid values are:\\n\\n- `user_count`: The total number of users associated with the permission profile.\\n- `closed_users`: Includes closed users in the `user_count`.\\n- `account_management`: The account management settings.\\n- `metadata`: Metadata indicating whether the properties associated with the account permission profile are editable.\\n\\nExample: `user_count,closed_users`\\n\",\n \"in\": \"query\",\n \"name\": \"include\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/permission_profiles\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"permission_profiles_get_permission_profiles\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Gets a list of permission profiles.\",\n \"tags\": [\n \"AccountPermissionProfiles\"\n ]\n },\n \"permission_profiles_post_permission_profiles\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"This method creates a new permission profile for an account.\\n\\n### Related topics\\n\\n- [How to create a permission profile](/docs/esign-rest-api/how-to/permission-profile-creating/)\\n\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"permission_profiles_post_permission_profiles\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"A comma-separated list of additional properties to return in the response. The only valid value for this request is `metadata`, which returns metadata indicating whether the properties associated with the account permission profile are editable.\",\n \"in\": \"query\",\n \"name\": \"include\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/permission_profiles\",\n \"request_body\": {\n \"$ref\": \"#/definitions/permissionProfile\"\n },\n \"security\": null,\n \"skill_name\": \"permission_profiles_post_permission_profiles\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Creates a new permission profile for an account.\",\n \"tags\": [\n \"AccountPermissionProfiles\"\n ]\n },\n \"permission_profiles_put_permission_profiles\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"This method updates an account permission profile.\\n\\n### Related topics\\n\\n- [How to update individual permission settings](/docs/esign-rest-api/how-to/permission-profile-updating/)\\n\",\n \"destructive\": true,\n \"method\": \"PUT\",\n \"operation_id\": \"permission_profiles_put_permission_profiles\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The ID of the permission profile.\\n\\nUse [AccountPermissionProfiles: list](/docs/esign-rest-api/reference/accounts/accountpermissionprofiles/list/)\\nto get a list of permission profiles and their IDs.\\n\\nYou can also download a CSV file of all permission profiles\\nand their IDs from the **Settings > Permission Profiles** page\\nof your eSignature account page.\\n\",\n \"in\": \"path\",\n \"name\": \"permissionProfileId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"A comma-separated list of additional properties to return in the response. The only valid value for this request is `metadata`, which returns metadata indicating whether the properties associated with the account permission profile are editable.\",\n \"in\": \"query\",\n \"name\": \"include\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/permission_profiles/{permissionProfileId}\",\n \"request_body\": {\n \"$ref\": \"#/definitions/permissionProfile\"\n },\n \"security\": null,\n \"skill_name\": \"permission_profiles_put_permission_profiles\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Updates a permission profile.\",\n \"tags\": [\n \"AccountPermissionProfiles\"\n ]\n },\n \"power_forms_delete_power_form\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"This method deletes a PowerForm.\",\n \"destructive\": true,\n \"method\": \"DELETE\",\n \"operation_id\": \"power_forms_delete_power_form\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The ID of the PowerForm.\",\n \"in\": \"path\",\n \"name\": \"powerFormId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/powerforms/{powerFormId}\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"power_forms_delete_power_form\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Deletes a PowerForm.\",\n \"tags\": [\n \"PowerForms\"\n ]\n },\n \"power_forms_delete_power_forms_list\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"This method deletes one or more PowerForms. The request body takes an array of PowerForm objects that are deleted based on the `powerFormId`.\",\n \"destructive\": true,\n \"method\": \"DELETE\",\n \"operation_id\": \"power_forms_delete_power_forms_list\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/powerforms\",\n \"request_body\": {\n \"$ref\": \"#/definitions/powerFormsRequest\"\n },\n \"security\": null,\n \"skill_name\": \"power_forms_delete_power_forms_list\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Deletes one or more PowerForms.\",\n \"tags\": [\n \"PowerForms\"\n ]\n },\n \"power_forms_get_power_form\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"This method returns detailed information about a specific PowerForm.\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"power_forms_get_power_form\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The ID of the PowerForm.\",\n \"in\": \"path\",\n \"name\": \"powerFormId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/powerforms/{powerFormId}\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"power_forms_get_power_form\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Returns a single PowerForm.\",\n \"tags\": [\n \"PowerForms\"\n ]\n },\n \"power_forms_get_power_form_form_data\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"This method enables Powerform Administrators or the sender of a PowerForm to download the data that recipients have entered into a PowerForm.\\n\\nYou specify the format in which you want to retrieve the data in the `Accept` header. This header accepts the following values:\\n- `application/json`: JSON format\\n- `application/xml`: XML format\\n- `text/csv`: Comma-separated value (CSV) format\\n\\nYou can further specify the type of CSV format in the `data_layout` query parameter.\\n\\n**Note:** Only PowerForm Administrators or the PowerForm Sender can download the data associated with a PowerForm.\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"power_forms_get_power_form_form_data\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The ID of the PowerForm.\",\n \"in\": \"path\",\n \"name\": \"powerFormId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The layout in which to return the PowerForm data. \\n\\nFor each of the following layouts, set the `Accept` header to the corresponding value.\\n\\nValid values are:\\n\\n- `Native` (Set `Accept` header to `application/json`)\\n- `Csv_Classic` (Set `Accept` header to `application/csv`)\\n- `Csv_One_Envelope_Per_Line` (Set `Accept` header to `text/csv`)\\n- `Xml_Classic` (Set `Accept` header to `application/xml`)\",\n \"in\": \"query\",\n \"name\": \"data_layout\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The start date for a date range in UTC DateTime format.\\n\\n**Note:** If this property is null, no date filtering is applied.\",\n \"in\": \"query\",\n \"name\": \"from_date\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The end date of a date range in UTC DateTime format. The default value is `UtcNow`.\",\n \"in\": \"query\",\n \"name\": \"to_date\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/powerforms/{powerFormId}/form_data\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"power_forms_get_power_form_form_data\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Returns the data that users entered in a PowerForm.\",\n \"tags\": [\n \"PowerFormData\"\n ]\n },\n \"power_forms_get_power_forms_list\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"This method returns a list of PowerForms that are available to the user.\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"power_forms_get_power_forms_list\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The maximum number of results to return.\",\n \"in\": \"query\",\n \"name\": \"count\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The start date for a date range.\\n\\n**Note:** If no value is provided, no date filtering is applied.\",\n \"in\": \"query\",\n \"name\": \"from_date\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The order in which to sort the results.\\n\\nValid values are: \\n\\n\\n* `asc`: Ascending order.\\n* `desc`: Descending order. \",\n \"in\": \"query\",\n \"name\": \"order\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The file attribute to use to sort the results.\\n\\nValid values are:\\n\\n- `sender`\\n- `auth`\\n- `used`\\n- `remaining`\\n- `lastused`\\n- `status`\\n- `type`\\n- `templatename`\\n- `created`\",\n \"in\": \"query\",\n \"name\": \"order_by\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"A comma-separated list of additional properties to include in a search.\\n\\n- `sender`: Include sender name and email in the search.\\n- `recipients`: Include recipient names and emails in the search.\\n- `envelope`: Include envelope information in the search.\\n\",\n \"in\": \"query\",\n \"name\": \"search_fields\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Use this parameter to search for specific text.\",\n \"in\": \"query\",\n \"name\": \"search_text\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The position within the total result set from which to start returning values. The value **thumbnail** may be used to return the page image.\",\n \"in\": \"query\",\n \"name\": \"start_position\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The end date for a date range.\\n\\n**Note:** If no value is provided, this property defaults to the current date.\",\n \"in\": \"query\",\n \"name\": \"to_date\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/powerforms\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"power_forms_get_power_forms_list\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Returns a list of PowerForms.\",\n \"tags\": [\n \"PowerForms\"\n ]\n },\n \"power_forms_get_power_forms_senders\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"This method returns a list of users who have sent PowerForms.\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"power_forms_get_power_forms_senders\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The position within the total result set from which to start returning values. The value **thumbnail** may be used to return the page image.\",\n \"in\": \"query\",\n \"name\": \"start_position\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/powerforms/senders\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"power_forms_get_power_forms_senders\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Gets PowerForm senders.\",\n \"tags\": [\n \"PowerForms\"\n ]\n },\n \"power_forms_post_power_form\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"This method creates a new PowerForm.\\n\\nYou create a PowerForm from an existing Docusign [template](/docs/esign-rest-api/reference/templates/templates/create/), based on the `templateId` in the request body.\\n\\n PowerForms that you create from a template are referred to as *web PowerForms*.\\n\\n**Note:** The Docusign Admin console also supports creating a PowerForm by uploading a PDF file that has active form fields (referred to as a *PDF PowerForm*). However, PDF PowerForms are deprecated and are not supported in the API.\\n\\n**Note:** A PowerForm can have only one sender. (Because PowerForms are not necessarily sent by email, this user is also referred to as the PowerForm *initiator*.) If you need to associate multiple senders with a PowerForm, create multiple copies of the PowerForm by using the same template (one copy for each sender). By default, the sender is the PowerForm Administrator who creates the PowerForm.\\n\\n\\n### Signing modes\\n\\nYou can use one of the following signing modes for a PowerForm:\\n\\n**`email`**\\n\\nThis mode verifies the recipient's identity by using email authentication before the recipient can sign a document. The recipient enters their email address on the landing page and then clicks **Begin Signing** to begin the signing process. The system then sends an email message with a validation code to the recipient. If the recipient does not provide a valid email address, they do not receive the email message containing the access code and are not able to open and sign the document.\\n\\nAlternatively, you can make the process easier for signers by using email authentication only and omitting the access code. To do this, you append the `activateonly` flag to the PowerForm URL and set it to true by passing in the value `1`. When the flag is active, the first recipient receives an email with a link that initiates the signing session without having to enter access code.\\n\\nExample: `activateonly=1`\\n\\n**`direct`**\\n\\nThis mode does not require any verification. After a recipient enters their email address on the landing page and clicks **Begin Signing,** a new browser tab opens and the recipient can immediately begin the signing process.\\n\\nBecause the `direct` signing mode does not verify the recipient's identity by using email authentication, we strongly recommend that you use this mode only when the PowerForm is accessible behind a secure portal where the recipient's identity is already authenticated, or where another form of authentication is specified for the recipient in the Docusign template (for example, an access code, phone authentication, or ID check).\\n\\n**Note:** In the account settings, `enablePowerFormDirect` must be **true** to use `direct` as the `signingMode`.\\n\\n### Redirect URLs\\n\\nYou can control the URL to which signers are redirected after signing your PowerForm. However, the URL is specified elsewhere, outside of the PowerForm creation process. For details, see [How do I specify a URL to redirect to when a PowerForm is completed?](https://support.docusign.com/s/articles/How-do-I-specify-a-URL-to-redirect-to-when-a-Powerform-is-completed).\\n\\n### More information\\n\\nFor more information about creating PowerForms, see [Create a PowerForm](https://support.docusign.com/en/guides/ndse-user-guide-create-a-powerform).\\n\\n\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"power_forms_post_power_form\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/powerforms\",\n \"request_body\": {\n \"$ref\": \"#/definitions/powerForm\"\n },\n \"security\": null,\n \"skill_name\": \"power_forms_post_power_form\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Creates a new PowerForm\",\n \"tags\": [\n \"PowerForms\"\n ]\n },\n \"power_forms_put_power_form\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"This method updates an existing PowerForm.\",\n \"destructive\": true,\n \"method\": \"PUT\",\n \"operation_id\": \"power_forms_put_power_form\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The ID of the PowerForm.\",\n \"in\": \"path\",\n \"name\": \"powerFormId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/powerforms/{powerFormId}\",\n \"request_body\": {\n \"$ref\": \"#/definitions/powerForm\"\n },\n \"security\": null,\n \"skill_name\": \"power_forms_put_power_form\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Updates an existing PowerForm.\",\n \"tags\": [\n \"PowerForms\"\n ]\n },\n \"purchased_envelopes_put_purchased_envelopes\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Reserved: At this time, this endpoint is limited to Docusign internal use only. Completes the purchase of envelopes for your account. The actual purchase is done as part of an internal workflow interaction with an envelope vendor.\",\n \"destructive\": true,\n \"method\": \"PUT\",\n \"operation_id\": \"purchased_envelopes_put_purchased_envelopes\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/billing_plan/purchased_envelopes\",\n \"request_body\": {\n \"$ref\": \"#/definitions/purchasedEnvelopesInformation\"\n },\n \"security\": null,\n \"skill_name\": \"purchased_envelopes_put_purchased_envelopes\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Reserved: Purchase additional envelopes.\",\n \"tags\": [\n \"BillingPlans\"\n ]\n },\n \"recipients_delete_recipient\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Deletes a recipient from a `draft` or `sent` envelope.\\n\\nIf the envelope is \\\"In Process\\\" (has been sent and is not completed or voided), recipients that have completed their actions cannot be deleted.\",\n \"destructive\": true,\n \"method\": \"DELETE\",\n \"operation_id\": \"recipients_delete_recipient\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The envelope's GUID. \\n\\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\\n\",\n \"in\": \"path\",\n \"name\": \"envelopeId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"A local reference used to map\\nrecipients to other objects, such as specific\\ndocument tabs.\\n\\nA `recipientId` must be\\neither an integer or a GUID,\\nand the `recipientId` must be\\nunique within an envelope.\\n\\nFor example, many envelopes assign the first recipient\\na `recipientId` of `1`.\\n\",\n \"in\": \"path\",\n \"name\": \"recipientId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"recipients_delete_recipient\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Deletes a recipient from an envelope.\",\n \"tags\": [\n \"EnvelopeRecipients\"\n ]\n },\n \"recipients_delete_recipient_tabs\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Deletes one or more tabs associated with a recipient in a draft envelope.\",\n \"destructive\": true,\n \"method\": \"DELETE\",\n \"operation_id\": \"recipients_delete_recipient_tabs\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The envelope's GUID. \\n\\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\\n\",\n \"in\": \"path\",\n \"name\": \"envelopeId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"A local reference used to map\\nrecipients to other objects, such as specific\\ndocument tabs.\\n\\nA `recipientId` must be\\neither an integer or a GUID,\\nand the `recipientId` must be\\nunique within an envelope.\\n\\nFor example, many envelopes assign the first recipient\\na `recipientId` of `1`.\\n\",\n \"in\": \"path\",\n \"name\": \"recipientId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/tabs\",\n \"request_body\": {\n \"$ref\": \"#/definitions/EnvelopeRecipientTabs\"\n },\n \"security\": null,\n \"skill_name\": \"recipients_delete_recipient_tabs\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Deletes the tabs associated with a recipient.\\n\\n**Note:** It is an error to delete a tab that has the\\n`templateLocked` property set to true.\\nThis property corresponds to the **Restrict changes** option in the web app.\\n\\n\",\n \"tags\": [\n \"EnvelopeRecipientTabs\"\n ]\n },\n \"recipients_delete_recipients\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Deletes one or more recipients from a draft or sent envelope. List the recipients that you want to delete in the body of the request. This method uses the `recipientId` as the key for deleting recipients.\\n\\nIf the envelope is `In Process`, meaning that it has been sent and has not been completed or voided, recipients that have completed their actions cannot be deleted.\",\n \"destructive\": true,\n \"method\": \"DELETE\",\n \"operation_id\": \"recipients_delete_recipients\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The envelope's GUID. \\n\\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\\n\",\n \"in\": \"path\",\n \"name\": \"envelopeId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients\",\n \"request_body\": {\n \"$ref\": \"#/definitions/EnvelopeRecipients\"\n },\n \"security\": null,\n \"skill_name\": \"recipients_delete_recipients\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Deletes recipients from an envelope.\",\n \"tags\": [\n \"EnvelopeRecipients\"\n ]\n },\n \"recipients_delete_template_recipient\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Deletes the specified recipient file from the specified template.\",\n \"destructive\": true,\n \"method\": \"DELETE\",\n \"operation_id\": \"recipients_delete_template_recipient\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"A local reference used to map\\nrecipients to other objects, such as specific\\ndocument tabs.\\n\\nA `recipientId` must be\\neither an integer or a GUID,\\nand the `recipientId` must be\\nunique within an envelope.\\n\\nFor example, many envelopes assign the first recipient\\na `recipientId` of `1`.\\n\",\n \"in\": \"path\",\n \"name\": \"recipientId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The ID of the template.\",\n \"in\": \"path\",\n \"name\": \"templateId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/templates/{templateId}/recipients/{recipientId}\",\n \"request_body\": {\n \"$ref\": \"#/definitions/templateRecipients\"\n },\n \"security\": null,\n \"skill_name\": \"recipients_delete_template_recipient\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Deletes the specified recipient file from a template.\",\n \"tags\": [\n \"TemplateRecipients\"\n ]\n },\n \"recipients_delete_template_recipient_tabs\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Deletes one or more tabs associated with a recipient in a template.\",\n \"destructive\": true,\n \"method\": \"DELETE\",\n \"operation_id\": \"recipients_delete_template_recipient_tabs\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"A local reference used to map\\nrecipients to other objects, such as specific\\ndocument tabs.\\n\\nA `recipientId` must be\\neither an integer or a GUID,\\nand the `recipientId` must be\\nunique within an envelope.\\n\\nFor example, many envelopes assign the first recipient\\na `recipientId` of `1`.\\n\",\n \"in\": \"path\",\n \"name\": \"recipientId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The ID of the template.\",\n \"in\": \"path\",\n \"name\": \"templateId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/templates/{templateId}/recipients/{recipientId}/tabs\",\n \"request_body\": {\n \"$ref\": \"#/definitions/templateTabs\"\n },\n \"security\": null,\n \"skill_name\": \"recipients_delete_template_recipient_tabs\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Deletes the tabs associated with a recipient in a template.\",\n \"tags\": [\n \"TemplateRecipientTabs\"\n ]\n },\n \"recipients_delete_template_recipients\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Deletes one or more recipients from a template. Recipients to be deleted are listed in the request, with the `recipientId` being used as the key for deleting recipients.\",\n \"destructive\": true,\n \"method\": \"DELETE\",\n \"operation_id\": \"recipients_delete_template_recipients\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The ID of the template.\",\n \"in\": \"path\",\n \"name\": \"templateId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/templates/{templateId}/recipients\",\n \"request_body\": {\n \"$ref\": \"#/definitions/templateRecipients\"\n },\n \"security\": null,\n \"skill_name\": \"recipients_delete_template_recipients\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Deletes recipients from a template.\",\n \"tags\": [\n \"TemplateRecipients\"\n ]\n },\n \"recipients_get_recipient_document_visibility\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"This method returns information about document visibility for a recipient.\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"recipients_get_recipient_document_visibility\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The envelope's GUID. \\n\\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\\n\",\n \"in\": \"path\",\n \"name\": \"envelopeId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"A local reference used to map\\nrecipients to other objects, such as specific\\ndocument tabs.\\n\\nA `recipientId` must be\\neither an integer or a GUID,\\nand the `recipientId` must be\\nunique within an envelope.\\n\\nFor example, many envelopes assign the first recipient\\na `recipientId` of `1`.\\n\",\n \"in\": \"path\",\n \"name\": \"recipientId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/document_visibility\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"recipients_get_recipient_document_visibility\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Returns document visibility for a recipient\",\n \"tags\": [\n \"EnvelopeDocumentVisibility\"\n ]\n },\n \"recipients_get_recipient_initials_image\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Retrieves the initials image for the specified recipient.\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"recipients_get_recipient_initials_image\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The envelope's GUID. \\n\\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\\n\",\n \"in\": \"path\",\n \"name\": \"envelopeId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"A local reference used to map\\nrecipients to other objects, such as specific\\ndocument tabs.\\n\\nA `recipientId` must be\\neither an integer or a GUID,\\nand the `recipientId` must be\\nunique within an envelope.\\n\\nFor example, many envelopes assign the first recipient\\na `recipientId` of `1`.\\n\",\n \"in\": \"path\",\n \"name\": \"recipientId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Obsolete. The chrome is included in the image if it's present in the envelope.\",\n \"in\": \"query\",\n \"name\": \"include_chrome\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/initials_image\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"recipients_get_recipient_initials_image\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Gets the initials image for a user.\",\n \"tags\": [\n \"Envelopes\"\n ]\n },\n \"recipients_get_recipient_signature\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Retrieves signature information for a signer or sign-in-person recipient.\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"recipients_get_recipient_signature\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The envelope's GUID. \\n\\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\\n\",\n \"in\": \"path\",\n \"name\": \"envelopeId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"A local reference used to map\\nrecipients to other objects, such as specific\\ndocument tabs.\\n\\nA `recipientId` must be\\neither an integer or a GUID,\\nand the `recipientId` must be\\nunique within an envelope.\\n\\nFor example, many envelopes assign the first recipient\\na `recipientId` of `1`.\\n\",\n \"in\": \"path\",\n \"name\": \"recipientId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/signature\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"recipients_get_recipient_signature\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Gets signature information for a signer or sign-in-person recipient.\",\n \"tags\": [\n \"Envelopes\"\n ]\n },\n \"recipients_get_recipient_signature_image\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Retrieves the specified recipient signature image.\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"recipients_get_recipient_signature_image\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The envelope's GUID. \\n\\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\\n\",\n \"in\": \"path\",\n \"name\": \"envelopeId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"A local reference used to map\\nrecipients to other objects, such as specific\\ndocument tabs.\\n\\nA `recipientId` must be\\neither an integer or a GUID,\\nand the `recipientId` must be\\nunique within an envelope.\\n\\nFor example, many envelopes assign the first recipient\\na `recipientId` of `1`.\\n\",\n \"in\": \"path\",\n \"name\": \"recipientId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Obsolete. The chrome is included in the image if it's present in the envelope.\",\n \"in\": \"query\",\n \"name\": \"include_chrome\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/signature_image\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"recipients_get_recipient_signature_image\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Retrieve signature image information for a signer/sign-in-person recipient.\",\n \"tags\": [\n \"Envelopes\"\n ]\n },\n \"recipients_get_recipient_tabs\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Retrieves information about the tabs associated\\nwith a recipient. You can make a single API call\\nto get all the tab values and information from a\\ngiven, completed envelope in addition to draft\\nones. Tab values can be retrieved by using the\\n[EnvelopeRecipients:list method](/docs/esign-rest-api/reference/envelopes/enveloperecipients/list/)\\nwith query parameter `include_tabs` set to **true.**\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"recipients_get_recipient_tabs\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The envelope's GUID. \\n\\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\\n\",\n \"in\": \"path\",\n \"name\": \"envelopeId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"A local reference used to map\\nrecipients to other objects, such as specific\\ndocument tabs.\\n\\nA `recipientId` must be\\neither an integer or a GUID,\\nand the `recipientId` must be\\nunique within an envelope.\\n\\nFor example, many envelopes assign the first recipient\\na `recipientId` of `1`.\\n\",\n \"in\": \"path\",\n \"name\": \"recipientId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"When **true,** all tabs with anchor tab properties are included in the response. The default value is **false.**\",\n \"in\": \"query\",\n \"name\": \"include_anchor_tab_locations\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"When **true,** the response includes metadata indicating which properties are editable.\",\n \"in\": \"query\",\n \"name\": \"include_metadata\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/tabs\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"recipients_get_recipient_tabs\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Gets the tabs information for a signer or sign-in-person recipient in an envelope.\",\n \"tags\": [\n \"EnvelopeRecipientTabs\"\n ]\n },\n \"recipients_get_recipients\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Retrieves the status of all recipients in a single envelope and identifies the current recipient in the routing list. This method can also be used to retrieve the tab values.\\n\\nThe `currentRoutingOrder` property of the response contains the `routingOrder` value of the current recipient indicating that the envelope has been sent to the recipient, but the recipient has not completed their actions.\\n\\n### Related topics\\n\\n- [How to list envelope recipients](/docs/esign-rest-api/how-to/get-envelope-recipients/)\\n- [How to retrieve ID Evidence events](/docs/idevidence-api/how-to/retrieve-idevidence-events/)\\n- [How to retrieve ID Evidence media](/docs/idevidence-api/how-to/retrieve-idevidence-media/)\\n\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"recipients_get_recipients\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The envelope's GUID. \\n\\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\\n\",\n \"in\": \"path\",\n \"name\": \"envelopeId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \" When **true** and `include_tabs` value is set to **true,** all tabs with anchor tab properties are included in the response. \",\n \"in\": \"query\",\n \"name\": \"include_anchor_tab_locations\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \" When **true,** the extended properties are included in the response. \",\n \"in\": \"query\",\n \"name\": \"include_extended\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Boolean value that specifies whether to include metadata associated with the recipients (for envelopes only, not templates).\",\n \"in\": \"query\",\n \"name\": \"include_metadata\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"When **true,** the tab information associated with the recipient is included in the response.\",\n \"in\": \"query\",\n \"name\": \"include_tabs\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"recipients_get_recipients\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Gets the status of recipients for an envelope.\",\n \"tags\": [\n \"EnvelopeRecipients\"\n ]\n },\n \"recipients_get_template_recipient_document_visibility\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"This method returns information about document visibility for a template recipient.\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"recipients_get_template_recipient_document_visibility\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"A local reference used to map\\nrecipients to other objects, such as specific\\ndocument tabs.\\n\\nA `recipientId` must be\\neither an integer or a GUID,\\nand the `recipientId` must be\\nunique within an envelope.\\n\\nFor example, many envelopes assign the first recipient\\na `recipientId` of `1`.\\n\",\n \"in\": \"path\",\n \"name\": \"recipientId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The ID of the template.\",\n \"in\": \"path\",\n \"name\": \"templateId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/templates/{templateId}/recipients/{recipientId}/document_visibility\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"recipients_get_template_recipient_document_visibility\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Returns document visibility for a template recipient\",\n \"tags\": [\n \"TemplateDocumentVisibility\"\n ]\n },\n \"recipients_get_template_recipient_tabs\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Gets the tabs information for a signer or sign-in-person recipient in a template.\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"recipients_get_template_recipient_tabs\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"A local reference used to map\\nrecipients to other objects, such as specific\\ndocument tabs.\\n\\nA `recipientId` must be\\neither an integer or a GUID,\\nand the `recipientId` must be\\nunique within an envelope.\\n\\nFor example, many envelopes assign the first recipient\\na `recipientId` of `1`.\\n\",\n \"in\": \"path\",\n \"name\": \"recipientId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The ID of the template.\",\n \"in\": \"path\",\n \"name\": \"templateId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"When **true,** all tabs with anchor tab properties are included in the response. The default value is **false.**\",\n \"in\": \"query\",\n \"name\": \"include_anchor_tab_locations\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"When **true,** the response includes metadata indicating which properties are editable.\",\n \"in\": \"query\",\n \"name\": \"include_metadata\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/templates/{templateId}/recipients/{recipientId}/tabs\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"recipients_get_template_recipient_tabs\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Gets the tabs information for a signer or sign-in-person recipient in a template.\",\n \"tags\": [\n \"TemplateRecipientTabs\"\n ]\n },\n \"recipients_get_template_recipients\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Retrieves the information for all recipients in the specified template.\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"recipients_get_template_recipients\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The ID of the template.\",\n \"in\": \"path\",\n \"name\": \"templateId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \" When **true** and `include_tabs` is set to **true,** all tabs with anchor tab properties are included in the response. \",\n \"in\": \"query\",\n \"name\": \"include_anchor_tab_locations\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \" When **true,** the extended properties are included in the response. \",\n \"in\": \"query\",\n \"name\": \"include_extended\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"When **true,** the tab information associated with the recipient is included in the response.\",\n \"in\": \"query\",\n \"name\": \"include_tabs\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/templates/{templateId}/recipients\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"recipients_get_template_recipients\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Gets recipient information from a template.\",\n \"tags\": [\n \"TemplateRecipients\"\n ]\n },\n \"recipients_post_recipient_proof_file_resource_token\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Creates a resource token for a sender. This token allows a sender to return identification data for a recipient using the [ID Evidence API](/docs/idevidence-api/).\\n\\n### Related topics\\n\\n- [How to retrieve ID Evidence events](/docs/idevidence-api/how-to/retrieve-idevidence-events/)\\n- [How to retrieve ID Evidence media](/docs/idevidence-api/how-to/retrieve-idevidence-media/)\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"recipients_post_recipient_proof_file_resource_token\",\n \"parameters\": [\n {\n \"description\": \"The account ID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The envelope's GUID. \\n\\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\\n\",\n \"in\": \"path\",\n \"name\": \"envelopeId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The `recipientIdGuid`.\",\n \"in\": \"path\",\n \"name\": \"recipientId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"\",\n \"in\": \"query\",\n \"name\": \"token_scopes\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/identity_proof_token\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"recipients_post_recipient_proof_file_resource_token\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Creates a resource token for a sender to request ID Evidence data. \",\n \"tags\": [\n \"EnvelopeRecipients\"\n ]\n },\n \"recipients_post_recipient_tabs\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Adds one or more tabs for a recipient.\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"recipients_post_recipient_tabs\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The envelope's GUID. \\n\\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\\n\",\n \"in\": \"path\",\n \"name\": \"envelopeId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"A local reference used to map\\nrecipients to other objects, such as specific\\ndocument tabs.\\n\\nA `recipientId` must be\\neither an integer or a GUID,\\nand the `recipientId` must be\\nunique within an envelope.\\n\\nFor example, many envelopes assign the first recipient\\na `recipientId` of `1`.\\n\",\n \"in\": \"path\",\n \"name\": \"recipientId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/tabs\",\n \"request_body\": {\n \"$ref\": \"#/definitions/EnvelopeRecipientTabs\"\n },\n \"security\": null,\n \"skill_name\": \"recipients_post_recipient_tabs\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Adds tabs for a recipient.\",\n \"tags\": [\n \"EnvelopeRecipientTabs\"\n ]\n },\n \"recipients_post_recipients\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Adds one or more recipients to an envelope.\\n\\nFor an in-process envelope,\\none that has been sent and has not been completed or voided,\\nan email is sent to a new recipient\\nwhen they are reached in the routing order.\\nIf the new recipient's routing order\\nis before or the same as the envelope's\\nnext recipient,\\nan email is only sent if the optional\\n`resend_envelope` query string is set to **true.**\\n\\n\\n**Note:** This method works on recipients only.\\nTo add recipient tabs,\\nuse methods from the [EnvelopeRecipientTabs][recipientTabs] resource.\\nFor example, this request body will add a recipient (`astanton@example.com`)\\nbut **NOT** the Sign Here recipient tab.\\n\\n```json\\n{\\n \\\"signers\\\": [\\n {\\n \\\"email\\\": \\\"astanton@example.com\\\",\\n \\\"name\\\": \\\"Anne Stanton\\\",\\n \\\"recipientId\\\": \\\"1\\\",\\n \\\"tabs\\\": { // These tabs will NOT be added\\n \\\"signHereTabs\\\": [ // with this method. See note above.\\n {\\n \\\"anchorString\\\": \\\"below\\\",\\n \\\"tooltip\\\": \\\"please sign here\\\"\\n },\\n . . .\\n ]\\n }\\n }\\n ]\\n}\\n```\\n\\n[recipientTabs]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/\\n\\n\\n### Related topics\\n\\n- [How to bulk send envelopes](/docs/esign-rest-api/how-to/bulk-send-envelopes/)\\n- [How to request a signature by email](/docs/esign-rest-api/how-to/request-signature-email-remote/)\\n- [How to request a signature through your app](/docs/esign-rest-api/how-to/request-signature-in-app-embedded/)\\n\\n\\n\\n\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"recipients_post_recipients\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The envelope's GUID. \\n\\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\\n\",\n \"in\": \"path\",\n \"name\": \"envelopeId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"When **true,**\\nforces the envelope to be resent\\nif it would not be resent otherwise.\\n\\nOrdinarily, if the recipient's routing order\\nis before or the same as the envelope's next recipient,\\nthe envelope is not resent.\\n\\nSetting this query parameter\\nto **false** has no effect and is the same as omitting\\nit altogether.\\n\",\n \"in\": \"query\",\n \"name\": \"resend_envelope\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients\",\n \"request_body\": {\n \"$ref\": \"#/definitions/EnvelopeRecipients\"\n },\n \"security\": null,\n \"skill_name\": \"recipients_post_recipients\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Adds one or more recipients to an envelope.\",\n \"tags\": [\n \"EnvelopeRecipients\"\n ]\n },\n \"recipients_post_template_recipient_tabs\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Adds one or more tabs for a recipient.\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"recipients_post_template_recipient_tabs\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"A local reference used to map\\nrecipients to other objects, such as specific\\ndocument tabs.\\n\\nA `recipientId` must be\\neither an integer or a GUID,\\nand the `recipientId` must be\\nunique within an envelope.\\n\\nFor example, many envelopes assign the first recipient\\na `recipientId` of `1`.\\n\",\n \"in\": \"path\",\n \"name\": \"recipientId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The ID of the template.\",\n \"in\": \"path\",\n \"name\": \"templateId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/templates/{templateId}/recipients/{recipientId}/tabs\",\n \"request_body\": {\n \"$ref\": \"#/definitions/templateTabs\"\n },\n \"security\": null,\n \"skill_name\": \"recipients_post_template_recipient_tabs\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Adds tabs for a recipient.\",\n \"tags\": [\n \"TemplateRecipientTabs\"\n ]\n },\n \"recipients_post_template_recipients\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Adds one or more recipients to a template.\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"recipients_post_template_recipients\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The ID of the template.\",\n \"in\": \"path\",\n \"name\": \"templateId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"When **true,**\\nresends the envelope to the recipients\\nthat you specify in the request body.\\nUse this parameter to resend the envelope\\nto a recipient\\nwho deleted the original email notification.\\n\\n**Note:** Correcting an envelope is a different process.\\nDocusign always resends an envelope when you correct it,\\nregardless of the value that you enter here.\",\n \"in\": \"query\",\n \"name\": \"resend_envelope\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/templates/{templateId}/recipients\",\n \"request_body\": {\n \"$ref\": \"#/definitions/templateRecipients\"\n },\n \"security\": null,\n \"skill_name\": \"recipients_post_template_recipients\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Adds tabs for a recipient.\",\n \"tags\": [\n \"TemplateRecipients\"\n ]\n },\n \"recipients_put_recipient_document_visibility\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"This method updates document visibility for a recipient.\\n\\n**Note:** A document cannot be hidden from a recipient if the recipient has tabs assigned to them on the document. Carbon Copy, Certified Delivery (Needs to Sign), Editor, and Agent recipients can always see all documents.\",\n \"destructive\": true,\n \"method\": \"PUT\",\n \"operation_id\": \"recipients_put_recipient_document_visibility\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The envelope's GUID. \\n\\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\\n\",\n \"in\": \"path\",\n \"name\": \"envelopeId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"A local reference used to map\\nrecipients to other objects, such as specific\\ndocument tabs.\\n\\nA `recipientId` must be\\neither an integer or a GUID,\\nand the `recipientId` must be\\nunique within an envelope.\\n\\nFor example, many envelopes assign the first recipient\\na `recipientId` of `1`.\\n\",\n \"in\": \"path\",\n \"name\": \"recipientId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/document_visibility\",\n \"request_body\": {\n \"$ref\": \"#/definitions/documentVisibilityList\"\n },\n \"security\": null,\n \"skill_name\": \"recipients_put_recipient_document_visibility\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Updates document visibility for a recipient\",\n \"tags\": [\n \"EnvelopeDocumentVisibility\"\n ]\n },\n \"recipients_put_recipient_initials_image\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Updates the initials image for a signer that does not have a Docusign account. The supported image formats for this file are: gif, png, jpeg, and bmp. The file size must be less than 200K.\\n\\nFor the Authentication/Authorization for this call, the credentials must match the sender of the envelope, the recipient must be an accountless signer or in person signer. The account must have the `CanSendEnvelope` property set to **true** and the `ExpressSendOnly` property in `SendingUser` structure must be set to **false.**\",\n \"destructive\": true,\n \"method\": \"PUT\",\n \"operation_id\": \"recipients_put_recipient_initials_image\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The envelope's GUID. \\n\\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\\n\",\n \"in\": \"path\",\n \"name\": \"envelopeId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"A local reference used to map\\nrecipients to other objects, such as specific\\ndocument tabs.\\n\\nA `recipientId` must be\\neither an integer or a GUID,\\nand the `recipientId` must be\\nunique within an envelope.\\n\\nFor example, many envelopes assign the first recipient\\na `recipientId` of `1`.\\n\",\n \"in\": \"path\",\n \"name\": \"recipientId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/initials_image\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"recipients_put_recipient_initials_image\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Sets the initials image for an accountless signer.\",\n \"tags\": [\n \"Envelopes\"\n ]\n },\n \"recipients_put_recipient_signature_image\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Updates the signature image for an accountless signer. The supported image formats for this file are: gif, png, jpeg, and bmp. The file size must be less than 200K.\\n\\nFor the Authentication/Authorization for this call, the credentials must match the sender of the envelope, the recipient must be an accountless signer or in person signer. The account must have the `CanSendEnvelope` property set to **true** and the `ExpressSendOnly` property in `SendingUser` structure must be set to **false.**\",\n \"destructive\": true,\n \"method\": \"PUT\",\n \"operation_id\": \"recipients_put_recipient_signature_image\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The envelope's GUID. \\n\\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\\n\",\n \"in\": \"path\",\n \"name\": \"envelopeId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"A local reference used to map\\nrecipients to other objects, such as specific\\ndocument tabs.\\n\\nA `recipientId` must be\\neither an integer or a GUID,\\nand the `recipientId` must be\\nunique within an envelope.\\n\\nFor example, many envelopes assign the first recipient\\na `recipientId` of `1`.\\n\",\n \"in\": \"path\",\n \"name\": \"recipientId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/signature_image\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"recipients_put_recipient_signature_image\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Sets the signature image for an accountless signer.\",\n \"tags\": [\n \"Envelopes\"\n ]\n },\n \"recipients_put_recipient_tabs\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Updates one or more tabs for a recipient in a draft envelope.\\nA draft envelope is one that is not yet complete.\\n\\n**Note:** It is an error to update a tab that has the\\n`templateLocked` property set to true.\\nThis property corresponds to the **Restrict changes** option in the web app.\\n\\n\",\n \"destructive\": true,\n \"method\": \"PUT\",\n \"operation_id\": \"recipients_put_recipient_tabs\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The envelope's GUID. \\n\\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\\n\",\n \"in\": \"path\",\n \"name\": \"envelopeId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"A local reference used to map\\nrecipients to other objects, such as specific\\ndocument tabs.\\n\\nA `recipientId` must be\\neither an integer or a GUID,\\nand the `recipientId` must be\\nunique within an envelope.\\n\\nFor example, many envelopes assign the first recipient\\na `recipientId` of `1`.\\n\",\n \"in\": \"path\",\n \"name\": \"recipientId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/tabs\",\n \"request_body\": {\n \"$ref\": \"#/definitions/EnvelopeRecipientTabs\"\n },\n \"security\": null,\n \"skill_name\": \"recipients_put_recipient_tabs\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Updates the tabs for a recipient.\\n\\n\",\n \"tags\": [\n \"EnvelopeRecipientTabs\"\n ]\n },\n \"recipients_put_recipients\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Updates the recipients of a draft envelope or corrects recipient information for an in-process envelope.\\n\\nIf you send information for a recipient that does not already\\nexist in a draft envelope, the recipient is added to the envelope\\n(similar to the [EnvelopeRecipients: Create][EnvelopeRecipients-create] method).\\n\\nYou can also use this method to resend an envelope to a recipient\\nby using the `resend_envelope` option.\\n\\n**Updating Sent Envelopes**\\n\\nAfter an envelope has been sent, you can edit only the following properties:\\n\\n- `accessCode`\\n- `agentCanEditName`\\n- `agentCanEditEmail`\\n- `customFields`\\n- `deliveryMethod`\\n- `documentVisibility`\\n- `email` (If you provide an email address in this method, it will be treated as a new email address, even if it is exactly the same as the current address. Do not provide an email address if you do not want a correction email sent.)\\n- `emailNotification`\\n- `idCheckConfigurationName`\\n- `identityVerification`\\n- `name`\\n- `note`\\n- `phoneAuthentication`\\n- `recipientType` (For this to work, you must also change the recipient object to match the recipient type.)\\n- `requireIdLookup`\\n- `routingOrder`\\n- `signingGroupId` (You can change this ID to switch to a different signing group and its corresponding set of recipients.)\\n- `smsAuthentication`\\n- `suppressEmails`\\n- `userName`\\n\\nIf the recipient has signed,\\nbut the envelope is still active,\\nthe method will return success,\\nbut the `recipientUpdateResults` property\\nin the response will include an error\\nthat the recipient could not be updated:\\n\\n```\\n{\\n \\\"recipientUpdateResults\\\": [\\n {\\n \\\"recipientId\\\": \\\"999\\\",\\n \\\"errorDetails\\\": {\\n \\\"errorCode\\\": \\\"RECIPIENT_UPDATE_FAILED\\\",\\n \\\"message\\\": \\\"The recipient could not be updated. Recipient not in state that allows correction.\\\"\\n }\\n }\\n ]\\n}\\n```\\n\\nIf the envelope is completed,\\nand you try to change a recipient's address,\\nthe method will fail with this error:\\n\\n```\\n{\\n \\\"errorCode\\\": \\\"ENVELOPE_INVALID_STATUS\\\",\\n \\\"message\\\": \\\"Invalid envelope status. Envelope status is not one of: Created, Sent, Delivered, Correct.\\\"\\n}\\n```\\n\\n**Note:** This method works on recipients only.\\nTo add recipient tabs,\\nuse methods from the [EnvelopeRecipientTabs][recipientTabs] resource.\\nFor example, this request body will add a recipient (`astanton@example.com`)\\nbut **NOT** the Sign Here recipient tab.\\n\\n```json\\n{\\n \\\"signers\\\": [\\n {\\n \\\"email\\\": \\\"astanton@example.com\\\",\\n \\\"name\\\": \\\"Anne Stanton\\\",\\n \\\"recipientId\\\": \\\"1\\\",\\n// THIS WILL NOT WORK\\n \\\"tabs\\\": {\\n \\\"signHereTabs\\\": [\\n {\\n \\\"anchorString\\\": \\\"below\\\",\\n \\\"tooltip\\\": \\\"please sign here3\\\"\\n },\\n . . .\\n ]\\n }\\n }\\n ]\\n}\\n```\\n\\n\\n[EnvelopeRecipients-create]: /docs/esign-rest-api/reference/envelopes/enveloperecipients/create/\\n[recipientTabs]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/\\n\\n\",\n \"destructive\": true,\n \"method\": \"PUT\",\n \"operation_id\": \"recipients_put_recipients\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The envelope's GUID. \\n\\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\\n\",\n \"in\": \"path\",\n \"name\": \"envelopeId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"When **true,** recipients are combined or merged with matching recipients. Recipient matching occurs as part of [template matching](https://support.docusign.com/s/document-item?bundleId=jux1643235969954&topicId=fxo1578456612662.html), and is based on Recipient Role and Routing Order.\",\n \"in\": \"query\",\n \"name\": \"combine_same_order_recipients\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Indicates if offline signing is enabled for the recipient when a network connection is unavailable. \",\n \"in\": \"query\",\n \"name\": \"offline_signing\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"When **true,**\\nforces the envelope to be resent\\nif it would not be resent otherwise.\\n\\nOrdinarily, if the recipient's routing order\\nis before or the same as the envelope's next recipient,\\nthe envelope is not resent.\\n\\nSetting this query parameter\\nto **false** has no effect and is the same as omitting\\nit altogether.\\n\",\n \"in\": \"query\",\n \"name\": \"resend_envelope\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients\",\n \"request_body\": {\n \"$ref\": \"#/definitions/EnvelopeRecipients\"\n },\n \"security\": null,\n \"skill_name\": \"recipients_put_recipients\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Updates recipients in a draft envelope or corrects recipient information for an in-process envelope.\",\n \"tags\": [\n \"EnvelopeRecipients\"\n ]\n },\n \"recipients_put_recipients_document_visibility\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"This method updates document visibility for one or more recipients based on the `recipientId` and `visible` values that you include in the request body.\\n\\n**Note:** A document cannot be hidden from a recipient if the recipient has tabs assigned to them on the document. Carbon Copy, Certified Delivery (Needs to Sign), Editor, and Agent recipients can always see all documents.\",\n \"destructive\": true,\n \"method\": \"PUT\",\n \"operation_id\": \"recipients_put_recipients_document_visibility\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The envelope's GUID. \\n\\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\\n\",\n \"in\": \"path\",\n \"name\": \"envelopeId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/document_visibility\",\n \"request_body\": {\n \"$ref\": \"#/definitions/documentVisibilityList\"\n },\n \"security\": null,\n \"skill_name\": \"recipients_put_recipients_document_visibility\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Updates document visibility for recipients\",\n \"tags\": [\n \"EnvelopeDocumentVisibility\"\n ]\n },\n \"recipients_put_template_recipient_document_visibility\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"This method updates the document visibility for a template recipient.\\n\\n**Note:** A document cannot be hidden from a recipient if the recipient has tabs assigned to them on the document. Carbon Copy, Certified Delivery (Needs to Sign), Editor, and Agent recipients can always see all documents.\",\n \"destructive\": true,\n \"method\": \"PUT\",\n \"operation_id\": \"recipients_put_template_recipient_document_visibility\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"A local reference used to map\\nrecipients to other objects, such as specific\\ndocument tabs.\\n\\nA `recipientId` must be\\neither an integer or a GUID,\\nand the `recipientId` must be\\nunique within an envelope.\\n\\nFor example, many envelopes assign the first recipient\\na `recipientId` of `1`.\\n\",\n \"in\": \"path\",\n \"name\": \"recipientId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The ID of the template.\",\n \"in\": \"path\",\n \"name\": \"templateId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/templates/{templateId}/recipients/{recipientId}/document_visibility\",\n \"request_body\": {\n \"$ref\": \"#/definitions/templateDocumentVisibilityList\"\n },\n \"security\": null,\n \"skill_name\": \"recipients_put_template_recipient_document_visibility\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Updates document visibility for a template recipient\",\n \"tags\": [\n \"TemplateDocumentVisibility\"\n ]\n },\n \"recipients_put_template_recipient_tabs\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Updates one or more tabs for a recipient in a template.\",\n \"destructive\": true,\n \"method\": \"PUT\",\n \"operation_id\": \"recipients_put_template_recipient_tabs\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"A local reference used to map\\nrecipients to other objects, such as specific\\ndocument tabs.\\n\\nA `recipientId` must be\\neither an integer or a GUID,\\nand the `recipientId` must be\\nunique within an envelope.\\n\\nFor example, many envelopes assign the first recipient\\na `recipientId` of `1`.\\n\",\n \"in\": \"path\",\n \"name\": \"recipientId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The ID of the template.\",\n \"in\": \"path\",\n \"name\": \"templateId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/templates/{templateId}/recipients/{recipientId}/tabs\",\n \"request_body\": {\n \"$ref\": \"#/definitions/templateTabs\"\n },\n \"security\": null,\n \"skill_name\": \"recipients_put_template_recipient_tabs\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Updates the tabs for a recipient.\",\n \"tags\": [\n \"TemplateRecipientTabs\"\n ]\n },\n \"recipients_put_template_recipients\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Updates recipients in a template. \\n\\nYou can edit the following properties: `email`, `userName`, `routingOrder`, `faxNumber`, `deliveryMethod`, `accessCode`, and `requireIdLookup`.\",\n \"destructive\": true,\n \"method\": \"PUT\",\n \"operation_id\": \"recipients_put_template_recipients\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The ID of the template.\",\n \"in\": \"path\",\n \"name\": \"templateId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"When **true,**\\nresends the envelope to the recipients\\nthat you specify in the request body.\\nUse this parameter to resend the envelope\\nto a recipient\\nwho deleted the original email notification.\\n\\n**Note:** Correcting an envelope is a different process.\\nDocusign always resends an envelope when you correct it,\\nregardless of the value that you enter here.\",\n \"in\": \"query\",\n \"name\": \"resend_envelope\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/templates/{templateId}/recipients\",\n \"request_body\": {\n \"$ref\": \"#/definitions/templateRecipients\"\n },\n \"security\": null,\n \"skill_name\": \"recipients_put_template_recipients\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Updates recipients in a template.\",\n \"tags\": [\n \"TemplateRecipients\"\n ]\n },\n \"recipients_put_template_recipients_document_visibility\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"This method updates document visibility for one or more template recipients based on the `recipientId` and `visible` values that you include in the request body.\\n\\n\\n**Note:** A document cannot be hidden from a recipient if the recipient has tabs assigned to them on the document. Carbon Copy, Certified Delivery (Needs to Sign), Editor, and Agent recipients can always see all documents.\",\n \"destructive\": true,\n \"method\": \"PUT\",\n \"operation_id\": \"recipients_put_template_recipients_document_visibility\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The ID of the template.\",\n \"in\": \"path\",\n \"name\": \"templateId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/templates/{templateId}/recipients/document_visibility\",\n \"request_body\": {\n \"$ref\": \"#/definitions/templateDocumentVisibilityList\"\n },\n \"security\": null,\n \"skill_name\": \"recipients_put_template_recipients_document_visibility\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Updates document visibility for template recipients\",\n \"tags\": [\n \"TemplateDocumentVisibility\"\n ]\n },\n \"responsive_html_get_envelope_document_html_definitions\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Retrieves the HTML definition used to generate a dynamically sized responsive document.\\n\\nIf the document was not created as a signable HTML document, this endpoint will return a 200-OK response and an empty JSON body. \\n\\n**Note:** The `documentId` query parameter is a GUID value, not an integer document ID. If an invalid document ID is provided, this endpoint will return a 200-OK response and an empty JSON body.\\n\\n### Related topics\\n\\n- [Responsive signing](/docs/esign-rest-api/esign101/concepts/responsive/)\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"responsive_html_get_envelope_document_html_definitions\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The GUID of the document.\\n\\nExample: c671747c-xxxx-xxxx-xxxx-4a4a48e23744\",\n \"in\": \"path\",\n \"name\": \"documentId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The envelope's GUID. \\n\\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\\n\",\n \"in\": \"path\",\n \"name\": \"envelopeId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/html_definitions\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"responsive_html_get_envelope_document_html_definitions\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Retrieves the HTML definition used to generate a dynamically sized responsive document.\",\n \"tags\": [\n \"EnvelopeDocumentHtmlDefinitions\"\n ]\n },\n \"responsive_html_get_envelope_html_definitions\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Gets the Original HTML Definition used to generate the Responsive HTML for the envelope.\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"responsive_html_get_envelope_html_definitions\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The envelope's GUID. \\n\\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\\n\",\n \"in\": \"path\",\n \"name\": \"envelopeId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/envelopes/{envelopeId}/html_definitions\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"responsive_html_get_envelope_html_definitions\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Gets the Original HTML Definition used to generate the Responsive HTML for the envelope.\",\n \"tags\": [\n \"EnvelopeHtmlDefinitions\"\n ]\n },\n \"responsive_html_get_template_document_html_definitions\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Gets the Original HTML Definition used to generate the Responsive HTML for a given document in a template.\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"responsive_html_get_template_document_html_definitions\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The unique ID of the document within the envelope.\\n\\nUnlike other IDs in the eSignature API,\\nyou specify the `documentId` yourself.\\nTypically the first document has the ID\\n`1`, the second document `2`, and so on,\\nbut you can use any numbering scheme\\nthat fits within a 32-bit signed integer\\n(1 through 2147483647).\\n\\n\\nTab objects have a `documentId` property\\nthat specifies the document on which to place\\nthe tab.\\n\",\n \"in\": \"path\",\n \"name\": \"documentId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The ID of the template.\",\n \"in\": \"path\",\n \"name\": \"templateId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/templates/{templateId}/documents/{documentId}/html_definitions\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"responsive_html_get_template_document_html_definitions\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Gets the Original HTML Definition used to generate the Responsive HTML for a given document in a template.\",\n \"tags\": [\n \"TemplateDocumentHtmlDefinitions\"\n ]\n },\n \"responsive_html_get_template_html_definitions\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Gets the Original HTML Definition used to generate the Responsive HTML for the template.\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"responsive_html_get_template_html_definitions\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The ID of the template.\",\n \"in\": \"path\",\n \"name\": \"templateId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/templates/{templateId}/html_definitions\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"responsive_html_get_template_html_definitions\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Gets the Original HTML Definition used to generate the Responsive HTML for the template.\",\n \"tags\": [\n \"TemplateHtmlDefinitions\"\n ]\n },\n \"responsive_html_post_document_responsive_html_preview\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Creates a preview of the\\n[responsive](/docs/esign-rest-api/esign101/concepts/responsive/)\\nHTML version of a specific document.\\nThis method enables you to preview a PDF document\\nconversion to responsive HTML across device types prior to sending.\\n\\nThe request body is a `documentHtmlDefinition` object, which holds the responsive signing parameters that define how to generate the HTML version of the signing document.\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"responsive_html_post_document_responsive_html_preview\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The unique ID of the document within the envelope.\\n\\nUnlike other IDs in the eSignature API,\\nyou specify the `documentId` yourself.\\nTypically the first document has the ID\\n`1`, the second document `2`, and so on,\\nbut you can use any numbering scheme\\nthat fits within a 32-bit signed integer\\n(1 through 2147483647).\\n\\n\\nTab objects have a `documentId` property\\nthat specifies the document on which to place\\nthe tab.\\n\",\n \"in\": \"path\",\n \"name\": \"documentId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The envelope's GUID. \\n\\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\\n\",\n \"in\": \"path\",\n \"name\": \"envelopeId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/responsive_html_preview\",\n \"request_body\": {\n \"$ref\": \"#/definitions/documentHtmlDefinition\"\n },\n \"security\": null,\n \"skill_name\": \"responsive_html_post_document_responsive_html_preview\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Creates a preview of the responsive version of a document.\",\n \"tags\": [\n \"DocumentResponsiveHtmlPreview\"\n ]\n },\n \"responsive_html_post_responsive_html_preview\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Creates a preview of the\\n[responsive](/docs/esign-rest-api/esign101/concepts/responsive/),\\nHTML versions of all of the documents in an\\nenvelope. This method enables you to preview the\\nPDF document conversions to responsive HTML across\\ndevice types prior to sending.\\n\\nThe request body is a `documentHtmlDefinition`\\nobject, which holds the responsive signing\\nparameters that define how to generate the HTML\\nversion of the documents.\\n\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"responsive_html_post_responsive_html_preview\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The envelope's GUID. \\n\\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\\n\",\n \"in\": \"path\",\n \"name\": \"envelopeId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/envelopes/{envelopeId}/responsive_html_preview\",\n \"request_body\": {\n \"$ref\": \"#/definitions/documentHtmlDefinition\"\n },\n \"security\": null,\n \"skill_name\": \"responsive_html_post_responsive_html_preview\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Creates a preview of the responsive versions of all of the documents in an envelope.\",\n \"tags\": [\n \"ResponsiveHtmlPreview\"\n ]\n },\n \"responsive_html_post_template_document_responsive_html_preview\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Creates a preview of the\\n[responsive](/docs/esign-rest-api/esign101/concepts/responsive/),\\nHTML version of a specific template document. This\\nmethod enables you to preview a PDF document\\nconversion to responsive HTML across device types\\nprior to sending.\\n\\nThe request body is a `documentHtmlDefinition`\\nobject, which holds the responsive signing\\nparameters that define how to generate the HTML\\nversion of the signing document.\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"responsive_html_post_template_document_responsive_html_preview\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The unique ID of the document within the envelope.\\n\\nUnlike other IDs in the eSignature API,\\nyou specify the `documentId` yourself.\\nTypically the first document has the ID\\n`1`, the second document `2`, and so on,\\nbut you can use any numbering scheme\\nthat fits within a 32-bit signed integer\\n(1 through 2147483647).\\n\\n\\nTab objects have a `documentId` property\\nthat specifies the document on which to place\\nthe tab.\\n\",\n \"in\": \"path\",\n \"name\": \"documentId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The ID of the template.\",\n \"in\": \"path\",\n \"name\": \"templateId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/templates/{templateId}/documents/{documentId}/responsive_html_preview\",\n \"request_body\": {\n \"$ref\": \"#/definitions/documentHtmlDefinition\"\n },\n \"security\": null,\n \"skill_name\": \"responsive_html_post_template_document_responsive_html_preview\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Creates a preview of the responsive version of a template document.\",\n \"tags\": [\n \"TemplateDocumentResponsiveHtmlPreview\"\n ]\n },\n \"responsive_html_post_template_responsive_html_preview\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Creates a preview of the\\n[responsive](/docs/esign-rest-api/esign101/concepts/responsive/),\\nHTML versions of all of the documents associated\\nwith a template. This method enables you to\\npreview the PDF document conversions to responsive\\nHTML across device types prior to sending.\\n\\nThe request body is a `documentHtmlDefinition`\\nobject, which holds the responsive signing\\nparameters that define how to generate the HTML\\nversion of the documents.\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"responsive_html_post_template_responsive_html_preview\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The ID of the template.\",\n \"in\": \"path\",\n \"name\": \"templateId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/templates/{templateId}/responsive_html_preview\",\n \"request_body\": {\n \"$ref\": \"#/definitions/documentHtmlDefinition\"\n },\n \"security\": null,\n \"skill_name\": \"responsive_html_post_template_responsive_html_preview\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Creates a preview of the responsive versions of all of the documents associated with a template.\",\n \"tags\": [\n \"TemplateResponsiveHtmlPreview\"\n ]\n },\n \"search_folders_get_search_folder_contents\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"<ds-inlinemessage kind=\\\"warning\\\" markdown=\\\"1\\\">\\n<strong>This method is deprecated in API v2.1</strong>\\n\\nUse [Envelopes: listStatusChanges](/docs/esign-rest-api/reference/envelopes/envelopes/liststatuschanges/) instead.\\n</ds-inlinemessage>\\n\\n\\nRetrieves a list of items that match the criteria specified in the query.\\n\\nIf the user ID of the user making the call is the\\nsame as the user ID for any returned recipient,\\nthen the `userId` property is added to the returned\\ninformation for those recipients.\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"search_folders_get_search_folder_contents\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Specifies the envelope group that is searched by the request. These are logical groupings, not actual folder names. Valid values are: drafts, awaiting_my_signature, completed, out_for_signature.\",\n \"in\": \"path\",\n \"name\": \"searchFolderId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Specifies that all envelopes that match the criteria are returned.\",\n \"in\": \"query\",\n \"name\": \"all\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The maximum number of results to return.\\n\\nUse `start_position` to specify the number of results to skip.\\n\\nValid values: `1` to `100`\\n\",\n \"in\": \"query\",\n \"name\": \"count\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Specifies the start of the date range to return. If no value is provided, the default search is the previous 30 days.\",\n \"in\": \"query\",\n \"name\": \"from_date\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"When **true,** the recipient information is returned in the response.\",\n \"in\": \"query\",\n \"name\": \"include_recipients\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Specifies the order in which the list is returned. Valid values are: `asc` for ascending order, and `desc` for descending order.\",\n \"in\": \"query\",\n \"name\": \"order\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Specifies the property used to sort the list. Valid values are: `action_required`, `created`, `completed`, `sent`, `signer_list`, `status`, or `subject`.\",\n \"in\": \"query\",\n \"name\": \"order_by\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The zero-based index of the\\nresult from which to start returning results.\\n\\nUse with `count` to limit the number\\nof results.\\n\\nThe default value is `0`.\\n\",\n \"in\": \"query\",\n \"name\": \"start_position\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Specifies the end of the date range to return.\",\n \"in\": \"query\",\n \"name\": \"to_date\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/search_folders/{searchFolderId}\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"search_folders_get_search_folder_contents\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Deprecated. Use Envelopes: listStatusChanges.\",\n \"tags\": [\n \"Folders\"\n ]\n },\n \"service_information_get_resource_information\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Retrieves the base resources available for the eSignature REST API.\\n\\nYou do not need an integrator key to view the REST API versions and resources.\\n\\n\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"service_information_get_resource_information\",\n \"parameters\": [],\n \"path\": \"/v2.1\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"service_information_get_resource_information\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Lists resources for REST version specified\",\n \"tags\": [\n \"Resources\"\n ]\n },\n \"service_information_get_service_information\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Retrieves the available REST API versions.\\n\\nDocusign Production system: https://www.docusign.net/restapi/service_information\\nDocusign Demo system: https://demo.docusign.net/restapi/service_information\\n\\nYou do not need an integration key to view the REST API versions and resources.\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"service_information_get_service_information\",\n \"parameters\": [],\n \"path\": \"/service_information\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"service_information_get_service_information\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Retrieves the available REST API versions.\",\n \"tags\": [\n \"Services\"\n ]\n },\n \"settings_get_settings\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Retrieves the account settings information for the specified account.\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"settings_get_settings\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/settings\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"settings_get_settings\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Gets account settings information.\",\n \"tags\": [\n \"Accounts\"\n ]\n },\n \"settings_put_settings\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Updates the account settings for the specified account.\\n\\nAlthough the request body for this method\\nis a complete\\n`accountSettingsInformation` object,\\nyou only need to provide\\nthe properties that\\nyou are updating.\",\n \"destructive\": true,\n \"method\": \"PUT\",\n \"operation_id\": \"settings_put_settings\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/settings\",\n \"request_body\": {\n \"$ref\": \"#/definitions/accountSettingsInformation\"\n },\n \"security\": null,\n \"skill_name\": \"settings_put_settings\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Updates the account settings for an account.\",\n \"tags\": [\n \"Accounts\"\n ]\n },\n \"shared_access_get_shared_access\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Retrieves shared item status for one or more users and types of items.\\n\\nUsers with account administration privileges can retrieve shared access information for all account users. Users without account administrator privileges can only retrieve shared access information for themselves, and the returned information is limited to retrieving the status of the members of the account that are sharing their folders to the user. This is equivalent to setting the `shared` parameter to `shared_from`.\\n\\n**Note:** This endpoint returns the shared status for the legacy Shared Envelopes feature. To use the new Shared Access feature, use the [Authorizations resource](/docs/esign-rest-api/reference/accounts/authorizations/).\\n\\n### Related topics\\n\\n- [How to share access to a Docusign envelope inbox](/docs/esign-rest-api/how-to/shared-access/)\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"shared_access_get_shared_access\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The maximum number of results to return.\\n\\nUse `start_position` to specify the number of results to skip.\\n\\nDefault: `1000`\\n\",\n \"in\": \"query\",\n \"name\": \"count\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"This query parameter works in conjunction with `user_ids`. When you specify one of the following user statuses, the query limits the results to only users that match the specified status:\\n- `ActivationRequired`: Membership Activation required\\n- `ActivationSent`: Membership activation sent to user\\n- `Active`: User Membership is active\\n- `Closed`: User Membership is closed\\n- `Disabled`: User Membership is disabled\",\n \"in\": \"query\",\n \"name\": \"envelopes_not_shared_user_status\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"A comma-separated list of folder IDs for which to return shared item information. If `item_type` is set to `folders`, at least one folder ID is required.\",\n \"in\": \"query\",\n \"name\": \"folder_ids\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Specifies the type of shared item being requested. Valid values:\\n\\n- `envelopes`: Get information about envelope sharing between users.\\n- `templates`: Get information about template sharing among users and groups.\\n- `folders`: Get information about folder sharing among users and groups.\\n\",\n \"in\": \"query\",\n \"name\": \"item_type\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Filter user names based on the specified string. The wild-card '*' (asterisk) can be used in the string.\",\n \"in\": \"query\",\n \"name\": \"search_text\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"A comma-separated list of sharing filters that specifies which users appear in the response. \\n\\n- `not_shared`: The response lists users who do not share items of `item_type` with the current user.\\n\\n- `shared_to`: The response lists users in `user_list` who are sharing items to current user.\\n\\n- `shared_from`: The response lists users in `user_list` who are sharing items from the current user.\\n\\n- `shared_to_and_from`: The response lists users in `user_list` who are sharing items to and from the current user.\\n\\nIf the current user does not have administrative privileges, only the `shared_to` option is valid.\",\n \"in\": \"query\",\n \"name\": \"shared\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The zero-based index of the\\nresult from which to start returning results.\\n\\nUse with `count` to limit the number\\nof results.\\n\\nThe default value is `0`.\\n\",\n \"in\": \"query\",\n \"name\": \"start_position\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"A comma-separated list of user IDs for whom the shared item information is being requested.\",\n \"in\": \"query\",\n \"name\": \"user_ids\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/shared_access\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"shared_access_get_shared_access\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Reserved: Gets the shared item status for one or more users.\",\n \"tags\": [\n \"Accounts\"\n ]\n },\n \"shared_access_put_shared_access\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"This sets the shared access status for one or more users or templates.\\n\\nWhen setting user shared access, only users with account administration privileges can set shared access status for envelopes.\\n\\nWhen setting template shared access, only users who own a template and have sharing permission or with account administration privileges can set shared access for templates.\\n\\nChanges to the shared items status are not additive. The change always replaces the current status.\\n\\nTo change template shared access, add the query parameter `item_type` = `templates` to the request. When this is set, the user and envelopes properties are not required.\\n\\n**Note:** This functionality is a newer version of the [Update Group Share](/docs/esign-rest-api/reference/templates/templates/updategroupshare/) functionality.\\n\\n### Related topics\\n\\n- [How to share access to a Docusign envelope inbox](/docs/esign-rest-api/how-to/shared-access/)\\n\\n\",\n \"destructive\": true,\n \"method\": \"PUT\",\n \"operation_id\": \"shared_access_put_shared_access\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Specifies the type of shared item being set:\\n- `envelopes`: Set envelope sharing between users.\\n- `templates`: Set information about template sharing among users and groups.\\n- `folders`: Get information about folder sharing among users and groups.\\n\",\n \"in\": \"query\",\n \"name\": \"item_type\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"When **true,** preserve the existing shared access settings.\",\n \"in\": \"query\",\n \"name\": \"preserve_existing_shared_access\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"A comma-separated list of IDs for users whose shared item access is being set.\",\n \"in\": \"query\",\n \"name\": \"user_ids\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/shared_access\",\n \"request_body\": {\n \"$ref\": \"#/definitions/accountSharedAccess\"\n },\n \"security\": null,\n \"skill_name\": \"shared_access_put_shared_access\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Reserved: Sets the shared access information for users.\",\n \"tags\": [\n \"Accounts\"\n ]\n },\n \"shared_envelopes_list_get_shared_envelopes\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"SharedEnvelopesList_GetSharedEnvelopes\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"shared_envelopes_list_get_shared_envelopes\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The maximum number of results to return.\",\n \"in\": \"query\",\n \"name\": \"count\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The start date for a date range in UTC DateTime format.\\n\\n**Note:** If this property is null, no date filtering is applied.\",\n \"in\": \"query\",\n \"name\": \"from_date\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"\",\n \"in\": \"query\",\n \"name\": \"include\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The order in which to sort the results.\\n\\nValid values are: \\n\\n\\n* `asc`: Ascending order.\\n* `desc`: Descending order. \",\n \"in\": \"query\",\n \"name\": \"order\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The file attribute to use to sort the results.\\n\\nValid values are: \\n\\n* `modified`\\n* `name`\",\n \"in\": \"query\",\n \"name\": \"order_by\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Use this parameter to search for specific text.\",\n \"in\": \"query\",\n \"name\": \"search_text\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The position within the total result set from which to start returning values. The value **thumbnail** may be used to return the page image.\",\n \"in\": \"query\",\n \"name\": \"start_position\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The status of the item.\",\n \"in\": \"query\",\n \"name\": \"status\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The end of a search date range in UTC DateTime format. When you use this parameter, only templates created up to this date and time are returned.\\n\\n**Note:** If this property is null, the value defaults to the current date.\",\n \"in\": \"query\",\n \"name\": \"to_date\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/envelopes/shared\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"shared_envelopes_list_get_shared_envelopes\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"SharedEnvelopesList_GetSharedEnvelopes\",\n \"tags\": [\n \"EnvelopeShares\"\n ]\n },\n \"signing_groups_delete_signing_group_users\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Deletes one or more members from the specified signing group. \",\n \"destructive\": true,\n \"method\": \"DELETE\",\n \"operation_id\": \"signing_groups_delete_signing_group_users\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The ID of the [signing group](https://support.docusign.com/s/document-item?bundleId=gav1643676262430&topicId=zgn1578456447934.html).\\n\\n**Note:** When you send an envelope to a signing group,\\nanyone in the group can open it and sign it with their own signature.\\nFor this reason, Docusign recommends that\\nyou do not include non-signer recipients\\n(such as carbon copy recipients)\\nin the same signing group as signer recipients.\\nHowever, you could create a second signing group\\nfor the non-signer recipients and change t\\nhe default action of Needs to Sign to a different value,\\nsuch as Receives a Copy.\",\n \"in\": \"path\",\n \"name\": \"signingGroupId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/signing_groups/{signingGroupId}/users\",\n \"request_body\": {\n \"$ref\": \"#/definitions/signingGroupUsers\"\n },\n \"security\": null,\n \"skill_name\": \"signing_groups_delete_signing_group_users\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Deletes one or more members from a signing group.\",\n \"tags\": [\n \"SigningGroupUsers\"\n ]\n },\n \"signing_groups_delete_signing_groups\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Deletes one or more signing groups in the specified account.\",\n \"destructive\": true,\n \"method\": \"DELETE\",\n \"operation_id\": \"signing_groups_delete_signing_groups\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/signing_groups\",\n \"request_body\": {\n \"$ref\": \"#/definitions/signingGroupInformation\"\n },\n \"security\": null,\n \"skill_name\": \"signing_groups_delete_signing_groups\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Deletes one or more signing groups.\",\n \"tags\": [\n \"SigningGroups\"\n ]\n },\n \"signing_groups_get_signing_group\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Retrieves information, including group member information, for the specified signing group. \",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"signing_groups_get_signing_group\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The ID of the [signing group](https://support.docusign.com/s/document-item?bundleId=gav1643676262430&topicId=zgn1578456447934.html).\\n\",\n \"in\": \"path\",\n \"name\": \"signingGroupId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/signing_groups/{signingGroupId}\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"signing_groups_get_signing_group\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Gets information about a signing group. \",\n \"tags\": [\n \"SigningGroups\"\n ]\n },\n \"signing_groups_get_signing_group_users\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Retrieves the list of members in the specified Signing Group.\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"signing_groups_get_signing_group_users\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The ID of the [signing group](https://support.docusign.com/s/document-item?bundleId=gav1643676262430&topicId=zgn1578456447934.html).\\n\\n**Note:** When you send an envelope to a signing group,\\nanyone in the group can open it and sign it with their own signature.\\nFor this reason, Docusign recommends that\\nyou do not include non-signer recipients\\n(such as carbon copy recipients)\\nin the same signing group as signer recipients.\\nHowever, you could create a second signing group\\nfor the non-signer recipients and change t\\nhe default action of Needs to Sign to a different value,\\nsuch as Receives a Copy.\",\n \"in\": \"path\",\n \"name\": \"signingGroupId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/signing_groups/{signingGroupId}/users\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"signing_groups_get_signing_group_users\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Gets a list of members in a Signing Group.\",\n \"tags\": [\n \"SigningGroupUsers\"\n ]\n },\n \"signing_groups_get_signing_groups\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Retrieves a list of all signing groups in the specified account.\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"signing_groups_get_signing_groups\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Filters by the type of signing group. Valid values:\\n* `sharedSigningGroup`\\n* `privateSigningGroup`\\n* `systemSigningGroup`\",\n \"in\": \"query\",\n \"name\": \"group_type\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"When **true,** the response includes the signing group members. \",\n \"in\": \"query\",\n \"name\": \"include_users\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/signing_groups\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"signing_groups_get_signing_groups\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Gets a list of the Signing Groups in an account.\",\n \"tags\": [\n \"SigningGroups\"\n ]\n },\n \"signing_groups_post_signing_groups\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Creates one or more signing groups. \\n\\nMultiple signing groups can be created in one call. Only users with account administrator privileges can create signing groups. \\n\\nAn account can have a maximum of 50 signing groups. Each signing group can have a maximum of 50 group members.\\n \\nSigning groups can be used by any account user.\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"signing_groups_post_signing_groups\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/signing_groups\",\n \"request_body\": {\n \"$ref\": \"#/definitions/signingGroupInformation\"\n },\n \"security\": null,\n \"skill_name\": \"signing_groups_post_signing_groups\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Creates a signing group. \",\n \"tags\": [\n \"SigningGroups\"\n ]\n },\n \"signing_groups_put_signing_group\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Updates signing group name and member information. You can also add new members to the signing group. A signing group can have a maximum of 50 members. \",\n \"destructive\": true,\n \"method\": \"PUT\",\n \"operation_id\": \"signing_groups_put_signing_group\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The ID of the [signing group](https://support.docusign.com/s/document-item?bundleId=gav1643676262430&topicId=zgn1578456447934.html).\\n\",\n \"in\": \"path\",\n \"name\": \"signingGroupId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/signing_groups/{signingGroupId}\",\n \"request_body\": {\n \"$ref\": \"#/definitions/signingGroup\"\n },\n \"security\": null,\n \"skill_name\": \"signing_groups_put_signing_group\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Updates a signing group. \",\n \"tags\": [\n \"SigningGroups\"\n ]\n },\n \"signing_groups_put_signing_group_users\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Adds one or more new members to a signing group. A signing group can have a maximum of 50 members. \",\n \"destructive\": true,\n \"method\": \"PUT\",\n \"operation_id\": \"signing_groups_put_signing_group_users\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The ID of the [signing group](https://support.docusign.com/s/document-item?bundleId=gav1643676262430&topicId=zgn1578456447934.html).\\n\\n**Note:** When you send an envelope to a signing group,\\nanyone in the group can open it and sign it with their own signature.\\nFor this reason, Docusign recommends that\\nyou do not include non-signer recipients\\n(such as carbon copy recipients)\\nin the same signing group as signer recipients.\\nHowever, you could create a second signing group\\nfor the non-signer recipients and change t\\nhe default action of Needs to Sign to a different value,\\nsuch as Receives a Copy.\",\n \"in\": \"path\",\n \"name\": \"signingGroupId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/signing_groups/{signingGroupId}/users\",\n \"request_body\": {\n \"$ref\": \"#/definitions/signingGroupUsers\"\n },\n \"security\": null,\n \"skill_name\": \"signing_groups_put_signing_group_users\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Adds members to a signing group. \",\n \"tags\": [\n \"SigningGroupUsers\"\n ]\n },\n \"signing_groups_put_signing_groups\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Updates the name of one or more existing signing groups. \",\n \"destructive\": true,\n \"method\": \"PUT\",\n \"operation_id\": \"signing_groups_put_signing_groups\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/signing_groups\",\n \"request_body\": {\n \"$ref\": \"#/definitions/signingGroupInformation\"\n },\n \"security\": null,\n \"skill_name\": \"signing_groups_put_signing_groups\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Updates signing group names.\",\n \"tags\": [\n \"SigningGroups\"\n ]\n },\n \"supported_languages_get_supported_languages\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Retrieves a list of supported languages that you can set for an individual recipient when creating an envelope, as well as their simple type enumeration values. These are the languages that you can set for the standard email format and signing view for each recipient.\\n\\nFor example, in the recipient's email notification, this setting affects elements such as the standard introductory text describing the request to sign. It also determines the language used for buttons and tabs in both the email notification and the signing experience.\\n\\n**Note:** Setting a language for a recipient affects only the Docusign standard text. Any custom text that you enter for the `emailBody` and `emailSubject` of the notification is not translated, and appears exactly as you enter it.\\n\\nFor more information, see [Set Recipient Language and Specify Custom Email Messages](https://support.docusign.com/s/document-item?bundleId=gbo1643332197980&topicId=wxf1578456494201.html).\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"supported_languages_get_supported_languages\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/supported_languages\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"supported_languages_get_supported_languages\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Gets the supported languages for envelope recipients.\",\n \"tags\": [\n \"Accounts\"\n ]\n },\n \"tab_delete_custom_tab\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Deletes the custom from the specified account.\",\n \"destructive\": true,\n \"method\": \"DELETE\",\n \"operation_id\": \"tab_delete_custom_tab\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The Docusign-generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties.\",\n \"in\": \"path\",\n \"name\": \"customTabId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/tab_definitions/{customTabId}\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"tab_delete_custom_tab\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Deletes custom tab information.\",\n \"tags\": [\n \"CustomTabs\"\n ]\n },\n \"tab_get_custom_tab\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Retrieves information about the requested custom tab on the specified account.\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"tab_get_custom_tab\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The Docusign-generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties.\",\n \"in\": \"path\",\n \"name\": \"customTabId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/tab_definitions/{customTabId}\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"tab_get_custom_tab\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Gets custom tab information.\",\n \"tags\": [\n \"CustomTabs\"\n ]\n },\n \"tab_put_custom_tab\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Updates the information in a custom tab for the specified account.\",\n \"destructive\": true,\n \"method\": \"PUT\",\n \"operation_id\": \"tab_put_custom_tab\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The Docusign-generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties.\",\n \"in\": \"path\",\n \"name\": \"customTabId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/tab_definitions/{customTabId}\",\n \"request_body\": {\n \"$ref\": \"#/definitions/tabMetadata\"\n },\n \"security\": null,\n \"skill_name\": \"tab_put_custom_tab\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Updates custom tab information.\\n\\n\",\n \"tags\": [\n \"CustomTabs\"\n ]\n },\n \"tab_settings_get_tab_settings\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"This method returns information about the tab types and tab functionality that is currently enabled for an account.\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"tab_settings_get_tab_settings\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/settings/tabs\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"tab_settings_get_tab_settings\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Returns tab settings list for specified account\",\n \"tags\": [\n \"AccountTabSettings\"\n ]\n },\n \"tab_settings_put_settings\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"This method modifies the tab types and tab functionality that is enabled for an account.\",\n \"destructive\": true,\n \"method\": \"PUT\",\n \"operation_id\": \"tab_settings_put_settings\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/settings/tabs\",\n \"request_body\": {\n \"$ref\": \"#/definitions/tabAccountSettings\"\n },\n \"security\": null,\n \"skill_name\": \"tab_settings_put_settings\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Modifies tab settings for specified account\",\n \"tags\": [\n \"AccountTabSettings\"\n ]\n },\n \"tabs_blob_get_tabs_blob\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"This endpoint has been deprecated.\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"tabs_blob_get_tabs_blob\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The envelope's GUID. \\n\\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\\n\",\n \"in\": \"path\",\n \"name\": \"envelopeId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/envelopes/{envelopeId}/tabs_blob\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"tabs_blob_get_tabs_blob\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Reserved for Docusign.\",\n \"tags\": [\n \"TabsBlob\"\n ]\n },\n \"tabs_blob_put_tabs_blob\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"This endpoint has been deprecated.\",\n \"destructive\": true,\n \"method\": \"PUT\",\n \"operation_id\": \"tabs_blob_put_tabs_blob\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The envelope's GUID. \\n\\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\\n\",\n \"in\": \"path\",\n \"name\": \"envelopeId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/envelopes/{envelopeId}/tabs_blob\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"tabs_blob_put_tabs_blob\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Reserved for Docusign.\",\n \"tags\": [\n \"TabsBlob\"\n ]\n },\n \"tabs_delete_document_tabs\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Deletes tabs from the document specified by `documentId` in the\\nenvelope specified by `envelopeId`.\\n\",\n \"destructive\": true,\n \"method\": \"DELETE\",\n \"operation_id\": \"tabs_delete_document_tabs\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The unique ID of the document within the envelope.\\n\\nUnlike other IDs in the eSignature API,\\nyou specify the `documentId` yourself.\\nTypically the first document has the ID\\n`1`, the second document `2`, and so on,\\nbut you can use any numbering scheme\\nthat fits within a 32-bit signed integer\\n(1 through 2147483647).\\n\\n\\nTab objects have a `documentId` property\\nthat specifies the document on which to place\\nthe tab.\\n\",\n \"in\": \"path\",\n \"name\": \"documentId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The envelope's GUID. \\n\\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\\n\",\n \"in\": \"path\",\n \"name\": \"envelopeId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/tabs\",\n \"request_body\": {\n \"$ref\": \"#/definitions/tabs\"\n },\n \"security\": null,\n \"skill_name\": \"tabs_delete_document_tabs\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Deletes tabs from a document in an envelope.\",\n \"tags\": [\n \"EnvelopeDocumentTabs\"\n ]\n },\n \"tabs_delete_template_document_tabs\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Deletes tabs from the document specified by `documentId` in the\\ntemplate specified by `templateId`.\\n\",\n \"destructive\": true,\n \"method\": \"DELETE\",\n \"operation_id\": \"tabs_delete_template_document_tabs\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The unique ID of the document within the envelope.\\n\\nUnlike other IDs in the eSignature API,\\nyou specify the `documentId` yourself.\\nTypically the first document has the ID\\n`1`, the second document `2`, and so on,\\nbut you can use any numbering scheme\\nthat fits within a 32-bit signed integer\\n(1 through 2147483647).\\n\\n\\nTab objects have a `documentId` property\\nthat specifies the document on which to place\\nthe tab.\\n\",\n \"in\": \"path\",\n \"name\": \"documentId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The ID of the template.\",\n \"in\": \"path\",\n \"name\": \"templateId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/templates/{templateId}/documents/{documentId}/tabs\",\n \"request_body\": {\n \"$ref\": \"#/definitions/templateTabs\"\n },\n \"security\": null,\n \"skill_name\": \"tabs_delete_template_document_tabs\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Deletes tabs from a template.\",\n \"tags\": [\n \"TemplateDocumentTabs\"\n ]\n },\n \"tabs_get_document_tabs\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Returns the tabs on the document specified by `documentId` in the\\nenvelope specified by `envelopeId`.\\n\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"tabs_get_document_tabs\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The unique ID of the document within the envelope.\\n\\nUnlike other IDs in the eSignature API,\\nyou specify the `documentId` yourself.\\nTypically the first document has the ID\\n`1`, the second document `2`, and so on,\\nbut you can use any numbering scheme\\nthat fits within a 32-bit signed integer\\n(1 through 2147483647).\\n\\n\\nTab objects have a `documentId` property\\nthat specifies the document on which to place\\nthe tab.\\n\",\n \"in\": \"path\",\n \"name\": \"documentId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The envelope's GUID. \\n\\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\\n\",\n \"in\": \"path\",\n \"name\": \"envelopeId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"When **true,** the response includes metadata indicating which properties are editable.\",\n \"in\": \"query\",\n \"name\": \"include_metadata\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Filters for tabs that occur on the pages that you specify. Enter as a comma-separated list of page GUIDs.\\n\\nExample: `page_numbers=2,6`\\n\\nNote: You can only enter individual page numbers, and not a page range.\",\n \"in\": \"query\",\n \"name\": \"page_numbers\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/tabs\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"tabs_get_document_tabs\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Returns the tabs on a document.\",\n \"tags\": [\n \"EnvelopeDocumentTabs\"\n ]\n },\n \"tabs_get_page_tabs\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Returns the tabs from the page specified by `pageNumber` of the document specified by `documentId` in the\\nenvelope specified by `envelopeId`.\\n\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"tabs_get_page_tabs\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The unique ID of the document within the envelope.\\n\\nUnlike other IDs in the eSignature API,\\nyou specify the `documentId` yourself.\\nTypically the first document has the ID\\n`1`, the second document `2`, and so on,\\nbut you can use any numbering scheme\\nthat fits within a 32-bit signed integer\\n(1 through 2147483647).\\n\\n\\nTab objects have a `documentId` property\\nthat specifies the document on which to place\\nthe tab.\\n\",\n \"in\": \"path\",\n \"name\": \"documentId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The envelope's GUID. \\n\\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\\n\",\n \"in\": \"path\",\n \"name\": \"envelopeId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The page number being accessed.\",\n \"in\": \"path\",\n \"name\": \"pageNumber\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/pages/{pageNumber}/tabs\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"tabs_get_page_tabs\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Returns tabs on the specified page.\",\n \"tags\": [\n \"EnvelopeDocumentTabs\"\n ]\n },\n \"tabs_get_tab_definitions\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Retrieves a list of all tabs associated with the account.\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"tabs_get_tab_definitions\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"When **true,** only custom tabs are returned in the response. \",\n \"in\": \"query\",\n \"name\": \"custom_tab_only\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/tab_definitions\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"tabs_get_tab_definitions\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Gets a list of all account tabs.\",\n \"tags\": [\n \"CustomTabs\"\n ]\n },\n \"tabs_get_template_document_tabs\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Returns the tabs on the document specified by `documentId` in the\\ntemplate specified by `templateId`.\\n\\n\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"tabs_get_template_document_tabs\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The unique ID of the document within the envelope.\\n\\nUnlike other IDs in the eSignature API,\\nyou specify the `documentId` yourself.\\nTypically the first document has the ID\\n`1`, the second document `2`, and so on,\\nbut you can use any numbering scheme\\nthat fits within a 32-bit signed integer\\n(1 through 2147483647).\\n\\n\\nTab objects have a `documentId` property\\nthat specifies the document on which to place\\nthe tab.\\n\",\n \"in\": \"path\",\n \"name\": \"documentId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The ID of the template.\",\n \"in\": \"path\",\n \"name\": \"templateId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Filters for tabs that occur on the pages that you specify. Enter as a comma-separated list of page Guids.\\n\\nExample: `page_numbers=2,6`\",\n \"in\": \"query\",\n \"name\": \"page_numbers\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/templates/{templateId}/documents/{documentId}/tabs\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"tabs_get_template_document_tabs\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Returns tabs on a template.\",\n \"tags\": [\n \"TemplateDocumentTabs\"\n ]\n },\n \"tabs_get_template_page_tabs\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Returns the tabs from the page specified by `pageNumber` of the document specified by `documentId` in the\\ntemplate specified by `templateId`.\\n\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"tabs_get_template_page_tabs\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The unique ID of the document within the envelope.\\n\\nUnlike other IDs in the eSignature API,\\nyou specify the `documentId` yourself.\\nTypically the first document has the ID\\n`1`, the second document `2`, and so on,\\nbut you can use any numbering scheme\\nthat fits within a 32-bit signed integer\\n(1 through 2147483647).\\n\\n\\nTab objects have a `documentId` property\\nthat specifies the document on which to place\\nthe tab.\\n\",\n \"in\": \"path\",\n \"name\": \"documentId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The page number being accessed.\",\n \"in\": \"path\",\n \"name\": \"pageNumber\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The ID of the template.\",\n \"in\": \"path\",\n \"name\": \"templateId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/templates/{templateId}/documents/{documentId}/pages/{pageNumber}/tabs\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"tabs_get_template_page_tabs\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Returns tabs on the specified page.\",\n \"tags\": [\n \"TemplateDocumentTabs\"\n ]\n },\n \"tabs_post_document_tabs\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Adds tabs to the document specified by `documentId` in the\\nenvelope specified by `envelopeId`.\\n\\n<ds-inlinemessage kind=\\\"information\\\" markdown=\\\"1\\\">\\nThis method operates only on\\n<a href=\\\"/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/create/#schema__enveloperecipienttabs_smartsectiontabs\\\"><code>smartSection</code></a>\\nand\\n<a href=\\\"/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/create/#schema__enveloperecipienttabs_polylineoverlaytabs\\\"><code>polyLineOverlay</code></a>\\ntabs.\\n</ds-inlinemessage>\\n\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"tabs_post_document_tabs\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The unique ID of the document within the envelope.\\n\\nUnlike other IDs in the eSignature API,\\nyou specify the `documentId` yourself.\\nTypically the first document has the ID\\n`1`, the second document `2`, and so on,\\nbut you can use any numbering scheme\\nthat fits within a 32-bit signed integer\\n(1 through 2147483647).\\n\\n\\nTab objects have a `documentId` property\\nthat specifies the document on which to place\\nthe tab.\\n\",\n \"in\": \"path\",\n \"name\": \"documentId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The envelope's GUID. \\n\\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\\n\",\n \"in\": \"path\",\n \"name\": \"envelopeId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/tabs\",\n \"request_body\": {\n \"$ref\": \"#/definitions/tabs\"\n },\n \"security\": null,\n \"skill_name\": \"tabs_post_document_tabs\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Adds tabs to a document in an envelope.\",\n \"tags\": [\n \"EnvelopeDocumentTabs\"\n ]\n },\n \"tabs_post_tab_definitions\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Creates a tab with pre-defined properties, such as a text tab with a certain font type and validation pattern. Users can access the custom tabs when sending documents through the Docusign web application.\\n\\nCustom tabs can be created for approve, checkbox, company, date, date signed, decline, email, email address, envelope ID, first name, formula, full name, initial here, last name, list, note, number, radio, sign here, signer attachment, SSN, text, title, and zip tabs.\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"tabs_post_tab_definitions\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/tab_definitions\",\n \"request_body\": {\n \"$ref\": \"#/definitions/tabMetadata\"\n },\n \"security\": null,\n \"skill_name\": \"tabs_post_tab_definitions\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Creates a custom tab.\",\n \"tags\": [\n \"CustomTabs\"\n ]\n },\n \"tabs_post_template_document_tabs\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Adds tabs to the document specified by `documentId` in the\\ntemplate specified by `templateId`.\\n\\nIn the request body, you only need to specify the tabs that your\\nare adding. For example, to add a text\\n[prefill tab](/docs/esign-rest-api/reference/templates/templatedocumenttabs/create/#definition__templatetabs_prefilltabs),\\nyour request body might look like this:\\n\\n```\\n{\\n \\\"prefillTabs\\\": {\\n \\\"textTabs\\\": [\\n {\\n \\\"value\\\": \\\"a prefill text tab\\\",\\n \\\"pageNumber\\\": \\\"1\\\",\\n \\\"documentId\\\": \\\"1\\\",\\n \\\"xPosition\\\": 316,\\n \\\"yPosition\\\": 97\\n }\\n ]\\n }\\n}\\n```\\n\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"tabs_post_template_document_tabs\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The unique ID of the document within the envelope.\\n\\nUnlike other IDs in the eSignature API,\\nyou specify the `documentId` yourself.\\nTypically the first document has the ID\\n`1`, the second document `2`, and so on,\\nbut you can use any numbering scheme\\nthat fits within a 32-bit signed integer\\n(1 through 2147483647).\\n\\n\\nTab objects have a `documentId` property\\nthat specifies the document on which to place\\nthe tab.\\n\",\n \"in\": \"path\",\n \"name\": \"documentId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The ID of the template.\",\n \"in\": \"path\",\n \"name\": \"templateId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/templates/{templateId}/documents/{documentId}/tabs\",\n \"request_body\": {\n \"$ref\": \"#/definitions/templateTabs\"\n },\n \"security\": null,\n \"skill_name\": \"tabs_post_template_document_tabs\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Adds tabs to a document in a template.\",\n \"tags\": [\n \"TemplateDocumentTabs\"\n ]\n },\n \"tabs_put_document_tabs\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Updates tabs in the document specified by `documentId` in the\\nenvelope specified by `envelopeId`.\\n\\n<ds-inlinemessage kind=\\\"information\\\" markdown=\\\"1\\\">\\nThis method operates only on\\n<a href=\\\"/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/create/#schema__enveloperecipienttabs_smartsectiontabs\\\"><code>smartSection</code></a>\\nand\\n<a href=\\\"/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/create/#schema__enveloperecipienttabs_polylineoverlaytabs\\\"><code>polyLineOverlay</code></a>\\ntabs.\\n</ds-inlinemessage>\\n\",\n \"destructive\": true,\n \"method\": \"PUT\",\n \"operation_id\": \"tabs_put_document_tabs\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The unique ID of the document within the envelope.\\n\\nUnlike other IDs in the eSignature API,\\nyou specify the `documentId` yourself.\\nTypically the first document has the ID\\n`1`, the second document `2`, and so on,\\nbut you can use any numbering scheme\\nthat fits within a 32-bit signed integer\\n(1 through 2147483647).\\n\\n\\nTab objects have a `documentId` property\\nthat specifies the document on which to place\\nthe tab.\\n\",\n \"in\": \"path\",\n \"name\": \"documentId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The envelope's GUID. \\n\\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\\n\",\n \"in\": \"path\",\n \"name\": \"envelopeId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/tabs\",\n \"request_body\": {\n \"$ref\": \"#/definitions/tabs\"\n },\n \"security\": null,\n \"skill_name\": \"tabs_put_document_tabs\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Updates the tabs for document.\",\n \"tags\": [\n \"EnvelopeDocumentTabs\"\n ]\n },\n \"tabs_put_template_document_tabs\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Updates tabs in the document specified by `documentId` in the\\ntemplate specified by `templateId`.\\n\",\n \"destructive\": true,\n \"method\": \"PUT\",\n \"operation_id\": \"tabs_put_template_document_tabs\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The unique ID of the document within the envelope.\\n\\nUnlike other IDs in the eSignature API,\\nyou specify the `documentId` yourself.\\nTypically the first document has the ID\\n`1`, the second document `2`, and so on,\\nbut you can use any numbering scheme\\nthat fits within a 32-bit signed integer\\n(1 through 2147483647).\\n\\n\\nTab objects have a `documentId` property\\nthat specifies the document on which to place\\nthe tab.\\n\",\n \"in\": \"path\",\n \"name\": \"documentId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The ID of the template.\",\n \"in\": \"path\",\n \"name\": \"templateId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/templates/{templateId}/documents/{documentId}/tabs\",\n \"request_body\": {\n \"$ref\": \"#/definitions/templateTabs\"\n },\n \"security\": null,\n \"skill_name\": \"tabs_put_template_document_tabs\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Updates the tabs for a template.\",\n \"tags\": [\n \"TemplateDocumentTabs\"\n ]\n },\n \"template_workflow_definition_delete_template_workflow_definition\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Deletes the specified template's workflow definition if it has one.\\n\\n**Note:** If the specified template does not have a workflow definition, this endpoint returns a 200 response.\",\n \"destructive\": true,\n \"method\": \"DELETE\",\n \"operation_id\": \"template_workflow_definition_delete_template_workflow_definition\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The ID of the template.\",\n \"in\": \"path\",\n \"name\": \"templateId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/templates/{templateId}/workflow\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"template_workflow_definition_delete_template_workflow_definition\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Delete the workflow definition for a template.\",\n \"tags\": [\n \"EnvelopeWorkflowDefinition\"\n ]\n },\n \"template_workflow_definition_get_template_workflow_definition\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Returns the workflow definition for the template specified by `templateId`. If the template does not have a workflow object, this method returns a 404.\\n\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"template_workflow_definition_get_template_workflow_definition\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The ID of the template.\",\n \"in\": \"path\",\n \"name\": \"templateId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/templates/{templateId}/workflow\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"template_workflow_definition_get_template_workflow_definition\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Returns the workflow definition for a template.\",\n \"tags\": [\n \"EnvelopeWorkflowDefinition\"\n ]\n },\n \"template_workflow_definition_put_template_workflow_definition\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Updates the specified template's workflow definition.\",\n \"destructive\": true,\n \"method\": \"PUT\",\n \"operation_id\": \"template_workflow_definition_put_template_workflow_definition\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The ID of the template.\",\n \"in\": \"path\",\n \"name\": \"templateId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/templates/{templateId}/workflow\",\n \"request_body\": {\n \"$ref\": \"#/definitions/workflow\"\n },\n \"security\": null,\n \"skill_name\": \"template_workflow_definition_put_template_workflow_definition\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Updates the workflow definition for a template.\",\n \"tags\": [\n \"EnvelopeWorkflowDefinition\"\n ]\n },\n \"template_workflow_delayed_routing_delete_template_delayed_routing_definition\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Deletes the delayed routing rules for the specified template workflow step.\",\n \"destructive\": true,\n \"method\": \"DELETE\",\n \"operation_id\": \"template_workflow_delayed_routing_delete_template_delayed_routing_definition\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The ID of the template.\",\n \"in\": \"path\",\n \"name\": \"templateId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The ID of the workflow step.\",\n \"in\": \"path\",\n \"name\": \"workflowStepId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/templates/{templateId}/workflow/steps/{workflowStepId}/delayedRouting\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"template_workflow_delayed_routing_delete_template_delayed_routing_definition\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Deletes the delayed routing rules for the specified template workflow step.\",\n \"tags\": [\n \"EnvelopeWorkflowDefinition\"\n ]\n },\n \"template_workflow_delayed_routing_get_template_delayed_routing_definition\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Given a template and a workflow step, returns the delayed routing rules for that workflow step.\\n\\n**Note:** If the workflow step does not have a delayed routing object, this method returns a 404.\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"template_workflow_delayed_routing_get_template_delayed_routing_definition\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The ID of the template.\",\n \"in\": \"path\",\n \"name\": \"templateId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The ID of the workflow step.\",\n \"in\": \"path\",\n \"name\": \"workflowStepId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/templates/{templateId}/workflow/steps/{workflowStepId}/delayedRouting\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"template_workflow_delayed_routing_get_template_delayed_routing_definition\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Returns the delayed routing rules for a template's workflow step definition.\",\n \"tags\": [\n \"EnvelopeWorkflowDefinition\"\n ]\n },\n \"template_workflow_delayed_routing_put_template_delayed_routing_definition\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Updates the scheduled sending rules for a template's workflow.\",\n \"destructive\": true,\n \"method\": \"PUT\",\n \"operation_id\": \"template_workflow_delayed_routing_put_template_delayed_routing_definition\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The ID of the template.\",\n \"in\": \"path\",\n \"name\": \"templateId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The ID of the workflow step.\",\n \"in\": \"path\",\n \"name\": \"workflowStepId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/templates/{templateId}/workflow/steps/{workflowStepId}/delayedRouting\",\n \"request_body\": {\n \"$ref\": \"#/definitions/delayedRouting\"\n },\n \"security\": null,\n \"skill_name\": \"template_workflow_delayed_routing_put_template_delayed_routing_definition\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Updates the delayed routing rules for a template's workflow step.\",\n \"tags\": [\n \"EnvelopeWorkflowDefinition\"\n ]\n },\n \"template_workflow_scheduled_sending_delete_template_scheduled_sending_definition\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Deletes the scheduled sending rules for the template's workflow.\",\n \"destructive\": true,\n \"method\": \"DELETE\",\n \"operation_id\": \"template_workflow_scheduled_sending_delete_template_scheduled_sending_definition\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The ID of the template.\",\n \"in\": \"path\",\n \"name\": \"templateId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/templates/{templateId}/workflow/scheduledSending\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"template_workflow_scheduled_sending_delete_template_scheduled_sending_definition\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Deletes the scheduled sending rules for the template's workflow.\",\n \"tags\": [\n \"EnvelopeWorkflowDefinition\"\n ]\n },\n \"template_workflow_scheduled_sending_get_template_scheduled_sending_definition\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Given a template specified by `templateId`, returns the scheduled sending rules for that template's workflow object.\\n\\n**Note:** If the template's workflow does not have a scheduled sending object, this method returns a 404.\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"template_workflow_scheduled_sending_get_template_scheduled_sending_definition\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The ID of the template.\",\n \"in\": \"path\",\n \"name\": \"templateId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/templates/{templateId}/workflow/scheduledSending\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"template_workflow_scheduled_sending_get_template_scheduled_sending_definition\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Returns the scheduled sending rules for a template's workflow definition.\",\n \"tags\": [\n \"EnvelopeWorkflowDefinition\"\n ]\n },\n \"template_workflow_scheduled_sending_put_template_scheduled_sending_definition\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Updates the scheduled sending rules for a template's workflow definition.\",\n \"destructive\": true,\n \"method\": \"PUT\",\n \"operation_id\": \"template_workflow_scheduled_sending_put_template_scheduled_sending_definition\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The ID of the template.\",\n \"in\": \"path\",\n \"name\": \"templateId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/templates/{templateId}/workflow/scheduledSending\",\n \"request_body\": {\n \"$ref\": \"#/definitions/scheduledSending\"\n },\n \"security\": null,\n \"skill_name\": \"template_workflow_scheduled_sending_put_template_scheduled_sending_definition\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Updates the scheduled sending rules for a template's workflow definition.\",\n \"tags\": [\n \"EnvelopeWorkflowDefinition\"\n ]\n },\n \"template_workflow_step_delete_template_workflow_step_definition\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Deletes a workflow step from an template's workflow definition.\",\n \"destructive\": true,\n \"method\": \"DELETE\",\n \"operation_id\": \"template_workflow_step_delete_template_workflow_step_definition\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The ID of the template.\",\n \"in\": \"path\",\n \"name\": \"templateId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The ID of the workflow step.\",\n \"in\": \"path\",\n \"name\": \"workflowStepId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/templates/{templateId}/workflow/steps/{workflowStepId}\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"template_workflow_step_delete_template_workflow_step_definition\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Deletes a workflow step from an template's workflow definition.\",\n \"tags\": [\n \"EnvelopeWorkflowDefinition\"\n ]\n },\n \"template_workflow_step_get_template_workflow_step_definition\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Returns a workflow step specified by `workflowStepId` for a template specified by `templateId`.\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"template_workflow_step_get_template_workflow_step_definition\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The ID of the template.\",\n \"in\": \"path\",\n \"name\": \"templateId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The ID of the workflow step.\",\n \"in\": \"path\",\n \"name\": \"workflowStepId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/templates/{templateId}/workflow/steps/{workflowStepId}\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"template_workflow_step_get_template_workflow_step_definition\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Returns a specified workflow step for a specified envelope.\",\n \"tags\": [\n \"EnvelopeWorkflowDefinition\"\n ]\n },\n \"template_workflow_step_post_template_workflow_step_definition\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Adds a new step to a template's workflow.\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"template_workflow_step_post_template_workflow_step_definition\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The ID of the template.\",\n \"in\": \"path\",\n \"name\": \"templateId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/templates/{templateId}/workflow/steps\",\n \"request_body\": {\n \"$ref\": \"#/definitions/workflowStep\"\n },\n \"security\": null,\n \"skill_name\": \"template_workflow_step_post_template_workflow_step_definition\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Adds a new step to a template's workflow.\",\n \"tags\": [\n \"EnvelopeWorkflowDefinition\"\n ]\n },\n \"template_workflow_step_put_template_workflow_step_definition\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Updates a specified workflow step for a template.\",\n \"destructive\": true,\n \"method\": \"PUT\",\n \"operation_id\": \"template_workflow_step_put_template_workflow_step_definition\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The ID of the template.\",\n \"in\": \"path\",\n \"name\": \"templateId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The ID of the workflow step.\",\n \"in\": \"path\",\n \"name\": \"workflowStepId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/templates/{templateId}/workflow/steps/{workflowStepId}\",\n \"request_body\": {\n \"$ref\": \"#/definitions/workflowStep\"\n },\n \"security\": null,\n \"skill_name\": \"template_workflow_step_put_template_workflow_step_definition\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Updates a specified workflow step for a template.\",\n \"tags\": [\n \"EnvelopeWorkflowDefinition\"\n ]\n },\n \"templates_auto_match_put_templates\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"TemplatesAutoMatch_PutTemplates\",\n \"destructive\": true,\n \"method\": \"PUT\",\n \"operation_id\": \"templates_auto_match_put_templates\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/templates/auto_match\",\n \"request_body\": {\n \"$ref\": \"#/definitions/templateAutoMatchList\"\n },\n \"security\": null,\n \"skill_name\": \"templates_auto_match_put_templates\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"TemplatesAutoMatch_PutTemplates\",\n \"tags\": [\n \"Templates\"\n ]\n },\n \"templates_delete_document_templates\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Deletes the specified template from a document in an existing envelope.\",\n \"destructive\": true,\n \"method\": \"DELETE\",\n \"operation_id\": \"templates_delete_document_templates\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The unique ID of the document within the envelope.\\n\\nUnlike other IDs in the eSignature API,\\nyou specify the `documentId` yourself.\\nTypically the first document has the ID\\n`1`, the second document `2`, and so on,\\nbut you can use any numbering scheme\\nthat fits within a 32-bit signed integer\\n(1 through 2147483647).\\n\\n\\nTab objects have a `documentId` property\\nthat specifies the document on which to place\\nthe tab.\\n\",\n \"in\": \"path\",\n \"name\": \"documentId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The envelope's GUID. \\n\\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\\n\",\n \"in\": \"path\",\n \"name\": \"envelopeId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The ID of the template.\",\n \"in\": \"path\",\n \"name\": \"templateId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/templates/{templateId}\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"templates_delete_document_templates\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Deletes a template from a document in an existing envelope.\",\n \"tags\": [\n \"EnvelopeTemplates\"\n ]\n },\n \"templates_delete_template_part\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Removes a member group's sharing permissions for a specified template.\",\n \"destructive\": true,\n \"method\": \"DELETE\",\n \"operation_id\": \"templates_delete_template_part\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The ID of the template.\",\n \"in\": \"path\",\n \"name\": \"templateId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Currently, the only defined part is **groups.**\",\n \"in\": \"path\",\n \"name\": \"templatePart\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/templates/{templateId}/{templatePart}\",\n \"request_body\": {\n \"$ref\": \"#/definitions/groupInformation\"\n },\n \"security\": null,\n \"skill_name\": \"templates_delete_template_part\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Removes a member group's sharing permissions for a template.\",\n \"tags\": [\n \"Templates\"\n ]\n },\n \"templates_get_document_templates\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Retrieves the templates associated with a document in the specified envelope.\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"templates_get_document_templates\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The unique ID of the document within the envelope.\\n\\nUnlike other IDs in the eSignature API,\\nyou specify the `documentId` yourself.\\nTypically the first document has the ID\\n`1`, the second document `2`, and so on,\\nbut you can use any numbering scheme\\nthat fits within a 32-bit signed integer\\n(1 through 2147483647).\\n\\n\\nTab objects have a `documentId` property\\nthat specifies the document on which to place\\nthe tab.\\n\",\n \"in\": \"path\",\n \"name\": \"documentId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The envelope's GUID. \\n\\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\\n\",\n \"in\": \"path\",\n \"name\": \"envelopeId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"A comma-separated list that limits the results.\\nValid values are:\\n\\n* `applied`\\n* `matched`\\n\",\n \"in\": \"query\",\n \"name\": \"include\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/templates\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"templates_get_document_templates\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Gets the templates associated with a document in an existing envelope.\",\n \"tags\": [\n \"EnvelopeTemplates\"\n ]\n },\n \"templates_get_envelope_templates\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"This returns a list of the server-side templates, their name and ID, used in an envelope.\\n\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"templates_get_envelope_templates\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The envelope's GUID. \\n\\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\\n\",\n \"in\": \"path\",\n \"name\": \"envelopeId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Filters the results by template type. Valid values:\\n* `applied`: Returns the templates applied to an envelope.\\n* `matching`: Returns the [matching templates](https://support.docusign.com/s/document-item?language=en_US&bundleId=jux1643235969954&topicId=far1578456612069.html&_LANG=enus) for an envelope.\\n\\nThe default value is `applied`.\",\n \"in\": \"query\",\n \"name\": \"include\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/envelopes/{envelopeId}/templates\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"templates_get_envelope_templates\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Gets templates used in an envelope.\",\n \"tags\": [\n \"EnvelopeTemplates\"\n ]\n },\n \"templates_get_template\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Retrieves the definition of the specified template.\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"templates_get_template\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The ID of the template.\",\n \"in\": \"path\",\n \"name\": \"templateId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"A comma-separated list\\nof additional template attributes\\nto include in the response.\\nValid values are:\\n\\n- `powerforms`: Includes information about PowerForms.\\n- `tabs`: Includes information about tabs.\\n- `documents`: Includes information about documents.\\n- `favorite_template_status`: : Includes the template `favoritedByMe` property in the response. **Note:** You can mark a template as a favorite only in eSignature v2.1.\",\n \"in\": \"query\",\n \"name\": \"include\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/templates/{templateId}\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"templates_get_template\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Gets a specific template associated with a specified account.\",\n \"tags\": [\n \"Templates\"\n ]\n },\n \"templates_get_templates\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Retrieves the list of templates for the specified account. The request can be limited to a specific folder.\\n\\n### Related topics\\n\\n- [How to create a template](/docs/esign-rest-api/how-to/create-template/)\\n\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"templates_get_templates\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The maximum number of results to return.\\n\\nUse `start_position` to specify the number of results to skip.\\n\\n**Note:** If the `count` parameter is not used, `listTemplates` has a default limit of 2,000 templates. If the account has more than 2,000 templates, `listTemplates` will return the first 2,000 templates. To retrieve more than 2,000 templates, repeat the API call, specifying `start_position` and `count` to control the number of templates retrieved.\",\n \"in\": \"query\",\n \"name\": \"count\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Lists templates created on or after this date.\",\n \"in\": \"query\",\n \"name\": \"created_from_date\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Lists templates modified before this date.\",\n \"in\": \"query\",\n \"name\": \"created_to_date\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"A comma-separated list of folder ID GUIDs.\",\n \"in\": \"query\",\n \"name\": \"folder_ids\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The type of folder to return templates for. Possible values are:\\n\\n- `templates`: Templates in the **My Templates** folder.\\n Templates in the **Shared Templates** and **All Template** folders (if the request ID from and Admin) are excluded.\\n- `templates_root`: Templates in the root level of the **My Templates** folder, but not in an actual folder. Note that the **My Templates** folder is not a real folder.\\n- `recylebin`: Templates that have been deleted.\\n\",\n \"in\": \"query\",\n \"name\": \"folder_types\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Start of the search date range. Only returns templates created on or after this date/time. If no value is specified, there is no limit on the earliest date created.\",\n \"in\": \"query\",\n \"name\": \"from_date\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"A comma-separated list\\nof additional template attributes\\nto include in the response.\\nValid values are:\\n\\n- `powerforms`: Includes details about the PowerForms associated with the templates.\\n- `documents`: Includes information about template documents.\\n- `folders`: Includes information about the folder that holds the template.\\n- `favorite_template_status`: Includes the template `favoritedByMe` property. **Note:** You can mark a template as a favorite only in eSignature v2.1.\\n- `advanced_templates`: Includes information about advanced templates.\\n- `recipients`: Includes information about template recipients.\\n- `custom_fields`: Includes information about template custom fields.\\n- `notifications`: Includes information about the notification settings for templates.\",\n \"in\": \"query\",\n \"name\": \"include\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"When **true,** retrieves templates that have been permanently deleted. The default is **false.**\\n\\n**Note:** After you delete a template, you can see it in the `Deleted` bin in the UI for 24 hours. After 24 hours, the template is permanently deleted.\\n\",\n \"in\": \"query\",\n \"name\": \"is_deleted_template_only\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"When **true,** downloads the templates listed in `template_ids` as a collection of JSON definitions in a single zip file.\\n\\nThe `Content-Disposition` header is set in the response. The value of the header provides the filename of the file.\\n\\nThe default is **false.**\\n\\n**Note:** This parameter only works when you specify a list of templates in the `template_ids` parameter.\",\n \"in\": \"query\",\n \"name\": \"is_download\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"\",\n \"in\": \"query\",\n \"name\": \"link_configuration_id\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Lists templates modified on or after this date.\",\n \"in\": \"query\",\n \"name\": \"modified_from_date\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Lists templates modified before this date.\",\n \"in\": \"query\",\n \"name\": \"modified_to_date\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Specifies the sort order of the search results.\\nValid values are:\\n\\n- `asc`: Ascending (A to Z)\\n- `desc`: Descending (Z to A)\",\n \"in\": \"query\",\n \"name\": \"order\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Specifies how the search results are listed.\\nValid values are:\\n\\n- `name`: template name\\n- `modified`: date/time template was last modified\\n- `used`: date/time the template was last used.\",\n \"in\": \"query\",\n \"name\": \"order_by\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"A comma-separated list of additional template properties to search.\\n\\n\\n- `sender`: Include sender name and email in the search.\\n- `recipients`: Include recipient names and emails in the search.\\n- `envelope`: Not used in template searches.\\n\",\n \"in\": \"query\",\n \"name\": \"search_fields\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The text to use to search the names of templates.\\n\\nLimit: 48 characters.\",\n \"in\": \"query\",\n \"name\": \"search_text\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"When **true,** the response only includes templates shared by the user. When **false,** the response only returns template not shared by the user. If not specified, templates are returned whether or not they have been shared by the user.\",\n \"in\": \"query\",\n \"name\": \"shared_by_me\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The zero-based index of the\\nresult from which to start returning results.\\n\\nUse with `count` to limit the number\\nof results.\\n\\nThe default value is `0`.\\n\",\n \"in\": \"query\",\n \"name\": \"start_position\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"A comma-separated list of template IDs to download. This value is valid only when `is_download` is **true.**\",\n \"in\": \"query\",\n \"name\": \"template_ids\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The end of a search date range in UTC DateTime format. When you use this parameter, only templates created up to this date and time are returned.\\n\\n**Note:** If this property is null, the value defaults to the current date.\",\n \"in\": \"query\",\n \"name\": \"to_date\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Start of the search date range. Only returns templates used or edited on or after this date/time. If no value is specified, there is no limit on the earliest date used.\",\n \"in\": \"query\",\n \"name\": \"used_from_date\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"End of the search date range. Only returns templates used or edited up to this date/time. If no value is provided, this defaults to the current date.\",\n \"in\": \"query\",\n \"name\": \"used_to_date\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Filters the templates in the response. Valid values are: \\n\\n- `owned_by_me`: Results include only templates owned by the user.\\n- `shared_with_me`: Results include only templates shared with the user. \\n- `all`: Results include all templates owned or shared with the user.\",\n \"in\": \"query\",\n \"name\": \"user_filter\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The ID of the user.\",\n \"in\": \"query\",\n \"name\": \"user_id\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/templates\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"templates_get_templates\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Gets the list of templates.\",\n \"tags\": [\n \"Templates\"\n ]\n },\n \"templates_post_document_templates\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Adds templates to a document in the specified envelope.\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"templates_post_document_templates\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The unique ID of the document within the envelope.\\n\\nUnlike other IDs in the eSignature API,\\nyou specify the `documentId` yourself.\\nTypically the first document has the ID\\n`1`, the second document `2`, and so on,\\nbut you can use any numbering scheme\\nthat fits within a 32-bit signed integer\\n(1 through 2147483647).\\n\\n\\nTab objects have a `documentId` property\\nthat specifies the document on which to place\\nthe tab.\\n\",\n \"in\": \"path\",\n \"name\": \"documentId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The envelope's GUID. \\n\\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\\n\",\n \"in\": \"path\",\n \"name\": \"envelopeId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"If omitted or set to false (the default),\\nenvelope recipients _will be removed_\\nif the template being applied\\nincludes only tabs positioned via anchor text for the recipient,\\nand none of the documents include the anchor text. \\n\\nWhen **true,** the recipients _will be preserved_ after the template is applied.\\n\\n\",\n \"in\": \"query\",\n \"name\": \"preserve_template_recipient\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/templates\",\n \"request_body\": {\n \"$ref\": \"#/definitions/documentTemplateList\"\n },\n \"security\": null,\n \"skill_name\": \"templates_post_document_templates\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Adds templates to a document in an envelope.\",\n \"tags\": [\n \"EnvelopeTemplates\"\n ]\n },\n \"templates_post_envelope_templates\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Adds templates to the specified envelope.\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"templates_post_envelope_templates\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The envelope's GUID. \\n\\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\\n\",\n \"in\": \"path\",\n \"name\": \"envelopeId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"If omitted or set to false (the default),\\nenvelope recipients _will be removed_\\nif the template being applied\\nincludes only tabs positioned via anchor text for the recipient,\\nand none of the documents include the anchor text. \\n\\nWhen **true,** the recipients _will be preserved_ after the template is applied.\\n\\n\",\n \"in\": \"query\",\n \"name\": \"preserve_template_recipient\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/envelopes/{envelopeId}/templates\",\n \"request_body\": {\n \"$ref\": \"#/definitions/documentTemplateList\"\n },\n \"security\": null,\n \"skill_name\": \"templates_post_envelope_templates\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Adds templates to an envelope.\",\n \"tags\": [\n \"EnvelopeTemplates\"\n ]\n },\n \"templates_post_templates\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Creates one or more template definitions, using a multipart\\nrequest for each template.\\n\\n[Templates](/docs/esign-rest-api/esign101/concepts/templates/)\\nhelp streamline the sending process when you frequently\\nsend the same or similar documents, or send different documents\\nto the same group of people.\\n\\nWhen you create a template, you define placeholder roles. Rather\\nthan specifying a person, you specify a role that regularly\\nparticipates in a transaction that uses the template. Then, when\\nyou create or send an envelope based on the template, you assign\\nactual recipients to the template roles. The recipients\\nautomatically inherit all of the workflow that is defined for\\nthat role in the template, such as the tabs and routing\\ninformation.\\n\\n## Template Email Subject Merge Fields\\n\\nPlaceholder roles have associated merge fields that personalize\\nthe email notification that Docusign sends. For example, the\\ntemplate automatically personalizes the email message by adding\\nplaceholders for the recipient's name and email address within\\nthe email subject line, based on the recipient's role. When the\\nsender adds the name and email information for the recipient and\\nsends the envelope, the recipient information is automatically\\nmerged into the appropriate fields in the email subject line.\\n\\nBoth the sender and the recipients will see the information in\\nthe email subject line for any emails associated with the\\ntemplate. This provides an easy way for senders to organize their\\nenvelope emails without having to open an envelope to find out\\nwho the recipient is.\\n\\n\\n\\nUse the following placeholders\\nto insert a recipient's name or\\nemail address in the subject line\\n\\nTo insert a recipient's name into the subject line,\\nuse the `[[<roleName>_UserName]]` placeholder\\nin the `emailSubject` property when you create the\\ntemplate:\\n\\nTo include a recipient's name\\nor email address in the subject line,\\nuse the following placeholders\\nin the `emailSubject` property:\\n\\n- `[[<roleName>_UserName]]`\\n- `[[<roleName>_Email]]`\\n\\n\\nFor example, if the role name is `Signer 1`,\\nyou might set `emailSubject` to one of these strings:\\n\\n- `\\\"[[Signer 1_UserName]], Please sign this NDA\\\"`\\n- `\\\"[[Signer 1_Email]], Please sign this NDA\\\"`\\n\\n\\n**Note:** The maximum length of the\\nsubject line is 100 characters,\\nincluding any merged text.\\n\\n\\n## Creating multiple templates\\n\\nTo create multiple templates, you provide a zip file of JSON\\nfiles. You can also use the Templates::ListTemplates method with\\nthe `is_download` query parameter to download a zip file\\ncontaining your existing templates and use that as a guide. The\\nAPI supports both .zip and .gzip file formats as input.\\n\\nYou also need to set the\\n`Content-Length`,\\n`Content-Type`,\\nand\\n`Content-Disposition`\\nheaders:\\n\\n\\n```\\nContent-Length: 71068\\nContent-Type: application/zip\\nContent-Disposition: file; filename=\\\"DocuSignTemplates_Nov_25_2019_20_40_21.zip\\\"; fileExtension=.zip\\n```\\n\\n### Related topics\\n\\n- [How to create a template](/docs/esign-rest-api/how-to/create-template/)\\n\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"templates_post_templates\",\n \"parameters\": [\n {\n \"description\": \"(Required) The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/templates\",\n \"request_body\": {\n \"$ref\": \"#/definitions/envelopeTemplate\"\n },\n \"security\": null,\n \"skill_name\": \"templates_post_templates\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Creates one or more templates.\",\n \"tags\": [\n \"Templates\"\n ]\n },\n \"templates_put_template\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Updates an existing template.\",\n \"destructive\": true,\n \"method\": \"PUT\",\n \"operation_id\": \"templates_put_template\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The ID of the template.\",\n \"in\": \"path\",\n \"name\": \"templateId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/templates/{templateId}\",\n \"request_body\": {\n \"$ref\": \"#/definitions/envelopeTemplate\"\n },\n \"security\": null,\n \"skill_name\": \"templates_put_template\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Updates an existing template.\",\n \"tags\": [\n \"Templates\"\n ]\n },\n \"templates_put_template_part\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Shares a template with the specified members group.\\n\\n**Note:** For a newer version of this functionality, see [Accounts: Update Shared Access](/docs/esign-rest-api/reference/accounts/accounts/updatesharedaccess/).\",\n \"destructive\": true,\n \"method\": \"PUT\",\n \"operation_id\": \"templates_put_template_part\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The ID of the template.\",\n \"in\": \"path\",\n \"name\": \"templateId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Currently, the only defined part is **groups.**\",\n \"in\": \"path\",\n \"name\": \"templatePart\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/templates/{templateId}/{templatePart}\",\n \"request_body\": {\n \"$ref\": \"#/definitions/groupInformation\"\n },\n \"security\": null,\n \"skill_name\": \"templates_put_template_part\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Shares a template with a group.\",\n \"tags\": [\n \"Templates\"\n ]\n },\n \"templates_put_templates\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Templates_PutTemplates\",\n \"destructive\": true,\n \"method\": \"PUT\",\n \"operation_id\": \"templates_put_templates\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/templates\",\n \"request_body\": {\n \"$ref\": \"#/definitions/templateAutoMatchList\"\n },\n \"security\": null,\n \"skill_name\": \"templates_put_templates\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Templates_PutTemplates\",\n \"tags\": [\n \"Templates\"\n ]\n },\n \"unsupported_file_types_get_unsupported_file_types\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Retrieves a list of file types (mime-types and file-extensions) that are not supported for upload through the Docusign system.\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"unsupported_file_types_get_unsupported_file_types\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/unsupported_file_types\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"unsupported_file_types_get_unsupported_file_types\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Gets a list of unsupported file types.\",\n \"tags\": [\n \"Accounts\"\n ]\n },\n \"user_agent_authorizations_get_agent_user_authorizations\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Returns the user authorizations for which the user specified by `userId` is the agent user.\\n\\nIf the calling user is an account administrator, the full results will be returned. Otherwise, only authorizations for which the calling user is the principal user will be returned.\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"user_agent_authorizations_get_agent_user_authorizations\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The user who is acting as the agent.\",\n \"in\": \"path\",\n \"name\": \"userId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"When **true,** only active users are returned. The default value is **false.**\",\n \"in\": \"query\",\n \"name\": \"active_only\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The maximum number of results to return.\",\n \"in\": \"query\",\n \"name\": \"count\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Filters returned user records by full email address or a substring of email address.\",\n \"in\": \"query\",\n \"name\": \"email_substring\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"When **true,** returns active and scheduled authorizations of closed users. The default value is **true.** This value is only applied when `active_only` is **false.**\",\n \"in\": \"query\",\n \"name\": \"include_closed_users\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"\",\n \"in\": \"query\",\n \"name\": \"permissions\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The position within the total result set from which to start returning values. The value **thumbnail** may be used to return the page image.\",\n \"in\": \"query\",\n \"name\": \"start_position\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"\",\n \"in\": \"query\",\n \"name\": \"task_source\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"\",\n \"in\": \"query\",\n \"name\": \"task_type\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Filters results based on a full or partial user name.\\n\\n**Note:** When you enter a partial user name, you do not use a wildcard character.\",\n \"in\": \"query\",\n \"name\": \"user_name_substring\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/users/{userId}/authorizations/agent\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"user_agent_authorizations_get_agent_user_authorizations\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Returns the authorizations for which the specified user is the agent user.\",\n \"tags\": [\n \"Authorizations\"\n ]\n },\n \"user_authorization_create_user_authorization\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Creates an authorization allowing one user to send and/or manage envelopes on behalf of another user.\\n\\nThe _agent_ user acts on behalf of the _principal_ user. The principal user is specified by the `userId` path parameter. The agent user is specified in the request body. Each principal user can only share signing permission with one agent user.\\n\\nSpecify in the request the level of access to share with the agent user. If you share signing access, the agent user will receive an email notification.\\n\\nTo call this endpoint:\\n* You must be an account administrator or you must be the principal user.\\n* The agent user and principal user must belong to the same account.\\n* At least one of the following account settings must be enabled: `AllowDelegatedSigning`, `AllowManagingEnvelopesOnBehalfOfOthers`, `AllowEditingEnvelopesOnBehalfOfOthers`, `AllowSendingEnvelopesOnBehalfOfOthers`. These settings correspond to the level of access you can set for the authorization.\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"user_authorization_create_user_authorization\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The ID of the principal user.\",\n \"in\": \"path\",\n \"name\": \"userId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/users/{userId}/authorization\",\n \"request_body\": {\n \"$ref\": \"#/definitions/userAuthorizationCreateRequest\"\n },\n \"security\": null,\n \"skill_name\": \"user_authorization_create_user_authorization\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Creates a user authorization.\",\n \"tags\": [\n \"Authorizations\"\n ]\n },\n \"user_authorization_delete_user_authorization\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Deletes the user authorization specified by the `authorizationId`.\\n\\nTo call this endpoint, you must be an account administrator or you must be the principal user for the specified authorization.\",\n \"destructive\": true,\n \"method\": \"DELETE\",\n \"operation_id\": \"user_authorization_delete_user_authorization\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The ID of the user authorization.\",\n \"in\": \"path\",\n \"name\": \"authorizationId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The ID of the principal user.\",\n \"in\": \"path\",\n \"name\": \"userId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/users/{userId}/authorization/{authorizationId}\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"user_authorization_delete_user_authorization\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Deletes the user authorization.\\n\",\n \"tags\": [\n \"Authorizations\"\n ]\n },\n \"user_authorization_get_user_authorization\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Returns the details for the user authorization specified by the `authorizationId`.\\n\\nTo call this endpoint, you must be an account administrator or you must be the principal user for the specified authorization.\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"user_authorization_get_user_authorization\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The ID of the user authorization.\",\n \"in\": \"path\",\n \"name\": \"authorizationId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The ID of the principal user.\",\n \"in\": \"path\",\n \"name\": \"userId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/users/{userId}/authorization/{authorizationId}\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"user_authorization_get_user_authorization\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Returns the user authorization for a given authorization ID.\\n\",\n \"tags\": [\n \"Authorizations\"\n ]\n },\n \"user_authorization_update_user_authorization\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Updates the start and/or end date for a given user authorization. Specify the user authorization and principal user with the path parameters.\\n\\nTo call this endpoint, you must be an account administrator or you must be the principal user for the specified authorization.\",\n \"destructive\": true,\n \"method\": \"PUT\",\n \"operation_id\": \"user_authorization_update_user_authorization\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The ID of the user authorization.\",\n \"in\": \"path\",\n \"name\": \"authorizationId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The ID of the principal user.\",\n \"in\": \"path\",\n \"name\": \"userId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/users/{userId}/authorization/{authorizationId}\",\n \"request_body\": {\n \"$ref\": \"#/definitions/userAuthorizationUpdateRequest\"\n },\n \"security\": null,\n \"skill_name\": \"user_authorization_update_user_authorization\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Updates the start or end date for a user authorization.\",\n \"tags\": [\n \"Authorizations\"\n ]\n },\n \"user_authorizations_delete_user_authorizations\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Delete one or more user authorizations for a given principal user. The principal user is specified by the `userId` path parameter.\\n\\nTo call this endpoint, you must be an account administrator or you must be the principal user for the specified authorizations.\",\n \"destructive\": true,\n \"method\": \"DELETE\",\n \"operation_id\": \"user_authorizations_delete_user_authorizations\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The ID of the principal user.\",\n \"in\": \"path\",\n \"name\": \"userId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/users/{userId}/authorizations\",\n \"request_body\": {\n \"$ref\": \"#/definitions/userAuthorizationsDeleteRequest\"\n },\n \"security\": null,\n \"skill_name\": \"user_authorizations_delete_user_authorizations\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Delete multiple user authorizations.\",\n \"tags\": [\n \"Authorizations\"\n ]\n },\n \"user_authorizations_get_principal_user_authorizations\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Returns the user authorizations for which the user specified by `userId` is the principal user.\\n\\nTo call this endpoint, you must be an account administrator or you must be the specified principal user.\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"user_authorizations_get_principal_user_authorizations\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The ID of the principal user.\",\n \"in\": \"path\",\n \"name\": \"userId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"When **true,** return only active authorizations. The default value is **true.**\",\n \"in\": \"query\",\n \"name\": \"active_only\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The maximum number of results to return.\",\n \"in\": \"query\",\n \"name\": \"count\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Filters returned user records by full email address or a substring of email address.\",\n \"in\": \"query\",\n \"name\": \"email_substring\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"When **true,** returns active and scheduled authorizations of closed users. The default value is **true.** This value is only applied when `active_only` is **false.**\",\n \"in\": \"query\",\n \"name\": \"include_closed_users\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Filters results by authorization permission. Valid values:\\n* `Send`\\n* `Manage`\\n* `Sign`\",\n \"in\": \"query\",\n \"name\": \"permissions\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The position within the total result set from which to start returning values. The value **thumbnail** may be used to return the page image.\",\n \"in\": \"query\",\n \"name\": \"start_position\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"\",\n \"in\": \"query\",\n \"name\": \"task_source\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"\",\n \"in\": \"query\",\n \"name\": \"task_type\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Filters results based on a full or partial user name.\\n\\n**Note:** When you enter a partial user name, you do not use a wildcard character.\",\n \"in\": \"query\",\n \"name\": \"user_name_substring\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/users/{userId}/authorizations\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"user_authorizations_get_principal_user_authorizations\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Returns the authorizations for which the specified user is the principal user.\",\n \"tags\": [\n \"Authorizations\"\n ]\n },\n \"user_authorizations_post_user_authorizations\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Create or update multiple user authorizations in a single request. The body of the request is a list of userAuthorizationSomething objects. To create a new authorization, specify the `agentUser` and `permission` fields, with the optional `startDate` and `endDate` fields. To update an existing authorization, specify the `authorizationId` field and the `startDate` and/or `endDate` fields.\\n\\nFor example, to create a new authorization and update the end date of an existing authorization, your request body might look like this:\\n\\n```\\n{\\n \\\"authorizations\\\": [\\n {\\n \\\"agentUser\\\": {\\n \\\"userId\\\": \\\"1470ff66-xxxx-xxxx-xxxx-8c46f140da37\\\",\\n \\\"accountId\\\": \\\"230546a7-xxxx-xxxx-xxxx-af205d5494ad\\\"\\n },\\n \\\"permission\\\": \\\"manage\\\"\\n },\\n {\\n \\\"authorizationId\\\": \\\"b73ac983-xxxx-xxxx-xxxx-b3c0ea5b09d3\\\",\\n \\\"endDate\\\": \\\"2023-05-09T21:36:27.0000000+00:00\\\"\\n }\\n ]\\n}\\n```\\n\\nThe principal user is specified by the `userId` path parameter. To call this endpoint, you must be an account administrator or the principal user.\\n\\n**Note:** To create an authorization with signing permission, the `AllowDelegationSigning` setting must be enabled on the account. If you share signing access, the agent user will receive an email notification. Each principal user can only share signing permission with one agent user.\\n\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"user_authorizations_post_user_authorizations\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The ID of the principal user.\",\n \"in\": \"path\",\n \"name\": \"userId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/users/{userId}/authorizations\",\n \"request_body\": {\n \"$ref\": \"#/definitions/userAuthorizationsRequest\"\n },\n \"security\": null,\n \"skill_name\": \"user_authorizations_post_user_authorizations\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Create or update multiple user authorizations.\",\n \"tags\": [\n \"Authorizations\"\n ]\n },\n \"user_custom_settings_delete_custom_settings\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Deletes the specified custom user settings for a single user.\\n\\nIf the custom user settings you want to delete are grouped, you\\nmust include the `X-DocuSign-User-Settings-Key` header\\nin the request:\\n\\n`X-DocuSign-User-Settings-Key:group_name`\\n\\nWhere the `group_name` is your designated name for the group of\\ncustomer user settings.\\n\\nIf the `X-DocuSign-User-Settings-Key` header is not included,\\nonly the custom user settings that were added without\\na group are deleted.\",\n \"destructive\": true,\n \"method\": \"DELETE\",\n \"operation_id\": \"user_custom_settings_delete_custom_settings\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The ID of the user to access.\\n\\n**Note:** Users can only access their own information. A user, even one with Admin rights, cannot access another user's settings.\",\n \"in\": \"path\",\n \"name\": \"userId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/users/{userId}/custom_settings\",\n \"request_body\": {\n \"$ref\": \"#/definitions/customSettingsInformation\"\n },\n \"security\": null,\n \"skill_name\": \"user_custom_settings_delete_custom_settings\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Deletes custom user settings for a specified user.\",\n \"tags\": [\n \"UserCustomSettings\"\n ]\n },\n \"user_custom_settings_get_custom_settings\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Retrieves a list of custom user settings for a single user.\\n\\nCustom settings provide a flexible way to store and retrieve\\ncustom user information that can be used in your own system.\\n\\n**Note:** Custom user settings are not the same as user account\\nsettings.\\n\\n\\nIf the custom user settings you want to retrieve are grouped, you\\nmust include the `X-DocuSign-User-Settings-Key` header\\nin the request:\\n\\n`X-DocuSign-User-Settings-Key:group_name`\\n\\nWhere the `group_name` is your designated name for the group of\\ncustomer user settings.\\n\\nIf the `X-DocuSign-User-Settings-Key` header is not included, only the custom\\nuser settings that were added without a group are retrieved.\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"user_custom_settings_get_custom_settings\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The ID of the user to access.\\n\\n**Note:** Users can only access their own information. A user, even one with Admin rights, cannot access another user's settings.\",\n \"in\": \"path\",\n \"name\": \"userId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/users/{userId}/custom_settings\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"user_custom_settings_get_custom_settings\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Retrieves the custom user settings for a specified user.\",\n \"tags\": [\n \"UserCustomSettings\"\n ]\n },\n \"user_custom_settings_put_custom_settings\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Adds or updates custom user settings for the specified user.\\n\\n**Note:** Custom user settings are not the same as user account\\nsettings.\\n\\nCustom settings provide a flexible way to store and retrieve\\ncustom user information that you can use in your own system.\\n\\n**Important:** There is a limit on the size for all the custom\\nuser settings for a single user. The limit is 4,000 characters,\\nwhich includes the XML and JSON structure for the settings.\\n\\nYou can group custom user settings when adding them. Grouping\\nallows you to retrieve settings that are in a specific group,\\ninstead of retrieving all the user custom settings.\\n\\nTo group custom user settings, include the\\n`X-DocuSign-User-Settings-Key` header in the request:\\n\\n`X-DocuSign-User-Settings-Key:group_name`\\n\\nWhere the `group_name` is your designated name for the group of\\ncustomer user settings.\\n\\nWhen getting or deleting grouped custom user settings, you must\\ninclude the `X-DocuSign-User-Settings-Key` header information.\\n\\nGrouping custom user settings is not required and if the `X-DocuSign-User-Settings-Key`\\nheader information is not included, the custom user settings are\\nadded normally and can be retrieved or deleted without including\\nthe `X-DocuSign-User-Settings-Key` header.\\n\",\n \"destructive\": true,\n \"method\": \"PUT\",\n \"operation_id\": \"user_custom_settings_put_custom_settings\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The ID of the user to access.\\n\\n**Note:** Users can only access their own information. A user, even one with Admin rights, cannot access another user's settings.\",\n \"in\": \"path\",\n \"name\": \"userId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/users/{userId}/custom_settings\",\n \"request_body\": {\n \"$ref\": \"#/definitions/customSettingsInformation\"\n },\n \"security\": null,\n \"skill_name\": \"user_custom_settings_put_custom_settings\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Adds or updates custom user settings for the specified user.\",\n \"tags\": [\n \"UserCustomSettings\"\n ]\n },\n \"user_get_user\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Retrieves the user information for the specified user. For example:\\n\\n```json\\n{\\n \\\"userName\\\": \\\"Tania Morales\\\",\\n \\\"userId\\\": \\\"6b67a1ee-xxxx-xxxx-xxxx-385763624163\\\",\\n \\\"userType\\\": \\\"CompanyUser\\\",\\n \\\"isAdmin\\\": \\\"False\\\",\\n \\\"isNAREnabled\\\": \\\"false\\\",\\n \\\"userStatus\\\": \\\"Active\\\",\\n \\\"uri\\\": \\\"/users/6b67a1ee-xxxx-xxxx-xxxx-385763624163\\\",\\n \\\"email\\\": \\\"examplename42@orobia.net\\\",\\n \\\"createdDateTime\\\": \\\"2019-04-01T22:11:56.4570000Z\\\",\\n \\\"userAddedToAccountDateTime\\\": \\\"0001-01-01T08:00:00.0000000Z\\\",\\n \\\"firstName\\\": \\\"Tania\\\",\\n \\\"lastName\\\": \\\"Morales\\\",\\n \\\"jobTitle\\\": \\\"\\\",\\n \\\"company\\\": \\\"Company\\\",\\n \\\"permissionProfileId\\\": \\\"12345678\\\",\\n \\\"permissionProfileName\\\": \\\"DocuSign Viewer\\\",\\n \\\"userSettings\\\": {. . .},\\n \\\"sendActivationOnInvalidLogin\\\": \\\"false\\\",\\n \\\"enableConnectForUser\\\": \\\"false\\\",\\n \\\"groupList\\\": [. . .],\\n \\\"workAddress\\\": {. . .},\\n \\\"homeAddress\\\": {. . .},\\n \\\"signatureImageUri\\\": \\\"/users/6b67a1ee-xxxx-xxxx-xxxx-385763624163/signatures/0304c47b-xxxx-xxxx-xxxx-c9673963bb50/signature_image\\\",\\n \\\"initialsImageUri\\\": \\\"/users/6b67a1ee-xxxx-xxxx-xxxx-385763624163/signatures/0304c47b-xxxx-xxxx-xxxx-c9673963bb50/initials_image\\\",\\n \\\"defaultAccountId\\\": \\\"f636f297-xxxx-xxxx-xxxx-8e7a14715950\\\"\\n}\\n```\\n\\n\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"user_get_user\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The ID of the user to access.\\n\\n**Note:** Users can only access their own information. A user, even one with Admin rights, cannot access another user's settings.\",\n \"in\": \"path\",\n \"name\": \"userId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Setting this parameter has no effect in this operation.\",\n \"in\": \"query\",\n \"name\": \"additional_info\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Setting this parameter has no effect in this operation.\",\n \"in\": \"query\",\n \"name\": \"email\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"\",\n \"in\": \"query\",\n \"name\": \"include_license\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/users/{userId}\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"user_get_user\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Gets the user information for a specified user using a userId (GUID). To find a user based on their email address, use the list endpoint.\",\n \"tags\": [\n \"Users\"\n ]\n },\n \"user_profile_get_profile\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Retrieves the user profile information, the privacy settings and personal information (address, phone number, etc.) for the specified user.\\n\\nThe userId parameter specified in the endpoint must match the authenticated user's user ID and the user must be a member of the specified account.\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"user_profile_get_profile\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The ID of the user to access.\\n\\n**Note:** Users can only access their own information. A user, even one with Admin rights, cannot access another user's settings.\",\n \"in\": \"path\",\n \"name\": \"userId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/users/{userId}/profile\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"user_profile_get_profile\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Retrieves the user profile for a specified user.\",\n \"tags\": [\n \"UserProfiles\"\n ]\n },\n \"user_profile_image_delete_user_profile_image\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Deletes the user profile image from the specified user's profile.\\n\\nThe userId parameter specified in the endpoint must match the authenticated user's user ID and the user must be a member of the specified account.\",\n \"destructive\": true,\n \"method\": \"DELETE\",\n \"operation_id\": \"user_profile_image_delete_user_profile_image\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The ID of the user to access.\\n\\n**Note:** Users can only access their own information. A user, even one with Admin rights, cannot access another user's settings.\",\n \"in\": \"path\",\n \"name\": \"userId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/users/{userId}/profile/image\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"user_profile_image_delete_user_profile_image\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Deletes the user profile image for the specified user.\",\n \"tags\": [\n \"Users\"\n ]\n },\n \"user_profile_image_get_user_profile_image\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Retrieves the user profile picture for the specified user.\\n\\nThe `userId` path parameter must match the authenticated user's user ID,\\nand the user must be a member of the specified account.\\n\\n| Return value | Meaning |\\n| :---------------- | :----------------------------------------------------------------------------- |\\n| `200 OK` | The response contains the profile image in the same format as it was uploaded. |\\n| `404 Not found` | The user does not have a profile image. |\\n| `400 Bad request` | There was an error in the request. The response has more information. |\\n\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"user_profile_image_get_user_profile_image\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The ID of the user to access.\\n\\n**Note:** Users can only access their own information. A user, even one with Admin rights, cannot access another user's settings.\",\n \"in\": \"path\",\n \"name\": \"userId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Reserved for Docusign.\",\n \"in\": \"query\",\n \"name\": \"encoding\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/users/{userId}/profile/image\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"user_profile_image_get_user_profile_image\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Retrieves the user profile image for the specified user.\",\n \"tags\": [\n \"Users\"\n ]\n },\n \"user_profile_image_put_user_profile_image\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Updates the user profile image by uploading an image to the user profile.\\n\\nThe supported image formats are: gif, png, jpeg, and bmp. The file must be less than 200K. For best viewing results, Docusign recommends that the image is no more than 79 pixels wide and high.\",\n \"destructive\": true,\n \"method\": \"PUT\",\n \"operation_id\": \"user_profile_image_put_user_profile_image\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The ID of the user to access.\\n\\n**Note:** Users can only access their own information. A user, even one with Admin rights, cannot access another user's settings.\",\n \"in\": \"path\",\n \"name\": \"userId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/users/{userId}/profile/image\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"user_profile_image_put_user_profile_image\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Updates the user profile image for a specified user.\",\n \"tags\": [\n \"Users\"\n ]\n },\n \"user_profile_put_profile\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Updates the user's detail information, profile information, privacy settings, and personal information in the user ID card.\\n\\nYou can also change a user's name by changing the information in the `userDetails` property. When changing a user's name, you can either change the information in the `userName` property OR change the information in `firstName`, `middleName`, `lastName, suffixName`, and `title` properties. Changes to `firstName`, `middleName`, `lastName`, `suffixName`, and `title` properties take precedence over changes to the `userName` property.\",\n \"destructive\": true,\n \"method\": \"PUT\",\n \"operation_id\": \"user_profile_put_profile\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The ID of the user to access.\\n\\n**Note:** Users can only access their own information. A user, even one with Admin rights, cannot access another user's settings.\",\n \"in\": \"path\",\n \"name\": \"userId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/users/{userId}/profile\",\n \"request_body\": {\n \"$ref\": \"#/definitions/userProfile\"\n },\n \"security\": null,\n \"skill_name\": \"user_profile_put_profile\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Updates the user profile information for the specified user.\",\n \"tags\": [\n \"UserProfiles\"\n ]\n },\n \"user_put_user\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"To update user information for a specific user, submit a [Users](#Users) object with updated field values in the request body of this operation.\",\n \"destructive\": true,\n \"method\": \"PUT\",\n \"operation_id\": \"user_put_user\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The ID of the user to access.\\n\\n**Note:** Users can only access their own information. A user, even one with Admin rights, cannot access another user's settings.\",\n \"in\": \"path\",\n \"name\": \"userId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"\",\n \"in\": \"query\",\n \"name\": \"allow_all_languages\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/users/{userId}\",\n \"request_body\": {\n \"$ref\": \"#/definitions/userInformation\"\n },\n \"security\": null,\n \"skill_name\": \"user_put_user\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Updates user information for the specified user.\",\n \"tags\": [\n \"Users\"\n ]\n },\n \"user_settings_get_user_settings\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Retrieves a list of the account settings and email\\nnotification information for the specified user.\\n\\nThe response returns the account setting\\nname/value information and the email notification\\nsettings for the specified user. For more\\ninformation, see\\n[Users:create](/docs/esign-rest-api/reference/users/users/create/).\\n\\n\\n\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"user_settings_get_user_settings\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The ID of the user to access.\\n\\n**Note:** Users can only access their own information. A user, even one with Admin rights, cannot access another user's settings.\",\n \"in\": \"path\",\n \"name\": \"userId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/users/{userId}/settings\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"user_settings_get_user_settings\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Gets the user account settings for a specified user.\",\n \"tags\": [\n \"Users\"\n ]\n },\n \"user_settings_put_user_settings\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Updates the account settings list and email notification types for the specified user.\",\n \"destructive\": true,\n \"method\": \"PUT\",\n \"operation_id\": \"user_settings_put_user_settings\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The ID of the user to access.\\n\\n**Note:** Users can only access their own information. A user, even one with Admin rights, cannot access another user's settings.\",\n \"in\": \"path\",\n \"name\": \"userId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"\",\n \"in\": \"query\",\n \"name\": \"allow_all_languages\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/users/{userId}/settings\",\n \"request_body\": {\n \"$ref\": \"#/definitions/userSettingsInformation\"\n },\n \"security\": null,\n \"skill_name\": \"user_settings_put_user_settings\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Updates the user account settings for a specified user.\",\n \"tags\": [\n \"Users\"\n ]\n },\n \"user_signatures_delete_user_signature\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Removes the signature information for the user.\\n\\nThe userId parameter specified in the endpoint must match the authenticated user's user ID and the user must be a member of the account.\\n\\nThe `signatureId` accepts a signature ID or a signature name. Docusign recommends you use signature ID (`signatureId`), since some names contain characters that do not properly encode into a URL. If you use the user name, it is likely that the name includes spaces. In that case, URL encode the name before using it in the endpoint. \\n\\nFor example encode \\\"Bob Smith\\\" as \\\"Bob%20Smith\\\".\",\n \"destructive\": true,\n \"method\": \"DELETE\",\n \"operation_id\": \"user_signatures_delete_user_signature\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The ID of the account stamp.\",\n \"in\": \"path\",\n \"name\": \"signatureId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The ID of the user to access.\\n\\n**Note:** Users can only access their own information. A user, even one with Admin rights, cannot access another user's settings.\",\n \"in\": \"path\",\n \"name\": \"userId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/users/{userId}/signatures/{signatureId}\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"user_signatures_delete_user_signature\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Removes removes signature information for the specified user.\",\n \"tags\": [\n \"UserSignatures\"\n ]\n },\n \"user_signatures_delete_user_signature_image\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Deletes the specified initials image or signature image for the specified user.\\n\\nThe function deletes one or the other of the image types, to delete both the initials image and signature image you must call the endpoint twice.\\n\\nThe userId parameter specified in the endpoint must match the authenticated user's user ID and the user must be a member of the account.\\n\\nThe `signatureId` parameter accepts a signature ID or a signature name. Docusign recommends you use signature ID (`signatureId`), since some names contain characters that do not properly encode into a URL. If you use the user name, it is likely that the name includes spaces. In that case, URL encode the name before using it in the endpoint. \\n\\nFor example encode \\\"Bob Smith\\\" as \\\"Bob%20Smith\\\".\",\n \"destructive\": true,\n \"method\": \"DELETE\",\n \"operation_id\": \"user_signatures_delete_user_signature_image\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Specificies the type of image. Valid values:\\n\\n- `stamp_image`\\n- `signature_image`\\n- `initials_image`\",\n \"in\": \"path\",\n \"name\": \"imageType\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The ID of the account stamp.\",\n \"in\": \"path\",\n \"name\": \"signatureId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The ID of the user to access.\\n\\n**Note:** Users can only access their own information. A user, even one with Admin rights, cannot access another user's settings.\",\n \"in\": \"path\",\n \"name\": \"userId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/users/{userId}/signatures/{signatureId}/{imageType}\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"user_signatures_delete_user_signature_image\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Deletes the user initials image or the user signature image for the specified user.\",\n \"tags\": [\n \"UserSignatures\"\n ]\n },\n \"user_signatures_get_user_signature\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Retrieves the structure of a single signature with a known signature name.\\n\\nThe userId specified in the endpoint must match the authenticated user's user ID and the user must be a member of the account.\\n\\nThe `signatureId` parameter accepts a signature ID or a signature name. Docusign recommends you use signature ID (`signatureId`), since some names contain characters that do not properly encode into a URL. If you use the user name, it is likely that the name includes spaces. In that case, URL encode the name before using it in the endpoint. \\n\\nFor example encode \\\"Bob Smith\\\" as \\\"Bob%20Smith\\\".\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"user_signatures_get_user_signature\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The ID of the account stamp.\",\n \"in\": \"path\",\n \"name\": \"signatureId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The ID of the user to access.\\n\\n**Note:** Users can only access their own information. A user, even one with Admin rights, cannot access another user's settings.\",\n \"in\": \"path\",\n \"name\": \"userId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/users/{userId}/signatures/{signatureId}\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"user_signatures_get_user_signature\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Gets the user signature information for the specified user.\",\n \"tags\": [\n \"UserSignatures\"\n ]\n },\n \"user_signatures_get_user_signature_image\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Retrieves the specified initials image or signature image for the specified user. The image is returned in the same format in which it was uploaded. In the request you can specify if the chrome (the added line and identifier around the initial image) is returned with the image.\\n\\nThe userId property specified in the endpoint must match the authenticated user's user ID and the user must be a member of the account.\\n\\nThe `signatureId` parameter accepts a signature ID or a signature name. Docusign recommends you use signature ID (`signatureId`), since some names contain characters that do not properly encode into a URL. If you use the user name, it is likely that the name includes spaces. In that case, URL encode the name before using it in the endpoint.\\n\\nFor example encode \\\"Bob Smith\\\" as \\\"Bob%20Smith\\\".\\n\\n**Note:** Older envelopes might only have chromed images. If getting the non-chromed image fails, try getting the chromed image.\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"user_signatures_get_user_signature_image\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Specificies the type of image. Valid values:\\n\\n- `stamp_image`\\n- `signature_image`\\n- `initials_image`\",\n \"in\": \"path\",\n \"name\": \"imageType\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The ID of the account stamp.\",\n \"in\": \"path\",\n \"name\": \"signatureId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The ID of the user to access.\\n\\n**Note:** Users can only access their own information. A user, even one with Admin rights, cannot access another user's settings.\",\n \"in\": \"path\",\n \"name\": \"userId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"When **true,** the chrome (or frame containing the added line and identifier) is included with the signature image.\",\n \"in\": \"query\",\n \"name\": \"include_chrome\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/users/{userId}/signatures/{signatureId}/{imageType}\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"user_signatures_get_user_signature_image\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Retrieves the user initials image or the user signature image for the specified user.\",\n \"tags\": [\n \"UserSignatures\"\n ]\n },\n \"user_signatures_get_user_signatures\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"This method retrieves the signature definitions for the user that you specify.\\n\\nThe `userId` parameter specified in the endpoint must match the authenticated user's user ID, and the user must be a member of the account.\\n\\nThe `signatureId` parameter accepts a signature ID or a signature name. Docusign recommends you use signature ID (`signatureId`), since some names contain characters that do not properly encode into a URL. If you use the user name, it is likely that the name includes spaces. In that case, URL encode the name before using it in the endpoint. \\n\\nFor example, encode \\\"Bob Smith\\\" as \\\"Bob%20Smith\\\".\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"user_signatures_get_user_signatures\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The ID of the user to access.\\n\\n**Note:** Users can only access their own information. A user, even one with Admin rights, cannot access another user's settings.\",\n \"in\": \"path\",\n \"name\": \"userId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The type of stamps to return. Valid values are:\\n\\n- `signature`: Returns information about signature images only. This is the default value.\\n- `stamp`: Returns information about eHanko and custom stamps only.\\n- null\",\n \"in\": \"query\",\n \"name\": \"stamp_type\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/users/{userId}/signatures\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"user_signatures_get_user_signatures\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Retrieves a list of signature definitions for a user.\",\n \"tags\": [\n \"UserSignatures\"\n ]\n },\n \"user_signatures_post_user_signatures\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Adds a user signature image and/or user initials image to the specified user. \\n\\nThe userId property specified in the endpoint must match the authenticated user's `userId` and the user must be a member of the account.\\n\\nThe rules and processes associated with this are:\\n\\n* If `Content-Type` is set to `application/json`, then the default behavior for creating a default signature image, based on the name and a Docusign font, is used.\\n* If `Content-Type` is set to `multipart/form-data`, then the request must contain a first part with the user signature information, followed by parts that contain the images.\\n\\nFor each Image part, the Content-Disposition header has a \\\"filename\\\" value that is used to map to the `signatureName` and/or `signatureInitials` properties in the JSON to the image. \\n\\nFor example: \\n`Content-Disposition: file; filename=\\\"Ron Test20121127083900\\\"`\\n\\nIf no matching image (by filename value) is found, then the image is not set. One, both, or neither of the signature and initials images can be set with this call.\\n\\nThe Content-Transfer-Encoding: base64 header, set in the header for the part containing the image, can be set to indicate that the images are formatted as base64 instead of as binary.\\n\\nIf successful, 200-OK is returned, and a JSON structure containing the signature information is provided, note that the signatureId can change with each API POST, PUT, or DELETE since the changes to the signature structure cause the current signature to be closed, and a new signature record to be created.\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"user_signatures_post_user_signatures\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The ID of the user to access.\\n\\n**Note:** Users can only access their own information. A user, even one with Admin rights, cannot access another user's settings.\",\n \"in\": \"path\",\n \"name\": \"userId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/users/{userId}/signatures\",\n \"request_body\": {\n \"$ref\": \"#/definitions/userSignaturesInformation\"\n },\n \"security\": null,\n \"skill_name\": \"user_signatures_post_user_signatures\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Adds user Signature and initials images to a Signature.\",\n \"tags\": [\n \"UserSignatures\"\n ]\n },\n \"user_signatures_put_user_signature\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Adds/updates a user signature.\",\n \"destructive\": true,\n \"method\": \"PUT\",\n \"operation_id\": \"user_signatures_put_user_signature\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The ID of the user to access.\\n\\n**Note:** Users can only access their own information. A user, even one with Admin rights, cannot access another user's settings.\",\n \"in\": \"path\",\n \"name\": \"userId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/users/{userId}/signatures\",\n \"request_body\": {\n \"$ref\": \"#/definitions/userSignaturesInformation\"\n },\n \"security\": null,\n \"skill_name\": \"user_signatures_put_user_signature\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Adds/updates a user signature.\",\n \"tags\": [\n \"UserSignatures\"\n ]\n },\n \"user_signatures_put_user_signature_by_id\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Creates, or updates, the signature font and initials for the specified user. When creating a signature, you use this resource to create the signature name and then add the signature and initials images into the signature.\\n\\n**Note:** This will also create a default signature for the user when one does not exist.\\n\\nThe userId property specified in the endpoint must match the authenticated user's user ID and the user must be a member of the account.\\n\\nThe `signatureId` parameter accepts a signature ID. Docusign recommends you use signature ID (`signatureId`), since some names contain characters that do not properly encode into a URL. If you use the user name, it is likely that the name includes spaces. In that case, URL encode the name before using it in the endpoint.\\n\\nFor example encode \\\"Bob Smith\\\" as \\\"Bob%20Smith\\\".\",\n \"destructive\": true,\n \"method\": \"PUT\",\n \"operation_id\": \"user_signatures_put_user_signature_by_id\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The ID of the account stamp.\",\n \"in\": \"path\",\n \"name\": \"signatureId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The ID of the user to access.\\n\\n**Note:** Users can only access their own information. A user, even one with Admin rights, cannot access another user's settings.\",\n \"in\": \"path\",\n \"name\": \"userId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"When **true,** closes the current signature.\",\n \"in\": \"query\",\n \"name\": \"close_existing_signature\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/users/{userId}/signatures/{signatureId}\",\n \"request_body\": {\n \"$ref\": \"#/definitions/userSignatureDefinition\"\n },\n \"security\": null,\n \"skill_name\": \"user_signatures_put_user_signature_by_id\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Updates the user signature for a specified user.\",\n \"tags\": [\n \"UserSignatures\"\n ]\n },\n \"user_signatures_put_user_signature_image\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Updates the user signature image or user initials image for the specified user. The supported image formats for this file are: gif, png, jpeg, and bmp. The file must be less than 200K.\\n\\nThe userId property specified in the endpoint must match the authenticated user's user ID and the user must be a member of the account.\\n\\nThe `signatureId` parameter accepts a signature ID or a signature name. Docusign recommends you use signature ID (`signatureId`), since some names contain characters that do not properly encode into a URL. If you use the user name, it is likely that the name includes spaces. In that case, URL encode the name before using it in the endpoint. \\n\\nFor example encode \\\"Bob Smith\\\" as \\\"Bob%20Smith\\\".\\n\",\n \"destructive\": true,\n \"method\": \"PUT\",\n \"operation_id\": \"user_signatures_put_user_signature_image\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Specificies the type of image. Valid values:\\n\\n- `stamp_image`\\n- `signature_image`\\n- `initials_image`\",\n \"in\": \"path\",\n \"name\": \"imageType\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The ID of the account stamp.\",\n \"in\": \"path\",\n \"name\": \"signatureId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The ID of the user to access.\\n\\n**Note:** Users can only access their own information. A user, even one with Admin rights, cannot access another user's settings.\",\n \"in\": \"path\",\n \"name\": \"userId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"\",\n \"in\": \"query\",\n \"name\": \"transparent_png\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/users/{userId}/signatures/{signatureId}/{imageType}\",\n \"request_body\": {\n \"format\": \"binary\",\n \"type\": \"string\"\n },\n \"security\": null,\n \"skill_name\": \"user_signatures_put_user_signature_image\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Updates the user signature image or user initials image for the specified user.\",\n \"tags\": [\n \"UserSignatures\"\n ]\n },\n \"users_delete_users\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Closes one or more users in the account,\\npreventing them from accessing account features.\\nUsers are not permanently deleted.\\n\\nThe request body requires only\\nthe IDs of the users to close:\\n\\n```json\\n{\\n \\\"users\\\": [\\n { \\\"userId\\\": \\\"6b67a1ee-xxxx-xxxx-xxxx-385763624163\\\" },\\n { \\\"userId\\\": \\\"b6c74c52-xxxx-xxxx-xxxx-457a81d88926\\\" },\\n { \\\"userId\\\": \\\"464f7988-xxxx-xxxx-xxxx-781ee556ab7a\\\" }\\n ]\\n}\\n```\\n\\nYou can use [`Users:update`](/docs/esign-rest-api/reference/users/users/update/)\\nto re-open a closed user.\\n\\n\",\n \"destructive\": true,\n \"method\": \"DELETE\",\n \"operation_id\": \"users_delete_users\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"A list of groups to remove the user from.\\nA comma-separated list of the following:\\n\\n- `Groups`\\n- `PermissionSet`\\n- `SigningGroupsEmail`\",\n \"in\": \"query\",\n \"name\": \"delete\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/users\",\n \"request_body\": {\n \"$ref\": \"#/definitions/userInfoList\"\n },\n \"security\": null,\n \"skill_name\": \"users_delete_users\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Closes one or more users in the account.\",\n \"tags\": [\n \"Users\"\n ]\n },\n \"users_get_users\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Retrieves the list of users for the specified account.\\n\\nThe response returns the list of users for the account, with information about the result set. If the `additional_info` query is added to the endpoint and set to **true,** full user information is returned for each user.\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"users_get_users\",\n \"parameters\": [\n {\n \"description\": \"(Required) The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"When **true,** the custom settings information is returned for each user in the account. If this parameter is omitted, the default behavior is **false.**\",\n \"in\": \"query\",\n \"name\": \"additional_info\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"When **true,** returns only alternate administrators. These users are not administrators but will be set as such if all administrator memberships are closed. The default value is **false.**\",\n \"in\": \"query\",\n \"name\": \"alternate_admins_only\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The maximum number of results to return.\\n\\nUse `start_position` to specify the number of results to skip.\\n\\nValid values: `1` to `100`\\n\",\n \"in\": \"query\",\n \"name\": \"count\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"When **true,** return only users in [domains](https://support.docusign.com/s/document-item?rsc_301=&bundleId=rrf1583359212854&topicId=jub1589318086105.html) claimed by your organization. The default value is **false.**\",\n \"in\": \"query\",\n \"name\": \"domain_users_only\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Filters results based on the email address associated with the user that you want to return.\\n\\n**Note:** You can use either this parameter or the `email_substring` parameter, but not both. For older accounts, this parameter might return multiple users who are associated with a single email address. \",\n \"in\": \"query\",\n \"name\": \"email\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Filters results based on a fragment of an email address. For example, you could enter `gmail.com` to return all users who have Gmail addresses.\\n\\n**Note:** You do not use a wildcard character with this parameter. You can use either this parameter or the `email` parameter, but not both. \",\n \"in\": \"query\",\n \"name\": \"email_substring\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Filters results based on one or more group IDs.\",\n \"in\": \"query\",\n \"name\": \"group_id\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"\",\n \"in\": \"query\",\n \"name\": \"include_license\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"When **true,** the response includes the `userSettings` object data in CSV format.\",\n \"in\": \"query\",\n \"name\": \"include_usersettings_for_csv\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"When **true,** the response includes the login status of each user.\",\n \"in\": \"query\",\n \"name\": \"login_status\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Return user records excluding the specified group IDs.\",\n \"in\": \"query\",\n \"name\": \"not_group_id\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The zero-based index of the\\nresult from which to start returning results.\\n\\nUse with `count` to limit the number\\nof results.\\n\\nThe default value is `0`.\\n\",\n \"in\": \"query\",\n \"name\": \"start_position\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Filters results by user account status.\\nA comma-separated list of any of the following:\\n\\n* `ActivationRequired`\\n* `ActivationSent`\\n* `Active`\\n* `Closed`\\n* `Disabled`\\n\",\n \"in\": \"query\",\n \"name\": \"status\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Filters the user records returned by the user name or a sub-string of user name.\",\n \"in\": \"query\",\n \"name\": \"user_name_substring\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/users\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"users_get_users\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Retrieves the list of users for the specified account. You can filter the users list to get specific users.\",\n \"tags\": [\n \"Users\"\n ]\n },\n \"users_post_users\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Adds new users to an account. \\n\\nThe body of this request is an array of `newUsers` objects. For each new user, you must provide at least the `userName` and `email` properties. The maximum number of users you can create in one request is 500 users. \\n\\nThe `userSettings` property specifies the actions users can perform. In the example below, Tal Mason will be able to send envelopes, and the activation email will be in French because the `locale` is set to `fr`.\\n\\n\\n```\\nPOST /restapi/v2.1/accounts/{accountId}/users\\nContent-Type: application/json\\n```\\n```\\n{\\n \\\"newUsers\\\": [\\n {\\n \\\"userName\\\": \\\"Claire Horace\\\",\\n \\\"email\\\": \\\"claire@example.com\\\"\\n },\\n {\\n \\\"userName\\\": \\\"Tal Mason\\\",\\n \\\"email\\\": \\\"talmason@example.com\\\",\\n \\\"company\\\": \\\"TeleSel\\\",\\n \\\"userSettings\\\": {\\n \\\"locale\\\": \\\"fr\\\",\\n \\\"canSendEnvelope\\\": true\\n }\\n }\\n ]\\n}\\n```\\n\\nA successful response is a `newUsers` array with information about the newly created users. If there was a problem in creating a user, that user entry will contain an `errorDetails` property that describes what went wrong.\\n\\n```json\\n{\\n \\\"newUsers\\\": [\\n {\\n \\\"userId\\\": \\\"18f3be12-xxxx-xxxx-xxxx-883d8f9b8ade\\\",\\n \\\"uri\\\": \\\"/users/18f3be12-xxxx-xxxx-xxxx-883d8f9b8ade\\\",\\n \\\"email\\\": \\\"claire@example.com\\\",\\n \\\"userName\\\": \\\"Claire Horace\\\",\\n \\\"createdDateTime\\\": \\\"0001-01-01T08:00:00.0000000Z\\\",\\n \\\"errorDetails\\\": {\\n \\\"errorCode\\\": \\\"USER_ALREADY_EXISTS_IN_ACCOUNT\\\",\\n \\\"message\\\": \\\"Username and email combination already exists for this account.\\\"\\n }\\n },\\n {\\n \\\"userId\\\": \\\"be9899a3-xxxx-xxxx-xxxx-2c8dd7156e33\\\",\\n \\\"uri\\\": \\\"/users/be9899a3-xxxx-xxxx-xxxx-2c8dd7156e33\\\",\\n \\\"email\\\": \\\"talmason@example.com\\\",\\n \\\"userName\\\": \\\"Tal Mason\\\",\\n \\\"userStatus\\\": \\\"ActivationSent\\\",\\n \\\"createdDateTime\\\": \\\"2020-05-26T23:25:30.7330000Z\\\"\\n }\\n ]\\n}\\n```\\n\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"users_post_users\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/users\",\n \"request_body\": {\n \"$ref\": \"#/definitions/newUsersDefinition\"\n },\n \"security\": null,\n \"skill_name\": \"users_post_users\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Adds new users to the specified account.\",\n \"tags\": [\n \"Users\"\n ]\n },\n \"users_put_users\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"This method updates the information about one or more account users.\",\n \"destructive\": true,\n \"method\": \"PUT\",\n \"operation_id\": \"users_put_users\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"\",\n \"in\": \"query\",\n \"name\": \"allow_all_languages\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/users\",\n \"request_body\": {\n \"$ref\": \"#/definitions/userInformationList\"\n },\n \"security\": null,\n \"skill_name\": \"users_put_users\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Changes one or more users in the specified account.\",\n \"tags\": [\n \"Users\"\n ]\n },\n \"views_delete_envelope_correct_view\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"This API method is obsolete. Your application should not call it. It acts as a null operation.\",\n \"destructive\": true,\n \"method\": \"DELETE\",\n \"operation_id\": \"views_delete_envelope_correct_view\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The envelope's GUID. \\n\\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\\n\",\n \"in\": \"path\",\n \"name\": \"envelopeId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/envelopes/{envelopeId}/views/correct\",\n \"request_body\": {\n \"$ref\": \"#/definitions/correctViewRequest\"\n },\n \"security\": null,\n \"skill_name\": \"views_delete_envelope_correct_view\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Revokes the correction view URL to the Envelope UI.\",\n \"tags\": [\n \"EnvelopeViews\"\n ]\n },\n \"views_post_account_console_view\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Returns a URL that enables you to embed the Docusign UI in your applications. To view a specific envelope, set the `envelopeId` property in the request body.\\n\\n## Information security notice\\n\\nThis method provides full access to the sending account.\\n\\n### Related topics\\n\\n- [How to embed the Docusign UI in your app](/docs/esign-rest-api/how-to/embed-ui/)\\n\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"views_post_account_console_view\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/views/console\",\n \"request_body\": {\n \"$ref\": \"#/definitions/consoleViewRequest\"\n },\n \"security\": null,\n \"skill_name\": \"views_post_account_console_view\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Returns a URL to the Docusign eSignature web application.\",\n \"tags\": [\n \"EnvelopeViews\"\n ]\n },\n \"views_post_envelope_correct_view\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Returns a URL that enables you to embed the envelope sender view of the Docusign UI. You can customize the appearance of the view via the settings request attribute. You can embed the view in an iframe. \\n\\n**API request update**\\n\\nThe request object for this API method was updated in June 2024. The new API request format is described below. Existing applications must update to the new version; it solves a security issue with the old version. The deprecation schedule has been announced in the [Docusign Core Release Notes](https://support.docusign.com/s/document-item?language=en_US&bundleId=adp1720620778794_24-2-02-00-demo&topicId=wcz1616195757589.html&_LANG=enus). While backwards compatibility will be provided for a while for existing applications, all applications must be updated to be secure. See below for migration information. \\n\\n**Best practices**\\n\\nThe returned URL expires after 10 minutes. Therefore, request the URL immediately before you redirect your user to it.\\n\\nDue to screen space issues, do not use an iframe for embedded operations on mobile devices. For mobile applications, use a [WebView](https://developer.android.com/reference/android/webkit/WebView) (Android) or [WKWebView](https://developer.apple.com/documentation/webkit/wkwebview) (iOS).\\n\\n## Customizing the user experience\\n\\nBy default, the view includes two pages: the **Prepare** and **Tagger** pages. The settings object is used to control the user experience. For example, to limit the user to the **Tagger** page, and not allow the user to change the recipient information:\\n\\n* `\\\"startingScreen\\\": \\\"Tagger\\\"`\\n* `\\\"showBackButton\\\": \\\"false\\\"`\\n* `\\\"showEditRecipients\\\": \\\"false\\\"`\\n\\n\\nUse the [Embedded Views Test Too](https://docusign.github.io/app-examples/embedded-views-v2/) to try the different UX controls. Some UI settings attributes are not yet implemented.\\n\\n### The envelope must be in the correct state for the Embedded View\\n\\nTo use the Correct View, the envelope **must** be in the `sent` or `delivered` state. Otherwise, a 400 error will be returned with an error message in the response body:\\n```\\n{\\n \\\"errorCode\\\": \\\"ENVELOPE_INVALID_STATUS\\\",\\n \\\"message\\\": \\\"Invalid envelope status. Correct view cannot be created for an envelope in a Created state.\\\"\\n}\\n```\\n\\n### Modifying the envelope after redirection\\nIf you set `\\\"sendButtonAction\\\": \\\"redirect\\\"` or `\\\"backButtonAction\\\": \\\"redirect\\\"`, and your app will modify the envelope before or after the view completes, you must lock the envelope before the API call and provide the lock as the lockToken attribute in the API request object.\\n\\nDelete the lock token after the browser has been redirected to your application.\\n\\n### Closing the view's iframe\\n\\nIf you choose to embed the view in your application via an iframe, Docusign recommends this software pattern to close the iframe after the view has completed:\\n\\n* (One time) create a standalone \\u00e2\\u0080\\u009creturn\\u00e2\\u0080\\u009d page that you will use as the `returnUrl` target for the view. The view will redirect the iframe to this URL when it has completed. Here's an [example return page](https://github.com/docusign/docusign.github.io/blob/master/jsfiddleDsResponse.html). In this page, use JavaScript and the [postMessage](https://developer.mozilla.org/en-US/docs/Web/API/Window/postMessage) method to send a message to your application with the results of the view.\\n* In your application, use `window.addEventListener(\\\"message\\\", function_name)` to register a listener for incoming messages.\\n* To show the view, use this API method, then set the iframe to load the URL from the API response.\\n* In your application, receive the completion message, validate it, and then close the iframe.\\n\\n### Information security\\n\\nThis view only has write access to the specific envelope referenced in the API call. It also has read access to templates and other secondary information that a user can access to modify the envelope. The read access corresponds to the access rights of the user associated with the access token used for the API call.\\n\\n>**Recommendations:**\\n>* Use the access token of a service user who can access the templates appropriate for your use case. \\n>* Do not use the access token of a user with administrator privileges.\\n\\n## Migrating to the current version of the request object\\n\\nThis section only applies to existing applications that use the older version of the request object.\\n\\nMigrating from the old API request object to the new version will take under a day of developer time.\\n\\n**Step 1.** Does your application set the `returnUrl` attribute?\\n\\nYes: continue with step 2.\\n\\nNo: In this case, your users first update the envelope, and then the Docusign eSignature home screen is shown. To accomplish this UI pattern with the new API request format:\\n* Set the `returnUrl` to a new endpoint for your application. You can use query parameters or session data to manage state. Remember to authenticate the incoming requests. \\n* When the new endpoint is called, use the [EnvelopeViews:createConsole](/docs/esign-rest-api/reference/envelopes/envelopeviews/createconsole/) API call to obtain and then display the Docusign eSignature home page to your application's user.\\n\\n**Step 2.** Does your application modify the default UI of the view?\\n\\nNo: continue with step 3.\\n\\nYes: With the new API request object, UI controls for the view are now set when you make the API call via the `settings` attribute. \\n\\n* Note the UI settings your application is currently modifying by adding and updating query parameters on the URL _returned_ by the API method.\\n\\n* Using the reference documentation below, create a settings object that accomplishes your UI goals. You can use the [Embedded Views Test tool](https://docusign.github.io/app-examples/embedded-views-v2/) to check your UI settings. Note that the `settings` object includes multiple objects and subobjects for various UI settings.\\n\\n* **Delete the code** in your application that modifies and adds query parameters to the URL returned by the API. With the new API format, your application will not make any changes to the returned URL. Exception: If you set the view's locale specifically, that is still accomplished by appending the `locale` query parameter.\\n\\n**Step 3.** Is the envelope always in the right state before you call the Embedded View?\\n\\nIf your software may try to create the Embedded View when the envelope is not in the right state (see above), then you must add additional checks and logic to prevent this.\\n\\n**Step 4.** Check that these API attributes are set:\\n* `\\\"view\\\" = \\\"envelope\\\"`\\n* The `returnUrl` is set\\n\\n**Step 5.** All done! Test your application.\\n\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"views_post_envelope_correct_view\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The envelope's GUID. \\n\\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\\n\",\n \"in\": \"path\",\n \"name\": \"envelopeId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/envelopes/{envelopeId}/views/correct\",\n \"request_body\": {\n \"$ref\": \"#/definitions/envelopeViewRequest\"\n },\n \"security\": null,\n \"skill_name\": \"views_post_envelope_correct_view\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Returns a URL to the envelope correction UI. Use after an envelope has been sent.\",\n \"tags\": [\n \"EnvelopeViews\"\n ]\n },\n \"views_post_envelope_edit_view\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"This API method has been replaced by the [EnvelopeViews:createSender](/docs/esign-rest-api/reference/envelopes/envelopeviews/createsender/) API method. The two API methods work exactly the same,\\n\\n**Migration required**\\n\\nTo solve an application security issue, you must migrate to the new API request format. See the [EnvelopeViews:createSender](/docs/esign-rest-api/reference/envelopes/envelopeviews/createsender/) API method for more information. Backwards compatibility will be provided for a limited time.\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"views_post_envelope_edit_view\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The envelope's GUID. \\n\\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\\n\",\n \"in\": \"path\",\n \"name\": \"envelopeId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/envelopes/{envelopeId}/views/edit\",\n \"request_body\": {\n \"$ref\": \"#/definitions/envelopeViewRequest\"\n },\n \"security\": null,\n \"skill_name\": \"views_post_envelope_edit_view\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Returns a URL to the edit view UI. Use before an envelope has been sent.\",\n \"tags\": [\n \"EnvelopeViews\"\n ]\n },\n \"views_post_envelope_recipient_preview\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Returns a URL to preview the recipients' view of a draft envelope or template. You can embed this view in your application to enable the sender to preview the recipients' experience.\\n\\nYou must specify a `returnUrl` value in the request body.\\n\\nFor more information, see [Preview and Send](https://support.docusign.com/s/document-item?bundleId=ulp1643236876813&topicId=oeg1578456408976.html).\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"views_post_envelope_recipient_preview\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The envelope's GUID. \\n\\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\\n\",\n \"in\": \"path\",\n \"name\": \"envelopeId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/envelopes/{envelopeId}/views/recipient_preview\",\n \"request_body\": {\n \"$ref\": \"#/definitions/recipientPreviewRequest\"\n },\n \"security\": null,\n \"skill_name\": \"views_post_envelope_recipient_preview\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Creates an envelope recipient preview.\",\n \"tags\": [\n \"EnvelopeRecipients\"\n ]\n },\n \"views_post_envelope_recipient_shared_view\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Returns a URL that enables you to embed the Docusign UI recipient view of a [shared envelope](https://support.docusign.com/s/document-item?bundleId=pik1583277475390&topicId=uzg1583277438725.html) in your applications. This is the view that a user sees of an envelope that a recipient on the same account has shared with them.\\n\\nDue to screen space issues,\\ndo not use an `<iframe>` for embedded operations on mobile devices.\\nFor iOS devices, Docusign recommends using a WebView.\\n\\n### Related topics\\n\\n- [Embedded signing and sending](/docs/esign-rest-api/esign101/concepts/embedding/)\\n- [How to send an envelope via your app](/docs/esign-rest-api/how-to/embedded-sending/)\\n- [How to embed the Docusign UI in your app](/docs/esign-rest-api/how-to/embed-ui/)\\n\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"views_post_envelope_recipient_shared_view\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The envelope's GUID. \\n\\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\\n\",\n \"in\": \"path\",\n \"name\": \"envelopeId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/envelopes/{envelopeId}/views/shared\",\n \"request_body\": {\n \"$ref\": \"#/definitions/recipientViewRequest\"\n },\n \"security\": null,\n \"skill_name\": \"views_post_envelope_recipient_shared_view\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Returns a URL to the shared recipient view UI for an envelope.\",\n \"tags\": [\n \"EnvelopeViews\"\n ]\n },\n \"views_post_envelope_recipient_view\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Returns a URL that enables you to\\n[embed the recipient view](/docs/esign-rest-api/esign101/concepts/embedding/)\\nof the\\nDocuSign UI in your applications. If the recipient is a signer,\\nthen the view will provide the signing ceremony.\\n\\nThis method is only used with envelopes in the `sent` status.\\n\\n<ds-inlinemessage kind=\\\"information\\\" markdown=\\\"1\\\">\\nDue to screen space issues,\\ndo not use an <code>&lt;iframe&gt;</code> for embedded operations on mobile devices.\\nFor iOS devices, Docusign recommends using a WebView.\\n</ds-inlinemessage>\\n\\n\\n### The returned URL\\n\\nThe URL returned in this method's response is intended to be used\\nimmediately to redirect the signer to the recipient view.\\nYou can open the recipient view\\nin the current browser or in a new tab.\\nAfter the signer is redirected to the\\nrecipient view, they must interact with the Docusign system\\nperiodically or their session will time out.\\n\\n<ds-inlinemessage kind=\\\"warning\\\" markdown=\\\"1\\\">\\nThe returned URL can be used only once and\\nexpires after 5 minutes.\\nDo not store or email the returned URL.\\n</ds-inlinemessage>\\n\\nIf you want to invite someone to an embedded signing session via\\nemail, the email invitation's URL must be to your application.\\nWhen invoked, your app should request a `recipientView` URL from\\nDocusign and then redirect the signer to that URL.\\n\\n### How to specify the default language\\n\\nYou can append the `locale`\\nquery parameter\\nto the URL returned by this method\\nto specify a language.\\n\\nThe language for the recipient view\\nfollows this order or precedence:\\n\\n- The language specified by the sender for the recipient.\\n- The `locale` parameter appended to the URL.\\n- The account language if the signer has a Docusign account.\\n- The language used in a previous signing if the signer is return signer.\\n- The browser language.\\n\\nFor example, to set the default language\\nto Canadian French, you would add this query parameter\\nto the returned URL:\\n\\n```\\n...&locale=fr_CA\\n```\\n\\n\\n## Authentication\\n\\nYour application is responsible for authenticating the identity\\nof the recipient or signer when you use this method. Use the\\nfollowing parameters to record how the recipient\\nwas authenticated.\\n\\n- `assertionId`\\n- `authenticationInstant`\\n- `authenticationMethod`\\n- `clientUserId`\\n- `securityDomain`\\n\\nAt a minimum, `authenticationMethod` and `clientUserId` are\\nrequired. The information that you provide is included in the\\nenvelope's certificate of completion.\\n\\n## Sending to a remote signer\\n\\nYou can request a signing session for a remote recipient\\nwho has a Docusign account.\\n\\nAuthenticate the request using the recipient's\\ncredentials, and do not specify a `clientUserId`.\\nThis differs from the typical behavior where the\\nrequest is authenticated using the sender's credentials,\\nand the recipient has a `clientUserId` defined.\\n\\n\\n\\n## Redirecting back to returnUrl\\nAfter the signer completes or ends the signing ceremony, Docusign\\nredirects the user's browser back to your app via the\\n`returnUrl` that you supplied in the request.\\n\\nThe signer may be redirected through various Docusign\\nsubdomains, depending on the region of the account sending the\\nenvelope. Please consult [Allowlists for Docusign eSignature service](https://www.docusign.com/trust/security/esignature#allowlists-for-docusign-esignature-service)\\nin **Security for Docusign eSignature**\\nwhen setting up your allowlists\\n\\n\\n### The event status parameter\\n\\nDocusign appends an `event` query parameter to the `returnUrl` with the\\noutcome of the signing ceremony. Your app can use this event\\nparameter to determine the next step for the envelope.\\nDo not fetch the envelope status by using\\n[Envelopes: get](/docs/esign-rest-api/reference/envelopes/envelopes/get/)\\nor a similar method because doing so\\nwill probably hit [request and polling limits](/docs/esign-rest-api/esign101/rules-and-limits/).\\n\\n\\n| event query parameter | Meaning |\\n| :------------------- | :--------------------------------------------------------------------------------------- |\\n| signing_complete | The recipient has signed the document. |\\n| cancel | The recipient decided to finish later. |\\n| decline | The recipient declined to sign the document. |\\n| exception | An exception has occurred on the server during the signing session. |\\n| fax_pending | Recipient has a fax pending. |\\n| session_timeout | The recipient did not sign the document in time. The timeout is set to 20 minutes. |\\n| ttl_expired | The token was not used within the timeout period or the token has already been accessed. |\\n| viewing_complete | The recipient did not need to sign but has completed the viewing ceremony. |\\n\\n\\n\\n<ds-inlinemessage kind=\\\"information\\\" markdown=\\\"1\\\">\\nBecause a user can cancel redirection, close their\\nbrowser after signing, or spoof the landing URL,\\nyou should not rely on the <code>returnUrl</code>\\nalone as the single source of truth for envelope\\nstatus for your integration.\\n</ds-inlinemessage>\\n\\n### Maintaining State\\nAfter the recipient completes the recipient view (or signing\\nceremony), they are redirected to your application. Your\\napplication can recover state information about the transaction\\nby storing information in a cookie, or by including query\\nparameters in the `returnUrl` field. For example.\\n`https://myapp.example.com/docusign_return?myState=12345` When the\\nuser is redirected to your app, the `event` query parameter will\\nbe appended. In this example, prevent spoofing by not using a\\nguessable value as the state value.\\n\\n\\n### Related topics\\n\\n- [How to request a signature through your app](/docs/esign-rest-api/how-to/request-signature-in-app-embedded/)\\n- [How to request a signature using a composite template](/docs/esign-rest-api/how-to/request-signature-composite-template-embedded/)\\n- [How to send an envelope via your app](/docs/esign-rest-api/how-to/embedded-sending/)\\n- [How to set envelope tab values](/docs/esign-rest-api/how-to/set-envelope-tab-values/)\\n- [How to set tab values in a template](/docs/esign-rest-api/how-to/set-template-tab-values/)\\n- [How to request a signature using focused view](/docs/esign-rest-api/how-to/request-signature-focused-view/)\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"views_post_envelope_recipient_view\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The ID of the draft envelope or template to preview.\",\n \"in\": \"path\",\n \"name\": \"envelopeId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/envelopes/{envelopeId}/views/recipient\",\n \"request_body\": {\n \"$ref\": \"#/definitions/recipientViewRequest\"\n },\n \"security\": null,\n \"skill_name\": \"views_post_envelope_recipient_view\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Returns a URL to the recipient view UI. For signer recipients, returns the embedded signing view. Can also be used for other recipient types.\",\n \"tags\": [\n \"EnvelopeViews\"\n ]\n },\n \"views_post_envelope_sender_view\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Returns a URL that enables you to embed the envelope sender view of the Docusign UI. You can customize the appearance of the view via the settings request attribute. You can embed the view in an iframe. \\n\\n**API request update**\\n\\nThe request object for this API method was updated in June 2024. The new API request format is described below. Existing applications must update to the new version; it solves a security issue with the old version. The deprecation schedule has been announced in the [Docusign Core Release Notes](https://support.docusign.com/s/document-item?language=en_US&bundleId=adp1720620778794_24-2-02-00-demo&topicId=wcz1616195757589.html&_LANG=enus). While backwards compatibility will be provided for a while for existing applications, all applications must be updated to be secure. See below for migration information. \\n\\n**Best practices**\\n\\nThe returned URL expires after 10 minutes. Therefore, request the URL immediately before you redirect your user to it.\\n\\nDue to screen space issues, do not use an iframe for embedded operations on mobile devices. For mobile applications, use a [WebView](https://developer.android.com/reference/android/webkit/WebView) (Android) or [WKWebView](https://developer.apple.com/documentation/webkit/wkwebview) (iOS).\\n\\n## Customizing the user experience\\n\\nBy default, the view includes two pages: the **Prepare** and **Tagger** pages. The settings object is used to control the user experience. For example, to limit the user to the **Tagger** page, and not allow the user to change the recipient information:\\n\\n* `\\\"startingScreen\\\": \\\"Tagger\\\"`\\n* `\\\"showBackButton\\\": \\\"false\\\"`\\n* `\\\"showEditRecipients\\\": \\\"false\\\"`\\n\\n\\nUse the [Embedded Views Test Too](https://docusign.github.io/app-examples/embedded-views-v2/) to try the different UX controls. Some UI settings attributes are not yet implemented.\\n\\n### The envelope must be in the correct state for the Embedded View\\n\\nTo use the Sender View, the envelope **must** be in the `created` state. Otherwise, a 400 error will be returned with an error message in the response body:\\n```\\n{\\n \\\"errorCode\\\": \\\"ENVELOPE_INVALID_STATUS\\\",\\n \\\"message\\\": \\\"Invalid envelope status. Sender view cannot be created for an envelope that is not in a draft state.\\\"\\n}\\n```\\n\\n### Closing the view's iframe\\n\\nIf you choose to embed the view in your application via an iframe, Docusign recommends this software pattern to close the iframe after the view has completed:\\n\\n* (One time) create a standalone \\u201creturn\\u201d page that you will use as the `returnUrl` target for the view. The view will redirect the iframe to this URL when it has completed. Here's an [example return page](https://github.com/docusign/docusign.github.io/blob/master/jsfiddleDsResponse.html). In this page, use JavaScript and the [postMessage](https://developer.mozilla.org/en-US/docs/Web/API/Window/postMessage) method to send a message to your application with the results of the view.\\n* In your application, use `window.addEventListener(\\\"message\\\", function_name)` to register a listener for incoming messages.\\n* To show the view, use this API method, then set the iframe to load the URL from the API response.\\n* In your application, receive the completion message, validate it, and then close the iframe.\\n\\n### Information security\\n\\nThis view only has write access to the specific envelope referenced in the API call. It also has read access to templates and other secondary information that a user can access to modify the envelope. The read access corresponds to the access rights of the user associated with the access token used for the API call.\\n\\n>**Recommendations:**\\n>* Use the access token of a service user who can access the templates appropriate for your use case. \\n>* Do not use the access token of a user with administrator privileges.\\n\\n## Migrating to the current version of the request object\\n\\nThis section only applies to existing applications that use the older version of the request object.\\n\\nMigrating from the old API request object to the new version will take under a day of developer time.\\n\\n**Step 1.** Does your application set the `returnUrl` attribute?\\n\\nYes: continue with step 2.\\n\\nNo: In this case, your users first update the envelope, and then the Docusign eSignature home screen is shown. To accomplish this UI pattern with the new API request format:\\n* Set the `returnUrl` to a new endpoint for your application. You can use query parameters or session data to manage state. Remember to authenticate the incoming requests. \\n* When the new endpoint is called, use the [EnvelopeViews:createConsole](/docs/esign-rest-api/reference/envelopes/envelopeviews/createconsole/) API call to obtain and then display the Docusign eSignature home page to your application's user.\\n\\n**Step 2.** Does your application modify the default UI of the view?\\n\\nNo: continue with step 3.\\n\\nYes: With the new API request object, UI controls for the view are now set when you make the API call via the `settings` attribute. \\n\\n* Note the UI settings your application is currently modifying by adding and updating query parameters on the URL _returned_ by the API method.\\n\\n* Using the reference documentation below, create a settings object that accomplishes your UI goals. You can use the [Embedded Views Test tool](https://docusign.github.io/app-examples/embedded-views-v2/) to check your UI settings. Note that the `settings` object includes multiple objects and subobjects for various UI settings.\\n\\n* **Delete the code** in your application that modifies and adds query parameters to the URL returned by the API. With the new API format, your application will not make any changes to the returned URL. Exception: If you set the view's locale specifically, that is still accomplished by appending the `locale` query parameter.\\n\\n**Step 3.** Is the envelope always in the right state before you call the Embedded View?\\n\\nIf your software may try to create the Embedded View when the envelope is not in the right state (see above), then you must add additional checks and logic to prevent this.\\n\\n**Step 4.** Check that these API attributes are set:\\n* `\\\"view\\\" = \\\"envelope\\\"`\\n* The `returnUrl` is set\\n\\n**Step 5.** All done! Test your application.\\n\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"views_post_envelope_sender_view\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The envelope's GUID. \\n\\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\\n\",\n \"in\": \"path\",\n \"name\": \"envelopeId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/envelopes/{envelopeId}/views/sender\",\n \"request_body\": {\n \"$ref\": \"#/definitions/envelopeViewRequest\"\n },\n \"security\": null,\n \"skill_name\": \"views_post_envelope_sender_view\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Returns a URL to the sender view UI. Used before an envelope has been sent.\",\n \"tags\": [\n \"EnvelopeViews\"\n ]\n },\n \"views_post_recipient_manual_review_view\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"This method returns the URL of the page that allows a sender to [manually review](https://support.docusign.com/s/document-item?bundleId=ced1643229641057&topicId=lyp1578456530647.html) the ID of a recipient. \",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"views_post_recipient_manual_review_view\",\n \"parameters\": [\n {\n \"description\": \"A value that identifies your account. This value is automatically generated by Docusign for any account you create. Copy the value from the API Account ID field in the [AppsI and Keys](https://support.docusign.com/s/document-item?bundleId=pik1583277475390&topicId=pmp1583277397015.html) page.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The envelope's GUID. \\n\\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\\n\",\n \"in\": \"path\",\n \"name\": \"envelopeId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"A GUID value that Docusign assigns to identify each recipient in an envelope. This value is globally unique for all recipients, not just those in your account.\\n\\nThe specified recipient must belong to a workflow that allows the [manual review](https://support.docusign.com/s/document-item?bundleId=pik1583277475390&topicId=eya1583277454804.html) of IDs. In addition, the status of the automatic verification for this recipient must return `Failed` and the value of the `vendorFailureStatusCode` field must be `MANUAL_REVIEW_STARTED` as shown in the following extract of a response to the [GET ENVELOPE](/docs/esign-rest-api/reference/envelopes/envelopes/get/) method:\\n<p>\\n\\n```\\n\\\"recipientAuthenticationStatus\\\": {\\n \\\"identityVerificationResult\\\": { \\n \\\"status\\\": \\\"Failed\\\",\\n \\\"eventTimestamp\\\": \\\"2020-09-04T16:59:42.8045667Z\\\",\\n \\\"vendorFailureStatusCode\\\": \\\"MANUAL_REVIEW_STARTED\\\"\\n }\\n }\\n```\",\n \"in\": \"path\",\n \"name\": \"recipientId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/views/identity_manual_review\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"views_post_recipient_manual_review_view\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Create the link to the page for manually reviewing IDs.\",\n \"tags\": [\n \"EnvelopeRecipients\"\n ]\n },\n \"views_post_template_edit_view\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Returns a URL that enables you to embed the Template Edit view of Docusign eSignature. You can embed the view in an iframe.\\n\\n**API request update**\\n\\nThe API request object for this API method was updated in June 2024. The new API request format is described below. Existing applications must update to the new version: it solves a security issue with the old version. The deprecation schedule was announced in the [Docusign Core Release Notes](https://support.docusign.com/s/document-item?language=en_US&bundleId=adp1720620778794_24-2-02-00-demo&topicId=wcz1616195757589.html&_LANG=enus). While backwards compatibility will be provided for a while for existing applications, all applications must be updated to be secure. See below for migration information. \\n\\n**Best practices**\\n\\nThe returned URL expires after 10 minutes. Therefore, request the URL immediately before you redirect your user to it.\\n\\nDue to screen space issues, do not use an iframe for embedded operations on mobile devices. For mobile applications, use a [WebView](https://developer.android.com/reference/android/webkit/WebView) (Android) or [WKWebView](https://developer.apple.com/documentation/webkit/wkwebview) (iOS).\\n\\n### Closing the view's iframe\\n\\nIf you choose to embed the view in your application via an iframe, Docusign recommends this software pattern to close the iframe after the view has completed:\\n\\n* (One time) create a standalone \\u201creturn\\u201d web page that you will use as the `returnUrl` target for the view. The view will redirect the iframe to this URL when it has completed. Here's an [example return page](https://github.com/docusign/docusign.github.io/blob/master/jsfiddleDsResponse.html). In this page, use JavaScript and the [postMessage](https://developer.mozilla.org/en-US/docs/Web/API/Window/postMessage) method to send a message to your application with the results of the view.\\n* In your application, use `window.addEventListener(\\\"message\\\", function_name)` to register a listener for incoming messages.\\n* To show the view, use this API method, then set the iframe to load the URL from the API response.\\n* In your application, receive the completion message, validate it, and then close the iframe.\\n\\n### Information security\\n\\nThis view only has write access to the specific template referenced in the API call. The edit access corresponds to the access rights of the user associated with the access token used for the API call.\\n\\n**Recommendations:**\\n* Use the access token of a service user who can access the template.\\n* Do not use the access token of a user with administrator privileges.\\n\\n### Migrating to the current version of the request object\\n\\nThis section only applies to existing applications that use the older version of the request object.\\n\\nMigrating from the old API request object to the new version will take under a day of developer time.\\n\\n**Step 1.** Does your application set the returnUrl attribute? \\n\\nYes: continue with step 2.\\n\\nNo: In this case, your users first edit the template, and then the Docusign eSignature home screen is shown. To accomplish this UI pattern with the new API request format:\\n\\n* Set the returnUrl to a new endpoint for your application. You can use query parameters or session data to manage state. Remember to authenticate the incoming requests. \\n* When the endpoint is called, use the EnvelopeViews:createConsole API call to obtain and then display the Docusign eSignature home page to your application's user.\\n\\n**Step 2.** Check that these API attributes are set:\\n* `\\\"view\\\" = \\\"template\\\" `\\n* the `returnUrl` is set.\\n\\n**Step 3.** All done! Test your application.\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"views_post_template_edit_view\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The ID of the template.\",\n \"in\": \"path\",\n \"name\": \"templateId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/templates/{templateId}/views/edit\",\n \"request_body\": {\n \"$ref\": \"#/definitions/templateViewRequest\"\n },\n \"security\": null,\n \"skill_name\": \"views_post_template_edit_view\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Gets a URL for a template edit view.\",\n \"tags\": [\n \"TemplateViews\"\n ]\n },\n \"views_post_template_recipient_preview\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"This method returns a URL for a template recipient preview in the Docusign UI that you can embed in your application. You use this method to enable the sender to preview the recipients' experience.\\n\\nFor more information, see [Preview and Send](https://support.docusign.com/s/document-item?bundleId=ulp1643236876813&topicId=oeg1578456408976.html).\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"views_post_template_recipient_preview\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The ID of the template.\",\n \"in\": \"path\",\n \"name\": \"templateId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/templates/{templateId}/views/recipient_preview\",\n \"request_body\": {\n \"$ref\": \"#/definitions/recipientPreviewRequest\"\n },\n \"security\": null,\n \"skill_name\": \"views_post_template_recipient_preview\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Creates a template recipient preview.\",\n \"tags\": [\n \"TemplateRecipients\"\n ]\n },\n \"watermark_get_watermark\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Enables you to preview a watermark specified by the request.\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"watermark_get_watermark\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/watermark\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"watermark_get_watermark\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Get watermark information.\",\n \"tags\": [\n \"AccountWatermarks\"\n ]\n },\n \"watermark_preview_put_watermark_preview\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Update the watermark for the account.\\n\\n**Note:** Many of the request fields must be set to specific values. If you use an invalid value for one of these fields, the endpoint may return 200 OK but set the field to a default value. See the request body for more information.\",\n \"destructive\": true,\n \"method\": \"PUT\",\n \"operation_id\": \"watermark_preview_put_watermark_preview\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/watermark/preview\",\n \"request_body\": {\n \"$ref\": \"#/definitions/watermark\"\n },\n \"security\": null,\n \"skill_name\": \"watermark_preview_put_watermark_preview\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Get watermark preview.\",\n \"tags\": [\n \"AccountWatermarks\"\n ]\n },\n \"watermark_put_watermark\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Returns information about the watermark for the account.\",\n \"destructive\": true,\n \"method\": \"PUT\",\n \"operation_id\": \"watermark_put_watermark\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/watermark\",\n \"request_body\": {\n \"$ref\": \"#/definitions/watermark\"\n },\n \"security\": null,\n \"skill_name\": \"watermark_put_watermark\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Update watermark information.\",\n \"tags\": [\n \"AccountWatermarks\"\n ]\n },\n \"workspace_delete_workspace\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Deletes an existing workspace (logically).\",\n \"destructive\": true,\n \"method\": \"DELETE\",\n \"operation_id\": \"workspace_delete_workspace\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The ID of the workspace.\",\n \"in\": \"path\",\n \"name\": \"workspaceId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/workspaces/{workspaceId}\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"workspace_delete_workspace\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Delete Workspace\",\n \"tags\": [\n \"Workspaces\"\n ]\n },\n \"workspace_file_get_workspace_file\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"This method returns a binary version of a file in a workspace.\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"workspace_file_get_workspace_file\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The ID of the file.\",\n \"in\": \"path\",\n \"name\": \"fileId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The ID of the folder.\",\n \"in\": \"path\",\n \"name\": \"folderId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The ID of the workspace.\",\n \"in\": \"path\",\n \"name\": \"workspaceId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"When **true,** the `Content-Disposition` header is set in the response. The value of the header provides the filename of the file. The default is **false.**\",\n \"in\": \"query\",\n \"name\": \"is_download\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"When **true** the file is returned in PDF format.\",\n \"in\": \"query\",\n \"name\": \"pdf_version\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/workspaces/{workspaceId}/folders/{folderId}/files/{fileId}\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"workspace_file_get_workspace_file\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Gets a workspace file\",\n \"tags\": [\n \"WorkspaceItems\"\n ]\n },\n \"workspace_file_pages_get_workspace_file_pages\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"This method returns a workspace file as rasterized pages.\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"workspace_file_pages_get_workspace_file_pages\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The ID of the file.\",\n \"in\": \"path\",\n \"name\": \"fileId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The ID of the folder.\",\n \"in\": \"path\",\n \"name\": \"folderId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The ID of the workspace.\",\n \"in\": \"path\",\n \"name\": \"workspaceId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The maximum number of results to return.\\n\\nUse `start_position` to specify the number of results to skip.\\n\",\n \"in\": \"query\",\n \"name\": \"count\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The number of dots per inch (DPI) for the resulting images. Valid values are 1-310 DPI. The default value is 94.\",\n \"in\": \"query\",\n \"name\": \"dpi\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Sets the maximum height of the returned images in pixels.\",\n \"in\": \"query\",\n \"name\": \"max_height\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"Sets the maximum width of the returned images in pixels.\",\n \"in\": \"query\",\n \"name\": \"max_width\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The zero-based index of the\\nresult from which to start returning results.\\n\\nUse with `count` to limit the number\\nof results.\\n\\nThe default value is `0`.\\n\",\n \"in\": \"query\",\n \"name\": \"start_position\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/workspaces/{workspaceId}/folders/{folderId}/files/{fileId}/pages\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"workspace_file_pages_get_workspace_file_pages\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"List File Pages\",\n \"tags\": [\n \"WorkspaceItems\"\n ]\n },\n \"workspace_file_post_workspace_files\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"This method adds a file to a workspace.\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"workspace_file_post_workspace_files\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The ID of the folder.\",\n \"in\": \"path\",\n \"name\": \"folderId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The ID of the workspace.\",\n \"in\": \"path\",\n \"name\": \"workspaceId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/workspaces/{workspaceId}/folders/{folderId}/files\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"workspace_file_post_workspace_files\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Creates a workspace file.\",\n \"tags\": [\n \"WorkspaceItems\"\n ]\n },\n \"workspace_file_put_workspace_file\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"This method updates the metadata for one or more specific files or folders in a workspace.\",\n \"destructive\": true,\n \"method\": \"PUT\",\n \"operation_id\": \"workspace_file_put_workspace_file\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The ID of the file.\",\n \"in\": \"path\",\n \"name\": \"fileId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The ID of the folder.\",\n \"in\": \"path\",\n \"name\": \"folderId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The ID of the workspace.\",\n \"in\": \"path\",\n \"name\": \"workspaceId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/workspaces/{workspaceId}/folders/{folderId}/files/{fileId}\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"workspace_file_put_workspace_file\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Update workspace file or folder metadata\",\n \"tags\": [\n \"WorkspaceItems\"\n ]\n },\n \"workspace_folder_delete_workspace_items\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"This method deletes one or more files or sub-folders from a workspace folder or root.\\n\\nNote: To delete items from a workspace, the `status` of the workspace must be `active`.\",\n \"destructive\": true,\n \"method\": \"DELETE\",\n \"operation_id\": \"workspace_folder_delete_workspace_items\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The ID of the folder.\",\n \"in\": \"path\",\n \"name\": \"folderId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The ID of the workspace.\",\n \"in\": \"path\",\n \"name\": \"workspaceId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/workspaces/{workspaceId}/folders/{folderId}\",\n \"request_body\": {\n \"$ref\": \"#/definitions/workspaceItemList\"\n },\n \"security\": null,\n \"skill_name\": \"workspace_folder_delete_workspace_items\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Deletes files or sub-folders from a workspace.\",\n \"tags\": [\n \"WorkspaceItems\"\n ]\n },\n \"workspace_folder_get_workspace_folder\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"This method returns the contents of a workspace folder, which can include sub-folders and files.\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"workspace_folder_get_workspace_folder\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The ID of the folder.\",\n \"in\": \"path\",\n \"name\": \"folderId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The ID of the workspace.\",\n \"in\": \"path\",\n \"name\": \"workspaceId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The maximum number of results to return.\\n\\nUse `start_position` to specify the number of results to skip.\\n\",\n \"in\": \"query\",\n \"name\": \"count\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"When **true,** the response includes file information (in addition to folder information). The default is **false.**\",\n \"in\": \"query\",\n \"name\": \"include_files\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"When **true,** the response includes information about the sub-folders of the current folder. The default is **false.**\",\n \"in\": \"query\",\n \"name\": \"include_sub_folders\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"When **true,** the response returns thumbnails. The default is **false.**\",\n \"in\": \"query\",\n \"name\": \"include_thumbnails\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"When **true,** the response includes extended details about the user. The default is **false.**\",\n \"in\": \"query\",\n \"name\": \"include_user_detail\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The zero-based index of the\\nresult from which to start returning results.\\n\\nUse with `count` to limit the number\\nof results.\\n\\nThe default value is `0`.\\n\",\n \"in\": \"query\",\n \"name\": \"start_position\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"If set, the response only includes results associated with the `userId` that you specify.\",\n \"in\": \"query\",\n \"name\": \"workspace_user_id\",\n \"required\": false,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/workspaces/{workspaceId}/folders/{folderId}\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"workspace_folder_get_workspace_folder\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"List workspace folder contents\",\n \"tags\": [\n \"WorkspaceItems\"\n ]\n },\n \"workspace_get_workspace\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Retrieves properties about a workspace given a unique workspaceId. \",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"workspace_get_workspace\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The ID of the workspace.\",\n \"in\": \"path\",\n \"name\": \"workspaceId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/workspaces/{workspaceId}\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"workspace_get_workspace\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Get Workspace\",\n \"tags\": [\n \"Workspaces\"\n ]\n },\n \"workspace_get_workspaces\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Gets information about the Workspaces that have been created.\",\n \"destructive\": false,\n \"method\": \"GET\",\n \"operation_id\": \"workspace_get_workspaces\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/workspaces\",\n \"request_body\": null,\n \"security\": null,\n \"skill_name\": \"workspace_get_workspaces\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"List Workspaces\",\n \"tags\": [\n \"Workspaces\"\n ]\n },\n \"workspace_post_workspace\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"This method creates a new workspace.\",\n \"destructive\": true,\n \"method\": \"POST\",\n \"operation_id\": \"workspace_post_workspace\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/workspaces\",\n \"request_body\": {\n \"$ref\": \"#/definitions/workspace\"\n },\n \"security\": null,\n \"skill_name\": \"workspace_post_workspace\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Create a Workspace\",\n \"tags\": [\n \"Workspaces\"\n ]\n },\n \"workspace_put_workspace\": {\n \"base_url\": \"https://www.docusign.net/restapi\",\n \"base_url_field\": \"OPENAPI_BASE_URL\",\n \"description\": \"Updates information about a specific workspace.\",\n \"destructive\": true,\n \"method\": \"PUT\",\n \"operation_id\": \"workspace_put_workspace\",\n \"parameters\": [\n {\n \"description\": \"The external account number (int) or account ID GUID.\",\n \"in\": \"path\",\n \"name\": \"accountId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n },\n {\n \"description\": \"The ID of the workspace.\",\n \"in\": \"path\",\n \"name\": \"workspaceId\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"path\": \"/v2.1/accounts/{accountId}/workspaces/{workspaceId}\",\n \"request_body\": {\n \"$ref\": \"#/definitions/workspace\"\n },\n \"security\": null,\n \"skill_name\": \"workspace_put_workspace\",\n \"source_index\": 1,\n \"source_openapi_url\": \"https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json\",\n \"source_title\": \"Docusign eSignature REST API\",\n \"summary\": \"Update Workspace\",\n \"tags\": [\n \"Workspaces\"\n ]\n }\n}")
OPERATION_GROUPS = json.loads("[\n {\n \"common_prefix\": \"/service_information\",\n \"description\": \"Handle 1 OpenAPI operation(s) under /service_information for the service information route group.\",\n \"id\": \"service_information\",\n \"label\": \"service information\",\n \"operation_ids\": [\n \"service_information_get_service_information\"\n ],\n \"skill_dir\": \"service-information\",\n \"skill_name\": \"service-information-routes\",\n \"skill_path\": \"skills/service-information/SKILL.md\",\n \"subagent_name\": \"service-information-api\"\n },\n {\n \"common_prefix\": \"/v2.1\",\n \"description\": \"Handle 1 OpenAPI operation(s) under /v2.1 for the Resources route group.\",\n \"id\": \"resources\",\n \"label\": \"Resources\",\n \"operation_ids\": [\n \"service_information_get_resource_information\"\n ],\n \"skill_dir\": \"resources\",\n \"skill_name\": \"resources-routes\",\n \"skill_path\": \"skills/resources/SKILL.md\",\n \"subagent_name\": \"resources-api\"\n },\n {\n \"common_prefix\": \"/v2.1/accounts\",\n \"description\": \"Handle 80 OpenAPI operation(s) under /v2.1/accounts for the accounts 1 route group.\",\n \"id\": \"accounts_1\",\n \"label\": \"accounts 1\",\n \"operation_ids\": [\n \"accounts_post_accounts\",\n \"accounts_get_account\",\n \"accounts_delete_account\",\n \"billing_charges_get_account_billing_charges\",\n \"billing_invoices_get_billing_invoices\",\n \"billing_invoices_get_billing_invoice\",\n \"billing_invoices_get_billing_invoices_past_due\",\n \"billing_payments_get_payment_list\",\n \"billing_payments_post_payment\",\n \"billing_payments_get_payment\",\n \"billing_plan_get_billing_plan\",\n \"billing_plan_put_billing_plan\",\n \"billing_plan_get_credit_card_info\",\n \"billing_plan_get_downgrade_request_billing_info\",\n \"billing_plan_put_downgrade_account_billing_plan\",\n \"purchased_envelopes_put_purchased_envelopes\",\n \"brands_get_brands\",\n \"brands_post_brands\",\n \"brands_delete_brands\",\n \"brand_get_brand\",\n \"brand_put_brand\",\n \"brand_delete_brand\",\n \"brand_export_get_brand_export_file\",\n \"brand_logo_get_brand_logo\",\n \"brand_logo_put_brand_logo\",\n \"brand_logo_delete_brand_logo\",\n \"brand_resources_get_brand_resources_list\",\n \"brand_resources_get_brand_resources\",\n \"brand_resources_put_brand_resources\",\n \"bulk_send_v2_batch_get_bulk_send_batches\",\n \"bulk_send_v2_batch_get_bulk_send_batch_status\",\n \"bulk_send_v2_batch_put_bulk_send_batch_status\",\n \"bulk_send_v2_batch_put_bulk_send_batch_action\",\n \"bulk_send_v2_envelopes_get_bulk_send_batch_envelopes\",\n \"bulk_send_v2_crud_get_bulk_send_lists\",\n \"bulk_send_v2_crud_post_bulk_send_list\",\n \"bulk_send_v2_crud_get_bulk_send_list\",\n \"bulk_send_v2_crud_put_bulk_send_list\",\n \"bulk_send_v2_crud_delete_bulk_send_list\",\n \"bulk_send_v2_send_post_bulk_send_request\",\n \"bulk_send_v2_test_post_bulk_send_test_request\",\n \"captive_recipients_delete_captive_recipients_part\",\n \"chunked_uploads_post_chunked_uploads\",\n \"chunked_uploads_get_chunked_upload\",\n \"chunked_uploads_put_chunked_uploads\",\n \"chunked_uploads_delete_chunked_upload\",\n \"chunked_uploads_put_chunked_upload_part\",\n \"connect_get_connect_configs\",\n \"connect_put_connect_configuration\",\n \"connect_post_connect_configuration\",\n \"connect_get_connect_config\",\n \"connect_delete_connect_config\",\n \"connect_get_connect_all_users\",\n \"connect_get_connect_users\",\n \"connect_publish_put_connect_retry_by_envelope\",\n \"historical_envelope_publish_post_historical_envelope_publish_transaction\",\n \"connect_publish_put_connect_retry\",\n \"connect_failures_get_connect_logs\",\n \"connect_failures_delete_connect_failure_log\",\n \"connect_log_get_connect_logs\",\n \"connect_log_delete_connect_logs\",\n \"connect_log_get_connect_log\",\n \"connect_log_delete_connect_log\",\n \"connect_o_auth_config_get_connect_o_auth_config\",\n \"connect_o_auth_config_put_connect_o_auth_config\",\n \"connect_o_auth_config_post_connect_o_auth_config\",\n \"connect_o_auth_config_delete_connect_o_auth_config\",\n \"connect_hmac_get_connect_secret\",\n \"connect_hmac_create_connect_secret\",\n \"connect_hmac_delete_connect_secret\",\n \"consumer_disclosure_get_consumer_disclosure\",\n \"consumer_disclosure_get_consumer_disclosure_lang_code\",\n \"consumer_disclosure_put_consumer_disclosure\",\n \"contacts_put_contacts\",\n \"contacts_post_contacts\",\n \"contacts_delete_contacts\",\n \"contacts_get_contact_by_id\",\n \"contacts_delete_contact_with_id\",\n \"account_custom_fields_get_account_custom_fields\",\n \"account_custom_fields_post_account_custom_fields\"\n ],\n \"skill_dir\": \"accounts-1\",\n \"skill_name\": \"accounts-1-routes\",\n \"skill_path\": \"skills/accounts-1/SKILL.md\",\n \"subagent_name\": \"accounts-1-api\"\n },\n {\n \"common_prefix\": \"/v2.1/accounts/{accountId}\",\n \"description\": \"Handle 80 OpenAPI operation(s) under /v2.1/accounts/{accountId} for the accounts 2 route group.\",\n \"id\": \"accounts_2\",\n \"label\": \"accounts 2\",\n \"operation_ids\": [\n \"account_custom_fields_put_account_custom_fields\",\n \"account_custom_fields_delete_account_custom_fields\",\n \"envelopes_get_envelopes\",\n \"envelopes_post_envelopes\",\n \"envelopes_get_envelope\",\n \"envelopes_put_envelope\",\n \"attachments_get_attachments\",\n \"attachments_put_attachments\",\n \"attachments_delete_attachments\",\n \"attachments_get_attachment\",\n \"attachments_put_attachment\",\n \"audit_events_get_audit_events\",\n \"comments_get_comments_transcript\",\n \"custom_fields_get_custom_fields\",\n \"custom_fields_put_custom_fields\",\n \"custom_fields_post_custom_fields\",\n \"custom_fields_delete_custom_fields\",\n \"doc_gen_form_fields_get_envelope_doc_gen_form_fields\",\n \"doc_gen_form_fields_put_envelope_doc_gen_form_fields\",\n \"documents_get_documents\",\n \"documents_put_documents\",\n \"documents_delete_documents\",\n \"documents_get_document\",\n \"documents_put_document\",\n \"document_fields_get_document_fields\",\n \"document_fields_put_document_fields\",\n \"document_fields_post_document_fields\",\n \"document_fields_delete_document_fields\",\n \"responsive_html_get_envelope_document_html_definitions\",\n \"pages_get_page_images\",\n \"pages_delete_page\",\n \"pages_get_page_image\",\n \"pages_put_page_image\",\n \"tabs_get_page_tabs\",\n \"responsive_html_post_document_responsive_html_preview\",\n \"tabs_get_document_tabs\",\n \"tabs_put_document_tabs\",\n \"tabs_post_document_tabs\",\n \"tabs_delete_document_tabs\",\n \"templates_get_document_templates\",\n \"templates_post_document_templates\",\n \"templates_delete_document_templates\",\n \"email_settings_get_email_settings\",\n \"email_settings_put_email_settings\",\n \"email_settings_post_email_settings\",\n \"email_settings_delete_email_settings\",\n \"form_data_get_form_data\",\n \"responsive_html_get_envelope_html_definitions\",\n \"lock_get_envelope_lock\",\n \"lock_put_envelope_lock\",\n \"lock_post_envelope_lock\",\n \"lock_delete_envelope_lock\",\n \"notification_get_envelopes_envelope_id_notification\",\n \"notification_put_envelopes_envelope_id_notification\",\n \"recipients_get_recipients\",\n \"recipients_put_recipients\",\n \"recipients_post_recipients\",\n \"recipients_delete_recipients\",\n \"recipients_delete_recipient\",\n \"consumer_disclosure_get_consumer_disclosure_envelope_id_recipient_id\",\n \"consumer_disclosure_get_consumer_disclosure_envelope_id_recipient_id_lang_code\",\n \"recipients_get_recipient_document_visibility\",\n \"recipients_put_recipient_document_visibility\",\n \"recipients_post_recipient_proof_file_resource_token\",\n \"recipients_get_recipient_initials_image\",\n \"recipients_put_recipient_initials_image\",\n \"recipients_get_recipient_signature\",\n \"recipients_get_recipient_signature_image\",\n \"recipients_put_recipient_signature_image\",\n \"recipients_get_recipient_tabs\",\n \"recipients_put_recipient_tabs\",\n \"recipients_post_recipient_tabs\",\n \"recipients_delete_recipient_tabs\",\n \"views_post_recipient_manual_review_view\",\n \"recipients_put_recipients_document_visibility\",\n \"responsive_html_post_responsive_html_preview\",\n \"envelopes_shares_get_envelopes_shares\",\n \"envelopes_shares_put_envelopes_shares\",\n \"envelopes_shares_post_envelopes_shares\",\n \"envelopes_shares_delete_envelopes_shares\"\n ],\n \"skill_dir\": \"accounts-2\",\n \"skill_name\": \"accounts-2-routes\",\n \"skill_path\": \"skills/accounts-2/SKILL.md\",\n \"subagent_name\": \"accounts-2-api\"\n },\n {\n \"common_prefix\": \"/v2.1/accounts/{accountId}\",\n \"description\": \"Handle 80 OpenAPI operation(s) under /v2.1/accounts/{accountId} for the accounts 3 route group.\",\n \"id\": \"accounts_3\",\n \"label\": \"accounts 3\",\n \"operation_ids\": [\n \"envelopes_shares_get_envelopes_share\",\n \"envelopes_shares_put_envelopes_share\",\n \"envelopes_shares_delete_envelopes_share\",\n \"tabs_blob_get_tabs_blob\",\n \"tabs_blob_put_tabs_blob\",\n \"templates_get_envelope_templates\",\n \"templates_post_envelope_templates\",\n \"views_post_envelope_correct_view\",\n \"views_delete_envelope_correct_view\",\n \"views_post_envelope_edit_view\",\n \"views_post_envelope_recipient_view\",\n \"views_post_envelope_recipient_preview\",\n \"views_post_envelope_sender_view\",\n \"views_post_envelope_recipient_shared_view\",\n \"envelope_workflow_definition_v2_get_envelope_workflow_definition\",\n \"envelope_workflow_definition_v2_put_envelope_workflow_definition\",\n \"envelope_workflow_definition_v2_delete_envelope_workflow_definition\",\n \"envelope_workflow_scheduled_sending_get_envelope_scheduled_sending_definition\",\n \"envelope_workflow_scheduled_sending_put_envelope_scheduled_sending_definition\",\n \"envelope_workflow_scheduled_sending_delete_envelope_scheduled_sending_definition\",\n \"envelope_workflow_step_post_envelope_workflow_step_definition\",\n \"envelope_workflow_step_get_envelope_workflow_step_definition\",\n \"envelope_workflow_step_put_envelope_workflow_step_definition\",\n \"envelope_workflow_step_delete_envelope_workflow_step_definition\",\n \"envelope_workflow_delayed_routing_get_envelope_delayed_routing_definition\",\n \"envelope_workflow_delayed_routing_put_envelope_delayed_routing_definition\",\n \"envelope_workflow_delayed_routing_delete_envelope_delayed_routing_definition\",\n \"shared_envelopes_list_get_shared_envelopes\",\n \"envelopes_put_status\",\n \"envelope_transfer_rules_get_envelope_transfer_rules\",\n \"envelope_transfer_rules_put_envelope_transfer_rules\",\n \"envelope_transfer_rules_post_envelope_transfer_rules\",\n \"envelope_transfer_rules_put_envelope_transfer_rule\",\n \"envelope_transfer_rules_delete_envelope_transfer_rules\",\n \"favorite_templates_get_favorite_templates\",\n \"favorite_templates_put_favorite_template\",\n \"favorite_templates_un_favorite_template\",\n \"folders_get_folders\",\n \"folders_get_folder_items\",\n \"folders_put_folder_by_id\",\n \"groups_get_groups\",\n \"groups_put_groups\",\n \"groups_post_groups\",\n \"groups_delete_groups\",\n \"brands_get_group_brands\",\n \"brands_put_group_brands\",\n \"brands_delete_group_brands\",\n \"groups_get_group_users\",\n \"groups_put_group_users\",\n \"groups_delete_group_users\",\n \"account_identity_verification_get_account_identity_verification\",\n \"payment_gateway_accounts_get_all_payment_gateway_accounts\",\n \"permission_profiles_get_permission_profiles\",\n \"permission_profiles_post_permission_profiles\",\n \"permission_profiles_get_permission_profile\",\n \"permission_profiles_put_permission_profiles\",\n \"permission_profiles_delete_permission_profiles\",\n \"power_forms_get_power_forms_list\",\n \"power_forms_post_power_form\",\n \"power_forms_delete_power_forms_list\",\n \"power_forms_get_power_form\",\n \"power_forms_put_power_form\",\n \"power_forms_delete_power_form\",\n \"power_forms_get_power_form_form_data\",\n \"power_forms_get_power_forms_senders\",\n \"account_signature_providers_get_seal_providers\",\n \"search_folders_get_search_folder_contents\",\n \"settings_get_settings\",\n \"settings_put_settings\",\n \"bcc_email_archive_get_bcc_email_archive_list\",\n \"bcc_email_archive_post_bcc_email_archive\",\n \"bcc_email_archive_get_bcc_email_archive_history_list\",\n \"bcc_email_archive_delete_bcc_email_archive\",\n \"e_note_configuration_get_e_note_configuration\",\n \"e_note_configuration_put_e_note_configuration\",\n \"e_note_configuration_delete_e_note_configuration\",\n \"envelope_purge_configuration_get_envelope_purge_configuration\",\n \"envelope_purge_configuration_put_envelope_purge_configuration\",\n \"notification_defaults_get_notification_defaults\",\n \"notification_defaults_put_notification_defaults\"\n ],\n \"skill_dir\": \"accounts-3\",\n \"skill_name\": \"accounts-3-routes\",\n \"skill_path\": \"skills/accounts-3/SKILL.md\",\n \"subagent_name\": \"accounts-3-api\"\n },\n {\n \"common_prefix\": \"/v2.1/accounts/{accountId}\",\n \"description\": \"Handle 80 OpenAPI operation(s) under /v2.1/accounts/{accountId} for the accounts 4 route group.\",\n \"id\": \"accounts_4\",\n \"label\": \"accounts 4\",\n \"operation_ids\": [\n \"account_password_rules_get_account_password_rules\",\n \"account_password_rules_put_account_password_rules\",\n \"tab_settings_get_tab_settings\",\n \"tab_settings_put_settings\",\n \"shared_access_get_shared_access\",\n \"shared_access_put_shared_access\",\n \"account_signature_providers_get_signature_providers\",\n \"account_signatures_get_account_signatures\",\n \"account_signatures_put_account_signature\",\n \"account_signatures_post_account_signatures\",\n \"account_signatures_get_account_signature\",\n \"account_signatures_put_account_signature_by_id\",\n \"account_signatures_delete_account_signature\",\n \"account_signatures_get_account_signature_image\",\n \"account_signatures_put_account_signature_image\",\n \"account_signatures_delete_account_signature_image\",\n \"signing_groups_get_signing_groups\",\n \"signing_groups_put_signing_groups\",\n \"signing_groups_post_signing_groups\",\n \"signing_groups_delete_signing_groups\",\n \"signing_groups_get_signing_group\",\n \"signing_groups_put_signing_group\",\n \"signing_groups_get_signing_group_users\",\n \"signing_groups_put_signing_group_users\",\n \"signing_groups_delete_signing_group_users\",\n \"supported_languages_get_supported_languages\",\n \"tabs_get_tab_definitions\",\n \"tabs_post_tab_definitions\",\n \"tab_get_custom_tab\",\n \"tab_put_custom_tab\",\n \"tab_delete_custom_tab\",\n \"templates_get_templates\",\n \"templates_put_templates\",\n \"templates_post_templates\",\n \"templates_get_template\",\n \"templates_put_template\",\n \"templates_put_template_part\",\n \"templates_delete_template_part\",\n \"custom_fields_get_template_custom_fields\",\n \"custom_fields_put_template_custom_fields\",\n \"custom_fields_post_template_custom_fields\",\n \"custom_fields_delete_template_custom_fields\",\n \"documents_get_template_documents\",\n \"documents_put_template_documents\",\n \"documents_delete_template_documents\",\n \"documents_get_template_document\",\n \"documents_put_template_document\",\n \"document_fields_get_template_document_fields\",\n \"document_fields_put_template_document_fields\",\n \"document_fields_post_template_document_fields\",\n \"document_fields_delete_template_document_fields\",\n \"responsive_html_get_template_document_html_definitions\",\n \"pages_get_template_page_images\",\n \"pages_delete_template_page\",\n \"pages_get_template_page_image\",\n \"pages_put_template_page_image\",\n \"tabs_get_template_page_tabs\",\n \"responsive_html_post_template_document_responsive_html_preview\",\n \"tabs_get_template_document_tabs\",\n \"tabs_put_template_document_tabs\",\n \"tabs_post_template_document_tabs\",\n \"tabs_delete_template_document_tabs\",\n \"responsive_html_get_template_html_definitions\",\n \"lock_get_template_lock\",\n \"lock_put_template_lock\",\n \"lock_post_template_lock\",\n \"lock_delete_template_lock\",\n \"notification_get_templates_template_id_notification\",\n \"notification_put_templates_template_id_notification\",\n \"recipients_get_template_recipients\",\n \"recipients_put_template_recipients\",\n \"recipients_post_template_recipients\",\n \"recipients_delete_template_recipients\",\n \"recipients_delete_template_recipient\",\n \"recipients_get_template_recipient_document_visibility\",\n \"recipients_put_template_recipient_document_visibility\",\n \"recipients_get_template_recipient_tabs\",\n \"recipients_put_template_recipient_tabs\",\n \"recipients_post_template_recipient_tabs\",\n \"recipients_delete_template_recipient_tabs\"\n ],\n \"skill_dir\": \"accounts-4\",\n \"skill_name\": \"accounts-4-routes\",\n \"skill_path\": \"skills/accounts-4/SKILL.md\",\n \"subagent_name\": \"accounts-4-api\"\n },\n {\n \"common_prefix\": \"/v2.1/accounts\",\n \"description\": \"Handle 75 OpenAPI operation(s) under /v2.1/accounts for the accounts 5 route group.\",\n \"id\": \"accounts_5\",\n \"label\": \"accounts 5\",\n \"operation_ids\": [\n \"recipients_put_template_recipients_document_visibility\",\n \"responsive_html_post_template_responsive_html_preview\",\n \"views_post_template_edit_view\",\n \"views_post_template_recipient_preview\",\n \"template_workflow_definition_get_template_workflow_definition\",\n \"template_workflow_definition_put_template_workflow_definition\",\n \"template_workflow_definition_delete_template_workflow_definition\",\n \"template_workflow_scheduled_sending_get_template_scheduled_sending_definition\",\n \"template_workflow_scheduled_sending_put_template_scheduled_sending_definition\",\n \"template_workflow_scheduled_sending_delete_template_scheduled_sending_definition\",\n \"template_workflow_step_post_template_workflow_step_definition\",\n \"template_workflow_step_get_template_workflow_step_definition\",\n \"template_workflow_step_put_template_workflow_step_definition\",\n \"template_workflow_step_delete_template_workflow_step_definition\",\n \"template_workflow_delayed_routing_get_template_delayed_routing_definition\",\n \"template_workflow_delayed_routing_put_template_delayed_routing_definition\",\n \"template_workflow_delayed_routing_delete_template_delayed_routing_definition\",\n \"templates_auto_match_put_templates\",\n \"unsupported_file_types_get_unsupported_file_types\",\n \"users_get_users\",\n \"users_put_users\",\n \"users_post_users\",\n \"users_delete_users\",\n \"user_get_user\",\n \"user_put_user\",\n \"user_authorization_create_user_authorization\",\n \"user_authorization_get_user_authorization\",\n \"user_authorization_update_user_authorization\",\n \"user_authorization_delete_user_authorization\",\n \"user_authorizations_get_principal_user_authorizations\",\n \"user_authorizations_post_user_authorizations\",\n \"user_authorizations_delete_user_authorizations\",\n \"user_agent_authorizations_get_agent_user_authorizations\",\n \"cloud_storage_get_cloud_storage_providers\",\n \"cloud_storage_post_cloud_storage\",\n \"cloud_storage_delete_cloud_storage_providers\",\n \"cloud_storage_get_cloud_storage\",\n \"cloud_storage_delete_cloud_storage\",\n \"cloud_storage_folder_get_cloud_storage_folder_all\",\n \"cloud_storage_folder_get_cloud_storage_folder\",\n \"user_custom_settings_get_custom_settings\",\n \"user_custom_settings_put_custom_settings\",\n \"user_custom_settings_delete_custom_settings\",\n \"user_profile_get_profile\",\n \"user_profile_put_profile\",\n \"user_profile_image_get_user_profile_image\",\n \"user_profile_image_put_user_profile_image\",\n \"user_profile_image_delete_user_profile_image\",\n \"user_settings_get_user_settings\",\n \"user_settings_put_user_settings\",\n \"user_signatures_get_user_signatures\",\n \"user_signatures_put_user_signature\",\n \"user_signatures_post_user_signatures\",\n \"user_signatures_get_user_signature\",\n \"user_signatures_put_user_signature_by_id\",\n \"user_signatures_delete_user_signature\",\n \"user_signatures_get_user_signature_image\",\n \"user_signatures_put_user_signature_image\",\n \"user_signatures_delete_user_signature_image\",\n \"views_post_account_console_view\",\n \"watermark_get_watermark\",\n \"watermark_put_watermark\",\n \"watermark_preview_put_watermark_preview\",\n \"workspace_get_workspaces\",\n \"workspace_post_workspace\",\n \"workspace_get_workspace\",\n \"workspace_put_workspace\",\n \"workspace_delete_workspace\",\n \"workspace_folder_get_workspace_folder\",\n \"workspace_folder_delete_workspace_items\",\n \"workspace_file_post_workspace_files\",\n \"workspace_file_get_workspace_file\",\n \"workspace_file_put_workspace_file\",\n \"workspace_file_pages_get_workspace_file_pages\",\n \"accounts_get_provisioning\"\n ],\n \"skill_dir\": \"accounts-5\",\n \"skill_name\": \"accounts-5-routes\",\n \"skill_path\": \"skills/accounts-5/SKILL.md\",\n \"subagent_name\": \"accounts-5-api\"\n },\n {\n \"common_prefix\": \"/v2.1/billing_plans\",\n \"description\": \"Handle 2 OpenAPI operation(s) under /v2.1/billing_plans for the billing plans route group.\",\n \"id\": \"billing_plans\",\n \"label\": \"billing plans\",\n \"operation_ids\": [\n \"billing_plans_get_billing_plans\",\n \"billing_plans_get_billing_plan\"\n ],\n \"skill_dir\": \"billing-plans\",\n \"skill_name\": \"billing-plans-routes\",\n \"skill_path\": \"skills/billing-plans/SKILL.md\",\n \"subagent_name\": \"billing-plans-api\"\n },\n {\n \"common_prefix\": \"/v2.1/current_user\",\n \"description\": \"Handle 10 OpenAPI operation(s) under /v2.1/current_user for the current user route group.\",\n \"id\": \"current_user\",\n \"label\": \"current user\",\n \"operation_ids\": [\n \"notary_get_notary\",\n \"notary_put_notary\",\n \"notary_post_notary\",\n \"notary_journals_get_notary_journals\",\n \"notary_jurisdictions_get_notary_jurisdictions\",\n \"notary_jurisdictions_post_notary_jurisdictions\",\n \"notary_jurisdictions_get_notary_jurisdiction\",\n \"notary_jurisdictions_put_notary_jurisdiction\",\n \"notary_jurisdictions_delete_notary_jurisdiction\",\n \"password_rules_get_password_rules\"\n ],\n \"skill_dir\": \"current-user\",\n \"skill_name\": \"current-user-routes\",\n \"skill_path\": \"skills/current-user/SKILL.md\",\n \"subagent_name\": \"current-user-api\"\n },\n {\n \"common_prefix\": \"/v2.1/diagnostics\",\n \"description\": \"Handle 5 OpenAPI operation(s) under /v2.1/diagnostics for the diagnostics route group.\",\n \"id\": \"diagnostics\",\n \"label\": \"diagnostics\",\n \"operation_ids\": [\n \"api_request_log_get_request_logs\",\n \"api_request_log_delete_request_logs\",\n \"api_request_log_get_request_log\",\n \"api_request_log_get_request_log_settings\",\n \"api_request_log_put_request_log_settings\"\n ],\n \"skill_dir\": \"diagnostics\",\n \"skill_name\": \"diagnostics-routes\",\n \"skill_path\": \"skills/diagnostics/SKILL.md\",\n \"subagent_name\": \"diagnostics-api\"\n }\n]")
ROOT_SECURITY = json.loads("[]")
SECURITY_SCHEMES = json.loads("{}")
SECURITY_FIELDS = json.loads("{}")
PATH_PARAMETER_RE = re.compile(r"{([^}/]+)}")
SOURCE_ROOT = Path(globals().get("__file__", "agent.py")).resolve().parent
SOURCE_SKILLS_DIR = SOURCE_ROOT / "skills"
RUNTIME_SKILLS_DIR = ".deepagents/openapi-skills/"
class OperationInput(BaseModel):
parameters: dict[str, Any] = Field(
default_factory=dict,
description="Path, query, header, and cookie parameters keyed by OpenAPI parameter name.",
)
body: Any | None = Field(default=None, description="JSON request body, when the operation accepts one.")
class DocusignEsignatureOpenapiAgent(A2AAgent):
name = "docusign-esignature-openapi-agent"
description = "Electronic signature and agreement workflow API for envelopes, recipients, documents, and tabs."
version = "v2.1"
consumer_setup = ConsumerSetup.from_fields(
ConsumerSetupField.config("OPENAPI_BASE_URL", label="API base URL", description="Override the default API server (https://www.docusign.net/restapi).", required=False, input_type="url"),
)
llm_provisioning = LLMProvisioning.PLATFORM
pricing = Pricing(
price_per_call_usd=0.0,
caller_pays_llm=True,
notes="Uses the caller's saved LLM credential through ctx.llm.",
)
resources = Resources(cpu="200m", memory="512Mi")
egress = EgressPolicy(
allow_hosts=('www.docusign.net',),
deny_internet_by_default=True,
)
tools_used = ("openapi", "deepagents")
capabilities = {
"openapi_auto_agent": {
"operation_count": len(OPERATIONS),
"default_base_url": DEFAULT_BASE_URL,
"source_openapi_url": 'https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json',
"source_openapi_urls": ['https://raw.githubusercontent.com/docusign/OpenAPI-Specifications/master/esignature.rest.swagger-v2.1.json'],
"server_urls": ['https://www.docusign.net/restapi'],
"regenerable": True,
"security_schemes": list(SECURITY_SCHEMES),
}
}
@skill(
name="auto",
description="Use the OpenAPI service to complete a natural-language goal.",
tags=("openapi", "auto"),
timeout_seconds=900,
)
async def auto(self, ctx: RunContext, goal: str) -> dict[str, Any]:
creds = ctx.llm
if not creds.api_key:
return {
"error": "llm_credentials_missing",
"final": (
"LLM key required. Add an LLM credential in Settings > "
"LLM credentials before running this agent."
),
"messages": [],
}
backend = ctx.workspace_backend()
skills_root = _seed_runtime_skills(backend, ctx)
graph = create_a2a_deep_agent(
ctx,
creds=creds,
backend=backend,
tools=[],
subagents=self._operation_subagents(ctx, skills_root),
system_prompt=self._system_prompt(),
)
result = await graph.ainvoke({"messages": [{"role": "user", "content": goal}]})
messages = result.get("messages", []) if isinstance(result, dict) else []
final = _message_text(messages[-1]) if messages else result
return {
"final": final,
"messages": [_message_to_dict(message) for message in messages[-8:]],
}
def _operation_subagents(self, ctx: RunContext, skills_root: str) -> list[dict[str, Any]]:
subagents: list[dict[str, Any]] = []
for group in OPERATION_GROUPS:
skill_path = (
f"{skills_root}{group['skill_dir']}/"
if skills_root
else ""
)
subagent = {
"name": group["subagent_name"],
"description": group["description"],
"system_prompt": self._subagent_prompt(group),
"tools": self._operation_tools(ctx, set(group["operation_ids"])),
}
if skill_path:
subagent["skills"] = [skill_path]
subagents.append(subagent)
return subagents
def _operation_tools(
self,
ctx: RunContext,
operation_ids: set[str] | None = None,
) -> list[StructuredTool]:
tools: list[StructuredTool] = []
for operation_id, operation in OPERATIONS.items():
if operation_ids is not None and operation_id not in operation_ids:
continue
async def call(
parameters: dict[str, Any] | None = None,
body: Any | None = None,
*,
_operation_id: str = operation_id,
) -> dict[str, Any]:
return await self._request(
ctx,
_operation_id,
parameters=parameters or {},
body=body,
)
tools.append(
StructuredTool.from_function(
coroutine=call,
name=operation["skill_name"],
description=self._tool_description(operation),
args_schema=OperationInput,
)
)
return tools
def _system_prompt(self) -> str:
if OPERATION_GROUPS:
lines = [
"You coordinate route-specific OpenAPI subagents.",
"Delegate API work to the matching subagent with the task tool.",
"Do not invent API responses; ask subagents to call their tools for real results.",
"If a subagent reports missing consumer setup, tell the user which setup field is required.",
"If a subagent reports that the generated OpenAPI agent may be stale, ask whether the user wants to refresh it from the latest OpenAPI spec.",
"",
"Available route groups:",
]
for group in OPERATION_GROUPS:
lines.append(
f"- {group['subagent_name']}: {group['description']}"
)
return "\n".join(lines)
lines = [
"You operate an API through generated OpenAPI tools.",
"Call tools to get real results. Do not invent API responses.",
"For write, update, or delete operations, explain the intended action before calling the tool.",
"If an operation reports missing consumer setup, tell the user which setup field is required.",
"If an operation returns 404, 405, 410, or a schema/validation error that suggests the live API no longer matches these tools, tell the user this generated agent may need to be refreshed from the latest OpenAPI spec and ask whether they want to refresh it.",
"",
"Available operations:",
]
for operation in OPERATIONS.values():
marker = "WRITE" if operation.get("destructive") else "READ"
lines.append(
f"- {operation['skill_name']}: {marker} {operation['method']} {operation['path']}{operation['summary']}"
)
return "\n".join(lines)
def _subagent_prompt(self, group: dict[str, Any]) -> str:
lines = [
"You operate one route group from a generated OpenAPI API.",
"Use the available operation tools to make real API calls. Do not invent API responses.",
"Read the route group's SKILL.md when it applies; it lists every route you cover.",
"For write, update, or delete operations, explain the intended action before calling the tool.",
"If an operation reports missing consumer setup, return the exact setup field name.",
"If an operation returns 404, 405, 410, or a schema/validation error that suggests the live API no longer matches these tools, say the generated agent may need to be refreshed from the latest OpenAPI spec.",
"",
f"Route group: {group['label']}",
f"Common prefix: {group.get('common_prefix') or '/'}",
"Available operation tools:",
]
for operation_id in group["operation_ids"]:
operation = OPERATIONS[operation_id]
marker = "WRITE" if operation.get("destructive") else "READ"
lines.append(
f"- {operation['skill_name']}: {marker} {operation['method']} {operation['path']} - {operation['summary']}"
)
return "\n".join(lines)
def _tool_description(self, operation: dict[str, Any]) -> str:
parts = [
f"{operation['method']} {operation['path']}",
str(operation.get("description") or operation.get("summary") or ""),
]
if operation.get("parameters"):
parts.append(
"Parameters: "
+ ", ".join(
f"{p['name']} in {p['in']}{' required' if p.get('required') else ''}"
for p in operation["parameters"]
)
)
if operation.get("request_body") is not None:
parts.append("Accepts a JSON request body.")
return "\n".join(part for part in parts if part)
async def _request(
self,
ctx: RunContext,
operation_id: str,
*,
parameters: dict[str, Any],
body: Any | None,
) -> dict[str, Any]:
operation = OPERATIONS[operation_id]
default_base_url = str(operation.get("base_url") or DEFAULT_BASE_URL).rstrip("/")
base_url_field = str(operation.get("base_url_field") or "OPENAPI_BASE_URL")
base_url = str(ctx.consumer_config(base_url_field, default_base_url) or default_base_url).rstrip("/")
url, query, headers = self._request_parts(ctx, operation, parameters)
request_kwargs: dict[str, Any] = {
"params": query,
"headers": headers,
}
if body is not None:
if isinstance(body, (bytes, bytearray)):
body = body.decode("utf-8", errors="replace")
if isinstance(body, str):
stripped = body.strip()
if stripped and stripped[0] in "{[":
try:
body = json.loads(stripped)
except ValueError:
pass
request_kwargs["json"] = body
async with httpx.AsyncClient(timeout=60.0, follow_redirects=True) as client:
response = await client.request(
operation["method"],
f"{base_url}{url}",
**request_kwargs,
)
content_type = response.headers.get("content-type", "")
try:
payload: Any = response.json() if "json" in content_type else response.text
except ValueError:
payload = response.text
if response.status_code >= 400:
out = {
"ok": False,
"status_code": response.status_code,
"operation_id": operation_id,
"error": payload,
}
if response.status_code in {404, 405, 410, 422}:
out["stale_openapi_hint"] = (
"This generated OpenAPI agent may be stale. Ask the user "
"whether they want to refresh it from the latest OpenAPI spec."
)
return out
return {
"ok": True,
"status_code": response.status_code,
"operation_id": operation_id,
"result": payload,
}
def _request_parts(
self,
ctx: RunContext,
operation: dict[str, Any],
parameters: dict[str, Any],
) -> tuple[str, dict[str, Any], dict[str, str]]:
path = operation["path"]
query: dict[str, Any] = {}
headers: dict[str, str] = {}
cookies: dict[str, Any] = {}
for param in operation.get("parameters") or []:
name = param["name"]
if name not in parameters:
if param.get("required"):
raise ValueError(f"missing required parameter {name!r}")
continue
value = parameters[name]
location = param["in"]
if location == "path":
path = path.replace("{" + name + "}", str(value))
elif location == "query":
query[name] = value
elif location == "header":
headers[name] = str(value)
elif location == "cookie":
cookies[name] = value
unresolved = PATH_PARAMETER_RE.findall(path)
if unresolved:
missing = ", ".join(sorted(set(unresolved)))
raise ValueError("missing required path parameter(s): " + missing)
if cookies:
headers["cookie"] = "; ".join(f"{key}={value}" for key, value in cookies.items())
auth_headers, auth_query = self._auth_for_operation(ctx, operation)
headers.update(auth_headers)
query.update(auth_query)
return path, query, headers
def _auth_for_operation(self, ctx: RunContext, operation: dict[str, Any]) -> tuple[dict[str, str], dict[str, Any]]:
requirements = operation.get("security")
if requirements is None:
requirements = ROOT_SECURITY
if requirements == []:
return {}, {}
missing: list[str] = []
for requirement in requirements or []:
if not isinstance(requirement, dict) or not requirement:
return {}, {}
headers: dict[str, str] = {}
query: dict[str, Any] = {}
ok = True
for scheme_name in requirement:
mapping = SECURITY_FIELDS.get(scheme_name) or {}
secret_name = mapping.get("field")
value = _consumer_secret_optional(ctx, secret_name) if secret_name else ""
if not value:
ok = False
if secret_name:
missing.append(secret_name)
continue
kind = mapping.get("kind")
if kind == "apiKey":
prefix = mapping.get("prefix") or ""
sent_value = f"{prefix}{value}"
if mapping.get("location") == "query":
query[mapping.get("name") or scheme_name] = sent_value
else:
headers[mapping.get("name") or scheme_name] = sent_value
elif kind in {"http", "oauth2"}:
scheme = mapping.get("scheme") or "Bearer"
if scheme.lower() == "basic":
token = base64.b64encode(value.encode("utf-8")).decode("ascii")
headers["authorization"] = f"Basic {token}"
else:
headers["authorization"] = f"{scheme} {value}"
else:
ok = False
if ok:
return headers, query
if missing:
raise ConsumerSetupMissing(
"operation requires consumer setup secret(s): "
+ ", ".join(sorted(set(missing)))
)
return {}, {}
def _consumer_secret_optional(ctx: RunContext, name: str | None) -> str:
if not name:
return ""
try:
return ctx.consumer_secret(name)
except ConsumerSetupMissing:
return ""
def _runtime_skills_root(ctx: RunContext) -> str:
workspace = getattr(ctx, "_workspace", None)
prefixes = tuple(getattr(workspace, "write_prefixes", ()) or ())
if not prefixes:
outputs_prefix = getattr(workspace, "outputs_prefix", None)
prefixes = (outputs_prefix or "outputs/",)
prefix = str(prefixes[0]).strip("/")
return f"/{prefix}/{RUNTIME_SKILLS_DIR}" if prefix else f"/{RUNTIME_SKILLS_DIR}"
def _seed_runtime_skills(backend: Any, ctx: RunContext) -> str:
if not SOURCE_SKILLS_DIR.exists():
return ""
runtime_root = _runtime_skills_root(ctx)
uploads: list[tuple[str, bytes]] = []
for path in SOURCE_SKILLS_DIR.rglob("*"):
if not path.is_file():
continue
rel = path.relative_to(SOURCE_SKILLS_DIR).as_posix()
uploads.append((runtime_root + rel, path.read_bytes()))
if not uploads:
return ""
backend.upload_files(uploads)
return runtime_root
def _message_text(message: Any) -> Any:
content = getattr(message, "content", message)
return content
def _message_to_dict(message: Any) -> dict[str, Any]:
if isinstance(message, BaseMessage):
return message.model_dump(mode="json")
if hasattr(message, "model_dump"):
return message.model_dump(mode="json")
if isinstance(message, dict):
return message
return {"content": str(message)}
agent = DocusignEsignatureOpenapiAgent()