Delete an existing album

POST/album/deleteAlbum

Authentication

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

Request body

albumIdstringrequired

The ID of the album to delete

Response · 200 Album deleted successfully

dataobjectrequired

messagestringrequired

warningsArray<string>

string

Errors

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

404Album 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.album.deleteAlbum({
  albumId: "22222222-2222-2222-2222-222222222222"
});

cURLbash

curl "https://public-api.joinswsh.com/album/deleteAlbum" \
  -X POST \
  -H "x-api-key: $SWSH_API_KEY" \
  -H "content-type: application/json" \
  -d '{
    "albumId": "22222222-2222-2222-2222-222222222222"
  }'

Example response

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