API Documentation
Contract
PDF and Word
Placeholder
Template
Client
Create client
Create a new client.
curl -X POST 'https://api.sendforsign.com/api/client' \
-H 'Authorization: Bearer 123456789' \
-H 'Content-Type: application/json' \
-d '{
"data": {
"action": "create",
"client": {
"fullname": "John Johnson",
"email": "john_johnson@mail.com",
"organization": "Company Inc.",
"customKey": "YOUR_COMBINATION",
"users": [{
"fullname": "John Johnson",
"email": "john_johnson@mail.com",
"customKey": "YOUR_COMBINATION"
}]
}
}
}'
{
"client": {
"createTime": "2023-12-01 12:18:55",
"clientKey": "CLIENT_KEY",
"users": [{
"createTime": "2023-12-01 12:18:55",
"default": true,
"userKey": "USER_KEY"
}]
},
"code": "201",
"message": "Client created"
}
All API calls related to the
/api/client endpoint require a Platform Bearer Token in the request header.Body parameters
Action type.
Structure, at least one of the fields must be filled.
First and second names of the client.
Email of the client.
Organization name.
Your custom key, if you don’t need to use any of the above fields.
Response
The code of the answer.
The message of the answer.
curl -X POST 'https://api.sendforsign.com/api/client' \
-H 'Authorization: Bearer 123456789' \
-H 'Content-Type: application/json' \
-d '{
"data": {
"action": "create",
"client": {
"fullname": "John Johnson",
"email": "john_johnson@mail.com",
"organization": "Company Inc.",
"customKey": "YOUR_COMBINATION",
"users": [{
"fullname": "John Johnson",
"email": "john_johnson@mail.com",
"customKey": "YOUR_COMBINATION"
}]
}
}
}'
{
"client": {
"createTime": "2023-12-01 12:18:55",
"clientKey": "CLIENT_KEY",
"users": [{
"createTime": "2023-12-01 12:18:55",
"default": true,
"userKey": "USER_KEY"
}]
},
"code": "201",
"message": "Client created"
}
curl -X POST 'https://api.sendforsign.com/api/client' \
-H 'Authorization: Bearer 123456789' \
-H 'Content-Type: application/json' \
-d '{
"data": {
"action": "create",
"client": {
"fullname": "John Johnson",
"email": "john_johnson@mail.com",
"organization": "Company Inc.",
"customKey": "YOUR_COMBINATION",
"users": [{
"fullname": "John Johnson",
"email": "john_johnson@mail.com",
"customKey": "YOUR_COMBINATION"
}]
}
}
}'
{
"client": {
"createTime": "2023-12-01 12:18:55",
"clientKey": "CLIENT_KEY",
"users": [{
"createTime": "2023-12-01 12:18:55",
"default": true,
"userKey": "USER_KEY"
}]
},
"code": "201",
"message": "Client created"
}