Recommendation Definition Photo

Community managers (users with the “Create and Set Up Communities” or “Manage Communities” permission) can access, create, and delete audiences, definitions, and schedules for community recommendations. Users with the “Modify All Data” permission can also access, create, and delete recommendation audiences, recommendation definitions, and scheduled recommendations.

To use an image from the Files page as a recommendation definition photo (existing content), pass the file ID in the fileId property of the request body or in the fileId request parameter.

To upload a binary file as a recommendation definition 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.

Resource

1/connect/recommendation-definitions/recommendationDefinitionId/photo

Available version

33.0

Requires Chatter

Yes

HTTP methods

GET, HEAD, PUT, DELETE

Request body for PUT

Root XML tag

<photo>

JSON example

1{   "cropSize" : "120",
2    "cropX" : "0",
3    "cropY" : "0",
4    "fileId" : "069D00000001IOh"
5}

Properties

Name	Type	Description	Required or Optional	Available Version
cropSize	Integer	The length, in pixels, of any edge of the crop square.	Required to crop an uploaded file or an existing file.	29.0
cropX	Integer	The position X, in pixels, from the left edge of the image to the start of the crop square. Top left is position (0,0).	Required to crop an uploaded file or an existing file.	29.0
cropY	Integer	The position Y, in pixels, from the top edge of the image to the start of the crop square. Top left is position (0,0).	Required to crop an uploaded file or an existing file.	29.0
fileId	String	18–character ID of an existing file. The key prefix must be 069 and the file size must be less 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 choose an existing file.	25.0
versionNumber	Integer	Version number of an existing file. If not provided, the latest version is used.	Optional	25.0

Request parameters for PUT

Parameter Name	Type	Description	Required or Optional	Available Version
cropSize	Integer	The length, in pixels, of any edge of the crop square.	Required to crop an uploaded file or an existing file.	29.0
cropX	Integer	The position X, in pixels, from the left edge of the image to the start of the crop square. Top left is position (0,0).	Required to crop an uploaded file or an existing file.	29.0
cropY	Integer	The position Y, in pixels, from the top edge of the image to the start of the crop square. Top left is position (0,0).	Required to crop an uploaded file or an existing file.	29.0
fileId	String	18 character ID of an existing file. The key prefix must be 069 and the file size must be less than 2 GB. Files uploaded on the Group page and on the User Profile page don’t have a file ID and can’t be posted or cropped. Files uploaded on the Files page have a file ID and can be posted and cropped. Note	Required to choose an existing file.	25.0
versionNumber	Integer	Version number of the existing content. If not provided, the latest version is used.	Optional	25.0

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

Note

Response body for GET and PUT

Photo