Create client template
POST/clients/templates
clients.templates.create
Request​
- application/json
Bodyrequired
Name.
Possible values: <= 255 characters
Partition ID.
Origination: allowed credit limit for prepaid clients.
Possible values: >= -999999999
and <= 999999999
Tag(s).
[]
Origination: rate table ID(s). If empty, the rate tables of the accounts are used.
[]
Origination: routing plan ID. If not given, the routing plans of the accounts are used.
null
Origination: concurrent channels capacity.
Possible values: >= 0
and <= 2147483647
null
Origination: low balance profile ID.
null
Origination: low balance threshold to enforce capacity limitation.
null
Origination: capacity limit after reaching low balance threshold.
Possible values: >= 0
and <= 65535
null
Responses​
- 200
- 400
- 401
- 404
- 422
- 500
Client template object as has been stored.
- application/json
- Schema
- Example (auto)
Schema
{}
The request contains invalid arguments or is malformed
- application/json
- Schema
- Example (auto)
Schema
error object
{
"error": {
"message": "Invalid request",
"data": {
"name": "Empty value is not allowed",
"payment_terms_id": "Object \"payment_terms(123)\" was not found!"
}
}
}
Access is not authorized
- application/json
- Schema
- Example (auto)
Schema
error object
{
"error": {
"message": "utoken-auth-failed: Authentication Failed: IP 10.0.0.1 is not allowed",
"data": {
"code": "utoken-auth-failed",
"message": "Authentication Failed: IP 10.0.0.1 is not allowed"
}
}
}
Requested object was not found
- application/json
- Schema
- Example (auto)
Schema
error object
{
"error": {
"message": "not_found: Object \"clients(123)\" was not found!",
"data": {
"code": "not_found",
"message": "Object \"clients(123)\" was not found!",
"object_name": "clients",
"object_id": "123"
}
}
}
A logical error occurred, making the request unprocessable
- application/json
- Schema
- Example (auto)
Schema
error object
{
"error": {
"message": "invoices-zero-amount: Impossible to create an invoice with zero amount",
"data": {
"code": "invoices-zero-amount",
"message": "Impossible to create an invoice with zero amount"
}
}
}
An unexpected error occurred
- application/json
- Schema
- Example (auto)
Schema
error object
{
"error": {
"message": "An unexpected error occurred"
}
}
Authorization: X-Api-Key
name: X-Api-Keytype: apiKeyin: headerdescription: Token for API access
- curl
- python
- nodejs
- php
- CURL
curl -L -X POST 'https://docs.jerasoft.net/clients/templates' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'X-Api-Key: <X-Api-Key>'