postV1AutomatedTestsId

Update an automated test

  • active
    Type: boolean
    required

    Whether the automated test is active. Inactive tests are not scheduled.

  • account_id
    Type: integerFormat: int32

    If provided, re-associates the automated test with this account. Must belong to the current project.

  • btob
    Type: boolean

    If true, the test targets a business (B2B) audience — Google Workspace and Office 365.

  • btoc
    Type: boolean

    If true, the test targets a consumer (B2C) audience — Gmail, Outlook.com, Hotmail, Yahoo.

  • hour
    Type: integerFormat: int32
    min:  
    0
    max:  
    23

    Local hour of the day (0–23) at which the test should run, in the provided time_zone.

  • repeat_period
    Type: stringenum

    Unit of the recurrence interval. One of WEEK or DAY.

    values
    • WEEK
    • DAY
  • repeat_period_delay
    Type: integerFormat: int32

    How many repeat_period units to wait between two runs. For example, repeat_period: "WEEK" + repeat_period_delay: 2 runs every two weeks.

  • seedlist
    Type: integerFormat: int32enum

    Seedlist identifier used for the test. One of 0, 1, 2, 3 or 4.

    values
    • 0
    • 1
    • 2
    • 3
    • 4
  • time_zone
    Type: string

    IANA time zone name used to interpret hour. Defaults to the project timezone when omitted.