PowerShell

SMSAPI - Edit a Subuser Account

See more SMSAPI Examples

Modify a sub-user account. PowerShell

Add-Type -Path "C:\chilkat\ChilkatDotNet47-x64\ChilkatDotNet47.dll"

$success = $false

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

$http = New-Object Chilkat.Http

# Implements the following CURL command:

# curl -X PUT -H "Content-Type: application/json" \
# -H "Authorization: Bearer token_api_oauth" -d\
# '{"credentials":{"password":"Customer_portal_password","api_password":"API_password"}, 
# "active":"1","description":"Test description","points":{"from_account":"2","per_month":"2"}}'
# 'https://api.smsapi.com/subusers/{subuser_id}'

# Use the following online tool to generate HTTP code from a CURL command
# Convert a cURL Command to HTTP Source Code

# Use this online tool to generate code from sample JSON:
# Generate Code to Create JSON

# The following JSON is sent in the request body.

# {
#   "credentials": {
#     "password": "Customer_portal_password",
#     "api_password": "API_password"
#   },
#   "active": "1",
#   "description": "Test description",
#   "points": {
#     "from_account": "2",
#     "per_month": "2"
#   }
# }

$json = New-Object Chilkat.JsonObject
$json.UpdateString("credentials.password","new_Password_1234")
$json.UpdateString("credentials.api_password","new_API_password_1234")
$json.UpdateString("active","1")
$json.UpdateString("description","Test description")
$json.UpdateString("points.from_account","3")
$json.UpdateString("points.per_month","3")

# Adds the "Authorization: Bearer token_api_oauth" header.
$http.AuthToken = "token_api_oauth"
$http.SetRequestHeader("Content-Type","application/json")

$sbRequestBody = New-Object Chilkat.StringBuilder
$json.EmitSb($sbRequestBody)

# In this example, the subuser_id is 5F8BB03E6436384B0AB36F1B
$resp = New-Object Chilkat.HttpResponse
$success = $http.HttpSb("PUT","https://api.smsapi.com/subusers/5F8BB03E6436384B0AB36F1B",$sbRequestBody,"utf-8","application/json",$resp)
if ($success -eq $false) {
    $($http.LastErrorText)
    exit
}

$sbResponseBody = New-Object Chilkat.StringBuilder
$resp.GetBodySb($sbResponseBody)
$jResp = New-Object Chilkat.JsonObject
$jResp.LoadSb($sbResponseBody)
$jResp.EmitCompact = $false

$("Response Body:")
$($jResp.Emit())

$respStatusCode = $resp.StatusCode
$("Response Status Code = " + $respStatusCode)
if ($respStatusCode -ge 400) {
    $("Response Header:")
    $($resp.Header)
    $("Failed.")
    exit
}

# Sample JSON response:
# (Sample code for parsing the JSON response is shown below)

# {
#   "id": "5F8BB03E6436384B0AB36F1B",
#   "username": "TestUser",
#   "active": true,
#   "description": "Test description",
#   "points": {
#     "from_account": 3.0,
#     "per_month": 3.0
#   }
# }

# Sample code for parsing the JSON response...
# Use the following online tool to generate parsing code from sample JSON:
# Generate Parsing Code from JSON

$id = $jResp.StringOf("id")
$username = $jResp.StringOf("username")
$active = $jResp.BoolOf("active")
$description = $jResp.StringOf("description")
$pointsFrom_account = $jResp.StringOf("points.from_account")
$pointsPer_month = $jResp.StringOf("points.per_month")