Back to Collection Items
func chilkatTest() {
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
let http = CkoHttp()
var success: Bool
let req = CkoHttpRequest()
req.HttpVerb = "POST"
req.Path = "/services/data/v{{version}}/connect/user-profiles/me/photo"
req.ContentType = "multipart/form-data"
let jsonFormData1 = CkoJsonObject()
jsonFormData1.UpdateString("cropY", value: "0")
jsonFormData1.UpdateString("cropX", value: "0")
jsonFormData1.UpdateString("cropSize", value: "200")
req.AddParam("json", value: jsonFormData1.Emit())
success = req.AddFileForUpload2("fileUpload", path: " path to file", contentType: "application/octet-stream")
req.AddHeader("Authorization", value: "Bearer <access_token>")
req.AddHeader("Content-Disposition", value: "form-data; name=\"photo\"")
req.AddHeader("Expect", value: "100-continue")
var resp: CkoHttpResponse? = http.SynchronousRequest("domain.com", port: 443, ssl: true, req: req)
if http.LastMethodSuccess == false {
print("\(http.LastErrorText)")
return
}
let sbResponseBody = CkoStringBuilder()
resp!.GetBodySb(sbResponseBody)
let jResp = CkoJsonObject()
jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = false
print("Response Body:")
print("\(jResp.Emit())")
var respStatusCode: Int = resp!.StatusCode.intValue
print("Response Status Code = \(respStatusCode)")
if respStatusCode >= 400 {
print("Response Header:")
print("\(resp!.Header)")
print("Failed.")
resp = nil
return
}
resp = nil
// 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
var fullEmailPhotoUrl: String? = jResp.StringOf("fullEmailPhotoUrl")
var largePhotoUrl: String? = jResp.StringOf("largePhotoUrl")
var mediumPhotoUrl: String? = jResp.StringOf("mediumPhotoUrl")
var photoVersionId: String? = jResp.StringOf("photoVersionId")
var smallPhotoUrl: String? = jResp.StringOf("smallPhotoUrl")
var standardEmailPhotoUrl: String? = jResp.StringOf("standardEmailPhotoUrl")
var url: String? = 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}"
}
]
}
