Skip to navigation

Update Organization Settings

Update the settings you send. tag_definitions and vendor_restrictions replace the whole value.

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.

Request

This endpoint expects an object.
auto_handle_model_deprecationsboolean or nullOptional
Move routing policies off deprecated models automatically. Omit, or send null, to keep the current value.
log_payloadsboolean or nullOptional
Store request and response bodies. Omit, or send null, to keep the current value.
namestring or nullOptional1-255 characters
The organization's name. Omit, or send null, to keep the current value.
tag_definitionslist of objects or nullOptional
The request tag keys the organization uses, and the values each allows. Replaces the whole list. Omit, or send null, to keep the current value.
vendor_restrictionsobject or nullOptional
Replaces the whole object. Omit, or send null, to keep the current value.
web_search_modeenum or nullOptional

How requests that use a vendor’s built-in web search run: auto uses the vendor’s search where the route can, else Merge’s; merge always uses Merge’s; native only the vendor’s, failing with 400 where the route can’t. Omit, or send null, to keep the current value.

Allowed values:
zero_data_retentionboolean or nullOptional
Route only to vendors that retain no data. Omit, or send null, to keep the current value.

Response

The updated organization settings
auto_handle_model_deprecationsboolean
Move routing policies off deprecated models automatically.
created_atdatetimeRead-only
When the organization was created.
idstringRead-onlyformat: "uuid"
The organization's id.
log_payloadsboolean
Store request and response bodies.
namestring
The organization's name.
slugstringRead-only
Set when the organization is created. It doesn't change.
tag_definitionslist of objects
The request tag keys the organization uses, and the values each allows.
vendor_restrictionsobject
Which vendors and regions requests may use, and whose credentials.
web_search_modeenum

How requests that use a vendor’s built-in web search run: auto uses the vendor’s search where the route can, else Merge’s; merge always uses Merge’s; native only the vendor’s, failing with 400 where the route can’t.

Allowed values:
zero_data_retentionboolean
Route only to vendors that retain no data.

Errors

401
Unauthorized Error
403
Forbidden Error
422
Unprocessable Entity Error