Chilkat Online Tools

TCL / Squadcast API V3 / Update User

Back to Collection Items

load ./chilkat.dll

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

set http [new_CkHttp]

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

# The following JSON is sent in the request body.

# {
#   "role": "<string>"
# }

set json [new_CkJsonObject]

CkJsonObject_UpdateString $json "role" "<string>"

CkHttp_SetRequestHeader $http "Authorization" ""
CkHttp_SetRequestHeader $http "Content-Type" "application/json"

set sbRequestBody [new_CkStringBuilder]

CkJsonObject_EmitSb $json $sbRequestBody

# resp is a CkHttpResponse
set resp [CkHttp_PTextSb $http "PUT" "https://api.squadcast.com/v3/users/:userID" $sbRequestBody "utf-8" "application/json" 0 0]
if {[CkHttp_get_LastMethodSuccess $http] == 0} then {
    puts [CkHttp_lastErrorText $http]
    delete_CkHttp $http
    delete_CkJsonObject $json
    delete_CkStringBuilder $sbRequestBody
    exit
}

set sbResponseBody [new_CkStringBuilder]

CkHttpResponse_GetBodySb $resp $sbResponseBody

set jResp [new_CkJsonObject]

CkJsonObject_LoadSb $jResp $sbResponseBody
CkJsonObject_put_EmitCompact $jResp 0

puts "Response Body:"
puts [CkJsonObject_emit $jResp]

set respStatusCode [CkHttpResponse_get_StatusCode $resp]
puts "Response Status Code = $respStatusCode"
if {$respStatusCode >= 400} then {
    puts "Response Header:"
    puts [CkHttpResponse_header $resp]
    puts "Failed."
    delete_CkHttpResponse $resp

    delete_CkHttp $http
    delete_CkJsonObject $json
    delete_CkStringBuilder $sbRequestBody
    delete_CkStringBuilder $sbResponseBody
    delete_CkJsonObject $jResp
    exit
}

delete_CkHttpResponse $resp

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

# {
#   "datd": {}
# }

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


delete_CkHttp $http
delete_CkJsonObject $json
delete_CkStringBuilder $sbRequestBody
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp

Curl Command

curl -X PUT
	-H "Authorization: "
	-H "Content-Type: application/json"
	-d '{
    "role": "<string>"
}'
https://api.squadcast.com/v3/users/:userID

Postman Collection Item JSON

{
  "name": "Update User",
  "request": {
    "auth": {
      "type": "noauth"
    },
    "method": "PUT",
    "header": [
      {
        "key": "Authorization",
        "value": ""
      },
      {
        "key": "Content-Type",
        "value": "application/json"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n    \"role\": \"<string>\"\n}"
    },
    "url": {
      "raw": "{{baseUrl}}/users/:userID",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "users",
        ":userID"
      ],
      "variable": [
        {
          "key": "userID",
          "value": "<string>",
          "type": "string",
          "description": "(Required) user id"
        }
      ]
    },
    "description": "Update organization user basic details and role. \nRequires `access_token` as a `Bearer {{token}}` in the `Authorization` header with `user-write` scope."
  },
  "response": [
    {
      "name": "Conflict",
      "originalRequest": {
        "method": "PUT",
        "header": [
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"role\": \"user\"\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/users/:userID",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "users",
            ":userID"
          ],
          "variable": [
            {
              "key": "userID"
            }
          ]
        }
      },
      "status": "Conflict",
      "code": 409,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n \"meta\": {\n  \"status\": \"<integer>\",\n  \"error_message\": \"<string>\"\n }\n}"
    },
    {
      "name": "OK",
      "originalRequest": {
        "method": "PUT",
        "header": [
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"role\": \"user\"\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/users/:userID",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "users",
            ":userID"
          ],
          "variable": [
            {
              "key": "userID"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n \"datd\": {}\n}"
    },
    {
      "name": "Unauthorized",
      "originalRequest": {
        "method": "PUT",
        "header": [
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"role\": \"user\"\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/users/:userID",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "users",
            ":userID"
          ],
          "variable": [
            {
              "key": "userID"
            }
          ]
        }
      },
      "status": "Unauthorized",
      "code": 401,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n \"meta\": {\n  \"status\": \"<integer>\",\n  \"error_message\": \"<string>\"\n }\n}"
    },
    {
      "name": "Not Found",
      "originalRequest": {
        "method": "PUT",
        "header": [
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"role\": \"user\"\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/users/:userID",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "users",
            ":userID"
          ],
          "variable": [
            {
              "key": "userID"
            }
          ]
        }
      },
      "status": "Not Found",
      "code": 404,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n \"meta\": {\n  \"status\": \"<integer>\",\n  \"error_message\": \"<string>\"\n }\n}"
    },
    {
      "name": "Forbidden",
      "originalRequest": {
        "method": "PUT",
        "header": [
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"role\": \"user\"\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/users/:userID",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "users",
            ":userID"
          ],
          "variable": [
            {
              "key": "userID"
            }
          ]
        }
      },
      "status": "Forbidden",
      "code": 403,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n \"meta\": {\n  \"status\": \"<integer>\",\n  \"error_message\": \"<string>\"\n }\n}"
    },
    {
      "name": "Internal Server Error",
      "originalRequest": {
        "method": "PUT",
        "header": [
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"role\": \"user\"\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/users/:userID",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "users",
            ":userID"
          ],
          "variable": [
            {
              "key": "userID"
            }
          ]
        }
      },
      "status": "Internal Server Error",
      "code": 500,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n \"meta\": {\n  \"status\": \"<integer>\",\n  \"error_message\": \"<string>\"\n }\n}"
    }
  ]
}