OUoutrival
experiments

Update a saved draft experiment

Changed on
patch/api/v1/experiments/{experiment_id}

Request

  • Base URL
    https://api.outrival.com (the document declares no server; this is the origin it was published from)
  • URL
    https://api.outrival.com/api/v1/experiments/{experiment_id}
  • Auth
    HTTP bearer

Path parameters

experiment_idstring required

Request body

namestring required

What this experiment is testing

primary_metric'transfer' | 'success' | 'contact_rate' | 'opted_out' | 'not_interested' | 'post_transfer_follow_up' required
allocationnumber nullable

Optional. The experiment's total share of the campaign's traffic, as a PROPORTION IN 0..1. It is NOT stored — allocation lives on the groups — so supplying it only asks this endpoint to confirm that the group shares add up to what you meant, and the request is refused when they do not

notestring nullable

Free text stored with the experiment

expected_revisioninteger required

Response

Successful Response

object required

Changes