Chilkat Online Tools

delphiDll / Salesforce Platform APIs / User Photo

Back to Collection Items

var
http: HCkHttp;
success: Boolean;
req: HCkHttpRequest;
jsonFormData1: HCkJsonObject;
resp: HCkHttpResponse;
sbResponseBody: HCkStringBuilder;
jResp: HCkJsonObject;
respStatusCode: Integer;
fullEmailPhotoUrl: PWideChar;
largePhotoUrl: PWideChar;
mediumPhotoUrl: PWideChar;
photoVersionId: PWideChar;
smallPhotoUrl: PWideChar;
standardEmailPhotoUrl: PWideChar;
url: PWideChar;

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

http := CkHttp_Create();

req := CkHttpRequest_Create();
CkHttpRequest_putHttpVerb(req,'POST');
CkHttpRequest_putPath(req,'/services/data/v{{version}}/connect/user-profiles/me/photo');
CkHttpRequest_putContentType(req,'multipart/form-data');

jsonFormData1 := CkJsonObject_Create();
CkJsonObject_UpdateString(jsonFormData1,'cropY','0');
CkJsonObject_UpdateString(jsonFormData1,'cropX','0');
CkJsonObject_UpdateString(jsonFormData1,'cropSize','200');
CkHttpRequest_AddStringForUpload2(req,'json','',jsonFormData1,'utf-8','application/json');

success := CkHttpRequest_AddFileForUpload2(req,'fileUpload',' path to file','application/octet-stream');

CkHttpRequest_AddHeader(req,'Authorization','Bearer <access_token>');
CkHttpRequest_AddHeader(req,'Content-Disposition','form-data; name="photo"');
CkHttpRequest_AddHeader(req,'Expect','100-continue');

resp := CkHttp_SynchronousRequest(http,'domain.com',443,True,req);
if (CkHttp_getLastMethodSuccess(http) = False) then
  begin
    Memo1.Lines.Add(CkHttp__lastErrorText(http));
    Exit;
  end;

sbResponseBody := CkStringBuilder_Create();
CkHttpResponse_GetBodySb(resp,sbResponseBody);

jResp := CkJsonObject_Create();
CkJsonObject_LoadSb(jResp,sbResponseBody);
CkJsonObject_putEmitCompact(jResp,False);

Memo1.Lines.Add('Response Body:');
Memo1.Lines.Add(CkJsonObject__emit(jResp));

respStatusCode := CkHttpResponse_getStatusCode(resp);
Memo1.Lines.Add('Response Status Code = ' + IntToStr(respStatusCode));
if (respStatusCode >= 400) then
  begin
    Memo1.Lines.Add('Response Header:');
    Memo1.Lines.Add(CkHttpResponse__header(resp));
    Memo1.Lines.Add('Failed.');
    CkHttpResponse_Dispose(resp);
    Exit;
  end;
CkHttpResponse_Dispose(resp);

// 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 := CkJsonObject__stringOf(jResp,'fullEmailPhotoUrl');
largePhotoUrl := CkJsonObject__stringOf(jResp,'largePhotoUrl');
mediumPhotoUrl := CkJsonObject__stringOf(jResp,'mediumPhotoUrl');
photoVersionId := CkJsonObject__stringOf(jResp,'photoVersionId');
smallPhotoUrl := CkJsonObject__stringOf(jResp,'smallPhotoUrl');
standardEmailPhotoUrl := CkJsonObject__stringOf(jResp,'standardEmailPhotoUrl');
url := CkJsonObject__stringOf(jResp,'url');

CkHttp_Dispose(http);
CkHttpRequest_Dispose(req);
CkJsonObject_Dispose(jsonFormData1);
CkStringBuilder_Dispose(sbResponseBody);
CkJsonObject_Dispose(jResp);

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}"
    }
  ]
}