curl -X POST 'https://api.sendforsign.com/api/placeholder' \
-H 'X-Sendforsign-Key: YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{
"data": {
"action": "create",
"clientKey": "YOUR_CLIENT_KEY",
"contractKey": "CONTRACT_KEY",
"placeholder": {
"name": "Placeholder name",
"value": "Placeholder value",
"fillingType": 4,
"externalRecipientKey": "RECIPIENT_KEY"
}
}
}'
{
"placeholder": {
"id": "3",
"createTime": "2024-11-22T11:11:24.000Z",
"changeTime": "2024-11-22T11:11:24.000Z",
"name": "1",
"value": "hello",
"type": "1",
"placeholderKey": "PLACEHOLDER_KEY",
"position": "3"
},
"code": 201,
"message": "Placeholder created"
}
Placeholder
Create placeholder
Add a placeholder to a contract or template with the Sendforsign API, and choose who fills it in.
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": "create",
"clientKey": "YOUR_CLIENT_KEY",
"contractKey": "CONTRACT_KEY",
"placeholder": {
"name": "Placeholder name",
"value": "Placeholder value",
"fillingType": 4,
"externalRecipientKey": "RECIPIENT_KEY"
}
}
}'
{
"placeholder": {
"id": "3",
"createTime": "2024-11-22T11:11:24.000Z",
"changeTime": "2024-11-22T11:11:24.000Z",
"name": "1",
"value": "hello",
"type": "1",
"placeholderKey": "PLACEHOLDER_KEY",
"position": "3"
},
"code": 201,
"message": "Placeholder created"
}
One way to add placeholders to a contract is when you create a new contract.
See this page to learn more.
If a contract already exists, use the request below.
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
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.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": "create",
"clientKey": "YOUR_CLIENT_KEY",
"contractKey": "CONTRACT_KEY",
"placeholder": {
"name": "Placeholder name",
"value": "Placeholder value",
"fillingType": 4,
"externalRecipientKey": "RECIPIENT_KEY"
}
}
}'
{
"placeholder": {
"id": "3",
"createTime": "2024-11-22T11:11:24.000Z",
"changeTime": "2024-11-22T11:11:24.000Z",
"name": "1",
"value": "hello",
"type": "1",
"placeholderKey": "PLACEHOLDER_KEY",
"position": "3"
},
"code": 201,
"message": "Placeholder created"
}