COcommpeak
Dynamic-Caller-IDs

Update a Dynamic Caller ID rule

Updates a Dynamic Caller ID rule by its id. Only the fields sent are changed. SIP accounts using the rule are updated with the change. The same restrictions as on create apply.

put/dynamic_caller_ids/{id}

Request

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

Path parameters

idinteger required

Dynamic Caller ID rule identifier.

Request body

Example request

{
  "dynamic_caller_id": {
    "action": "fixed",
    "caller_id_number": "12125551234",
    "condition": "country",
    "name": "USA",
    "prefix": "1"
  }
}

Response

Successful Response

Example response

{
  "dynamic_caller_id": {
    "action": "fixed",
    "caller_id_name": "John Doe",
    "caller_id_number": "12125551234",
    "condition": "country",
    "id": 12,
    "name": "USA",
    "prefix": "1",
    "sip_accounts": [
      "2BZgTQS4X0qaUEHt4YF-oQ"
    ],
    "verified": true
  }
}

Changes

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