Chilkat Online Tools

Ruby / Plivo REST API / Delete a Subaccount

Back to Collection Items

require 'chilkat'

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

http = Chilkat::CkHttp.new()

http.put_BasicAuth(true)
http.put_Login("{{auth_id}}")
http.put_Password("password")

# resp is a CkHttpResponse
resp = http.QuickRequest("DELETE","https://api.plivo.com/v1/Account/<auth_id>/Subaccount/{subauth_id}/")
if (http.get_LastMethodSuccess() == false)
    print http.lastErrorText() + "\n";
    exit
end

print resp.get_StatusCode().to_s() + "\n";
print resp.bodyStr() + "\n";

Curl Command

curl -X DELETE
	-u '{{auth_id}}:password'
https://api.plivo.com/v1/Account/<auth_id>/Subaccount/{subauth_id}/

Postman Collection Item JSON

{
  "name": "Delete a Subaccount",
  "request": {
    "method": "DELETE",
    "header": [
    ],
    "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": "Permanently delete a Subaccount. This also associates all Numbers, Endpoints and Applications that were linked to the deleted subaccount to the main Plivo 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/account/api/subaccount#delete-a-subaccount)\n\n| Arguments   | Description | Required/Conditional/Optional     |\n| :---        |    :----:   |          ---: |\n| cascade      | If cascade is set to true, the Applications, Endpoints, and Numbers associated with the Subaccount are also deleted. When set to false, the Applications, Endpoints, and Numbers are mapped with the main account.cascade is set to false by default when not specified.| Optional  |"
  },
  "response": [
    {
      "name": "Delete a Subaccount",
      "originalRequest": {
        "method": "DELETE",
        "header": [
        ],
        "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": 201,
      "_postman_previewlanguage": "Text",
      "header": [
      ],
      "cookie": [
      ],
      "body": ""
    }
  ]
}