{"_id":"57624357653c2d2200fec7e6","category":{"_id":"57624356653c2d2200fec7a6","__v":0,"project":"55c8cff571d7580d0063a5e5","version":"57624356653c2d2200fec79c","sync":{"url":"","isSync":false},"reference":true,"createdAt":"2016-03-29T05:00:50.119Z","from_sync":false,"order":21,"slug":"account-numbers","title":"Account Phone Numbers"},"editedParams2":true,"editedParams":true,"parentDoc":null,"project":"55c8cff571d7580d0063a5e5","version":{"_id":"57624356653c2d2200fec79c","__v":20,"project":"55c8cff571d7580d0063a5e5","createdAt":"2016-06-16T06:12:38.244Z","releaseDate":"2016-06-16T06:12:38.244Z","categories":["57624356653c2d2200fec79d","57624356653c2d2200fec79e","57624356653c2d2200fec79f","57624356653c2d2200fec7a0","57624356653c2d2200fec7a1","57624356653c2d2200fec7a2","57624356653c2d2200fec7a3","57624356653c2d2200fec7a4","57624356653c2d2200fec7a5","57624356653c2d2200fec7a6","57624356653c2d2200fec7a7","57624356653c2d2200fec7a8","57624356653c2d2200fec7a9","57624356653c2d2200fec7aa","5779ca1b99b40b0e005abb3a","5779d198aea88b0e00f63277","5797d3ab17ced017003c4be4","57ac170ef1cdae0e0053cdfc","57dbfc723ed3450e00dc9e6d","5804d12d16161c0f0077df9b","5841064b652e5b0f0015a7c8","588b5e5f2966b2230009cbf9","58a68ebf3239fa0f00857619","58c23c8b4922930f0050ac91","58fd1460809fc30f00f2ee07","5934eaf5328680002d77de6a","594bf91601cfe6000f40f4c5","595c4ed696b447001ba0cf6d","596524495cee50001575f5be","5970d4f1313162004dd303b5","59780fac24dbd1001a1fa057","59a8cfd3ead78a002d63cafe","59e0323d93da1f001c9ec170"],"is_deprecated":false,"is_hidden":false,"is_beta":true,"is_stable":true,"codename":"","version_clean":"4.0.0","version":"4"},"__v":2,"user":"571fcfeea0acd42000af95be","updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-04-28T19:38:19.601Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[{"language":"php","code":"<?php\n$client = new \\GuzzleHttp\\Client([\n    'base_uri' => 'https://api.phone.com/v4/',\n    'headers' => ['Authorization' => \"Bearer $token\"]\n]);\n$response = $client->put('accounts/123/phone-numbers/456', ['json' => [\n    'pool_item' => [\n        'number' => '+15303616862'\n    ],\n    'name' => 'Bobby Joe',\n    'route' => [\n        'id' => 123\n    ],\n    'block_incoming' => true,\n    'block_anonymous' => false,\n    'caller_id' => [\n        'name' => 'Ryker',\n        'type' => 'personal'\n    ],\n    'sms_forwarding' => [\n        'type' => 'extension',\n        'extension' => 2664\n    ],\n    'call_notifications' => [\n        'emails' => ['minnie:::at:::mouse.com', 'star@wars.com'],\n        'sms' => '+16197740222'\n    ]\n]]);"}]},"method":"put","results":{"codes":[{"name":"","code":"{\n    \"id\": 6,\n    \"name\": \"Bobby\",\n    \"number\": \"+15303616862\",\n    \"block_incoming\": true,\n    \"block_anonymous\": false,\n    \"route\": {\n        \"id\": 3242342,\n        \"name\": \"Call center\"\n    },\n    \"caller_id\": {\n        \"name\": \"Bobby Joe\",\n        \"type\": \"business\"\n    },\n    \"sms_forwarding\": {\n        \"enabled\": true,\n        \"type\": \"extension\",\n        \"extension\": {\n            \"id\": 36,\n            \"name\": \"Snufflupagus\",\n            \"extension\": 987\n        }\n    },\n    \"call_notifications\": {\n        \"emails\": [\n          \t\"bobby@example.com\"\n        ],\n        \"sms\": \"+15557740222\"\n    }\n}","language":"json","status":200}]},"settings":"","auth":"required","params":[{"_id":"56fae7e0283ee90e004acaef","ref":"","in":"path","required":false,"desc":"Account ID","default":"","type":"int","name":"account_id"},{"_id":"5722685fecdfb819006bdb7c","ref":"","in":"path","required":false,"desc":"Number ID","default":"","type":"int","name":"number_id"},{"_id":"57224b4becdfb819006bdaf5","ref":"","in":"body","required":false,"desc":"Phone Name","default":"","type":"string","name":"name"},{"_id":"572247cdecdfb819006bdaea","ref":"","in":"body","required":false,"desc":"Route lookup object","default":"","type":"object","name":"route"},{"_id":"57224b4becdfb819006bdaf4","ref":"","in":"body","required":false,"desc":"Block incoming calls","default":"","type":"boolean","name":"block_incoming"},{"_id":"57224b4becdfb819006bdaf3","ref":"","in":"body","required":false,"desc":"Block anonymous cals","default":"","type":"boolean","name":"block_anonymous"},{"_id":"57224d08dcfa860e005bf086","ref":"","in":"body","required":false,"desc":"Caller ID name","default":"","type":"string","name":"caller_id[name]"},{"_id":"57224d08dcfa860e005bf085","ref":"","in":"body","required":false,"desc":"Caller ID type","default":"business","type":"string","name":"caller_id[type]"},{"_id":"5779c9f650ffec0e00ca56df","ref":"","in":"body","required":false,"desc":"\"application\" or \"extension\"","default":"","type":"string","name":"sms_forwarding[type]"},{"_id":"57224f93dcfa860e005bf093","ref":"","in":"body","required":false,"desc":"Application lookup object","default":"","type":"object","name":"sms_forwarding[application]"},{"_id":"57225e46dcfa860e005bf0b4","ref":"","in":"body","required":false,"desc":"Extension lookup object","default":"","type":"object","name":"sms_forwarding[extension]"},{"_id":"57225f233926280e00c92458","ref":"","in":"body","required":false,"desc":"Pool lookup object","default":"","type":"object","name":"pool_item"},{"_id":"5723c13f0426380e00a1a856","ref":"","in":"body","required":false,"desc":"Call notifications for emails.  Can be a single email or an array of emails","default":"","type":"mixed","name":"call_notifications[emails]"},{"_id":"5723c13f0426380e00a1a855","ref":"","in":"body","required":false,"desc":"Call notification for SMS","default":"","type":"string","name":"call_notifications[sms]"}],"url":"/accounts/:account_id/phone-numbers/:number_id"},"isReference":true,"order":4,"body":"See [Intro to Account Phone Numbers](doc:account-phone-numbers) for more info on the properties.\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Settings only\",\n  \"body\": \"This service is for updating the settings on an existing phone number.  You can't use it to replace one phone number with another.  If you need to do that, you may use our [Create Phone Number](doc:create-account-phone-number) service to add a new one, and then use our Control Panel to delete the one you no longer want.\"\n}\n[/block]","excerpt":"Update the settings for an existing phone number on your account. See [Account Phone Numbers](doc:account-phone-numbers) for more info on the properties.","slug":"replace-account-phone-number","type":"endpoint","title":"Replace Phone Number"}

putReplace Phone Number

Update the settings for an existing phone number on your account. See [Account Phone Numbers](doc:account-phone-numbers) for more info on the properties.

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

account_id:
integer
Account ID
number_id:
integer
Number ID

Body Params

name:
string
Phone Name
route:
object
Route lookup object
block_incoming:
boolean
Block incoming calls
block_anonymous:
boolean
Block anonymous cals
caller_id[name]:
string
Caller ID name
caller_id[type]:
stringbusiness
Caller ID type
sms_forwarding[type]:
string
"application" or "extension"
sms_forwarding[application]:
object
Application lookup object
sms_forwarding[extension]:
object
Extension lookup object
pool_item:
object
Pool lookup object
call_notifications[emails]:
mixed
Call notifications for emails. Can be a single email or an array of emails
call_notifications[sms]:
string
Call notification for SMS

Examples


Result Format


Documentation

See [Intro to Account Phone Numbers](doc:account-phone-numbers) for more info on the properties. [block:callout] { "type": "info", "title": "Settings only", "body": "This service is for updating the settings on an existing phone number. You can't use it to replace one phone number with another. If you need to do that, you may use our [Create Phone Number](doc:create-account-phone-number) service to add a new one, and then use our Control Panel to delete the one you no longer want." } [/block]

User Information

Try It Out

put
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}