Get allow/block bulk upload status

Get Allow/Block rule bulk create Process Status

Get an Allow/Block rule create Process Status

GEThttps://api.bird.com/workspaces/{workspaceId}/conversation-allowblock-rules-bulk/{bulkId}/status

Path parameters

workspaceId*string (uuid)

The workspace ID

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

bulkId*string (uuid)

Response

200404

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/{bulkId}/status', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200404

{
  "workspaceId": "123e4567-e89b-12d3-a456-426614174000",
  "bulkId": "123e4567-e89b-12d3-a456-426614174000",
  "currentIndex": 0,
  "total": 0,
  "status": "pending",
  "errors": [
    "text"
  ],
  "updatedAt": "2024-12-30T17:06:35.010Z"
}