PUT /comparison/{id}?type=update

Updates an A/B test's name, description and/or attached variants.

📘

Authorization

Requires a valid API Key in the Authorization header. Send the key directly — no Bearer prefix.

🚧

?type=update is required

Missing or wrong type returns 400 "Type not specified".

⚠️

Variants only mutable while DRAFT

The server‑side rule is: if status !== "DRAFT", video_ids is silently ignored — name/description still update, but the variant list does not change. Even so, video_ids is required in the body by the AJV validator. Send the current list when you only want to rename a running/completed test.

HTTP Method & Path

PUT /comparison/{id}?type=update

Base URL: https://api-v2.pandavideo.com.br

Path Parameters

Query Parameters

Request Body

Content-Type: application/json

{
  "name": "Thumb test — Q1 (renamed)",
  "description": "Comparing 3 thumbnails for the welcome video.",
  "video_ids": [
    "f1f2f3f4-aaaa-bbbb-cccc-d1d2d3d4d5d6",
    "f1f2f3f4-aaaa-bbbb-cccc-d1d2d3d4d5d7",
    "f1f2f3f4-aaaa-bbbb-cccc-d1d2d3d4d5d8"
  ]
}

Response

Success Response (200)

Returns the updated comparison plus pullzone (same shape as Get A/B Tests Properties).

Side effects

• When the status is not DRAFT, the S3 config is rewritten on success (status + variants). On DRAFT the S3 file is not regenerated by this endpoint.
• Audit logs:
  • category: comparison, activity: rename when name changed.
  • category: comparison, activity: duplicate_video when video_ids differs and ?duplicate=<id> was sent.

Error Responses

• 400 — body fails the AJV schema (missing name/description/video_ids, duplicates, invalid UUID v4, extra properties, or name.length > 255). Also "Type not specified" when the query is missing.
• 404 — "Comparison not found", or "Video not found" (only checked when status ≠ DRAFT — the validator pre‑checks the videos exist for the user before applying the no‑op).
• 401 — missing/invalid API Key.
• 500 — "Library not found" or internal error.

Example Usage

cURL

curl --request PUT \
  --url 'https://api-v2.pandavideo.com.br/comparison/636f6d70-e29b-41d4-a716-446655440000?type=update' \
  --header 'Authorization: <your-api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "Thumb test — Q1 (renamed)",
    "description": "Comparing 3 thumbnails for the welcome video.",
    "video_ids": [
      "f1f2f3f4-aaaa-bbbb-cccc-d1d2d3d4d5d6",
      "f1f2f3f4-aaaa-bbbb-cccc-d1d2d3d4d5d7"
    ]
  }'

Recipes