How to populate checkbox field of a template via a api call from within Oracle Integration Cloud iPaaS

Any update here

Hi,

It looks like you are trying to update the tabs using the EnvelopeRecipients:update endpoint: https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/enveloperecipients/update/

You cannot update tabs from this API, it is specified in an example on the page: 

Note: This method works on recipients only. To add recipient tabs, use methods from the EnvelopeRecipientTabs resource. For example, this request body will add a recipient (astanton@example.com) but NOT the Sign Here recipient tab.

You can use the following API Request to update the envelope tabs for a recipient: EnvelopeRecipientTabs:update

https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/update/

You will need to match to call an API to retrieve the tabId of the the tab you wish to update.

Here is a working workflow:

Step 1: Create a draft envelope

{
  "emailSubject": "Checkbox example",
  "status": "created", 
  "documents": [
    {
      "documentId": "1",
      "name": "example.pdf",
      "documentBase64": "documentbase64goeshere"
    }
  ],
  "recipients": {
    "signers": [
      {
        "email": "redactedemail@email.com",
        "name": "Signer Name",
        "recipientId": "1",
        "routingOrder": "1",
        "tabs": {
          "checkboxTabs": [
            {
              "tabLabel": "ckOptionA",
              "documentId": "1",
              "pageNumber": "1",
              "xPosition": "100",
              "yPosition": "200",
              "selected": "false"
            },
            {
              "tabLabel": "ckOptionB",
              "documentId": "1",
              "pageNumber": "1",
              "xPosition": "100",
              "yPosition": "230",
              "selected": "false"
            }
          ]
        }
      }
    ]
  }
}

Step 2: Need to find the tabIds so i can update the tab value, in this example i am calling: https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/enveloperecipients/list/

GET /restapi/v2.1/accounts/{{accountid}}/envelopes/{{envelopeid}}/recipients?include_tabs=true

{
    "signers": [
        {
            "tabs": {
                "checkboxTabs": [
                    {
                        "name": "",
                        "tabLabel": "ckOptionA",
                        "selected": "true",
                        "selectedOriginal": "true",
                        "requireInitialOnSharedChange": "false",
                        "bold": "false",
                        "italic": "false",
                        "underline": "false",
                        "required": "true",
                        "locked": "false",
                        "documentId": "1",
                        "recipientId": "1",
                        "pageNumber": "1",
                        "xPosition": "100",
                        "yPosition": "200",
                        "width": "0",
                        "height": "0",
                        "tabId": "006a19ac-d3fd-40e5-afb5-3dc44fdfce01",
                        "tabType": "checkbox",
                        "source": "Manual"
                    },
                    {
                        "name": "",
                        "tabLabel": "ckOptionB",
                        "selected": "false",
                        "selectedOriginal": "false",
                        "shared": "false",
                        "requireInitialOnSharedChange": "false",
                        "font": "arial",
                        "bold": "false",
                        "italic": "false",
                        "underline": "false",
                        "fontColor": "black",
                        "fontSize": "size9",
                        "required": "true",
                        "locked": "false",
                        "documentId": "1",
                        "recipientId": "1",
                        "pageNumber": "1",
                        "xPosition": "101",
                        "yPosition": "230",
                        "width": "0",
                        "height": "0",
                        "tabId": "b6e42eb3-ad7d-490d-95e3-66b1fbb21510",
                        "tabType": "checkbox",
                        "tooltip": "",
                        "source": "Manual",
                        "agreementAttributeLocked": "false"
                    }
                ]
            },
            "creationReason": "sender",
            "isBulkRecipient": "false",
            "recipientSignatureProviders": [
                {
                    "sealDocumentsWithTabsOnly": "false",
                    "signatureProviderName": "universalsignaturepen_imageonly",
                    "signatureProviderOptions": {}
                }
            ],
            "requireUploadSignature": "false",
            "name": "Signer Name",
            "email": "redactedemail@email.com",
            "recipientId": "1",
            "recipientIdGuid": "92cb229b-4a15-81af-817a-a0f26a600a66",
            "requireIdLookup": "false",
            "userId": "cda7e6c1-e77f-41b9-914e-3b19d842ebc3",
            "routingOrder": "1",
            "status": "created",
            "completedCount": "0",
            "deliveryMethod": "email",
            "totalTabCount": "2",
            "recipientType": "signer"
        }
    ],
    "agents": [],
    "editors": [],
    "intermediaries": [],
    "carbonCopies": [],
    "certifiedDeliveries": [],
    "inPersonSigners": [],
    "seals": [],
    "witnesses": [],
    "notaries": [],
    "recipientCount": "1"
}

Step 3: Match TabId to value and update selected value:

PUT /restapi/v2.1/accounts/{{accountid}}/envelopes/{{envelopeid}}/recipients/1/tabs

{
    "checkboxTabs": [
        {
            "tabId": "006a19ac-d3fd-40e5-afb5-3dc44fdfce01",
            "tabLabel": "ckOptionA",
            "selected": "true"
        },
        {
            "tabId": "b6e42eb3-ad7d-490d-95e3-66b1fbb21510",
            "tabLabel": "ckOptionB",
            "selected": "false"
        }
    ]
}

Here is the response:

{
    "checkboxTabs": [
        {
            "name": "",
            "tabLabel": "ckOptionA",
            "selected": "true",
            "selectedOriginal": "false",
            "shared": "false",
            "requireInitialOnSharedChange": "false",
            "font": "arial",
            "bold": "false",
            "italic": "false",
            "underline": "false",
            "fontColor": "black",
            "fontSize": "size7",
            "required": "true",
            "locked": "false",
            "documentId": "1",
            "recipientId": "1",
            "xPosition": "100",
            "yPosition": "200",
            "width": "0",
            "height": "0",
            "tabId": "006a19ac-d3fd-40e5-afb5-3dc44fdfce01",
            "tabOrder": "0",
            "tabType": "checkbox"
        },
        {
            "name": "",
            "tabLabel": "ckOptionB",
            "selected": "false",
            "selectedOriginal": "false",
            "shared": "false",
            "requireInitialOnSharedChange": "false",
            "font": "arial",
            "bold": "false",
            "italic": "false",
            "underline": "false",
            "fontColor": "black",
            "fontSize": "size9",
            "required": "true",
            "locked": "false",
            "documentId": "1",
            "recipientId": "1",
            "xPosition": "101",
            "yPosition": "230",
            "width": "0",
            "height": "0",
            "tabId": "b6e42eb3-ad7d-490d-95e3-66b1fbb21510",
            "tabOrder": "0",
            "tabType": "checkbox",
            "tooltip": "",
            "agreementAttributeLocked": "false"
        }
    ]
}

Hi Team,

We are facing an issue while setting a checkbox field in a DocuSign template using the OIC DocuSign Adapter.

The checkbox value is not being populated when the envelope is created through the DocuSign Adapter in OIC. However, the same checkbox can be successfully set when invoking the DocuSign REST API directly using the corresponding payload.
 

Please see attached documents for references.
 

Any help here

If you are having issues with Oracle OIC DocuSign Adapter, I suggest you reach out to Oracle regarding this issue.

We resolved this issue by way of transforming the checked value to small case aplhabet X.