---
title: "Star/Unstar Location Photos"
method: POST
path: "/locations/photos/star"
tags: ["Locations", "Photos"]
---

# Star/Unstar Location Photos

`POST /locations/photos/star`

## Request

- Base URL: `https://api.synup.com/api/v4`
- URL: `https://api.synup.com/api/v4/locations/photos/star`
- Auth: none required
- TypeScript: <https://skmtc.dev/synup/apis/synup-api/docs/locations/photos/star/post.ts> (a function with typed inputs; its response is checked against the schema)

This API allows you to star or unstar photo(s) for a specific location. A starred photo highlights its importance and increases its visibility in certain displays.

:::caution[]

A location can have a maximum of 4 starred images. Attempting to star additional photos will result in an error.
Only additional photo types can be starred or unstarred. The logo and cover image cannot be starred.

:::

For more details, refer to Manage photos for your location.

## Headers

- `Authorization` string, required

## Request body

- object
  - `input` object, required
    - `locationId` string, required: ID of the location containing the photos
    - `photoIds` string[], required: List of Photo IDs to be starred/unstarred, which can found from query locations
    - `starred` boolean, required: true to star; false to unstar

## Response `200`

The response will provide details of the photos that were processed, whether successfully starred or unstarred. If any errors occur, the response will include error information.

- object
  - `data` object, required
    - `starUnstarLocationPhotos` object, required
      - `success` boolean, required
      - `error` unknown, required
      - `photos` object[], required
        - `databaseId` integer
        - `fileSize` integer
        - `id` string
        - `name` string
        - `starred` boolean
        - `thumbnailUrl` string
        - `type` string
        - `url` string
        - `publisherOverride` string

---

[API](https://skmtc.dev/synup/apis/synup-api.md) - [All operations](https://skmtc.dev/synup/apis/synup-api/llms.txt) - [OpenAPI document](https://skmtc.dev/synup/apis/synup-api/revisions/67de2d51c22e?raw)