updateTiersProgramSettings( )

Updates the global settings of a loyalty tier program.

Use this endpoint to update settings that apply to all of a site's loyalty tiers. To update tier-specific settings for an individual tier, use updateTier().

By default, the status of a tiers program is set to "DISABLED" and must be manually updated to "ACTIVE" using this endpoint or through a site owner's dashboard.

Note: The status, revision, and rollingWindow parameters must be passed to update the tiers program settings. The baseTierDefinition fields are not required, however, if you don't pass them they will reset to their default values of empty fields.

Admin Method

This function requires elevated permissions and runs only on the backend and on dashboard pages.

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Loyalty
Learn more about permission scopes.
Method Declaration
Copy
Method Parameters
programSettingsTiersProgramSettingsRequired

Settings for the tiers program.

Returns
Return Type:Promise<UpdateTiersProgramSettingsResponse>
Was this helpful?
Yes
No