Waitlist API reference

Waitlist API · Waitlist-Variants

patch/v1/workspaces/{workspace_id}/waitlists/{waitlist_id}/variants/{id}Auth

Update a variant

Changes the locale, copy, weight or active flag; only the fields you send change.

Path parameters

workspace_id*string · uuid

Id of the workspace.

waitlist_id*string · uuid

Id of the waitlist.

id*string · uuid

Id of the variant.

Headers

Idempotency-Keystring

Idempotency key (24 h). A retry with the same key and body returns the first response instead of creating a second variant.

Request body

localestring

New BCP-47 locale tag.

Example: "pt-BR"

copyobject

Replacement copy overrides.

Example: {"display_name":"Acesso antecipado"}

weightinteger

New weight inside the A/B pool.

Example: 2

activeboolean

Serve (`true`) or stop serving (`false`) the variant.

Example: false

Response · 200 Variant updated

id*string · uuid

Variant id.

waitlist_id*string · uuid

The waitlist the variant belongs to.

kind*object

`locale`: the copy for visitors of one language; `ab`: one arm of a weighted A/B test within a locale.

locale*string

BCP-47 locale tag the variant serves or targets.

copy*object

Copy overrides by key: `display_name`, `description`, `confirmation_message` (only the keys that were set).

Example: {"display_name":"Accès anticipé"}

weight*integer

Relative weight inside the A/B pool (ignored for `locale`).

active*boolean

Whether the variant is served.

created_at*string · date-time

When the variant was created.

Example

Request

PATCH https://api.waitlist.productcraft.co/v1/workspaces/{workspace_id}/waitlists/{waitlist_id}/variants/{id}
Authorization: Bearer YOUR_TOKEN
Content-Type: application/json

{
  "locale": "pt-BR",
  "copy": {
    "display_name": "Acesso antecipado"
  },
  "weight": 2,
  "active": false
}

Response

{
  "id": "00000000-0000-0000-0000-000000000000",
  "waitlist_id": "00000000-0000-0000-0000-000000000000",
  "kind": {},
  "locale": "string",
  "copy": {
    "display_name": "Accès anticipé"
  },
  "weight": 0,
  "active": false,
  "created_at": "2026-01-01T00:00:00.000Z"
}