Hoppa till innehållet
Qrona Newsletter
Logga inSkapa konto

Referens / Listmedlemmar

Anmäl till lista

POST/api/v1/lists/{id}/members

Anmäler en adress till listan, med beviset för samtycket. Kontakten skapas om den inte finns.

Med status pending (standard på listor med dubbel opt-in) får personen ett bekräftelsemejl och kommer med när hen bekräftar. Med subscribed kommer personen med direkt – då intygar ni att samtycket finns.

Den som tidigare har avregistrerat sig får alltid ett bekräftelsemejl, vad ni än skickar: ingen integration kan anmäla någon igen mot hens vilja. Adresser som studsar, har anmält skräppost, är raderade eller spärrade ger 409 blocked.

Svarar 201 när något ändrades och 200 när personen redan var med (eller nyss fick ett bekräftelsemejl – ett nytt skickas tidigast efter tio minuter).

Behörighet

  • contacts:write Ändra kontakter – 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.

emailstringkrävs
E-postadressen.högst 254 tecken
first_namestring | null
Förnamn. Fyller bara i det som saknas på en befintlig kontakt.högst 100 tecken
last_namestring | null
Efternamn.högst 100 tecken
companystring | null
högst 200 tecken
statusstring
subscribed: med direkt. pending: ett bekräftelsemejl skickas och personen kommer med när hen bekräftar. Standard: listans eget läge. Den som tidigare har avregistrerat sig får alltid ett bekräftelsemejl.subscribedpending
consentobjectkrävs
Beviset för samtycket. Sparas i samtyckesloggen.
consent.textstringkrävs
Exakt den text personen godkände.minst 10 tecken · högst 5000 tecken
consent.sourcestring
Var det hände.högst 200 tecken
consent.ipstring
Personens IP-adress (inte er servers).högst 45 tecken
consent.user_agentstring
Personens webbläsare.högst 255 tecken

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

201 Resultatet (200 om inget ändrades).

list_idstringkrävs
contact_idstringkrävs
statusstringkrävs
pending: ett bekräftelsemejl har skickats (eller skickades nyss) och personen kommer med när hen bekräftar.subscribedpending
confirmation_sentbooleankrävs
Ett bekräftelsemejl skickades nu.
created_contactbooleankrävs
Kontakten fanns inte och skapades.

Fel

400
bad_request
401
unauthenticatedinvalid_keykey_revokedkey_expiredkey_inactive
402
payment_required
403
insufficient_scopeforbiddenworkspace_suspended
404
not_found
409
blockedsending_not_enabledidempotency_in_progress
415
unsupported_media_type
422
validation_failedidempotency_key_reused
429
rate_limited
500
internal_error