Chilkat Online Tools

C / Plivo REST API / Update a Powerpack

Back to Collection Items

#include <C_CkHttp.h>
#include <C_CkJsonObject.h>
#include <C_CkHttpResponse.h>

void ChilkatSample(void)
    {
    HCkHttp http;
    BOOL success;
    HCkJsonObject json;
    HCkHttpResponse resp;

    // 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.

    // {
    //   "name": "friendly_name",
    //   "sticky_sender": "True",
    //   "local_connect": "True",
    //   "application_type": "XML",
    //   "application_id": "application_id can be found from the dashboard"
    // }

    json = CkJsonObject_Create();
    CkJsonObject_UpdateString(json,"name","friendly_name");
    CkJsonObject_UpdateString(json,"sticky_sender","True");
    CkJsonObject_UpdateString(json,"local_connect","True");
    CkJsonObject_UpdateString(json,"application_type","XML");
    CkJsonObject_UpdateString(json,"application_id","application_id can be found from the dashboard");

    resp = CkHttp_PostJson3(http,"https://api.plivo.com/v1/Account/<auth_id>/Powerpack/{powerpack_uuid}/","application/json",json);
    if (CkHttp_getLastMethodSuccess(http) == FALSE) {
        printf("%s\n",CkHttp_lastErrorText(http));
        CkHttp_Dispose(http);
        CkJsonObject_Dispose(json);
        return;
    }

    printf("%d\n",CkHttpResponse_getStatusCode(resp));
    printf("%s\n",CkHttpResponse_bodyStr(resp));
    CkHttpResponse_Dispose(resp);


    CkHttp_Dispose(http);
    CkJsonObject_Dispose(json);

    }

Curl Command

curl -X POST
	-u '{{auth_id}}:password'
	-d '{
    "name":"friendly_name",
    "sticky_sender":"True",
    "local_connect":"True",
    "application_type":"XML",
    "application_id":"application_id can be found from the dashboard"
}'
https://api.plivo.com/v1/Account/<auth_id>/Powerpack/{powerpack_uuid}/

Postman Collection Item JSON

{
  "name": "Update a Powerpack",
  "request": {
    "method": "POST",
    "header": [
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n    \"name\":\"friendly_name\",\n    \"sticky_sender\":\"True\",\n    \"local_connect\":\"True\",\n    \"application_type\":\"XML\",\n    \"application_id\":\"application_id can be found from the dashboard\"\n}\n",
      "options": {
        "raw": {
          "language": "json"
        }
      }
    },
    "url": {
      "raw": "https://api.plivo.com/v1/Account/{{auth_id}}/Powerpack/{powerpack_uuid}/",
      "protocol": "https",
      "host": [
        "api",
        "plivo",
        "com"
      ],
      "path": [
        "v1",
        "Account",
        "{{auth_id}}",
        "Powerpack",
        "{powerpack_uuid}",
        ""
      ]
    },
    "description": "Change the Powerpack’s name, sticky_sender, local_connect or the application to it. Below is the list of arguments that can be passed in this API request, more information can be found [here](https://www.plivo.com/docs/sms/api/powerpack#create-a-powerpack)\n\n\n| Arguments   | Description | Required/Conditional/Optional     |\n| :---        |    :----:   |          ---: |\n| name      | Must be unique across all Powerpacks in customer's account| Required  |\n| sticky_sender | Sticky sender should be enabled by default. Default value is True. Sticky Sender ensures messages to a particular destination number are always sent from the same source number  | Optional      |\n| local_connect   | Local connect should be enabled by default. Default value is True. Local connect prioritizes local numbers matched on area code and State over other numbers in the pool | Optional |\n| application_type   | Must be specified if application_id is specified| Conditional |\n| application_id | Must be set to a valid PHLO or XML App Id or 'none'(String). If not specified (or set to 'none') no application to be associated with phone numbers added to this Powerpack. | Optional      |"
  },
  "response": [
    {
      "name": "Update a Powerpack",
      "originalRequest": {
        "method": "POST",
        "header": [
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"name\":\"friendly_name\",\n    \"sticky_sender\":\"True\",\n    \"local_connect\":\"True\",\n    \"application_type\":\"XML\",\n    \"application_id\":\"application_id can be found from the dashboard\"\n}\n",
          "options": {
            "raw": {
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "https://api.plivo.com/v1/Account/{{auth_id}}/Powerpack/{powerpack_uuid}/",
          "protocol": "https",
          "host": [
            "api",
            "plivo",
            "com"
          ],
          "path": [
            "v1",
            "Account",
            "{{auth_id}}",
            "Powerpack",
            "{powerpack_uuid}",
            ""
          ]
        }
      },
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
      ],
      "cookie": [
      ],
      "body": "{\n    \"api_id\": \"4b2c83c4-09ff-11ea-b072-0242ac110007\",\n    \"application_id\": \"20342783288007824\",\n    \"application_type\": \"XML\",\n    \"created_on\": \"2019-10-09T11:10:59.666461Z\",\n    \"local_connect\": true,\n    \"name\": \"test\",\n    \"number_pool\": \"/v1/Account/{auth_id}/NumberPool/<number_pool_uuid>/\",\n    \"sticky_sender\": true,\n    \"uuid\": \"<powerpack_uuid>\"\n}"
    }
  ]
}