ITiterable
experiments

Cancel an experiment

Changed on

Cancels a campaign experiment that's in <code>running</code> or <code>winner_found</code> status without declaring a winner. The campaign keeps its current template. This endpoint doesn't support journey experiments.

post/api/experiments/{experimentId}/cancel

Request

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

Path parameters

experimentIdinteger required

Experiment ID

Response

Experiment canceled

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