Chilkat Online Tools

Node.js / Plivo REST API / Update an account phone number

Back to Collection Items

var os = require('os');
if (os.platform() == 'win32') {  
    if (os.arch() == 'ia32') {
        var chilkat = require('@chilkat/ck-node21-win-ia32');
    } else {
        var chilkat = require('@chilkat/ck-node21-win64'); 
    }
} else if (os.platform() == 'linux') {
    if (os.arch() == 'arm') {
        var chilkat = require('@chilkat/ck-node21-arm');
    } else if (os.arch() == 'x86') {
        var chilkat = require('@chilkat/ck-node21-linux32');
    } else {
        var chilkat = require('@chilkat/ck-node21-linux64');
    }
} else if (os.platform() == 'darwin') {
    if (os.arch() == 'arm64') {
        var chilkat = require('@chilkat/ck-node21-mac-m1');
    } else {
        var chilkat = require('@chilkat/ck-node21-macosx');
    }
}


function chilkatExample() {

    // This example assumes the Chilkat API to have been previously unlocked.
    // See Global Unlock Sample for sample code.

    var http = new chilkat.Http();
    var success;

    http.BasicAuth = true;
    http.Login = "{{auth_id}}";
    http.Password = "password";

    // Use this online tool to generate code from sample JSON: Generate Code to Create JSON

    // The following JSON is sent in the request body.

    // {
    //   "app_id": "77494029089751836",
    //   "subaccount": "SAXXXXXXXXXX",
    //   "alias": "Updated Alias"
    // }

    var json = new chilkat.JsonObject();
    json.UpdateString("app_id","77494029089751836");
    json.UpdateString("subaccount","SAXXXXXXXXXX");
    json.UpdateString("alias","Updated Alias");

    // resp: HttpResponse
    var resp = http.PostJson3("https://api.plivo.com/v1/Account/<auth_id>/Number/{number}/","application/json",json);
    if (http.LastMethodSuccess == false) {
        console.log(http.LastErrorText);
        return;
    }

    console.log(resp.StatusCode);
    console.log(resp.BodyStr);


}

chilkatExample();

Curl Command

curl -X POST
	-u '{{auth_id}}:password'
	-d '{
    "app_id": "77494029089751836",
    "subaccount": "SAXXXXXXXXXX",
    "alias": "Updated Alias"
}'
https://api.plivo.com/v1/Account/<auth_id>/Number/{number}/

Postman Collection Item JSON

{
  "name": "Update an account phone number",
  "request": {
    "method": "POST",
    "header": [
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n    \"app_id\": \"77494029089751836\",\n    \"subaccount\": \"SAXXXXXXXXXX\",\n    \"alias\": \"Updated Alias\"\n}",
      "options": {
        "raw": {
          "language": "json"
        }
      }
    },
    "url": {
      "raw": "https://api.plivo.com/v1/Account/{{auth_id}}/Number/{number}/",
      "protocol": "https",
      "host": [
        "api",
        "plivo",
        "com"
      ],
      "path": [
        "v1",
        "Account",
        "{{auth_id}}",
        "Number",
        "{number}",
        ""
      ]
    },
    "description": "Change the application and sub-account associated to specified phone number from your account.\n\nBelow is the list of arguments that can be passed in this API request, more information can be found [here](https://www.plivo.com/docs/numbers/api/account-phone-number#update-a-number)\n\n| Arguments   | Description | Required/Conditional/Optional     |\n| :---        |    :----:   |          ---: |\n| app_id      | The application to be assigned to the phone number. If not specified, the application selected as the default_number_app of the Account is assigned. For more information, refer default_number_app argument in [application](https://www.plivo.com/docs/account/api/application/#create-an-application) and app_id attribute in [application object](https://www.plivo.com/docs/account/api/application#the-application-object)| Optional  |\n| subaccount      | The auth_id of the subaccount to which this number should be added. This can be performed only by the main account.| Optional  |\n| alias      | An alias assigned to the phone number.| Optional  |"
  },
  "response": [
  ]
}