Documentation for a newer release is available. View Latest

Scheduled Settings

A scheduled setting allows you to configure a setting to take effect at a specified future date and time. Once that date and time is reached, the scheduled setting becomes current, replacing the previous setting. A setting is considered scheduled when its activeFromDate is greater than the current date and time.

Creating a Scheduled Setting

  • If a setting does not already exist, a scheduled setting can be created using:

    POST/settings-objects/{settingType}

  • If a current setting is present and a scheduled setting does not exist, a scheduled setting can be created using:

    PUT/settings-objects/{settingType}/{settingId}

Updating a Scheduled Setting

  • An existing scheduled setting can be updated using:

    PUT/settings-objects/scheduled-settings/{settingType}/{settingId}

  • The version number remains unchanged when updating a scheduled setting.

Deleting a Scheduled Setting

  • If a scheduled setting is no longer needed, it can be deleted using:

    DELETE/settings-objects/scheduled-settings/{settingType}/{settingId}

Important Considerations

  1. Only one scheduled setting can exist at any given time.

  2. If a scheduled setting is present, updates to the current setting are not permitted. To make an immediate change to a current setting, either:

    • Delete the scheduled setting using:

      DELETE/settings-objects/scheduled-settings/{settingType}/{settingId}

    • Or adjust the activeFromDate of the scheduled setting to a few seconds or minutes after the current date & time via:

      PUT/settings-objects/{settingType}/scheduled-settings/{settingId}

  3. When activeToDate is added to a dynamic configuration (and the change is approved if needed), the dynamic configuration will become not be considered active from the date and time specified on the activeToDate attribute. The dynamic configuration cannot be searched after the activeToDate has reached and will not apply to any operations that query the dynamic configurations database collections using corresponding logical unique key of the record.