Private Message through REST API | Adobe Sign

Private Message through REST API | Adobe Sign

Search
User Guide

On this page

某些 Creative Cloud 应用程序、服务和功能在中国不可用。

Issue

How to configure private messaging for multiple signers through REST API Calls?

Environment

Adobe Sign REST-API

Resolution

Following are the steps to configure Private Messaging using REST API:

  1. Log in to Adobe Sign.

  2. Navigate to  Account>Adobe Sign API>API Information and click REST API Method Documentation.

    000205793_1

  3. POST /transientDocuments and upload a file and create a transient Document ID.

  4. Copy the transient Document ID and use it in the POST /agreements method. Mention the following JSON request in the box:

    {
    "documentCreationInfo": {
        "mergeFieldInfo": null,
        "recipientSetInfos": [{
                "signingOrder": null,
                "recipientSetRole": "SIGNER",
                "recipientSetMemberInfos": [{
                    "securityOptions": null,
                    "email": "test1@gmail.com"
                }],
                "privateMessage": "Hello 1",
                "securityOptions": null
            },
            {
                "signingOrder": null,
                "recipientSetRole": "SIGNER",
                "recipientSetMemberInfos": [{
                    "securityOptions": null,
                    "email": "test2@gmail.com"
                }],
                "privateMessage": "Hello 2",
                "securityOptions": null
            }
        ],
        "signatureType": "ESIGN",
        "callbackInfo": null,
        "message": "Please review and sign this document.",
        "locale": "en_US",
        "vaultingInfo": null,
        "securityOptions": null,
        "reminderFrequency": null,
        "ccs": null,
        "postSignOptions": null,
        "signatureFlow": "SENDER_SIGNATURE_NOT_REQUIRED",
        "daysUntilSigningDeadline": null,
        "formFieldLayerTemplates": [],
        "name": "Adobe Sign Agreement",
        "formFields": null,
        "fileInfos": [{
            "libraryDocumentName": null,
            "transientDocumentId": "XXXXXXXXXXXX",
            "documentURL": null,
            "libraryDocumentId": null
        }]
    }
}

  5. To execute the JSON Request, click the Try It Out button.

    000205793_2

    The correct JSON returns the response with the agreement ID.

    000205793_3

Additional information

It is the test call for the private messaging using the default REST API documentation. You can use the same JSON code in your own application as per your requirement.