curl -X POST 'https://api.sendforsign.com/api/placeholder' \
-H 'X-Sendforsign-Key: YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{
"data": {
"action": "update",
"clientKey": "YOUR_CLIENT_KEY",
"contractKey": "CONTRACT_KEY",
"placeholder": {
"placeholderKey": "PLACEHOLDER_KEY",
"name": "Name",
"value": "Value",
"fillingType": 4,
"externalRecipientKey": "RECIPIENT_KEY"
}
}
}'
{
"placeholder": {
"id": "1",
"createTime": "2024-03-14T20:34:08.000Z",
"changeTime": "2024-03-14T20:38:39.000Z",
"name": "Name",
"value": "Value",
"type": "1",
"placeholderKey": "PLACEHOLDER_KEY",
"position": null
},
"code": "201",
"message": "Placeholder updated"
}
Placeholder
Update placeholder
Update a placeholder’s name, value or who fills it in (fillingType) via the Sendforsign API.
POST
/
api
/
placeholder
curl -X POST 'https://api.sendforsign.com/api/placeholder' \
-H 'X-Sendforsign-Key: YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{
"data": {
"action": "update",
"clientKey": "YOUR_CLIENT_KEY",
"contractKey": "CONTRACT_KEY",
"placeholder": {
"placeholderKey": "PLACEHOLDER_KEY",
"name": "Name",
"value": "Value",
"fillingType": 4,
"externalRecipientKey": "RECIPIENT_KEY"
}
}
}'
{
"placeholder": {
"id": "1",
"createTime": "2024-03-14T20:34:08.000Z",
"changeTime": "2024-03-14T20:38:39.000Z",
"name": "Name",
"value": "Value",
"type": "1",
"placeholderKey": "PLACEHOLDER_KEY",
"position": null
},
"code": "201",
"message": "Placeholder updated"
}
Body parameters
object
required
Show child attribute
Show child attribute
string
required
Action type.
string
required
Key of the client.
string
required
Key of the contract.
object
required
Structure, add the fields that need to be updated and ignore the rest.
Show child attribute
Show child attribute
string
required
Key of the placeholder that needs to be updated.
string
Name of the placeholder
string
Value of the placeholder.
number
Who fills in this placeholder when the contract is shared (“Who fills in this field” in the editor):
1 — nobody (default), 2 — the contract owner, 4 — a specific recipient set in externalRecipientKey.
See the use case.string
recipientKey of the recipient who fills in this placeholder. Required when fillingType is 4.
Get it from the list of recipients. To unassign the recipient, send null together with "fillingType": 1; a field left out of the request keeps its current value.Response
string
The code of the answer.
string
The message of the answer.
curl -X POST 'https://api.sendforsign.com/api/placeholder' \
-H 'X-Sendforsign-Key: YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{
"data": {
"action": "update",
"clientKey": "YOUR_CLIENT_KEY",
"contractKey": "CONTRACT_KEY",
"placeholder": {
"placeholderKey": "PLACEHOLDER_KEY",
"name": "Name",
"value": "Value",
"fillingType": 4,
"externalRecipientKey": "RECIPIENT_KEY"
}
}
}'
{
"placeholder": {
"id": "1",
"createTime": "2024-03-14T20:34:08.000Z",
"changeTime": "2024-03-14T20:38:39.000Z",
"name": "Name",
"value": "Value",
"type": "1",
"placeholderKey": "PLACEHOLDER_KEY",
"position": null
},
"code": "201",
"message": "Placeholder updated"
}