ADadaptyvbio
experiments

Update experiment

Modify an existing experiment's configuration or status.

Updates experiment metadata or inputs. Most fields can only be changed while the experiment is in Draft or InReview status; naming one on a later status returns 409 Conflict. webhook_url is the exception and stays editable for the life of the experiment, so a customer can repoint delivery after submitting.

patch/api/v1/experiments/{experiment_id}

Request

  • Base URL
    https://devs.adaptyvbio.com
  • URL
    https://devs.adaptyvbio.com/api/v1/experiments/{experiment_id}
  • Auth
    HTTP bearer

Path parameters

experiment_idstring uuid required

Unique experiment request identifier to modify

Request body

antigen_concentrationsnumber[] nullable

Update antigen concentrations (only if not fulfilled)

descriptionstring nullable

Update experiment description

n_replicatesinteger nullable

Update replicate count (only if not fulfilled)

namestring nullable

Update experiment name

parametersobject nullable

Update experiment parameters (restrictions may apply, only if not fulfilled)

target_idstring nullable

Change the experiment's catalog target (only while the experiment is editable).

  • omitted: keep the current target
  • null: clear the target
  • a catalog product UUID (as returned by GET /targets): set the target to that product
webhook_urlstring nullable

Update the webhook URL for push notifications. The URL receives an experiment_update event for every customer-facing update on the experiment — the same updates that trigger an email notification.

Unlike every other field here, this one can be changed at any status, so delivery can be repointed after the experiment has been submitted.

Example request

{
  "sequences": [
    {
      "aa_string": "EVQLVESGGGLVQPGGSLRLSCAAS",
      "name": "mAb1"
    }
  ]
}

Response

Experiment modified successfully or no action taken (e.g., already fulfilled)

idstring required

Experiment identifier that was modified

messagestring nullable

Optional message, e.g., if modification is not allowed

updatedboolean required

Indicates if any changes were applied

Changes

No recorded changes to this operation across all 1 revision of this API.