Delete a list

Delete a list

delete

https://api.bird.comhttp://localhost:3000https://api.bird.ai

/workspaces/{workspaceId}/lists/{listId}

Delete a list given its ID.

Authorizations

MessageBird_userMessageBird_accessKey

AuthorizationstringRequired

An access token issued to a user.

Path parameters

workspaceIdstring · uuidRequired

Your workspace identifier.

Example: b4e02c85-c6d2-4b15-8885-e09671799c61

listIdstring · uuidRequired

The ID of a list.

Example: b4e02c85-c6d2-4b15-8885-e09671799c61

Responses

204

The list was deleted successfully.

404

The workspace or list was not found.

application/json

delete

/workspaces/{workspaceId}/lists/{listId}

HTTPcURLJavaScriptPython

DELETE /workspaces/{workspaceId}/lists/{listId} HTTP/1.1
Host: api.bird.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Examples

Let's establish some of our data that will be used in the following examples:

• Workspace ID: a1405560-c8d3-4b1a-877d-3f449ad95352

• AccessKey: abcd

• List ID: 123e4567-e89b-12d3-a456-426614174000

Delete a list

In this example, we are deleting a list given its ID.

Request

curl -X DELETE "https://api.bird.com/workspaces/a1405560-c8d3-4b1a-877d-3f449ad95352/lists/123e4567-e89b-12d3-a456-426614174000" \
-H "Content-Type: application/json" \
-H "Authorization: AccessKey abcd"

Response (204 - No Content)