Chilkat Online Tools

TCL / Sunshine Conversations API / Create 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]

CkHttp_put_BasicAuth $http 1
CkHttp_put_Login $http "username"
CkHttp_put_Password $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.

# {
#   "externalId": "your-own-id",
#   "signedUpAt": "2020-05-21T15:53:30.197Z",
#   "profile": {
#     "givenName": "Jane",
#     "surname": "Doe",
#     "email": "jane.doe@gmail.com",
#     "avatarUrl": "https://s3.amazonaws.com/avatar.jpg"
#   },
#   "metadata": {
#     "lang": "en-ca"
#   }
# }

set json [new_CkJsonObject]

CkJsonObject_UpdateString $json "externalId" "your-own-id"
CkJsonObject_UpdateString $json "signedUpAt" "2020-05-21T15:53:30.197Z"
CkJsonObject_UpdateString $json "profile.givenName" "Jane"
CkJsonObject_UpdateString $json "profile.surname" "Doe"
CkJsonObject_UpdateString $json "profile.email" "jane.doe@gmail.com"
CkJsonObject_UpdateString $json "profile.avatarUrl" "https://s3.amazonaws.com/avatar.jpg"
CkJsonObject_UpdateString $json "metadata.lang" "en-ca"

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

# resp is a CkHttpResponse
set resp [CkHttp_PostJson3 $http "https://domain.com/" "application/json" $json]
if {[CkHttp_get_LastMethodSuccess $http] == 0} then {
    puts [CkHttp_lastErrorText $http]
    delete_CkHttp $http
    delete_CkJsonObject $json
    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 $sbResponseBody
    delete_CkJsonObject $jResp
    exit
}

delete_CkHttpResponse $resp

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

# {
#   "user": {
#     "id": "7494535bff5cef41a15be74d",
#     "externalId": "your-own-id",
#     "signedUpAt": "2020-05-21T15:53:30.197Z",
#     "profile": {
#       "givenName": "Jane",
#       "surname": "Doe",
#       "email": "jane.doe@gmail.com",
#       "avatarUrl": "https://s3.amazonaws.com/avatar.jpg"
#     },
#     "metadata": {
#       "lang": "en-ca"
#     }
#   }
# }

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

set Id [CkJsonObject_stringOf $jResp "user.id"]
set ExternalId [CkJsonObject_stringOf $jResp "user.externalId"]
set SignedUpAt [CkJsonObject_stringOf $jResp "user.signedUpAt"]
set GivenName [CkJsonObject_stringOf $jResp "user.profile.givenName"]
set Surname [CkJsonObject_stringOf $jResp "user.profile.surname"]
set v_Email [CkJsonObject_stringOf $jResp "user.profile.email"]
set AvatarUrl [CkJsonObject_stringOf $jResp "user.profile.avatarUrl"]
set Lang [CkJsonObject_stringOf $jResp "user.metadata.lang"]

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

Curl Command

curl -X POST
	-u 'username:password'
	-H "Content-Type: application/json"
	-d '{
    "externalId": "your-own-id",
    "signedUpAt": "2020-05-21T15:53:30.197Z",
    "profile": {
        "givenName": "Jane",
        "surname": "Doe",
        "email": "jane.doe@gmail.com",
        "avatarUrl": "https://s3.amazonaws.com/avatar.jpg"
    },
    "metadata": {
        "lang": "en-ca"
    }
}'
https://domain.com/

Postman Collection Item JSON

{
  "name": "Create User",
  "_postman_id": "44749d06-472c-4409-82b1-abc8a22ad666",
  "request": {
    "method": "POST",
    "header": [
      {
        "key": "Content-Type",
        "value": "application/json"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n    \"externalId\": \"your-own-id\",\n    \"signedUpAt\": \"2020-05-21T15:53:30.197Z\",\n    \"profile\": {\n        \"givenName\": \"Jane\",\n        \"surname\": \"Doe\",\n        \"email\": \"jane.doe@gmail.com\",\n        \"avatarUrl\": \"https://s3.amazonaws.com/avatar.jpg\"\n    },\n    \"metadata\": {\n        \"lang\": \"en-ca\"\n    }\n}"
    },
    "url": "{{url}}/v2/apps/{{appId}}/users",
    "description": "Creates a new user."
  },
  "response": [
    {
      "id": "2f2a4e6e-0d1a-4483-b30d-160379704ff5",
      "name": "User already exists",
      "originalRequest": {
        "method": "POST",
        "header": [
          {
            "description": {
              "content": "Added as a part of security scheme: bearer",
              "type": "text/plain"
            },
            "key": "Authorization",
            "value": "Bearer <token>"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"externalId\": \"your-own-id\",\n    \"signedUpAt\": \"2020-05-21T15:53:30.197Z\",\n    \"profile\": {\n        \"givenName\": \"Jane\",\n        \"surname\": \"Doe\",\n        \"email\": \"jane.doe@gmail.com\",\n        \"avatarUrl\": \"https://s3.amazonaws.com/avatar.jpg\"\n    },\n    \"metadata\": {\n        \"lang\": \"en-ca\"\n    }\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/v2/apps/:appId/users",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "v2",
            "apps",
            ":appId",
            "users"
          ],
          "variable": [
            {
              "key": "appId"
            }
          ]
        }
      },
      "status": "Conflict",
      "code": 409,
      "_postman_previewlanguage": "text",
      "header": [
        {
          "key": "Content-Type",
          "value": "text/plain"
        }
      ],
      "cookie": [
      ],
      "body": ""
    },
    {
      "id": "6a8ada4a-ff1f-4176-9d03-904fbc145bb6",
      "name": "Created",
      "originalRequest": {
        "method": "POST",
        "header": [
          {
            "description": {
              "content": "Added as a part of security scheme: bearer",
              "type": "text/plain"
            },
            "key": "Authorization",
            "value": "Bearer <token>"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"externalId\": \"your-own-id\",\n    \"signedUpAt\": \"2020-05-21T15:53:30.197Z\",\n    \"profile\": {\n        \"givenName\": \"Jane\",\n        \"surname\": \"Doe\",\n        \"email\": \"jane.doe@gmail.com\",\n        \"avatarUrl\": \"https://s3.amazonaws.com/avatar.jpg\"\n    },\n    \"metadata\": {\n        \"lang\": \"en-ca\"\n    }\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/v2/apps/:appId/users",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "v2",
            "apps",
            ":appId",
            "users"
          ],
          "variable": [
            {
              "key": "appId"
            }
          ]
        }
      },
      "status": "Created",
      "code": 201,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n \"user\": {\n  \"id\": \"7494535bff5cef41a15be74d\",\n  \"externalId\": \"your-own-id\",\n  \"signedUpAt\": \"2020-05-21T15:53:30.197Z\",\n  \"profile\": {\n   \"givenName\": \"Jane\",\n   \"surname\": \"Doe\",\n   \"email\": \"jane.doe@gmail.com\",\n   \"avatarUrl\": \"https://s3.amazonaws.com/avatar.jpg\"\n  },\n  \"metadata\": {\n   \"lang\": \"en-ca\"\n  }\n }\n}"
    }
  ]
}