Avregistrera kontakt

POST/api/v1/contacts/{id}/unsubscribe

Personen vill inte ha fler utskick: kontakten lämnar alla listor, får status unsubscribed och adressen spärras.

Som när personen själv avregistrerar sig. Bara personen kan anmäla sig igen, genom att bekräfta via e-post. Gör inget om kontakten redan är avregistrerad.

Behörighet

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

Sökvägsparametrar

idstringkrävs: Kontaktens id.

Göra om anropet

Skicka gärna headern Idempotency-Key (t.ex. ett uuid). Skickas samma anrop igen med samma nyckel inom 24 timmar kommer det första svaret tillbaka, utan att något görs två gånger. Batch och idempotens

Svar

200 Kontakten efter avregistreringen.

idstringkrävs: Kontaktens id.
emailstringkrävs: E-postadressen (gemener). Ändras aldrig: samtycken och spärrar gäller adressen.
first_namestring | nullkrävs
last_namestring | nullkrävs
companystring | nullkrävs
phonestring | nullkrävs: I internationellt format (E.164), t.ex. +46701234567.
statusstringkrävs: active: kan få utskick · unsubscribed: har avregistrerat sig från allt · bounced: adressen studsar · complained: har anmält skräppost · deleted: raderad (GDPR), personuppgifterna är borta.activeunsubscribedbouncedcomplaineddeleted
fieldsobject<string | number | boolean>krävs: Egna fält efter nyckel (se GET /fields). Känsliga fält, som personnummer, skickas aldrig ut.
tagsarray<string>krävs
sourcestringkrävs: Hur kontakten kom in: manual, import, form, api …
consentobjectkrävs
consent.atstring (tid, ISO 8601) | nullkrävs: När samtycket gavs.
consent.sourcestring | nullkrävs: Hur personen samtyckte, med egna ord.
suppressionobject | nullkrävs: Arbetsytans spärr på adressen. En spärrad adress får aldrig utskick, oavsett status.
suppression.reasonstringkrävs: unsubscribed, bounced, complained, manual eller imported.
suppression.created_atstring (tid, ISO 8601)krävs: När adressen spärrades.
sharedbooleankrävs: Delad från en nivå ovanför i organisationen: kan läsas och få utskick härifrån, men bara ändras där den hör hemma.
created_atstring (tid, ISO 8601)krävs: När kontakten skapades.
updated_atstring (tid, ISO 8601)krävs: När kontakten senast ändrades.
unsubscribed_atstring (tid, ISO 8601) | nullkrävs: När personen avregistrerade sig.
listsarray<object>krävs: Arbetsytans listor som kontakten finns på. Tom för en delad kontakt.
lists[].list_idstringkrävs
lists[].namestringkrävs
lists[].statusstringkrävs: subscribed: med på listan · pending: väntar på att bekräfta via e-post · unsubscribed: har lämnat listan.subscribedpendingunsubscribed
lists[].subscribed_atstring (tid, ISO 8601) | nullkrävs: När personen kom med på listan.

Fel

401: unauthenticated invalid_key key_revoked key_expired key_inactive
402: payment_required
403: shared_contact insufficient_scope forbidden workspace_suspended
404: not_found
409: idempotency_in_progress
422: idempotency_key_reused
429: rate_limited
500: internal_error

Anrop

curl -X POST 'https://newsletter.qrona.se/api/v1/contacts/1042/unsubscribe' \
  -H "Authorization: Bearer $QRONA_NEWSLETTER_KEY"

Svar 200

{
  "id": "1042",
  "email": "anna@example.se",
  "first_name": "Anna",
  "last_name": "Svensson",
  "company": "Exempel AB",
  "phone": "+46701234567",
  "status": "active",
  "fields": {
    "kundnummer": "K-2041",
    "ort": "Göteborg"
  },
  "tags": [
    "kund",
    "vip"
  ],
  "source": "api",
  "consent": {
    "at": "2026-10-19T08:30:00.000Z",
    "source": "Kryssade i rutan i kassan på butik.se"
  },
  "suppression": null,
  "shared": false,
  "created_at": "2026-10-19T08:30:00.000Z",
  "updated_at": "2026-10-19T08:30:00.000Z",
  "unsubscribed_at": null,
  "lists": [
    {
      "list_id": "3f1c2a4e-8b7d-4c1e-9f0a-2d6b5e7c8a91",
      "name": "Nyhetsbrev",
      "status": "subscribed",
      "subscribed_at": "2026-10-19T08:30:00.000Z"
    }
  ]
}