• Global community
    • Language:
      • Deutsch
      • English
      • Español
      • Français
      • Português
  • 日本語コミュニティ
    Dedicated community for Japanese speakers
  • 한국 커뮤니티
    Dedicated community for Korean speakers
Exit
0

Individual Recipients are always "Groups" in Agreements Created through API

Community Beginner ,
Jan 03, 2024 Jan 03, 2024

Copy link to clipboard

Copied

When creating an agreement in UI, there's an option to "Add Recipient Group", or to simply add individual recipients.

 

When I'm creating agreements with the API, the recipients always show up as "groups" instead of just individuals.

 

Here is a screenshot of the recipient list for an agreement I created in UI. Note that the recipients show up as "(Signer)":

Stephane30690527gegt_0-1704316738001.png

 

Here is a screenshot of the recipient list for an agreement I created with the API. Note that the recipients show up as "(Group)":

Stephane30690527gegt_1-1704316795982.png

 

For the API call, I'm just following the format specified in the REST API Reference and this sample. I can't find any other way of formatting the API request such that it specifies the recipients as individuals rather than groups. Is this a limitation with the API?

 

Views

132

Translate

Translate

Report

Report
Community guidelines
Be kind and respectful, give credit to the original source of content, and search for duplicates before posting. Learn more
community guidelines

correct answers 1 Correct answer

Adobe Employee , Jan 09, 2024 Jan 09, 2024

The name in that part is for the "participantSet", for the recipient "member" (a participantSet of one still has at least one member) the name attribute goes "inside".

 

 

participantSetsInfo": [
    {
      "memberInfos": [
        {
          "email": "recipient1@example.com",
          "name": "Bob Smith"
        }
      ],
      "order": 1,
      "role": "SIGNER"
    },
    {
      "memberInfos": [
        {
          "email": "recipient2@example.com",
          "name": "Jane Doe"
        }
...

Votes

Translate

Translate
Adobe Employee ,
Jan 09, 2024 Jan 09, 2024

Copy link to clipboard

Copied

Hi @Stephane30690527gegt ,

 

In an attempt to make sure I'm clear on your question, are you trying to add multiple recipients as a group ( a recipient group means ANY member can sign) or as individual recipients where each of the people need to sign? 

For a group, (any of the 3 can sign as "recipient 1") the JSON recipients section looks like this:

 

 

 "participantSetsInfo": [
    {
      "memberInfos": [
        {
          "email": "recipientMember1@example.com"
        },
           {
          "email": "recipientMember2@example.com"
        },
        {
          "email": "recipientMember3@example.com"
        } 
      ],
      "order": 1,
      "role": "SIGNER",
      "name":"test agreement w recipient group"
    }
  ],

 

 

 

For individual recipients it needs to look like this:

 

 

"participantSetsInfo": [
    {
        "memberInfos": [
            {
                "email": "recipient1@example.com"
            }
        ],
        "order": 1,
        "privateMessage": "Private message for Signer 1",
        "role": "SIGNER"
    },
    {
        "memberInfos": [
            {
                "email": "recipient2@exaample.com"
            }
        ],
        "order": 2,
        "privateMessage": "Private message for Signer 2",
        "role": "SIGNER"
    },

 

 

 

Aaron Smusz -Customer Enablement Engineer - Adobe Acrobat Sign

Votes

Translate

Translate

Report

Report
Community guidelines
Be kind and respectful, give credit to the original source of content, and search for duplicates before posting. Learn more
community guidelines
Community Beginner ,
Jan 09, 2024 Jan 09, 2024

Copy link to clipboard

Copied

Hi @A.Smusz - CE Engineer , thanks for your response

 

I am trying to add individual signers only to the agreement. Initially, when I copied your second example above and tried it out, it gave me the result I was looking for (ie. it no longer says "(Group)" next to each individual signer's name).

 

However, I realized that the difference between your example and what I was doing before, is that your example does not have the "name" attribute specified for the individual signers. When I tried to specify a "name" attribute for each individual signer, it went back to adding the "(Group)" identifier to each signer when I view the agreement in Adobe Sign.

 

To be clear, here is a participant set that results in individual signers without the "(Group)" identifier (which is what I want):

 

"participantSetsInfo": [
	{
		"memberInfos": [
			{
				"email": "example@mail.com"
			}
		],
		"order": 1,
		"role": "SIGNER"
	},
	{
		"memberInfos": [
			{
				"email": "example2@mail.com"
			}
		],
		"order": 2,
		"role": "SIGNER"
	}
],

 

 

 Here is a participant set that results in individual signers with the "(Group)" identifier (which is what I don't want):

 

"participantSetsInfo": [
	{
		"memberInfos": [
			{
				"email": "example@mail.com"
			}
		],
		"name": "Signer 1 Name",
		"order": 1,
		"role": "SIGNER"
	},
	{
		"memberInfos": [
			{
				"email": "example2@mail.com"
			}
		],
		"name": "Signer 2 Name",
		"order": 2,
		"role": "SIGNER"
	}
],

 

 

As you can see, the only difference between the two is the added "name" attribute for each signer. 

 

On the Adobe Sign REST API Reference page, it says the "name" attribute relates to:

> name (stringoptional😞 Recipient's full name

 

The attribute reference says nothing about this attribute relating only to groups. So I'm not sure why adding this attribute changes each individual signer to a group. This seems like a bug in the API. I would like to be able to specify a name attribute without the signers showing up as groups.

Votes

Translate

Translate

Report

Report
Community guidelines
Be kind and respectful, give credit to the original source of content, and search for duplicates before posting. Learn more
community guidelines
Adobe Employee ,
Jan 09, 2024 Jan 09, 2024

Copy link to clipboard

Copied

The name in that part is for the "participantSet", for the recipient "member" (a participantSet of one still has at least one member) the name attribute goes "inside".

 

 

participantSetsInfo": [
    {
      "memberInfos": [
        {
          "email": "recipient1@example.com",
          "name": "Bob Smith"
        }
      ],
      "order": 1,
      "role": "SIGNER"
    },
    {
      "memberInfos": [
        {
          "email": "recipient2@example.com",
          "name": "Jane Doe"
        }
      ],
      "order": 2,
      "role": "SIGNER"
    }
  ],

 

Aaron Smusz -Customer Enablement Engineer - Adobe Acrobat Sign

Votes

Translate

Translate

Report

Report
Community guidelines
Be kind and respectful, give credit to the original source of content, and search for duplicates before posting. Learn more
community guidelines
Community Beginner ,
Jan 09, 2024 Jan 09, 2024

Copy link to clipboard

Copied

@A.Smusz - CE Engineer - When I put the name attribute inside the `memberInfos` object, it seems to be ignored. It does not show up in Adobe Sign UI, and doesn't show in any subsequent API calls for the agreement or its members. Does this mean it's not possible to specify a name for signers on the agreement?

Votes

Translate

Translate

Report

Report
Community guidelines
Be kind and respectful, give credit to the original source of content, and search for duplicates before posting. Learn more
community guidelines
Adobe Employee ,
Jan 09, 2024 Jan 09, 2024

Copy link to clipboard

Copied

Because the signer can change the name while signing, we don't necessarily show it in all places at all stages but it does show after the agreement is signed. ats-2024-01-09_10-40.png
Additionally, if you are creating the agreement in "AUTHORING" the name/s shows there in the UI.

ats-2024-01-09_10-46.png

Perhaps you could provide a bit more context so I can understand whaat you're trying to achieve?

It does also show up in the GET /agreements/[id] response for me ?

ats-flameshot-2024-01-09_10-53.png

Aaron Smusz -Customer Enablement Engineer - Adobe Acrobat Sign

Votes

Translate

Translate

Report

Report
Community guidelines
Be kind and respectful, give credit to the original source of content, and search for duplicates before posting. Learn more
community guidelines
Community Beginner ,
Jan 09, 2024 Jan 09, 2024

Copy link to clipboard

Copied

Ok that is useful to know. Thanks for your responses @A.Smusz - CE Engineer 

Votes

Translate

Translate

Report

Report
Community guidelines
Be kind and respectful, give credit to the original source of content, and search for duplicates before posting. Learn more
community guidelines
Adobe Employee ,
Jan 09, 2024 Jan 09, 2024

Copy link to clipboard

Copied

It shows up for me in the GET /agreements/[id]/members response for me as well.

 

ats-flameshot-2024-01-09_11-02.png

Perhaps you're missing the setting to allow/require adding a name ?

ats-flameshot-2024-01-09_11-08.png

Aaron Smusz -Customer Enablement Engineer - Adobe Acrobat Sign

Votes

Translate

Translate

Report

Report
Community guidelines
Be kind and respectful, give credit to the original source of content, and search for duplicates before posting. Learn more
community guidelines
Community Beginner ,
Jan 09, 2024 Jan 09, 2024

Copy link to clipboard

Copied

For me, it only shows up after the signer has already signed, and uses whatever they enter in the sig line rather than what I specified in my API call. It also shows a name if the recipient has an Adobe Sign account associated with their email - but again it uses the name they've specified in Adobe rather than the one I specified in my initial API call.

 

So in both cases it seems as though the name attribute in the API call is ignored and instead the API returns what the recipient enters in the signature, or the name they specified on their own account.

Votes

Translate

Translate

Report

Report
Community guidelines
Be kind and respectful, give credit to the original source of content, and search for duplicates before posting. Learn more
community guidelines
Adobe Employee ,
Jan 09, 2024 Jan 09, 2024

Copy link to clipboard

Copied

Please see my last edit above?  I think you may be missing the setting shown.

Aaron Smusz -Customer Enablement Engineer - Adobe Acrobat Sign

Votes

Translate

Translate

Report

Report
Community guidelines
Be kind and respectful, give credit to the original source of content, and search for duplicates before posting. Learn more
community guidelines
Community Beginner ,
Jan 09, 2024 Jan 09, 2024

Copy link to clipboard

Copied

LATEST

Ah you're right! That's what I was missing. Thanks for pointing that out

Votes

Translate

Translate

Report

Report
Community guidelines
Be kind and respectful, give credit to the original source of content, and search for duplicates before posting. Learn more
community guidelines