Ändra lista

PATCH/api/v1/lists/{id}

Namn, beskrivning och anmälningsläge.

Behörighet

lists:write Ändra listor – personen bakom nyckeln måste vara redaktör eller högre.

Sökvägsparametrar

idstringkrävs: Listans id.

Kropp

JSON, Content-Type: application/json. Okända fält ger 422.

namestring: minst 1 tecken · högst 200 tecken
descriptionstring | null: högst 1000 tecken
double_opt_inboolean: Nya anmälningar måste bekräfta via e-post. Standard: true.

Svar

200 Listan efter ändringen.

idstringkrävs
namestringkrävs
descriptionstring | nullkrävs
double_opt_inbooleankrävs: Nya anmälningar måste bekräfta via e-post innan de kommer med.
form_enabledbooleankrävs: Listans publika anmälningsformulär är öppet.
countsobjectkrävs: Bara de kontakter som personen bakom nyckeln får se.
counts.subscribedintegerkrävs: Får utskick: med på listan, aktiva och inte spärrade.
counts.pendingintegerkrävs: Har anmält sig men inte bekräftat än.
counts.unsubscribedintegerkrävs
counts.blockedintegerkrävs: Med på listan men nås inte: studsar, har anmält skräppost eller är spärrade.
created_atstring (tid, ISO 8601)krävs: När listan skapades.

Fel

400: bad_request
401: unauthenticated invalid_key key_revoked key_expired key_inactive
402: payment_required
403: insufficient_scope forbidden workspace_suspended
404: not_found
415: unsupported_media_type
422: validation_failed
429: rate_limited
500: internal_error

Anrop

curl -X PATCH 'https://newsletter.qrona.se/api/v1/lists/3f1c2a4e-8b7d-4c1e-9f0a-2d6b5e7c8a91' \
  -H "Authorization: Bearer $QRONA_NEWSLETTER_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"Nyhetsbrev – kunder"}'

Svar 200

{
  "id": "3f1c2a4e-8b7d-4c1e-9f0a-2d6b5e7c8a91",
  "name": "Nyhetsbrev",
  "description": "Månadsbrevet till kunder",
  "double_opt_in": true,
  "form_enabled": true,
  "counts": {
    "subscribed": 1840,
    "pending": 12,
    "unsubscribed": 96,
    "blocked": 7
  },
  "created_at": "2026-09-01T10:00:00.000Z"
}