Update test

Partial update of test metadata. After launch, title, hypothesisDescription, controlTitle, variantTitle, priority, surfaceArea, impact, effort, and tagIds remain mutable; implemented becomes mutable once the test has ended. All other fields (goal, device, visitorOption, controlTraffic, audiences, campaignId, variant, scheduling) are locked.

patch

Authorizations

AuthorizationstringRequired

All requests require Authorization: Bearer sl_live_<your_api_key>. Generate a key from the Shoplift admin's API Keys settings page.

Path parameters

idstring · uuidRequired

Body

titlestring · nullableOptional

hypothesisDescriptionstring · nullableOptional

controlTitlestring · nullableOptional

variantTitlestring · nullableOptional

goalstring · nullableOptional

devicestring · nullableOptional

visitorOptionstring · nullableOptional

controlTrafficinteger · nullableOptional

defaultAudiencesstring[] · nullableOptional

customAudienceIdsstring · uuid[] · nullableOptional

campaignIdstring · nullableOptional

automaticallyStartAtstring · nullableOptional

automaticallyEndAtstring · nullableOptional

endWhenSignificantboolean · nullableOptional

prioritystring · nullableOptional

surfaceAreastring · nullableOptional

impactinteger · nullableOptional

effortinteger · nullableOptional

implementedboolean · nullableOptional

tagIdsstring · uuid[] · nullableOptional

Responses

204

No Content

No content

400

Bad Request

application/problem+json

403

Forbidden

application/problem+json

404

Not Found

application/problem+json

409

Conflict

application/problem+json

422

Unprocessable Entity

application/problem+json

429

Too Many Requests

application/problem+json

502

Bad Gateway

application/problem+json

patch/api/public/v1/tests/{id}

PATCH /api/public/v1/tests/{id} HTTP/1.1
Host: app.shoplift.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 486

{
  "title": null,
  "hypothesisDescription": null,
  "controlTitle": null,
  "variantTitle": null,
  "goal": null,
  "device": null,
  "visitorOption": null,
  "controlTraffic": null,
  "defaultAudiences": [
    "text"
  ],
  "customAudienceIds": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "campaignId": null,
  "variant": null,
  "automaticallyStartAt": null,
  "automaticallyEndAt": null,
  "endWhenSignificant": null,
  "priority": null,
  "surfaceArea": null,
  "impact": null,
  "effort": null,
  "implemented": null,
  "tagIds": [
    "123e4567-e89b-12d3-a456-426614174000"
  ]
}

No content