experiments

Update experiment settings

Changed on

Updates settings on a campaign experiment that's in <code>draft</code> or <code>ready</code> status. Iterable changes only the fields you send. Omitted fields keep their current values, and <code>null</code> removes a setting when the field allows it. Blast campaigns accept blast and holdout settings, and triggered campaigns accept trigger settings. This endpoint works only with experiments that test message content: the subject line, preheader text, from name and sender, email body, or all content. It doesn't work with send time or Send Time Decisioning experiments. This endpoint doesn't support journey experiments.

patch/api/experiments/{experimentId}/settings

Request

  • Base URL
    https://api.iterable.com
  • Auth
    API key in header Api-Key

Path parameters

experimentIdinteger required

Experiment ID

Request body

evenlySplitVariationsboolean

Set to <code>true</code> to split the audience evenly across variants. This removes any blast or trigger test group. To stop splitting evenly, send blast or trigger settings instead. To keep the current split, leave this out from the request.

Response

Experiment settings updated

allocationModestring required

Traffic allocation mode

channelType'email' | 'push' | 'sms' | 'in_app' | 'web_push' required

Channel type for the experiment.

creationDatestring date-time

Date the experiment was created

experimentTypestring required

Experiment type

finishDatestring date-time

End date of the experiment

idinteger required

Experiment ID

startDatestring date-time

Start date of the experiment

status'draft' | 'ready' | 'running' | 'finished' | 'winner_found' required

Experiment status

Changes