{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://raw.githubusercontent.com/api-evangelist/signwell/main/json-schema/update_recipients_map.json",
"title": "update_recipients_map",
"type": "array",
"description": "List of recipients to update on the document.",
"items": {
"type": "object",
"required": [
"id",
"name",
"email"
],
"properties": {
"id": {
"type": "string",
"description": "The recipient's unique identifier from the Get Document response."
},
"name": {
"type": "string",
"description": "Updated name for the recipient."
},
"email": {
"type": "string",
"format": "email",
"example": "[email protected]",
"description": "Updated email address for the recipient."
},
"subject": {
"type": "string",
"description": "Updated email subject for the signature request that this recipient will see."
},
"message": {
"type": "string",
"description": "Updated email message for the signature request that this recipient will see."
},
"passcode": {
"type": "string",
"description": "Updated passcode for the recipient. If set, the signer will be required to enter the passcode before viewing and completing the document."
}
}
}
}