Create a new business policy

Request

🔒 Private label — contact sales. Requires a private-label entitlement on your API client.

Initializes a new business policy (e.g. SUBCATEGORY or CATEGORY) under the given policy group.

Security

oauth2ClientCredentials(Required scopes: business-policies:write)

Path

policyIdstringrequired

Policy group ID

Example:66788b3e2805e9ffbda6dcf7

business_idstringrequired

Business identifier for the request

Bodyapplication/jsonrequired

namestringrequired

Human-readable name for the new business policy

Example:"testing category"

descriptionstring

Optional description for the policy

Example:""

typestringrequired

Policy scope type (e.g. business, budget)

Example:"business"

curl -i -X POST \
  https://developer.boyahq.com/_mock/v2/openapi/business-policies/create/66788b3e2805e9ffbda6dcf7 \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'business_id: string' \
  -d '{
    "name": "testing category",
    "description": "",
    "type": "business"
  }'

Responses

Business policy created successfully

Bodyapplication/json

_idstring

Business policy MongoDB ObjectId

statusstring

Policy status

Enum:"ACTIVE""DISABLED""DELETED"

policyobject(PolicyRefV1Dto)

Parent policy group — either a MongoDB ObjectId string or an expanded PolicyRefV1Dto object

businessstring

Business MongoDB ObjectId this policy belongs to

policy_typestring

Policy scope (e.g. business, budget)

policy_codestring

Policy code inherited from the parent policy group

employeesArray of strings

Employee IDs this policy is scoped to

teamsArray of strings

Team IDs this policy is scoped to

budgetsArray of strings

Budget IDs this policy is scoped to

prioritynumber

Priority order among policies of the same type (lower = higher priority)

workflowobject or null

Approval workflow attached to this policy — null when no approval is required

rulesArray of objects(PolicyRuleV1Dto)

Rules defining the conditions and actions of this policy

namestring

Human-readable name for this business policy

descriptionstring

Optional description for this business policy

createdAtstring

ISO 8601 creation timestamp

updatedAtstring

ISO 8601 last-updated timestamp

Response

{
  "_id": "string",
  "status": "ACTIVE",
  "policy": {
    "_id": "string",
    "status": "ACTIVE",
    "description": "string",
    "policy_code": "string"
  },
  "business": "string",
  "policy_type": "string",
  "policy_code": "string",
  "employees": [
    "string"
  ],
  "teams": [
    "string"
  ],
  "budgets": [
    "string"
  ],
  "priority": 0,
  "workflow": {},
  "rules": [
    { … }
  ],
  "name": "string",
  "description": "string",
  "createdAt": "string",
  "updatedAt": "string"
}