Get allow/block rule

Get Allow/Block rule

GEThttps://api.bird.com/workspaces/{workspaceId}/conversation-allowblock-rules/{allowBlockRuleId}

Path parameters

workspaceId*string (uuid)

The workspace ID

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

allowBlockRuleId*string (uuid)

Response

200404

The Allow/Block rule.

Body

application/json

id*string (uuid)

workspaceId*string (uuid)

category*Conversations_AllowBlockRuleCategory (enum)

The category of the AllowBlockRule.

alldomaindomain_suffixemail

value*string

type*Conversations_AllowBlockRuleType (enum)

The type of the AllowBlockRule.

allowrejectsuspend

createdBy*string (uuid)

createdAt*string (date-time)

updatedBy*string (uuid)

updatedAt*string (date-time)

Request

JavaScriptCurlPython

const response = await fetch('https://api.bird.com/workspaces/{workspaceId}/conversation-allowblock-rules/{allowBlockRuleId}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200404

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "workspaceId": "123e4567-e89b-12d3-a456-426614174000",
  "category": "all",
  "value": "text",
  "type": "allow",
  "createdBy": "123e4567-e89b-12d3-a456-426614174000",
  "createdAt": "2025-01-21T01:41:42.611Z",
  "updatedBy": "123e4567-e89b-12d3-a456-426614174000",
  "updatedAt": "2025-01-21T01:41:42.611Z"
}