Recipient
Delete recipient
API Documentation
Contract
PDF and Word
Placeholder
Template
Recipient
Delete recipient
Delete an existing recipient.
curl -X POST 'https://api.sendforsign.com/api/recipient' \
-H 'Authorization: Bearer 123456789' \
-H 'Content-Type: application/json' \
-d '{
"data": {
"action": "delete",
"contractKey": "CONTRACT_KEY",
"recipient": {
"recipientKey": "RECIPIENT_KEY"
}
}
}'
{
"result": true,
"code": "200",
"message": "Recipient deleted"
}
Body parameters
Action type.
ID of the contract.
Structure.
Key of the recipient that needs to be deleted.
Response
The status.
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": "delete",
"contractKey": "CONTRACT_KEY",
"recipient": {
"recipientKey": "RECIPIENT_KEY"
}
}
}'
{
"result": true,
"code": "200",
"message": "Recipient deleted"
}
curl -X POST 'https://api.sendforsign.com/api/recipient' \
-H 'Authorization: Bearer 123456789' \
-H 'Content-Type: application/json' \
-d '{
"data": {
"action": "delete",
"contractKey": "CONTRACT_KEY",
"recipient": {
"recipientKey": "RECIPIENT_KEY"
}
}
}'
{
"result": true,
"code": "200",
"message": "Recipient deleted"
}