Skip to navigation
Management APIProjects

Update Project Controls

Replace the project’s override with exactly the fields you send; omit a unit to inherit it. A management key can only tighten the organization’s controls (narrow an allowlist, add to a denylist, turn zero data retention on); anything that loosens them is refused with 403 scoped_controls_loosening_forbidden. Loosening is available in the dashboard.

Authentication

AuthorizationBearer

A management key (mgmt_...), sent as Authorization: Bearer <key>. Reading /v1/routing-policies also accepts the organization’s gateway API keys; writing there needs a management key.

Path parameters

project_idstringRequiredformat: "uuid"

The project’s id.

Request

This endpoint expects an object.
allowed_regionslist of strings or nullOptional

When non-empty, the only regions the project may route to. Vendors with no known region are excluded. Each token is a vendor’s country_code or geo_region, as listed by GET /v1/organization/vendors, like US, CA or NA. Case-sensitive; an unknown token is a 422.

allowed_vendorslist of strings or nullOptional

When non-empty, the only vendors the project may route to.

ignored_regionslist of strings or nullOptional

Regions the project may never route to. Each token is a vendor’s country_code or geo_region, as listed by GET /v1/organization/vendors, like US, CA or NA. Case-sensitive; an unknown token is a 422.

ignored_vendorslist of strings or nullOptional
Vendors the project may never route to.
vendor_routing_preferencelist of strings or nullOptional
Vendors to try first among those that remain. Never excludes a vendor.
zero_data_retentionboolean or nullOptional
true routes only to vendors that retain no data. Omitted or null inherits the organization's value.

Response

The project's updated controls
effectiveobject
The controls in force.
overrideobject
What the project sets.
scopestring

Always project here.

scope_idstringformat: "uuid"
The project's id.
sourcesobject
Where each unit's effective value comes from.

Errors

401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
422
Unprocessable Entity Error
502
Bad Gateway Error