Chilkat Online Tools

delphiDll / Plivo REST API / Update the account details

Back to Collection Items

var
http: HCkHttp;
success: Boolean;
json: HCkJsonObject;
resp: HCkHttpResponse;

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

http := CkHttp_Create();

CkHttp_putBasicAuth(http,True);
CkHttp_putLogin(http,'{{auth_id}}');
CkHttp_putPassword(http,'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.

// {
//   "address": "Test address",
//   "name": "Test name",
//   "city": "Test city",
//   "state": "Test state",
//   "timezone": "Test timezone"
// }

json := CkJsonObject_Create();
CkJsonObject_UpdateString(json,'address','Test address');
CkJsonObject_UpdateString(json,'name','Test name');
CkJsonObject_UpdateString(json,'city','Test city');
CkJsonObject_UpdateString(json,'state','Test state');
CkJsonObject_UpdateString(json,'timezone','Test timezone');

resp := CkHttp_PostJson3(http,'https://api.plivo.com/v1/Account/<auth_id>/','application/json',json);
if (CkHttp_getLastMethodSuccess(http) = False) then
  begin
    Memo1.Lines.Add(CkHttp__lastErrorText(http));
    Exit;
  end;

Memo1.Lines.Add(IntToStr(CkHttpResponse_getStatusCode(resp)));
Memo1.Lines.Add(CkHttpResponse__bodyStr(resp));
CkHttpResponse_Dispose(resp);

CkHttp_Dispose(http);
CkJsonObject_Dispose(json);

Curl Command

curl -X POST
	-u '{{auth_id}}:password'
	-d '{
    "address": "Test address", // Postal address of the account which will be displayed in the invoices
    "name": "Test name", // Name of the account holder.
    "city": "Test city", // City of the account holder.
    "state": "Test state", // State or region of the account.
    "timezone": "Test timezone" // The time zone used in the Plivo dashboard for this account
}'
https://api.plivo.com/v1/Account/<auth_id>/

Postman Collection Item JSON

{
  "name": "Update the account details",
  "request": {
    "method": "POST",
    "header": [
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n    \"address\": \"Test address\", // Postal address of the account which will be displayed in the invoices\n    \"name\": \"Test name\", // Name of the account holder.\n    \"city\": \"Test city\", // City of the account holder.\n    \"state\": \"Test state\", // State or region of the account.\n    \"timezone\": \"Test timezone\" // The time zone used in the Plivo dashboard for this account\n}",
      "options": {
        "raw": {
          "language": "json"
        }
      }
    },
    "url": {
      "raw": "https://api.plivo.com/v1/Account/{{auth_id}}/",
      "protocol": "https",
      "host": [
        "api",
        "plivo",
        "com"
      ],
      "path": [
        "v1",
        "Account",
        "{{auth_id}}",
        ""
      ]
    },
    "description": "Updates the Account object by setting the values of the parameters passed. Parameters which are not provided will remain unchanged.\nThis request accepts only the name, city, state, timezone and address as parameters.\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/account/api/account#update-account-details)\n\n| Arguments   | Description | Required/Conditional/Optional     |\n| :---        |    :----:   |          ---: |\n| address      | Set this parameter to the sender ID you wish to use. This could a phone number, shortcode or alphanumeric string.| Conditional  |\n| name   | Name of the account holder.       | Required      |\n| city   | City of the account holder. | Optional |\n| state   | State or region of the account.        | Optional     |\n| timezone   | The time zone used in the Plivo dashboard for this account. A list of possible time zone values is maintained at the [IANA Time Zone Database](https://www.iana.org/time-zones).        | Optional      |"
  },
  "response": [
    {
      "name": "Update the account details",
      "originalRequest": {
        "method": "POST",
        "header": [
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"address\": \"Test address\", // Postal address of the account which will be displayed in the invoices\n    \"name\": \"Test name\", // Name of the account holder.\n    \"city\": \"Test city\", // City of the account holder.\n    \"state\": \"Test state\", // State or region of the account.\n    \"timezone\": \"Test timezone\" // The time zone used in the Plivo dashboard for this account\n}",
          "options": {
            "raw": {
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "https://api.plivo.com/v1/Account/{{auth_id}}/",
          "protocol": "https",
          "host": [
            "api",
            "plivo",
            "com"
          ],
          "path": [
            "v1",
            "Account",
            "{{auth_id}}",
            ""
          ]
        }
      },
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
      ],
      "cookie": [
      ],
      "body": "{\n    \"api_id\": \"02bbdbaa-9303-11e7-8bc8-065f6a74a84a\",\n    \"message\": \"changed\"\n}"
    }
  ]
}