Skip to main content

Create client template

POST 

/clients/templates

JSON-RPC

clients.templates.create

Request​

Bodyrequired

    namestringrequired

    Name.

    Possible values: <= 255 characters

    companies_idintegerrequired

    Partition ID.

    creditdecimalrequired

    Origination: allowed credit limit for prepaid clients.

    Possible values: >= -999999999 and <= 999999999

    tagsstring[]

    Tag(s).

    Default value: []
    orig_rate_tables_idsinteger[]

    Origination: rate table ID(s). If empty, the rate tables of the accounts are used.

    Default value: []
    routing_plans_idinteger | nullnullable

    Origination: routing plan ID. If not given, the routing plans of the accounts are used.

    Default value: null
    orig_capacityinteger | nullnullable

    Origination: concurrent channels capacity.

    Possible values: >= 0 and <= 2147483647

    Default value: null
    orig_low_balance_profiles_idinteger | nullnullable

    Origination: low balance profile ID.

    Default value: null
    low_balance_capacitydecimalnullable

    Origination: low balance threshold to enforce capacity limitation.

    Default value: null
    low_balance_capacity_valueinteger | nullnullable

    Origination: capacity limit after reaching low balance threshold.

    Possible values: >= 0 and <= 65535

    Default value: null

Responses​

Client template object as has been stored.

Schema
    objectobject

Authorization: X-Api-Key

name: X-Api-Keytype: apiKeyin: headerdescription: Token for API access
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>'
Request Collapse all
Auth
Body required
{
  "name": "string",
  "companies_id": 0,
  "credit": 0,
  "tags": [
    "string"
  ],
  "orig_rate_tables_ids": [
    0
  ]
}