Settings API - DELETE an object

Updates the specified settings object. Deletion cannot be undone!

Early Adopter

This request is an Early Adopter release and may be changed in non-compatible way.

  • Managed https://{your-domain}/e/{your-environment-id}/api/v2/settings/objects/{objectId}
  • SaaS https://{your-environment-id}{objectId}


To execute this request, you need the Write settings (settings.write) permission assigned to your API token. To learn how to obtain and use it, see Tokens and authentication.


Parameter Type Description In Required
objectId string

ID of a settings object (e.g. Y2ktaGdyb3VwLTEyMythZjhjOThlOS0wN2I0LTMyMGEtOTQzNi02NTEyMmVlNWY4NGQ=)

path required
updateToken string

Generated upon retrieval and can be used to detect concurrent modification when set

query optional


Response codes

Code Description

Success. Response doesn't have a body.


Failed. The requested resource doesn't exist.


Conflicting resource

Response body

The SettingsObjectErrorResponse object

The response to a failed settings object request

Element Type Description
invalidValue SettingsValue
error Error
code integer

The HTTP Status code

The Error object

Element Type Description
constraintViolations ConstraintViolation[]
message string
code integer

The ConstraintViolation object

Element Type Description
parameterLocation string
location string
message string
path string

The SettingsValue object

A single value to be written to the settings. Its content depends on the schema defined for this type of setting.

Element Type Description