Newsletter-Anmeldung auslösen

Startet das Double-Opt-in für eine E-Mail-Adresse, zum Beispiel aus einem Anmeldeformular auf einer anderen Webseite. Soulclick schickt seine Bestätigungs-E-Mail; deren Link führt auf die Bestätigungsseite dieser Instanz. Nach der Bestätigung gilt die Anmeldung wie eine auf Soulclick: opt_in wird true, Newsletter-Webhook und Integrationen folgen.

Ruf den Endpunkt vom Server dieser Webseite auf: Der Token gehört nie in JavaScript im Browser.

Eine Adresse, die schon bestätigt hat, erhält keine zweite E-Mail, und jede Adresse erhält höchstens eine Bestätigungs-E-Mail pro Stunde. Die Antwort ist in jedem Fall dieselbe und verrät nicht, ob eine Adresse angemeldet ist. Gehört eine Adresse zu einem Kontakt, kommen E-Mail und Bestätigungsseite in der Sprache des Kontakts.

Authentifizierung

  • API-Token (empfohlen): Authorization: Bearer sct_… mit der Berechtigung newsletter:doi
  • JWT eines Admin-Kontos: Authorization: Bearer <token>
  • Basic Auth eines Admin-Kontos ohne Zwei-Faktor-Authentifizierung: Authorization: Basic <base64(benutzername:passwort)>
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required
length between 1 and 100

E-Mail-Adresse, die angemeldet wird

string | null
string | null
enum

Anrede/Geschlecht (male, female, prefer-not-to-say)

  • male - male
  • female - female
  • prefer-not-to-say - prefer-not-to-say

  • male - male
  • female - female
  • prefer-not-to-say - prefer-not-to-say
enum

Sprache der Bestätigungs-E-Mail und -Seite; ohne Angabe die Hauptsprache der Instanz. Gehört die Adresse zu einem Kontakt, gilt dessen Sprache

  • de - de
  • fr - fr
  • it - it
  • en - en

  • de - de
  • fr - fr
  • it - it
  • en - en
Headers
string
enum
Defaults to application/json

Generated from available request content types

Allowed:
Responses

401

Authentifizierung fehlt oder ist ungültig

403

API-Token ohne die nötige Berechtigung oder Konto ohne Admin-Rechte

429

Zu viele Anfragen mit demselben API-Token oder zu viele fehlgeschlagene Anmeldungen

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json