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

accessKey

HTTPRequired

Uses the Authorization header: 'AccessKey ' followed by your access key token (e.g., 'Authorization: AccessKey AbCdEfGhIjKlMnOpQrStUvWxYzAbCdEfGhIj')

Path parameters

workspaceIdstring · uuidRequired

The workspace ID

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

Body

text/csv

stringOptional

Responses

202

The Allow/Block rule bulk insert progress.

application/json

400

Bad request

application/json

post

/workspaces/{workspaceId}/conversation-allowblock-rules-bulk

HTTPcURLJavaScriptPython

POST /workspaces/{workspaceId}/conversation-allowblock-rules-bulk HTTP/1.1
Host: api.bird.com
Authorization: AccessKey YOUR_SECRET_TOKEN
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-12-19T15:35:57.647Z"
}

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 '[email protected],allow'

Response (202 - Accepted)