Back to Collection Items
<?php
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.Http')
$http = new COM("Chilkat.Http");
$http->BasicAuth = 1;
$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"
// }
// }
// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.JsonObject')
$json = new COM("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');
// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.StringBuilder')
$sbRequestBody = new COM("Chilkat.StringBuilder");
$json->EmitSb($sbRequestBody);
// resp is a Chilkat.HttpResponse
$resp = $http->PTextSb('PATCH','https://domain.com/v2/apps/{{appId}}/users/:userIdOrExternalId',$sbRequestBody,'utf-8','application/json',0,0);
if ($http->LastMethodSuccess == 0) {
print $http->LastErrorText . "\n";
exit;
}
// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.StringBuilder')
$sbResponseBody = new COM("Chilkat.StringBuilder");
$resp->GetBodySb($sbResponseBody);
// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.JsonObject')
$jResp = new COM("Chilkat.JsonObject");
$jResp->LoadSb($sbResponseBody);
$jResp->EmitCompact = 0;
print 'Response Body:' . "\n";
print $jResp->emit() . "\n";
$respStatusCode = $resp->StatusCode;
print 'Response Status Code = ' . $respStatusCode . "\n";
if ($respStatusCode >= 400) {
print 'Response Header:' . "\n";
print $resp->Header . "\n";
print 'Failed.' . "\n";
exit;
}
// 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
$Id = $jResp->stringOf('user.id');
$ExternalId = $jResp->stringOf('user.externalId');
$SignedUpAt = $jResp->stringOf('user.signedUpAt');
$GivenName = $jResp->stringOf('user.profile.givenName');
$Surname = $jResp->stringOf('user.profile.surname');
$v_Email = $jResp->stringOf('user.profile.email');
$AvatarUrl = $jResp->stringOf('user.profile.avatarUrl');
$Lang = $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}"
}
]
}
