Create a new album

POST /album/createAlbum
application/json

Body Required

  • name string Required

    Minimum length is 1, maximum length is 40.

Responses

  • 200 application/json

    Album created successfully

    Hide response attributes Show response attributes object
    • data object Required
      Hide data attributes Show data attributes object
      • albumId string Required
      • name string
      • 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.

    • warnings array[string]
  • 400 application/json

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

    Hide response attribute Show response attribute object
POST /album/createAlbum 
curl \
 -X POST https://public-api.joinswsh.com/album/createAlbum \
 -H "x-api-key: $API_KEY" \
 -H "Content-Type: application/json" \
 -d '{"name":"My Album"}'
Request example 
{
  "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"
  },
  "warnings": [
    "Example warning"
  ]
}
Response examples (400) 
{
  "message": "Invalid request"
}