Placeholder
List of placeholders
API Documentation
Contract
PDF and Word
Placeholder
Template
Placeholder
List of placeholders
Get a list of all placeholders created in a specific contract or template.
curl -X POST 'https://api.sendforsign.com/api/placeholder' \
-H 'Authorization: Bearer 123456789' \
-H 'Content-Type: application/json' \
-d '{
"data": {
"action": "list",
"contractKey": "CONTRACT_KEY",
"templateKey": "TEMPLATE_KEY"
}
}'
{
"placeholders": [
{
"id": "1",
"createTime": "2024-02-26T11:07:55.000Z",
"changeTime": "2024-02-26T11:07:59.000Z",
"name": "Placeholder Name",
"value": "Placeholder Value",
"placeholderKey": "PLACEHOLDER_KEY",
"position": 1
}
],
"code": "200",
"message": "Placeholders found"
}
Body parameters
Action type.
ID of the template. Use this parameter if you need to retrieve a template’s placeholders.
ID of the contract. Use this parameter if you need to retrieve a contract’s placeholders.
Response
The code of the answer.
The message of the answer.
curl -X POST 'https://api.sendforsign.com/api/placeholder' \
-H 'Authorization: Bearer 123456789' \
-H 'Content-Type: application/json' \
-d '{
"data": {
"action": "list",
"contractKey": "CONTRACT_KEY",
"templateKey": "TEMPLATE_KEY"
}
}'
{
"placeholders": [
{
"id": "1",
"createTime": "2024-02-26T11:07:55.000Z",
"changeTime": "2024-02-26T11:07:59.000Z",
"name": "Placeholder Name",
"value": "Placeholder Value",
"placeholderKey": "PLACEHOLDER_KEY",
"position": 1
}
],
"code": "200",
"message": "Placeholders found"
}
curl -X POST 'https://api.sendforsign.com/api/placeholder' \
-H 'Authorization: Bearer 123456789' \
-H 'Content-Type: application/json' \
-d '{
"data": {
"action": "list",
"contractKey": "CONTRACT_KEY",
"templateKey": "TEMPLATE_KEY"
}
}'
{
"placeholders": [
{
"id": "1",
"createTime": "2024-02-26T11:07:55.000Z",
"changeTime": "2024-02-26T11:07:59.000Z",
"name": "Placeholder Name",
"value": "Placeholder Value",
"placeholderKey": "PLACEHOLDER_KEY",
"position": 1
}
],
"code": "200",
"message": "Placeholders found"
}