Recipient
Update recipient
API Documentation
Contract
PDF and Word
Placeholder
Template
Recipient
Update recipient
Update an existing recipient.
curl -X POST 'https://api.sendforsign.com/api/recipient' \
-H 'Authorization: Bearer 123456789' \
-H 'Content-Type: application/json' \
-d '{
"data": {
"action": "update",
"contractKey": "CONTRACT_KEY",
"recipient": {
"recipientKey": "RECIPIENT_KEY",
"action": "view",
"customMessage": "Custom message text",
"fullname": "Full Name",
"email": "email@email.com",
"position": 1
}
}
}'
{
"recipient": {
"changeTime": "2023-12-01 12:18:55"
},
"code": "201",
"message": "Recipient updated"
}
Body parameters
Action type.
ID of the contract.
Structure, add the fields that need to be updated and ignore the rest.
Key of the recipient that needs to be updated.
What the recipient needs to do with the contract. Available options: view, sign, approve, and lock.
Custom note to the recipient. If not specified, the default message will be sent.
Full name of the recipient.
Email of the recipient.
Signing order. If not specified, all requests will be sent simultaneously.
Response
The code of the answer.
The message of the answer.
curl -X POST 'https://api.sendforsign.com/api/recipient' \
-H 'Authorization: Bearer 123456789' \
-H 'Content-Type: application/json' \
-d '{
"data": {
"action": "update",
"contractKey": "CONTRACT_KEY",
"recipient": {
"recipientKey": "RECIPIENT_KEY",
"action": "view",
"customMessage": "Custom message text",
"fullname": "Full Name",
"email": "email@email.com",
"position": 1
}
}
}'
{
"recipient": {
"changeTime": "2023-12-01 12:18:55"
},
"code": "201",
"message": "Recipient updated"
}
curl -X POST 'https://api.sendforsign.com/api/recipient' \
-H 'Authorization: Bearer 123456789' \
-H 'Content-Type: application/json' \
-d '{
"data": {
"action": "update",
"contractKey": "CONTRACT_KEY",
"recipient": {
"recipientKey": "RECIPIENT_KEY",
"action": "view",
"customMessage": "Custom message text",
"fullname": "Full Name",
"email": "email@email.com",
"position": 1
}
}
}'
{
"recipient": {
"changeTime": "2023-12-01 12:18:55"
},
"code": "201",
"message": "Recipient updated"
}