Body parameters
Action type.
ID of the contract.
Structure, add the fields that need to be updated and ignore the rest.
Response
Recipient structure.
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"
}
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"
}
Show child attribute
view
, sign
, approve
, and lock
.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"
}