Add allow/block rules in bulk

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

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

POSThttps://api.bird.com/workspaces/{workspaceId}/conversation-allowblock-rules-bulk

Path parameters

workspaceId*string (uuid)

The workspace ID

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

Body

text/csv

string

Response

202400

The Allow/Block rule bulk insert progress.

Body

application/json

workspaceIdstring (uuid)

bulkIdstring (uuid)

currentIndexinteger

totalinteger

statusenum

pendingin_progresscompletedfailed

errorsnullable array of string

updatedAtstring (date-time)

Request

JavaScriptCurlPython

const response = await fetch('https://api.bird.com/workspaces/{workspaceId}/conversation-allowblock-rules-bulk', {
    method: 'POST',
    headers: {
      "Content-Type": "text/csv"
    },
    body: JSON.stringify("text"),
});
const data = await response.json();

Response

202400

{
  "workspaceId": "123e4567-e89b-12d3-a456-426614174000",
  "bulkId": "123e4567-e89b-12d3-a456-426614174000",
  "currentIndex": 0,
  "total": 0,
  "status": "pending",
  "errors": [
    "text"
  ],
  "updatedAt": "2025-01-21T01:43:32.247Z"
}

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"
}