Update allow/block rule
Authorizations
Path parameters
workspaceIdstring · uuidRequiredExample:
The workspace ID
b4e02c85-c6d2-4b15-8885-e09671799c61
allowBlockRuleIdstring · uuidRequired
Body
categoryall of | nullableOptional
string · enumOptionalPossible values:
The category of the AllowBlockRule.
valuestring | nullableOptional
typeall of | nullableOptional
string · enumOptionalPossible values:
The type of the AllowBlockRule.
Responses
200
The Allow/Block rule.
application/json
404
The resource specified in the URL was not found
application/json
422
The request body did not pass validation
application/json
patch
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"
}
{
"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-07-01T17:48:37.538Z",
"updatedBy": "123e4567-e89b-12d3-a456-426614174000",
"updatedAt": "2025-07-01T17:48:37.538Z"
}
Examples
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"
}'
Last updated
Was this helpful?