curl -X POST 'https://api.sendforsign.com/api/recipient' \
-H 'X-Sendforsign-Key: YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{
"data": {
"action": "create",
"clientKey": "YOUR_CLIENT_KEY",
"contractKey": "CONTRACT_KEY",
"recipients":[{
"action": "view",
"clientKey": "YOUR_CLIENT_KEY",
"customMessage": "Custom message text",
"fullname": "John Johnson",
"email": "john_johnson@mail.com",
"position": 1
}],
}
}'
{
"result": true,
"code": "200",
"message": "Recipient created"
}
Recipient
Create recipient
Add a recipient to a contract.
POST
/
api
/
recipient
curl -X POST 'https://api.sendforsign.com/api/recipient' \
-H 'X-Sendforsign-Key: YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{
"data": {
"action": "create",
"clientKey": "YOUR_CLIENT_KEY",
"contractKey": "CONTRACT_KEY",
"recipients":[{
"action": "view",
"clientKey": "YOUR_CLIENT_KEY",
"customMessage": "Custom message text",
"fullname": "John Johnson",
"email": "john_johnson@mail.com",
"position": 1
}],
}
}'
{
"result": true,
"code": "200",
"message": "Recipient created"
}
One way to add recipients to a contract is when you send a contract.
See this page to learn more.
If you need to add a recipient to a contract without sending it, use the request below.
Body parameters
Show child attribute
Show child attribute
Action type.
Key of the client.
ID of the user who is sending the contract. If not specified, the default user credentials will be used.
Key of the contract.
Array of recipients, optional.
Show child attribute
Show child attribute
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
Status.
The code of the answer.
The message of the answer.
curl -X POST 'https://api.sendforsign.com/api/recipient' \
-H 'X-Sendforsign-Key: YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{
"data": {
"action": "create",
"clientKey": "YOUR_CLIENT_KEY",
"contractKey": "CONTRACT_KEY",
"recipients":[{
"action": "view",
"clientKey": "YOUR_CLIENT_KEY",
"customMessage": "Custom message text",
"fullname": "John Johnson",
"email": "john_johnson@mail.com",
"position": 1
}],
}
}'
{
"result": true,
"code": "200",
"message": "Recipient created"
}
⌘I