API Documentation
MCP
Contract
PDF and Word
Placeholder
Recipient
Template
Webhook
Copy
curl -X POST 'https://api.sendforsign.com/api/recipient' \
-H 'X-Sendforsign-Key: YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{
"data": {
"action": "update",
"clientKey": "YOUR_CLIENT_KEY",
"contractKey": "CONTRACT_KEY",
"recipient": {
"recipientKey": "RECIPIENT_KEY",
"action": "view",
"clientKey": "YOUR_CLIENT_KEY",
"customMessage": "Custom message text",
"fullname": "Full Name",
"email": "[email protected]",
"position": 1
}
}
}'
Copy
{
"recipient": {
"changeTime": "2023-12-01 12:18:55"
},
"code": "201",
"message": "Recipient updated"
}
Recipient
Update recipient
Update an existing recipient.
POST
https://api.sendforsign.com
/
api
/
recipient
Copy
curl -X POST 'https://api.sendforsign.com/api/recipient' \
-H 'X-Sendforsign-Key: YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{
"data": {
"action": "update",
"clientKey": "YOUR_CLIENT_KEY",
"contractKey": "CONTRACT_KEY",
"recipient": {
"recipientKey": "RECIPIENT_KEY",
"action": "view",
"clientKey": "YOUR_CLIENT_KEY",
"customMessage": "Custom message text",
"fullname": "Full Name",
"email": "[email protected]",
"position": 1
}
}
}'
Copy
{
"recipient": {
"changeTime": "2023-12-01 12:18:55"
},
"code": "201",
"message": "Recipient updated"
}
Body parameters
Show child attribute
Show child attribute
Action type.
Key of the client.
Key of the contract.
Structure, add the fields that need to be updated and ignore the rest.
Show child attribute
Show child attribute
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.
Copy
curl -X POST 'https://api.sendforsign.com/api/recipient' \
-H 'X-Sendforsign-Key: YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{
"data": {
"action": "update",
"clientKey": "YOUR_CLIENT_KEY",
"contractKey": "CONTRACT_KEY",
"recipient": {
"recipientKey": "RECIPIENT_KEY",
"action": "view",
"clientKey": "YOUR_CLIENT_KEY",
"customMessage": "Custom message text",
"fullname": "Full Name",
"email": "[email protected]",
"position": 1
}
}
}'
Copy
{
"recipient": {
"changeTime": "2023-12-01 12:18:55"
},
"code": "201",
"message": "Recipient updated"
}
⌘I