Update an Account

patch

https://api.unipile.com/v2/accounts/{account_id}

Update an Account by ID.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

account_id

string

required

^acc_(.*)$

The ID of the Account to update.

Body Params

account_scope_id

string

^scope_(.*)$

The Scope to permanently assign to an unscoped Account. This field requires a Service API Key, and the Scope cannot be removed or replaced after assignment.

metadata

object

Custom key-value data for the account. Replaces the account metadata.custom_data field; other metadata fields are not modified. Any fields not provided will be removed.

auto_proxy_country

string

The rotation country to use for Automatic Proxy Protection. Choose from the countries where Unipile offers automatic proxies. A proxy may be temporarily unavailable even in a country included in the offering.

allow_country_fallback

boolean

Whether Automatic Proxy Protection may use an available proxy from another country when none is available in the rotation country, during authentication and throughout the account lifetime. Defaults to true. An explicitly selected rotation country must be part of Unipile’s proxy offering for the provider, but a proxy may still be temporarily unavailable there. If false, authentication fails when no proxy is available in the rotation country; if the selected proxy later fails without an available replacement there, the account enters Service interruption.

proxy

Custom proxy | null

A new proxy configuration for the account. This will restart the account. Set to null to remove the proxy. Removing the proxy will revert the account to using Automatic Proxy Protection if required for the provider.

Response

200Default Response