experiments

Copy a template as a new variant

Changed on

Copies the template you specify into a new variant on a campaign experiment that's in <code>draft</code> or <code>ready</code> status. Each successful request adds another variant, so retrying a successful request creates a duplicate. 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.

post/api/experiments/{experimentId}/variants

Request

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

Path parameters

experimentIdinteger required

Experiment ID

Request body

copyFromTemplateIdinteger required

ID of the template to copy. Iterable creates a new variant from this template.

namestring

Optional display name for the new variant.

Response

Variant created

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