Participants
- PDF
Participants
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Participants
This part of the request describes the participants of the entire signature workflow. It’s a JSON array, containing JSON objects. Each object corresponds to a specific participant participating in the signature workflow. Table 1 describes its parameters.
Table 1: Participant Parameters
| Parameter | Type | Optional/Required | Discerption |
| id | string | Required | An internal identifier for a participant that will be referenced by other areas of the API to refer to it NOTE Make sure to choose a unique identifier for each participant of a specific step |
| name | string | Required | The name of the participant will be used for embedding in communication messages (SMS or emails) |
| role | string | Required | The role of a participant |
Sample Call
"participants": [
{
"id": "agent",
"name": "Dennis",
"role": "rep"
},
{
"id": "customer1",
"name": "Naomi",
"role": "signer"
},
{
"id": "Dee",
"name": "The customer",
"role": "signer"
}
]Was this article helpful?