Skip to content

Rippling: Update a Setting — request body — body

Update a Setting: request body, field body. Complete fields and constraints for contract 2026-10-28.

API reference · Contract 2026-10-28

SDK schema: Update a Setting — request body — body

FieldTypePresenceDescription and constraints
$objectRoot
api_namestringOptionalThe unique api name of the setting
boolean_valuebooleanOptionalBoolean value of the setting, if it has boolean data type
data_typestringOptionalData type of the setting
display_namestringOptionalThe display name of setting
number_valuenumberOptionalNumber value of the setting, if it has number data type
secret_valuestringOptionalSecret value of the setting, if it has secret data type
string_valuestringOptionalString value of the setting, if it has string data type
valueJSONOptional
value (anyOf 1)stringAlternative
value (anyOf 2)numberAlternative
value (anyOf 3)booleanAlternative

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.