Update experiment

Modify an existing experiment’s configuration or status.

Updates experiment metadata or inputs. Only experiments in Draft or InReview status can be modified; attempts on later statuses return 409 Conflict.

PATCH /api/v1/experiments/{experiment_id}

Update experiment

cURL

curl --request PATCH \
  --url https://foundry-api-public.adaptyvbio.com/api/v1/experiments/{experiment_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "antigen_concentrations": [
    123
  ],
  "description": "<string>",
  "n_replicates": 1,
  "name": "<string>",
  "parameters": "<unknown>",
  "sequences": [
    {
      "aa_string": "EVQLVESGGGLVQPGGSLRLSCAAS",
      "control": true,
      "metadata": "<unknown>",
      "name": "mAb1"
    }
  ],
  "target_id": "<string>",
  "webhook_url": "<string>"
}
'

200

{
  "id": "<string>",
  "updated": true,
  "message": "<string>"
}

Authorizations

Authorization · string · header · required

Biscuit-based bearer token. Obtain tokens from the Adaptyv Portal or via the /tokens endpoint. Tokens encode organization membership and role-based capabilities; the API verifies the token's cryptographic signature and authorization claims before processing requests. Use /tokens/attenuate to create restricted tokens for delegation.

Path Parameters

experiment_id · string<uuid> · required

Unique experiment request identifier to modify

Body

application/json

Request payload for modifying an existing experiment.

All fields are optional - only provided fields will be updated. Note: Some modifications may be restricted based on experiment status. Modifications are only allowed if the experiment request is not yet fulfilled.

Status transitions are handled separately via the /experiments/{id}/confirm endpoint, which performs the appropriate transition based on current state.

antigen_concentrations · number<double>[] | null

Update antigen concentrations (only if not fulfilled)

description · string | null

Update experiment description

n_replicates · integer<int32> | null

Update replicate count (only if not fulfilled)

Required range: x >= 0

name · string | null

Update experiment name

parameters · any

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

sequences · object[] | null

Replace sequence list (only if not fulfilled)

Show child attributes

target_id · string | null

Update target identifier (only if not fulfilled).

• Omitted: keep current target
• null: remove target (deletes requested_materials and agreed_on_materials)
• "uuid": change to new target (performs catalog lookup, updates materials, autolinks)

webhook_url · string | null

Update the webhook URL for notifications

Response

200

application/json

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

Response confirming experiment modification.

id · string · required

Experiment identifier that was modified

updated · boolean · required

Indicates if any changes were applied

message · string | null

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