Skip to main content
PUT
Replace the Provider Allowlist
Replaces the whole set of providers your organization offers with the ids in the body. A provider the body omits stops being offered. This is a replace, not a merge — use Update Several Providers’ Visibility to change some providers without restating the rest. Removing a provider keeps its instruction override, so toggling it off and on again does not lose your wording.

Body

string[]
required
The complete set of provider ids your organization offers. UPPER_SNAKE_CASE catalogue ids ([A-Z0-9_]), at most 100 characters each, at most 500 entries. Case-insensitive — normalized to upper case.An empty array is a legal request and clears the allowlist, the same end state as Clear the Provider Allowlist. A save-everything admin screen therefore needs no special case for “the last provider was unticked”.
Under the opt-in rule, an empty provider_ids leaves your organization with no allowlist entries at all — it is not a “show everything” switch. Send the ids you want to offer rather than clearing the list to widen it.

Response

The refreshed overlay, in the same shape as List the White-label Provider Overlay.
boolean
Whether your organization has at least one allowlist entry, after this change.
object[]
The union of your allowlist, your instruction overrides, and your logo overrides.

Errors

Authorizations

PUBLIC-API-KEY
string
header
default:<Your PUBLIC-API-KEY>
required
PRIVATE-SECRET-KEY
string
header
default:<Your PRIVATE-SECRET-KEY>
required

Body

application/json

The complete set of provider ids to offer.

provider_ids
string[]
required

The complete set of provider ids the organization offers. UPPER_SNAKE_CASE catalogue ids ([A-Z0-9_]), at most 100 characters each, at most 500 entries.

Maximum array length: 500
Maximum string length: 100
Example:

Response

The refreshed overlay.

filtered
boolean

Whether the organization has at least one allowlist entry. Branch on this, never on the length of providers — the list is also non-empty when the only entries are instruction or logo overrides.

Example:

true

providers
object[]

The union of the allowlist, the instruction overrides, and the logo overrides. A provider can carry custom wording or a custom logo without being offered, in which case it appears with allowed: false.