SIP-Accounts

Update a SIP account

Updates a SIP account by its id (display token). Only the fields sent are changed; omitted fields keep their current values, including the authentication method, IPs and the assigned Dynamic Caller ID rules. When dynamic_caller_ids is sent it replaces the assigned rules (same format as on create). Sending password (and optionally username) changes the SIP credentials; sending jwt_signature_secret replaces the JWT signature secret. Accounts provisioned by CommPeak (editable false) only allow changing the name, channel limit, tech prefix, features and Caller ID rules. Returns 422 with errors when the update is rejected.

put/sip_accounts/{id}

Request

Base URL
https://api.commpeak.com/portal
URL
https://api.commpeak.com/portal/sip_accounts/{id}
Auth
API key in header Authorization

Path parameters

idstring required

SIP account display token.

Request body

Example request

{
  "sip_account": {
    "auth_ips": [
      "192.0.2.10"
    ],
    "auth_type": "ip",
    "channel_limit": 10,
    "dynamic_caller_ids": [
      {
        "id": 12
      },
      {
        "action": "fixed",
        "caller_id_number": "12125551234",
        "condition": "country",
        "prefix": "1"
      }
    ],
    "name": "demo"
  }
}

Response

Successful Response

Example response

{
  "sip_account": {
    "active": true,
    "auth_method": "password",
    "auto_nat_fix": true,
    "caller_id_fixing": false,
    "channel_limit": 3,
    "default_tech_prefix": "021001",
    "dynamic_caller_ids": [
      12
    ],
    "editable": true,
    "id": "2BZgTQS4X0qaUEHt4YF-oQ",
    "ip_acl": [
      "192.0.2.10"
    ],
    "jwt_enabled": false,
    "name": "demo",
    "out_of_balance_message": true,
    "username": "demo"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.