Add allow/block rules in bulk

Add allow/block rules to bulk process via a csv file.

post

Add allow/block to bulk process via a csv file.

Authorizations

MessageBird_userMessageBird_accessKey

Path parameters

workspaceIdstring · uuidRequired

The workspace ID

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

Body

stringOptional

Responses

202

The Allow/Block rule bulk insert progress.

application/json

400

Bad request

application/json

post

HTTPcURLJavaScriptPython

POST /workspaces/{workspaceId}/conversation-allowblock-rules-bulk HTTP/1.1
Host: api.bird.com
Authorization: Bearer JWT
Content-Type: text/csv
Accept: */*
Content-Length: 6

"text"

{
  "workspaceId": "123e4567-e89b-12d3-a456-426614174000",
  "bulkId": "123e4567-e89b-12d3-a456-426614174000",
  "currentIndex": 1,
  "total": 1,
  "status": "pending",
  "errors": [
    "text"
  ],
  "updatedAt": "2025-05-29T06:33:25.253Z"
}

Examples

Request

curl -X POST "https://api.bird.com/workspaces/a1405560-c8d3-4b1a-877d-3f449ad95352/conversation-allowblock-rules-bulk" \
-H "Content-Type: text/csv" \
-H "Authorization: AccessKey abcd" \
-d '[e-mail],allow'

Response (202 - Accepted)

{
  "workspaceId": "6b1908bd-2bc7-409e-bab4-ccfcd3ec69b9",
  "bulkId": "875cd425-d62d-4d16-b3af-61dafe71ea2d",
  "currentIndex": 0,
  "total": 1,
  "status": "pending",
  "errors": null,
  "updatedAt": "2024-11-29T15:45:56.780546536Z"
}