Create allow/block rule

Create Allow/Block Rule

Allow/Block rules are an abuse prevention mechanism that allows you to define an allow-list and a block-list indicating whether a conversation can be start for a given contact.

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

Path parameters

workspaceId*string (uuid)

The workspace ID

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

Body

application/json

category*Conversations_AllowBlockRuleCategory (enum)

The category of the AllowBlockRule.

alldomaindomain_suffixemail

value*string

type*Conversations_AllowBlockRuleType (enum)

The type of the AllowBlockRule.

allowrejectsuspend

Response

201409422

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', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "category": "all",
      "value": "text",
      "type": "allow"
    }),
});
const data = await response.json();

Response

201409422

{
  "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": "2024-12-21T15:40:43.794Z",
  "updatedBy": "123e4567-e89b-12d3-a456-426614174000",
  "updatedAt": "2024-12-21T15:40:43.794Z"
}

Examples

Request

curl -X POST "https://api.bird.com/workspaces/a1405560-c8d3-4b1a-877d-3f449ad95352/conversation-allowblock-rules" \
-H "Content-Type: application/json" \
-H "Authorization: AccessKey abcd" \
-d '{
  "category": "domain",
  "value": "test.com",
  "type": "reject"
}'

Response (201 - Created)

{
  "id": "01937888-e7c4-79dd-af1f-c00d91a0f3a6",
  "workspaceId": "6b1908bd-2bc7-409e-bab4-ccfcd3ec69b9",
  "category": "domain",
  "value": "test.com",
  "type": "reject",
  "createdBy": "00000000-0000-0000-0000-000000000000",
  "createdAt": "2024-11-29T15:27:38.436082756Z",
  "updatedBy": "00000000-0000-0000-0000-000000000000",
  "updatedAt": "2024-11-29T15:27:38.436082756Z"
}