Chilkat Online Tools

Objective-C / Plivo REST API / Create a Subaccount

Back to Collection Items

#import <CkoHttp.h>
#import <CkoJsonObject.h>
#import <CkoHttpResponse.h>

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

CkoHttp *http = [[CkoHttp alloc] init];
BOOL success;

http.BasicAuth = YES;
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"
// }

CkoJsonObject *json = [[CkoJsonObject alloc] init];
[json UpdateString: @"name" value: @"Name of SubAccount"];
[json UpdateString: @"enabled" value: @"false"];

CkoHttpResponse *resp = [http PostJson3: @"https://api.plivo.com/v1/Account/<auth_id>/Subaccount/" contentType: @"application/json" json: json];
if (http.LastMethodSuccess == NO) {
    NSLog(@"%@",http.LastErrorText);
    return;
}

NSLog(@"%d",[resp.StatusCode intValue]);
NSLog(@"%@",resp.BodyStr);

Curl Command

curl -X POST
	-u '{{auth_id}}:password'
	-d '{
    "name":"Name of SubAccount", 
    "enabled":"false" 
}'
https://api.plivo.com/v1/Account/<auth_id>/Subaccount/

Postman Collection Item JSON

{
  "name": "Create a Subaccount",
  "request": {
    "method": "POST",
    "header": [
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n    \"name\":\"Name of SubAccount\", \n    \"enabled\":\"false\" \n}",
      "options": {
        "raw": {
          "language": "json"
        }
      }
    },
    "url": {
      "raw": "https://api.plivo.com/v1/Account/{{auth_id}}/Subaccount/",
      "protocol": "https",
      "host": [
        "api",
        "plivo",
        "com"
      ],
      "path": [
        "v1",
        "Account",
        "{{auth_id}}",
        "Subaccount",
        ""
      ]
    },
    "description": "Creates a new Subaccount object.\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#create-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": "Create a Subaccount",
      "originalRequest": {
        "method": "POST",
        "header": [
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"name\":\"Name of SubAccount\", \n    \"enabled\":\"false\" \n}",
          "options": {
            "raw": {
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "https://api.plivo.com/v1/Account/{{auth_id}}/Subaccount/",
          "protocol": "https",
          "host": [
            "api",
            "plivo",
            "com"
          ],
          "path": [
            "v1",
            "Account",
            "{{auth_id}}",
            "Subaccount",
            ""
          ]
        }
      },
      "code": 201,
      "_postman_previewlanguage": "json",
      "header": [
      ],
      "cookie": [
      ],
      "body": "{\n    \"api_id\": \"324a7dd8-0db2-11e4-8a4a-123140008edf\",\n    \"auth_id\": \"SAXXXXXXXXXXXXXXXXXX\",\n    \"auth_token\": \"MTZjYWM0YzVjNjMwZmVmODFiNWJjNPJmOGJjZjgw\",\n    \"message\": \"created\"\n}"
    }
  ]
}