Skip to main content
POST
/
api
/
policies
/
import
/
{import_id}
/
activate
Activate Rules
curl --request POST \
  --url https://api.example.com/api/policies/import/{import_id}/activate \
  --header 'Content-Type: application/json' \
  --data '
{
  "rule_ids": [
    {}
  ],
  "overwrite": true
}
'
{
  "import_id": "550e8400-e29b-41d4-a716-446655440000",
  "status": "activated",
  "activated_count": 5,
  "activated_rule_ids": [
    "cust_abc123_no_misleading_claims",
    "cust_abc123_benchmark_comparison_required",
    "cust_abc123_risk_disclosure_present",
    "cust_abc123_fee_transparency",
    "cust_abc123_past_performance_disclaimer"
  ]
}
Activate rules extracted from a policy import. Once activated, these rules will be enforced during document validation for your account. You can activate all rules or a specific subset.

​
Path Parameters

​
import_id
string
required
The import ID to activate rules from

​
Request Body

​
rule_ids
array
Optional list of specific rule IDs to activate. If omitted, all extracted rules are activated.
​
overwrite
boolean
Set to true to overwrite rules that have already been activated from a previous import. Defaults to false.
When overwrite is false (default), if a rule ID already exists the request stops and returns a 409 conflict response. The 409 error body includes an error message that identifies the conflicting rule ID and indicates which rules were successfully activated before the collision. Use overwrite: true to replace existing rules unconditionally.

​
Response

​
import_id
string
Import identifier
​
status
string
Updated import status: activated
​
activated_count
integer
Number of rules successfully activated
​
activated_rule_ids
array
List of activated rule IDs (prefixed with cust_<customer_id>_)
​
conflicting_rule_id
string
For 409 responses, the rule ID that caused the conflict.
{
  "import_id": "550e8400-e29b-41d4-a716-446655440000",
  "status": "activated",
  "activated_count": 5,
  "activated_rule_ids": [
    "cust_abc123_no_misleading_claims",
    "cust_abc123_benchmark_comparison_required",
    "cust_abc123_risk_disclosure_present",
    "cust_abc123_fee_transparency",
    "cust_abc123_past_performance_disclaimer"
  ]
}

​
Example

curl -X POST "https://{api-url}/api/policies/import/550e8400-e29b-41d4-a716-446655440000/activate" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json"