Employee Banner Photo

To use an image from the Files page as the employee banner photo, pass the file ID in the request body or the request parameters.

To upload a binary file as the employee banner photo, send it in a multipart/form-data message. For information about how to create the multipart/form-data message, see Uploading Binary Files.

Resource

1/connect/employee-profiles/employeeId/banner-photo

Available version

51.0

Requires Chatter

No

HTTP methods

GET, POST, DELETE

Request body for POST

Root XML tag

<bannerPhoto>

JSON example

1{   "cropHeight" : "120",
2    "cropWidth" : "240",
3    "fileId" : "069D00000001IOh"
4}

Properties

Name	Type	Description	Required or Optional	Available Version
cropHeight	Integer	Height of the crop rectangle in pixels.	Optional	36.0
cropWidth	Integer	Width of the crop rectangle in pixels.	Optional	36.0
cropX	Integer	X position of the crop rectangle from the left edge of the image in pixels. Top left is position (0,0).	Optional	36.0
cropY	Integer	Y position of the crop rectangle from the top edge of the image in pixels. Top left is position (0,0).	Optional	36.0
fileId	String	18 character ID of an existing file. The key prefix must be 069 and the file must be an image and be smaller than 2 GB. Images uploaded on the Group page and on the User page don’t have file IDs and therefore can’t be used. Note	Required to use an existing file	36.0
versionNumber	Integer	Version number of an existing file. If not provided, the latest version is used.	Optional	36.0

Request parameters for POST

Parameter Name	Type	Description	Required or Optional	Available Version
cropHeight	Integer	Height of the crop rectangle in pixels.	Optional	51.0
cropWidth	Integer	Width of the crop rectangle in pixels.	Optional	51.0
cropX	Integer	X position of the crop rectangle from the left edge of the image in pixels. Top left is position (0,0).	Optional	51.0
cropY	Integer	Y position of the crop rectangle from the top edge of the image in pixels. Top left is position (0,0).	Optional	51.0
fileId	String	18 character ID of an existing file. The key prefix must be 069 and the file must be an image and be smaller than 2 GB.	Required to use an existing file	51.0
versionNumber	Integer	Version number of an existing file. If not provided, the latest version is used.	Optional	51.0

Photos are processed asynchronously and may not be visible right away.

Note

Response body for GET and POST

Banner Photo

Response for DELETE

204: Successful Delete