DocuSign: как отправить значения настраиваемых полей документа (или определения вкладок) при создании конверта?

Question

Мне нужна помощь, чтобы определить, как отправлять значения пользовательских полей документа на этапе создания конверта. Ниже приведен рабочий процесс:

1. Создание пользовательских полей документа (учетная запись c) с именем, типом и начальным значением через API (POST [BaseURI] / tab_definitions)
2. Создать шаблон с документом через API и поместите необходимые пользовательские поля документа в документ через DocuSign UI
3. Создайте конверт и отправьте определенные значения c для пользовательских полей документа через API (POST [BaseURI] / envelopes)

Создание конверта работает нормально со ссылкой (https://developers.docusign.com/esign-rest-api/reference/Envelopes/Envelopes/create). Я попытался отправить значения через:

• document -> documentFields
• customFields -> textCustomFields

{
    "templateId": "51234567-1244-1234-1234-12345a857203",
    "templateRoles": [
            {
                "roleName": "Role1",
                "name": "Jane Doe",
                "email": "jane@doe.com"
            },
            {
                "roleName": "Role2",
                "name": "John Doe",
                "email": "john@doe.com"
            }
    ],
    "customFields": {
        "textCustomFields": [
            {
                "name": "Account.Name",
                "value": "account-name1234"
            },
            {
                "name": "Candidate.FullName",
                "value": "candidate-name1234"
            },
            {
                "name": "Candidate.Mobile",
                "value": "0412345678"
            }
        ]
    },
    "status": "sent"
}

Answer 1

Параметр CustomFields предназначен для Конверт Пользовательские поля. Если вы хотите определить значения тега для получателя, параметры тега должны быть вложены в TemplateRole. Вы также захотите использовать параметр tabLabel для идентификации вкладок вместо name. Наконец, убедитесь, что ваши имена ролей и TabLabels точно соответствуют вашему шаблону и вызову API. Попробуйте это:

{
    "templateId": "51234567-1244-1234-1234-12345a857203",
    "templateRoles": [
            {
                "roleName": "Role1",
                "name": "Jane Doe",
                "email": "jane@doe.com"
                "tabs": {
                    "TextTabs": [
                        {
                        "tabLabel": "Account.Number",
                        "value": "00000000"
                        },
                        {
                        "tabLabel": "Account.Name",
                        "value":"ExampleAccount"
                        }
                    ],
            },
            {
                "roleName": "Role2",
                "name": "John Doe",
                "email": "john@doe.com"
            }
    ],
    "status": "sent"
}

Наконец, вы можете рассмотреть возможность использования составного шаблона вместо базового c вызова создания конверта. Подробности о том, почему доступны здесь: https://www.docusign.com/blog/dsdev-why-use-composite-templates/