DocumentazioneContatti e audience

Contatti e audience

Modello contatto, externalId, locale e filtri audience.

I contatti sono la base della newsletter in MailingCore. Ogni tenant mantiene un'audience isolata che puoi sincronizzare dall'applicazione o dal CRM tramite API.

Scope richiesti sulla API key: contacts:read e contacts:write. Dettagli in API key e scope.

Modello contatto

CampoDescrizione
emailIndirizzo univoco per tenant (chiave di upsert)
externalIdID nel tuo sistema (es. ludosafe-123) per integrazioni B2B
localeLingua preferita: es, en, it, fr, ca, de
optInConsenso esplicito alla newsletter
consentVersionVersione del testo di consenso accettato
sourceOrigine del contatto (es. signup-form)
projectIdProgetto SMTP opzionale per segmentazione
attributesAttributi custom (allowlist, default: sede)
suppressedAtData di soppressione; sincronizzata con /suppressions

Endpoint principali

AzioneEndpointScope
UpsertPUT /contactscontacts:write
Import massivoPOST /contacts/bulkcontacts:write
ElencareGET /contactscontacts:read
DettaglioGET /contacts/:idOrExternalIdcontacts:read
Aggiornare parzialePATCH /contacts/:idcontacts:write
Cancellazione GDPRDELETE /contacts/:externalIdcontacts:write

Filtri di lista

GET /contacts accetta parametri di query:

  • ?locale=it — filtra per lingua
  • ?optIn=true — solo iscritti attivi
  • ?suppressed=false — esclude soppressi
  • Paginazione standard

Questi stessi criteri alimentano audienceFilter nelle campagne.

Integrazione B2B

Per SaaS multi-tenant (es. un gestionale che invia newsletter per conto dei clienti), usa externalId per mappare l'utente nel tuo database. L'header X-Tenant-Id isola i dati per organizzazione — vedi Multi-tenant.

Prossimi passi