API
Start typing to search…

Update client settings

put https://{hostname}/papi/v1/client-settings

Update the current set of default values that apply to API clients keyed by the current authorization token.

Query Params
string

For customers who manage more than one account, this runs the operation from another account. The Identity and Access Management API provides a list of available account switch keys.

Body Params
string
required

A string key indicating the dated version of the API's set of features specified by a rule format schema. This specifies the default rule format version to apply to new properties. See API versioning for more information.

boolean
required

Whether ID values in response data should feature three-letter prefixes to indicate their type. You can set the PAPI-Use-Prefixes header to override the client's default for each request.

Responses

Response body
object
string
required

A string key indicating the dated version of the API's set of features specified by a rule format schema. This specifies the default rule format version to apply to new properties. See API versioning for more information.

boolean
required

Whether ID values in response data should feature three-letter prefixes to indicate their type. You can set the PAPI-Use-Prefixes header to override the client's default for each request.

Headers
object
integer

Maximum sustainable number of request allowed each minute per account. This rate limit protects PAPI resources from being exhausted by single users. Once you exceed the limit, you receive the 429 error. If you call PAPI using multiple API clients within the same account, the rate limit applies globally to all API clients.

This API also provides a burst limit that specifies how many requests you can make in excess of the imposed rate limit. The one-time burst limit is 1000 requests. Once you consume all available resources, the burst capacity increases steadily by 100 requests every minute, until it reaches its initial maximum limit of 1000.

integer

Remianing number of requests allowed each minute per account. See Rate and resource limiting for details.

Updated over 1 year ago

Did this page help you?
Language
Authentication
Remember to add your authentication credentials to run this code.
URL

Updated over 1 year ago

Did this page help you?