Back to Collection Items
<?php
include("chilkat.php");
// Use "chilkat_9_5_0.php" for versions of Chilkat < 10.0.0
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
$http = new CkHttp();
$req = new CkHttpRequest();
$req->put_HttpVerb('POST');
$req->put_Path('/services/data/v{{version}}/connect/user-profiles/me/photo');
$req->put_ContentType('multipart/form-data');
$jsonFormData1 = new CkJsonObject();
$jsonFormData1->UpdateString('cropY','0');
$jsonFormData1->UpdateString('cropX','0');
$jsonFormData1->UpdateString('cropSize','200');
$req->AddStringForUpload2('json','',$jsonFormData1,'utf-8','application/json');
$success = $req->AddFileForUpload2('fileUpload',' path to file','application/octet-stream');
$req->AddHeader('Authorization','Bearer <access_token>');
$req->AddHeader('Content-Disposition','form-data; name=\'photo\'');
$req->AddHeader('Expect','100-continue');
// resp is a CkHttpResponse
$resp = $http->SynchronousRequest('domain.com',443,true,$req);
if ($http->get_LastMethodSuccess() == false) {
print $http->lastErrorText() . "\n";
exit;
}
$sbResponseBody = new CkStringBuilder();
$resp->GetBodySb($sbResponseBody);
$jResp = new CkJsonObject();
$jResp->LoadSb($sbResponseBody);
$jResp->put_EmitCompact(false);
print 'Response Body:' . "\n";
print $jResp->emit() . "\n";
$respStatusCode = $resp->get_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)
// {
// "fullEmailPhotoUrl": "https://<my_domain>/img/userprofile/default_profile_200_v2.png?fromEmail=1",
// "largePhotoUrl": "https://<my_domain>/profilephoto/729.../F",
// "mediumPhotoUrl": "https://<my_domain>/profilephoto/729.../M",
// "photoVersionId": "729...",
// "smallPhotoUrl": "https://<my_domain>/profilephoto/729.../T",
// "standardEmailPhotoUrl": "https://<my_domain>/img/userprofile/default_profile_45_v2.png?fromEmail=1",
// "url": "/services/data/v58.0/connect/user-profiles/005.../photo"
// }
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
$fullEmailPhotoUrl = $jResp->stringOf('fullEmailPhotoUrl');
$largePhotoUrl = $jResp->stringOf('largePhotoUrl');
$mediumPhotoUrl = $jResp->stringOf('mediumPhotoUrl');
$photoVersionId = $jResp->stringOf('photoVersionId');
$smallPhotoUrl = $jResp->stringOf('smallPhotoUrl');
$standardEmailPhotoUrl = $jResp->stringOf('standardEmailPhotoUrl');
$url = $jResp->stringOf('url');
?>
Curl Command
curl -X POST
-H "Authorization: Bearer <access_token>"
-H "Content-Type: multipart/form-data"
-H "Content-Disposition: form-data; name=\"photo\""
-H "Content-Type: application/json; charset=UTF-8"
--form 'json={"cropY":"0","cropX":"0","cropSize":"200"}'
--form 'fileUpload=@"/path/to/file"'
https://domain.com/services/data/v{{version}}/connect/user-profiles/me/photo
Postman Collection Item JSON
{
"name": "User Photo",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "multipart/form-data",
"disabled": true
},
{
"key": "Content-Disposition",
"value": "form-data; name=\"photo\"",
"disabled": true
},
{
"key": "Content-Type",
"value": "application/json; charset=UTF-8",
"disabled": true
}
],
"body": {
"mode": "formdata",
"formdata": [
{
"key": "json",
"value": "{\"cropY\":\"0\",\"cropX\":\"0\",\"cropSize\":\"200\"}",
"type": "text"
},
{
"key": "fileUpload",
"type": "file",
"src": [
]
}
]
},
"url": {
"raw": "{{_endpoint}}/services/data/v{{version}}/connect/user-profiles/me/photo",
"host": [
"{{_endpoint}}"
],
"path": [
"services",
"data",
"v{{version}}",
"connect",
"user-profiles",
"me",
"photo"
]
},
"description": "Get, post, and crop a user photo.\nTo use an image from the Files page as a user photo, pass the file ID in the fileId property of the request body or in the fileId request parameter. Images uploaded on the User page don’t have a file ID and can’t be used as the fileId.\n\nTo upload a binary file as the user photo, you must send it in a multipart/form-data message. For information about how to create the multipart/form-data message, see Uploading Binary Files.\n\nTo display user profile photos in a feed, cache the user photos. Then use the photoVersionId property of the Photo response body to determine when you need to update a photo. This technique helps you avoid running over limits and may improve mobile client performance."
},
"response": [
{
"name": "Succesful User Photo",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "multipart/form-data",
"disabled": true
},
{
"key": "Content-Disposition",
"value": "form-data; name=\"photo\"",
"disabled": true
},
{
"key": "Content-Type",
"value": "application/json; charset=UTF-8",
"disabled": true
}
],
"body": {
"mode": "formdata",
"formdata": [
{
"key": "json",
"value": "{\"cropY\":\"0\",\"cropX\":\"0\",\"cropSize\":\"200\"}",
"type": "text"
},
{
"key": "fileUpload",
"type": "file",
"src": "/Users/scolladon/Downloads/1x1.png"
}
]
},
"url": {
"raw": "{{_endpoint}}/services/data/v{{version}}/connect/user-profiles/me/photo",
"host": [
"{{_endpoint}}"
],
"path": [
"services",
"data",
"v{{version}}",
"connect",
"user-profiles",
"me",
"photo"
]
}
},
"status": "Created",
"code": 201,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Date",
"value": "Mon, 20 Nov 2023 16:15:44 GMT"
},
{
"key": "Strict-Transport-Security",
"value": "max-age=63072000; includeSubDomains"
},
{
"key": "X-Content-Type-Options",
"value": "nosniff"
},
{
"key": "X-XSS-Protection",
"value": "1; mode=block"
},
{
"key": "X-Robots-Tag",
"value": "none"
},
{
"key": "Cache-Control",
"value": "no-cache,must-revalidate,max-age=0,no-store,private"
},
{
"key": "Content-Type",
"value": "application/json;charset=UTF-8"
},
{
"key": "Vary",
"value": "Accept-Encoding"
},
{
"key": "Content-Encoding",
"value": "gzip"
},
{
"key": "Transfer-Encoding",
"value": "chunked"
}
],
"cookie": [
],
"body": "{\n \"fullEmailPhotoUrl\": \"https://<my_domain>/img/userprofile/default_profile_200_v2.png?fromEmail=1\",\n \"largePhotoUrl\": \"https://<my_domain>/profilephoto/729.../F\",\n \"mediumPhotoUrl\": \"https://<my_domain>/profilephoto/729.../M\",\n \"photoVersionId\": \"729...\",\n \"smallPhotoUrl\": \"https://<my_domain>/profilephoto/729.../T\",\n \"standardEmailPhotoUrl\": \"https://<my_domain>/img/userprofile/default_profile_45_v2.png?fromEmail=1\",\n \"url\": \"/services/data/v58.0/connect/user-profiles/005.../photo\"\n}"
}
]
}
