API Documentation
MCP
Contract
PDF and Word
Placeholder
Template
Place basic placeholder
Place a basic placeholder in a PDF contract.
curl -X POST 'https://api.sendforsign.com/api/placeholder' \
-H 'Authorization: Bearer 123456789' \
-H 'Content-Type: application/json' \
-d '{
"data": {
"action": "update",
"contractKey": "CONTRACT_KEY",
"placeholders": [
{
"placeholderKey": "PLACEHOLDER_KEY",
"insertion": [
{
"action": "update",
"id": 0,
"pageId": 0,
"width": 100,
"height": 100,
"positionX": 1,
"positionY": 1
}
]
}
]
}
}'
{
"code": 201,
"message": "Placeholder updated"
}
Basic placeholders are text placeholders that can be used to fill in HTML and PDF contracts. Additionally, they can be linked to any recipient afterward.
Before placing placeholders in a PDF, you need to create them in advance.
Body parameters
Action type.
ID of the contract.
Array of placeholders.
Show child attribute
Show child attribute
Key of the placeholder that needs to be updated.
Array of places.
Show child attribute
Show child attribute
ID of the insertion. Provide a new ID for each insertion. If you provide the ID of an existing placeholder, the placeholder will be updated.
Page number where you insert the placeholder, starting from 0.
Width of the placeholder.
Height of the placeholder.
Position X of the placeholder, starting from the top-left corner of the page.
Position Y of the placeholder, starting from the top-left corner of the page.
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": "update",
"contractKey": "CONTRACT_KEY",
"placeholders": [
{
"placeholderKey": "PLACEHOLDER_KEY",
"insertion": [
{
"action": "update",
"id": 0,
"pageId": 0,
"width": 100,
"height": 100,
"positionX": 1,
"positionY": 1
}
]
}
]
}
}'
{
"code": 201,
"message": "Placeholder updated"
}
curl -X POST 'https://api.sendforsign.com/api/placeholder' \
-H 'Authorization: Bearer 123456789' \
-H 'Content-Type: application/json' \
-d '{
"data": {
"action": "update",
"contractKey": "CONTRACT_KEY",
"placeholders": [
{
"placeholderKey": "PLACEHOLDER_KEY",
"insertion": [
{
"action": "update",
"id": 0,
"pageId": 0,
"width": 100,
"height": 100,
"positionX": 1,
"positionY": 1
}
]
}
]
}
}'
{
"code": 201,
"message": "Placeholder updated"
}