Skip to main content
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",
        "placeholders": [
            {
                "placeholderKey": "RECIPIENT_KEY_4",
                "isSpecial": true,
                "specialType": 4,
                "insertion": [
                    {
                        "action": "update",
                        "clientKey": "YOUR_CLIENT_KEY",
                        "id": 2,
                        "pageId": 0,
                        "width": 150,
                        "height": 150,
                        "positionX": 1,
                        "positionY": 1
                    }
                ]
            }
        ]
    }
}'

{
    "code": 201,
    "message": "Placeholder updated"
}
Special placeholders are four types of placeholders that are created automatically for every recipient. So, before placing special fields in your PDF contract, create a recipient using this request. After this, all the special placeholders will be created automatically with corresponding keys: Recipient_Key_1, Recipient_Key_2, Recipient_Key_3, Recipient_Key_4. Here’s an example of a placeholder key: "placeholderKey": "93447fb5-91ee-41ad-9f73-b4ae2d467292_4". Available placeholder codes:
  • 1: Recipient’s date signed.
  • 2: Recipient’s full name.
  • 3: Recipient’s email.
  • 4: Recipient’s signature.

​
Body parameters

​
data
object
required

​
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 'X-Sendforsign-Key: YOUR_API_KEY' \
     -H 'Content-Type: application/json' \
     -d '{
    "data": {
        "action": "update",
        "clientKey": "YOUR_CLIENT_KEY",
        "contractKey": "CONTRACT_KEY",
        "placeholders": [
            {
                "placeholderKey": "RECIPIENT_KEY_4",
                "isSpecial": true,
                "specialType": 4,
                "insertion": [
                    {
                        "action": "update",
                        "clientKey": "YOUR_CLIENT_KEY",
                        "id": 2,
                        "pageId": 0,
                        "width": 150,
                        "height": 150,
                        "positionX": 1,
                        "positionY": 1
                    }
                ]
            }
        ]
    }
}'

{
    "code": 201,
    "message": "Placeholder updated"
}