Validate a configuration document

{
  "object": "string",
  "valid": true,
  "changes": [
    {
      "path": "outcome_definitions.chat_resolution.confirmation_window",
      "before": null,
      "after": null
    }
  ],
  "warnings": [
    {
      "code": "confirmation_window_short",
      "message": "The charge confirms almost at once, so only the reversal horizon protects you.",
      "path": "outcome_definitions.0.confirmation_window"
    }
  ],
  "errors": [
    {
      "code": "confirmation_window_short",
      "message": "The charge confirms almost at once, so only the reversal horizon protects you.",
      "path": "outcome_definitions.0.confirmation_window"
    }
  ]
}

Checks a document without writing anything: references between objects, clock windows against their bounds, and rates against credit types. A document with problems is a normal 200 response with valid: false and the errors, so an agent can read them and try again. Warnings, such as a confirmation window under one hour, don’t make a document invalid. Needs config:read. Works with sandbox and live keys.

Authentication

AuthorizationBearer

A secret key (rl_sk_test_..., rl_sk_live_...) or a restricted key with limited scopes (rl_rk_test_..., rl_rk_live_...). A restricted key can carry agent: true and an expires_at, and is what a coding agent should hold. Keys end in a checksum so secret scanners can recognize them. People create, roll and revoke keys in the dashboard; GET /v1/api_keys lists them, masked.

Request

This endpoint expects an object.

documentobjectRequired

Everything an agent or person configures, in the shape the create requests take. Leave a section out to leave it alone. Objects with a key are matched by key, webhook endpoints by url. Routing rules and notification rules are ordered lists that replace the current ones. Payment providers are connected with POST /v1/payment_providers, because a person completes that step.

reasonstringOptional<=500 characters

Why, in a sentence. Recorded in the audit log.

Response

The validation result.

object"config_validation"

validboolean

False when errors is not empty.

changeslist of objects

What applying the document would change.

warningslist of objects

errorslist of objects

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

429

Too Many Requests Error

500

Internal Server Error