Delete a list

Delete a list

Delete a list given its ID.

delete

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

Authorizations

MessageBird_userMessageBird_accessKey

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

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url 'https://api.bird.com/workspaces/{workspaceId}/lists/{listId}' \
  --header 'Authorization: Bearer JWT'

204

404

204

No body

The list was deleted successfully.

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)