Skip to content

Latest commit

 

History

History
executable file
·
15 lines (12 loc) · 2.48 KB

File metadata and controls

executable file
·
15 lines (12 loc) · 2.48 KB

AdobeSign.Rest.model.agreements.ParticipantSetInfo

Properties

Name Type Description Notes
Label string The unique label of a participant set.<br>For custom workflows, label specified in the participation set should map it to the participation step in the custom workflow. [optional]
MemberInfos List<ParticipantSetMemberInfo> Array of ParticipantInfo objects, containing participant-specific data (e.g. email). All participants in the array belong to the same set [optional]
Name string Name of the participant set (it can be empty, but needs not to be unique in a single agreement). Maximum no of characters in participant set name is restricted to 255 [optional]
Order int? Index indicating position at which signing group needs to sign. Signing group to sign at first place is assigned a 1 index. Different signingOrder specified in input should form a valid consecutive increasing sequence of integers. Otherwise signingOrder will be considered invalid. No signingOrder should be specified for SHARE role [optional]
PrivateMessage string Participant set's private message - all participants in the set will receive the same message [optional]
Role string Role assumed by all participants in the set (signer, approver etc.) [optional]
VisiblePages List<string> When you enable limited document visibility (documentVisibilityEnabled), you can specify which file (fileInfo) should be made visible to which specific participant set.<br>Specify one or more label values of a fileInfos element.<br>Each signer participant sets must contain at least one required signature field in at least one visible file included in this API call; if not a page with a signature field is automatically appended for any missing participant sets. If there is a possibility that one or more participant sets do not have a required signature field in the files included in the API call, all signer participant sets should include a special index value of '0' to make this automatically appended signature page visible to the signer. Not doing so may result in an error. For all other roles, you may omit this value to exclude this page. [optional]

[Back to Model list] [Back to API list] [Back to README]