Edit an existing album

POST /album/editAlbum

Api key auth

application/json

Body Required

albumId string Required

The ID of the album to edit
name string

Minimum length is 1, maximum length is 40.

Responses

200 application/json

Album edited successfully
Hide response attributes Show response attributes object
- data object Required
  
  Hide data attributes Show data attributes object
  
  albumId string Required
  
  name string
  
  Minimum length is 1, maximum length is 40.
  
  ownerId string
  
  shareUrl string
  
  A URL that can be shared with others to view the album. This URL is static and will always point to the album. You can safely cache this URL for future use.
  
  numPhotos integer
  
  The number of photos in the album
  
  numParticipants integer
  
  The number of participants in the album (inclusive of the album owner)
- warnings array[string]
400 application/json

Invalid request. The request was malformed or missing required parameters.
Hide response attribute Show response attribute object
- message string Required
404

Album not found

POST /album/editAlbum

curl \
 --request POST 'https://public-api.joinswsh.com/album/editAlbum' \
 --header "x-api-key: $API_KEY" \
 --header "Content-Type: application/json" \
 --data '{"albumId":"22222222-2222-2222-2222-222222222222","name":"My Album"}'

Request examples

{
  "albumId": "22222222-2222-2222-2222-222222222222",
  "name": "My Album"
}

Response examples (200)

{
  "data": {
    "albumId": "22222222-2222-2222-2222-222222222222",
    "name": "My Album",
    "ownerId": "11111111-1111-1111-1111-111111111111",
    "shareUrl": "https://joinswsh.com/album/abcdef",
    "numPhotos": 5,
    "numParticipants": 2
  },
  "warnings": [
    "Example warning"
  ]
}

Response examples (400)

{
  "message": "Invalid request"
}