Chilkat Online Tools

VB.NET / Sunshine Conversations API / Update User

Back to Collection Items

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

Dim http As New Chilkat.Http
Dim success As Boolean

http.BasicAuth = True
http.Login = "username"
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.

' {
'   "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"
'   }
' }

Dim json As New Chilkat.JsonObject
json.UpdateString("signedUpAt","2020-05-21T15:53:30.197Z")
json.UpdateString("profile.givenName","Jane")
json.UpdateString("profile.surname","Doe")
json.UpdateString("profile.email","jane.doe@gmail.com")
json.UpdateString("profile.avatarUrl","https://s3.amazonaws.com/avatar.jpg")
json.UpdateString("metadata.lang","en-ca")

http.SetRequestHeader("Content-Type","application/json")

Dim sbRequestBody As New Chilkat.StringBuilder
json.EmitSb(sbRequestBody)

Dim resp As Chilkat.HttpResponse = http.PTextSb("PATCH","https://domain.com/v2/apps/{{appId}}/users/:userIdOrExternalId",sbRequestBody,"utf-8","application/json",False,False)
If (http.LastMethodSuccess = False) Then
    Debug.WriteLine(http.LastErrorText)
    Exit Sub
End If


Dim sbResponseBody As New Chilkat.StringBuilder
resp.GetBodySb(sbResponseBody)

Dim jResp As New Chilkat.JsonObject
jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = False

Debug.WriteLine("Response Body:")
Debug.WriteLine(jResp.Emit())

Dim respStatusCode As Integer = resp.StatusCode
Debug.WriteLine("Response Status Code = " & respStatusCode)
If (respStatusCode >= 400) Then
    Debug.WriteLine("Response Header:")
    Debug.WriteLine(resp.Header)
    Debug.WriteLine("Failed.")

    Exit Sub
End If



' 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




Dim Id As String = jResp.StringOf("user.id")
Dim ExternalId As String = jResp.StringOf("user.externalId")
Dim SignedUpAt As String = jResp.StringOf("user.signedUpAt")
Dim GivenName As String = jResp.StringOf("user.profile.givenName")
Dim Surname As String = jResp.StringOf("user.profile.surname")
Dim v_Email As String = jResp.StringOf("user.profile.email")
Dim AvatarUrl As String = jResp.StringOf("user.profile.avatarUrl")
Dim Lang As String = jResp.StringOf("user.metadata.lang")

Curl Command

curl -X PATCH
	-u 'username:password'
	-H "Content-Type: application/json"
	-d '{
    "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/v2/apps/{{appId}}/users/:userIdOrExternalId

Postman Collection Item JSON

{
  "name": "Update User",
  "_postman_id": "8b3b25b1-b89b-4a6d-8aae-e72fd279cbc7",
  "request": {
    "method": "PATCH",
    "header": [
      {
        "key": "Content-Type",
        "value": "application/json"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\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": "{{url}}/v2/apps/{{appId}}/users/:userIdOrExternalId",
      "host": [
        "{{url}}"
      ],
      "path": [
        "v2",
        "apps",
        "{{appId}}",
        "users",
        ":userIdOrExternalId"
      ],
      "variable": [
        {
          "key": "userIdOrExternalId"
        }
      ]
    },
    "description": "Updates a user."
  },
  "response": [
    {
      "id": "386032bc-c4a4-4590-a4be-47f5a73f20ba",
      "name": "User not found",
      "originalRequest": {
        "method": "PATCH",
        "header": [
          {
            "description": {
              "content": "Added as a part of security scheme: bearer",
              "type": "text/plain"
            },
            "key": "Authorization",
            "value": "Bearer <token>"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\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/:userIdOrExternalId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "v2",
            "apps",
            ":appId",
            "users",
            ":userIdOrExternalId"
          ],
          "variable": [
            {
              "key": "appId"
            },
            {
              "key": "userIdOrExternalId"
            }
          ]
        }
      },
      "status": "Not Found",
      "code": 404,
      "_postman_previewlanguage": "text",
      "header": [
        {
          "key": "Content-Type",
          "value": "text/plain"
        }
      ],
      "cookie": [
      ],
      "body": ""
    },
    {
      "id": "cdd035df-8db2-4fe8-95fa-337219ee4c48",
      "name": "Ok",
      "originalRequest": {
        "method": "PATCH",
        "header": [
          {
            "description": {
              "content": "Added as a part of security scheme: bearer",
              "type": "text/plain"
            },
            "key": "Authorization",
            "value": "Bearer <token>"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\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/:userIdOrExternalId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "v2",
            "apps",
            ":appId",
            "users",
            ":userIdOrExternalId"
          ],
          "variable": [
            {
              "key": "appId"
            },
            {
              "key": "userIdOrExternalId"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_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}"
    }
  ]
}