Collaboration Step
Configures a collaborative document workflow with multiple parties, participants, and optional due dates. Use this step to coordinate document reviews, approvals, or signatures between an owner party and an optional external party.
Top-level properties
| name | type | required | constraints | description |
|---|---|---|---|---|
documentStep | string | yes | Reference to the document step in the workflow | |
documentName | string | yes | Name of the document to be collaborated on | |
dueDate | string | no | Optional due date for the collaboration workflow | |
ownerParty | object | yes | The owner party configuration including owner and optional participants | |
externalParty | object | no | Optional external party configuration including representative and participants |
Validation rules:
- All email addresses must be unique across owner, participants, and representative from both parties
- At least one party (owner) must be defined
Owner Party
The owner party represents the primary organization or individual initiating the collaboration.
| name | type | required | constraints | |
|---|---|---|---|---|
owner | object | yes | Main owner participant with optional business name | |
participants | array | no | Optional list of additional participants from the owner party |
External Party
The external party represents a secondary organization or individual participating in the collaboration.
| name | type | required | constraints | |
|---|---|---|---|---|
representative | object | yes | Main external party representative with optional business name | |
participants | array | no | Optional list of additional participants from the external party |
Main Participant (Owner or Representative)
Main participants can represent either the owner or external party representative.
| name | type | required | constraints | |
|---|---|---|---|---|
name | string | no | nullable: true | Full name of the main participant |
email | string | no | nullable: true; format: email | Email address of the main participant |
businessName | string | no | Optional business or organization name |
Participant
Standard participants for both owner and external parties.
| name | type | required | constraints | |
|---|---|---|---|---|
name | string | no | nullable: true | Full name of the participant |
email | string | no | nullable: true; format: email | Email address of the participant |
Example (JSON)
{
"documentStep": "step_001",
"documentName": "Service Agreement 2025",
"dueDate": "2025-12-31",
"ownerParty": {
"owner": {
"name": "John Doe",
"email": "[email protected]",
"businessName": "Acme Corporation"
},
"participants": [
{
"name": "Jane Smith",
"email": "[email protected]"
},
{
"name": "Bob Wilson",
"email": "[email protected]"
}
]
},
"externalParty": {
"representative": {
"name": "Alice Johnson",
"email": "[email protected]",
"businessName": "Partner Company LLC"
},
"participants": [
{
"name": "Charlie Brown",
"email": "[email protected]"
}
]
}
}Example without External Party (JSON)
{
"documentStep": "step_002",
"documentName": "Internal Review Document",
"dueDate": "2025-11-15",
"ownerParty": {
"owner": {
"name": "Sarah Davis",
"email": "[email protected]",
"businessName": "Internal Operations"
},
"participants": [
{
"name": "Michael Chen",
"email": "[email protected]"
}
]
}
}Updated 22 days ago
