Last updated 4 months ago
Was this helpful?
curl -X PATCH "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" }'
{ "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" }
The workspace ID
b4e02c85-c6d2-4b15-8885-e09671799c61
The category of the AllowBlockRule.
all
domain
domain_suffix
email
The type of the AllowBlockRule.
allow
reject
suspend
An AllowBlockRule is a rule that allows or blocks a specific value in a specific category.
PATCH /workspaces/{workspaceId}/conversation-allowblock-rules/{allowBlockRuleId} HTTP/1.1 Host: api.bird.com Authorization: Bearer JWT Content-Type: application/json Accept: */* Content-Length: 48 { "category": "all", "value": "text", "type": "allow" }
The Allow/Block rule.
{ "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-25T09:39:17.489Z", "updatedBy": "123e4567-e89b-12d3-a456-426614174000", "updatedAt": "2025-04-25T09:39:17.489Z" }