Skip to main content

Update Goal Settings

PUT 

/api/advertising/goals/settings

Sets the tenant's goal mode. The change is recorded in the activity log.

Required scope: advertising:write

Grant this scope to your token under Settings → Developer → Personal Access Tokens.

Requires the advertising.manage permission; the tenant must have the advertising-manager feature enabled. Setting auto additionally requires the advertising.approve permission (403 otherwise).

Body fields:

  • goal_mode (required): suggest or auto.

The response also returns dismissal_suppression_days: how many days a dismissed goal suggestion is not offered again for the same product and goal (14 by default).

Request​

Responses​

OK

Response Headers
    Content-Type