Get allow/block rule

Get Allow/Block rule

get

Authorizations

MessageBird_userMessageBird_accessKey

Path parameters

workspaceIdstring · uuidRequired

The workspace ID

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

allowBlockRuleIdstring · uuidRequired

Responses

application/json

objectOptional

An AllowBlockRule is a rule that allows or blocks a specific value in a specific category.

application/json

get

HTTPcURLJavaScriptPython

GET /workspaces/{workspaceId}/conversation-allowblock-rules/{allowBlockRuleId} HTTP/1.1
Host: api.bird.com
Authorization: Bearer JWT
Accept: */*

{
  "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-04-19T00:28:38.876Z",
  "updatedBy": "123e4567-e89b-12d3-a456-426614174000",
  "updatedAt": "2025-04-19T00:28:38.876Z"
}