Update Recommendation Settings

Partially updates the site's AEO recommendation settings. Omitted fields are left unchanged. Returns the fully resolved settings document after the update, including `createdOn` and `updatedOn` for the persisted document. <Warning title="AEO recommendations entitlement required">This endpoint requires a workspace with the AEO recommendations entitlement.</Warning> Required scope | `sites:write`

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

site_idstringRequiredformat: "objectid"
Unique identifier for a Site

Request

Partial update for recommendation settings. Provide at least one of ruleConfig or recurringAuditsEnabled.

ruleConfigobjectOptional
Partial map of recommendation rules to enable or disable. Omitted rules are left unchanged. At least one rule must be present when this object is sent.
recurringAuditsEnabledbooleanOptional
Enable or disable recurring audits.

Response

Updated recommendation settings
ruleConfigobject

Fully resolved per-rule toggles. Every recommendation rule is present.

recurringAuditsEnabledboolean
Whether recurring audits are enabled. Always present on the wire.
lastAuditedOnstringOptionalformat: "date-time"
When the site was last audited.
createdOnstringOptionalformat: "date-time"

When the settings document was created. Omitted when no settings document exists yet (never-configured site).

updatedOnstringOptionalformat: "date-time"

When the settings document was last updated. Omitted when no settings document exists yet (never-configured site).

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
429
Too Many Requests Error
500
Internal Server Error