Add a label to a photo. Requires admin access to the album.

POST/photo/addPhotoLabel

Authentication

Include your API key in the x-api-key header on every request.

Request body

albumIdstringrequired

The ID of the album containing the photo

photoIdstringrequired

The ID of the photo to label

labelstringrequiredmin 1max 40

The label to add to the photo (max. 40 characters)

isHiddenbooleandefault: false

Whether or not the label is hidden from non-admin users. Defaults to false.

Response · 200 Label added successfully

dataobjectrequired

messagestringrequired

warningsArray<string>

string

Errors

400Invalid request. The request was malformed or missing required parameters.

404Album or photo not found

TypeScript SDKts

import { SwshApiClient } from "@somewhere-somehow/swsh-public-api";

const client = new SwshApiClient({ apiKey: process.env.SWSH_API_KEY! });

const result = await client.photo.addPhotoLabel({
  albumId: "22222222-2222-2222-2222-222222222222",
  photoId: "44444444-4444-4444-4444-444444444444",
  label: "Vacation",
  isHidden: false
});

cURLbash

curl "https://public-api.joinswsh.com/photo/addPhotoLabel" \
  -X POST \
  -H "x-api-key: $SWSH_API_KEY" \
  -H "content-type: application/json" \
  -d '{
    "albumId": "22222222-2222-2222-2222-222222222222",
    "photoId": "44444444-4444-4444-4444-444444444444",
    "label": "Vacation",
    "isHidden": false
  }'

Example response

{"data": {"message": "Success!"
},
"warnings": ["Example warning"
]
}