Override Flags
Destructive or non-default behaviors require explicit opt-in via the X-Operator-Override header.
The grammar
Override flags live in a single header — X-Operator-Override — comma-separated. Some flags take a value via a pipe-separated sub-grammar.
DELETE /v2/partner/contacts/{id}
X-Operator-Override: destructive
→ 204 No Content Multiple flags:
X-Operator-Override: destructive,bulk
X-Operator-Override: force,bypass_validation=email_format|phone_format The standard flag set
| Flag | Purpose |
|---|---|
destructive | Required for any endpoint marked destructive in OpenAPI (most DELETE operations). Without it: 403 override_required. |
bulk | Required when the operation affects more rows than the endpoint's bulk threshold. Without it: 403 bulk_override_required with the row count in meta. |
force | Skips soft-validation (e.g., warnings about archived state, locked workflows). Required when the resource is in a state the endpoint would normally refuse. |
bypass_validation | Skips specific validators. Format: bypass_validation=<validator_name>. Multiple via pipe: bypass_validation=email_format|phone_format. |
dry_run | Computes the change without persisting. Returns the would-be response with X-Dry-Run: true header. No mutations. |
Per-endpoint declarations
Endpoints declare which flags they accept (and which they require) in their OpenAPI spec. The per-endpoint pages on this site enumerate accepted flags in the Parameters section under the X-Operator-Override header.
Why the comma vs pipe split
Comma separates top-level flags. Pipe separates the values inside a single flag's argument. This grammar avoids collisions when a flag's value list itself needs to contain multiple items (validator names, scoping kinds).
The valid composition shape:
X-Operator-Override: <flag>[=<value>[|<value>]*],... Errors
| Code | HTTP | Meaning |
|---|---|---|
override_required | 403 | Endpoint requires X-Operator-Override flag not present |
bulk_override_required | 403 | Operation exceeds bulk threshold; include bulk in override header |
invalid_override | 400 | Override flag isn't accepted by this endpoint |