Chilkat Online Tools

PowerBuilder / Plivo REST API / Update a Subaccount

Back to Collection Items

integer li_rc
oleobject loo_Http
integer li_Success
oleobject loo_Json
oleobject loo_Resp

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

loo_Http = create oleobject
li_rc = loo_Http.ConnectToNewObject("Chilkat_9_5_0.Http")
if li_rc < 0 then
    destroy loo_Http
    MessageBox("Error","Connecting to COM object failed")
    return
end if

loo_Http.BasicAuth = 1
loo_Http.Login = "{{auth_id}}"
loo_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.

// {
//   "name": "Name of SubAccount",
//   "enabled": "false"
// }

loo_Json = create oleobject
li_rc = loo_Json.ConnectToNewObject("Chilkat_9_5_0.JsonObject")

loo_Json.UpdateString("name","Name of SubAccount")
loo_Json.UpdateString("enabled","false")

loo_Resp = loo_Http.PostJson3("https://api.plivo.com/v1/Account/<auth_id>/Subaccount/{subauth_id}/","application/json",loo_Json)
if loo_Http.LastMethodSuccess = 0 then
    Write-Debug loo_Http.LastErrorText
    destroy loo_Http
    destroy loo_Json
    return
end if

Write-Debug string(loo_Resp.StatusCode)
Write-Debug loo_Resp.BodyStr
destroy loo_Resp


destroy loo_Http
destroy loo_Json

Curl Command

curl -X POST
	-u '{{auth_id}}:password'
	-d '{
    "name":"Name of SubAccount", // A human-readable name for the subaccount.
    "enabled":"false" // Specify if the subaccount should be enabled. Takes a value of true or false. Defaults to false.
}'
https://api.plivo.com/v1/Account/<auth_id>/Subaccount/{subauth_id}/

Postman Collection Item JSON

{
  "name": "Update a Subaccount",
  "request": {
    "method": "POST",
    "header": [
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n    \"name\":\"Name of SubAccount\", // A human-readable name for the subaccount.\n    \"enabled\":\"false\" // Specify if the subaccount should be enabled. Takes a value of true or false. Defaults to false.\n}",
      "options": {
        "raw": {
          "language": "json"
        }
      }
    },
    "url": {
      "raw": "https://api.plivo.com/v1/Account/{{auth_id}}/Subaccount/{subauth_id}/",
      "protocol": "https",
      "host": [
        "api",
        "plivo",
        "com"
      ],
      "path": [
        "v1",
        "Account",
        "{{auth_id}}",
        "Subaccount",
        "{subauth_id}",
        ""
      ]
    },
    "description": "Updates the account object by setting the values of the parameters passed. Parameters which are not provided will remain unchanged.\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/subaccount#update-a-subaccount)\n\n| Arguments   | Description | Required/Conditional/Optional     |\n| :---        |    :----:   |          ---: |\n| name      | A human-readable name for the subaccount | Required  |\n| enabled   | Specify if the subaccount should be enabled. Takes a value of true or false. Defaults to false.        | Optional      |"
  },
  "response": [
    {
      "name": "Update a Subaccount",
      "originalRequest": {
        "method": "POST",
        "header": [
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"name\":\"Name of SubAccount\", // A human-readable name for the subaccount.\n    \"enabled\":\"false\" // Specify if the subaccount should be enabled. Takes a value of true or false. Defaults to false.\n}",
          "options": {
            "raw": {
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "https://api.plivo.com/v1/Account/{{auth_id}}/Subaccount/{subauth_id}/",
          "protocol": "https",
          "host": [
            "api",
            "plivo",
            "com"
          ],
          "path": [
            "v1",
            "Account",
            "{{auth_id}}",
            "Subaccount",
            "{subauth_id}",
            ""
          ]
        }
      },
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
      ],
      "cookie": [
      ],
      "body": "{\n    \"message\": \"changed\",\n    \"api_id\": \"5a9fcb68-523d-11e1-86da-6ff39efcb949\"\n}"
    }
  ]
}