Star and Unstar Photos
1. Star a photo
Star the photos with mediaIds TWVkaWFGaWxlOjg4MjY5Nw== and TWVkaWFGaWxlOjg4MjY5OA== for the location with locationId TG9jYXRpb246NTIxMzI0.
2. Unstar a Photo
This API can also be used to unstar photos in a specific location.
Unstar the photos with mediaIds TWVkaWFGaWxlOjg4MjY5Nw== and TWVkaWFGaWxlOjg4MjY5OA== in the location with locationId TG9jYXRpb246NTIxMzI0.
Common errors while adding photos
When using the Star Photo(s) API, you may encounter the following errors. These typically occur when request parameters violate API rules or constraints.
| Error | Description | Resolution |
|---|---|---|
| Logo/Cover Cannot Be Starred | Attempted to star or unstar a photo of type LOGO or COVER. |
Ensure only photos of type ADDITIONAL are included in the request. |
| Only 4 Images Can Be Starred | Attempted to star more than 4 photos for a single location. | Unstar one or more existing starred photos before trying to star additional photos. |
| Partially Successful | An array of the photos that were successfully updated with their current status. | If the operation fails partially or entirely, the response will include an error message along with the status of each photo, indicating whether it was successfully starred/unstarred or why it failed. |
Example Error Responses
1. Logo/Cover Cannot Be Starred This error occurs when a LOGO or COVER photo type is included in the request.
2. Only 4 Images Can Be Starred This error occurs when the total number of starred photos exceeds the limit of 4 for a location.