curl -X POST 'https://api.sendforsign.com/api/placeholder' \
     -H 'Authorization: Bearer 123456789' \
     -H 'Content-Type: application/json' \
     -d '{
    "data": {
        "action": "create",
        "contractKey": "CONTRACT_KEY",
        "placeholder": {
            "name": "Placeholder name",
            "value": "Placeholder value"
        }
    }
}'

{
    "placeholder": {
        "id": "3",
        "createTime": "2024-11-22T11:11:24.000Z",
        "changeTime": "2024-11-22T11:11:24.000Z",
        "name": "1",
        "value": "hello",
        "type": "1",
        "placeholderKey": "PLACEHOLER_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

​
action
string
required

Action type.

​
contractKey
string
required

ID of the contract.

​
placeholder
required

Structure, add the fields that need to be updated and ignore the rest.

​
Response

​
placeholder
string

Placeholder structure.

​
code
string

The code of the answer.

​
message
string

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": "create",
        "contractKey": "CONTRACT_KEY",
        "placeholder": {
            "name": "Placeholder name",
            "value": "Placeholder value"
        }
    }
}'

{
    "placeholder": {
        "id": "3",
        "createTime": "2024-11-22T11:11:24.000Z",
        "changeTime": "2024-11-22T11:11:24.000Z",
        "name": "1",
        "value": "hello",
        "type": "1",
        "placeholderKey": "PLACEHOLER_KEY",
        "position": "3"
    },
    "code": 201,
    "message": "Placeholder created"
}
Download WordUpdate placeholder