Chilkat Online Tools

Swift / Plivo REST API / Update a Subaccount

Back to Collection Items

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

    let http = CkoHttp()
    var success: Bool

    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.

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

    let json = CkoJsonObject()
    json.UpdateString("name", value: "Name of SubAccount")
    json.UpdateString("enabled", value: "false")

    var resp: CkoHttpResponse? = http.PostJson3("https://api.plivo.com/v1/Account/<auth_id>/Subaccount/{subauth_id}/", contentType: "application/json", json: json)
    if http.LastMethodSuccess == false {
        print("\(http.LastErrorText)")
        return
    }

    print("\(resp!.StatusCode.intValue)")
    print("\(resp!.BodyStr)")
    resp = nil

}

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}"
    }
  ]
}