Update account

PATCH 
/clients/accounts/:id

JSON-RPC

clients.accounts.update

info

All parameters except id are optional, only provided parameters will be updated.

Request

Path Parameters

id integerrequired

Account ID.

application/json

Bodyrequired

clients_idintegerrequired
Client ID.
namestringrequired
Name.
Possible values: <= 64 characters
auth_typestringrequired
Type of identification.
Possible values: [name, ip, ani]
notesstring | nullnullable
Notes.
Default value: null
orig_tagsstring[]
Origination: tag(s) that are assigned to the event originated by the account.
Default value: []
term_tagsstring[]
Termination: tag(s) that are assigned to the event terminated by the account.
Default value: []
tech_prefixstring | nullnullable
Technical prefix. Checked against the prefix of the dst_party_id in the xDR. Stripped from the dst_party_id on successful match.
Possible values: <= 64 characters
Default value: null
anistring | nullnullable
Identification: ANI. Required when auth_type is ani.
Possible values: <= 64 characters
Default value: null
accnamestring | nullnullable
Identification: name. Required when auth_type is name.
Possible values: <= 128 characters
Default value: null
passwordstring | nullnullable
Identification: password. Used with name auth type. Should be supported by the equipment. Typically used when registration of the account is done via billing system.
Possible values: <= 256 characters
Default value: null
orig_enabledboolean
Origination: if True, the account is allowed to originate events (calls).
Default value: false
orig_capacityinteger | nullnullable
Origination: concurrent channels capacity.
Possible values: >= 0 and <= 2147483647
Default value: null
orig_rate_tables_idsinteger[]nullable
Origination: rate table ID(s). If not given, the rate tables of the client are used.
Default value: null
routing_plans_idinteger | nullnullable
Origination: routing plan ID. If not given, the routing plan of the client is used.
Default value: null
term_enabledboolean
Termination: if True, the account is allowed to terminate events (calls).
Default value: false
term_capacityinteger | nullnullable
Termination: concurrent channels capacity.
Possible values: >= 0 and <= 2147483647
Default value: null
term_rate_tables_idsinteger[]nullable
Termination: rate table ID(s). If not given, the rate tables of the client are used.
Default value: null
protocolstring | nullnullable
Termination: protocol. Should be supported by the equipment.
Possible values: <= 64 characters
Default value: null
portstring | nullnullable
Termination: port. Should be supported by the equipment.
Possible values: <= 64 characters
Default value: null
proxy_modeinteger
Termination: proxy mode. Should be supported by the equipment.
Possible values: >= 0 and <= 7
Default value: 1
ipscidr[]
Identification: IP address(es). Required when auth_type is ip.
Default value: []
equipment_idsinteger[]
Identification: Equipment ID(s) on which the account is allowed to be used.
Default value: []

Responses

200

Number of the affected rows.

application/json

Schema

Schema

integerinteger

400

The request contains invalid arguments or is malformed

application/json

Schema

Schema

error object
messagestring
Error message
Example: Invalid request
dataobject
Details for validation errors (if applicable)
Example: {"name":"Empty value is not allowed","payment_terms_id":"Object \"payment_terms(123)\" was not found!"}

Example (auto)

{
  "error": {
    "message": "Invalid request",
    "data": {
      "name": "Empty value is not allowed",
      "payment_terms_id": "Object \"payment_terms(123)\" was not found!"
    }
  }
}

401

Access is not authorized

application/json

Schema

Schema

error object
messagestring
Example: utoken-auth-failed: Authentication Failed: IP 10.0.0.1 is not allowed
data object
codestring
Error code
Example: utoken-auth-failed
messagestring
Example: Authentication Failed: IP 10.0.0.1 is not allowed

Example (auto)

{
  "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"
    }
  }
}

404

Requested object was not found

application/json

Schema

Schema

error object
messagestring
Example: not_found: Object "clients(123)" was not found!
data object
codestring
Error code (static: not_found)
Example: not_found
messagestring
Error message
Example: Object "clients(123)" was not found!
object_namestring
Type of the object
Example: clients
object_idstring
ID of the object
Example: 123

Example (auto)

{
  "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"
    }
  }
}

422

A logical error occurred, making the request unprocessable

application/json

Schema

Schema

error object
messagestring
Error message
Example: invoices-zero-amount: Impossible to create an invoice with zero amount
data object
codestring
Error code
Example: invoices-zero-amount
messagestring
Error message
Example: Impossible to create an invoice with zero amount

Example (auto)

{
  "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"
    }
  }
}

500

An unexpected error occurred

application/json

Schema

Schema

error object
messagestring
Error message
Example: An unexpected error occurred

Example (auto)

{
  "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 PATCH 'https://docs.jerasoft.net/clients/accounts/:id' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'X-Api-Key: <X-Api-Key>'

Request Collapse all

Auth

ApiKeyAuth

Parameters

id — pathrequired

Body required

{
  "clients_id": 0,
  "name": "string",
  "auth_type": "name",
  "orig_tags": [
    "string"
  ],
  "term_tags": [
    "string"
  ],
  "orig_enabled": false,
  "term_enabled": false,
  "proxy_mode": 1,
  "ips": [
    "string"
  ],
  "equipment_ids": [
    0
  ]
}