Delete a video playlist | OCT-103 Gumlet outreach

1 parameter

playlist_idstringrequired

The ID of the playlist to delete.

4 status codes

200Returns a successful response after the playlist is deleted.

400Returned when the request is invalid.

One documented failure

incorrect_playlist_id
No playlist with provided id exists.

errorobjectrequired

401Returned when the request has a missing or invalid API key or bearer token.

One documented failure

invalid_api_key
API key supplied with request is invalid

errorobjectrequired

403Returned when the account is unpaid or the authenticated user has insufficient role permissions.

One documented failure

unauthorized
You don't have access to this feature. Please contact your organization owner.

errorobjectrequired

Error handling

A 400 is returned for a bad request. A 401 is returned when the request has a missing or invalid API key or bearer token. A 403 is returned for an unpaid account or insufficient role permissions. The playlist_id path parameter must identify the playlist to delete.

import { Gumlet } from "oct-103-gumlet-outreach-sdk";

const client = new Gumlet({
  baseUrl: "https://api.gumlet.com/v1",
  auth: { apiKey: process.env.GUMLET_API_KEY! },
});

await client.videoPlaylists.deletePlaylist({ playlistId: "9b2f1c10-7a3e-4d54-8c2a-1f6b9e0d4a21" });

{
  "error": {
    "code": "incorrect_playlist_id",
    "message": "No playlist with provided id exists."
  }
}

Request

Response

Errors