Slå upp kontakter på e-post
POST/api/v1/contacts/lookup
Upp till 100 adresser i ett anrop. Svaret har de kontakter som finns (alla statusar, även raderade).
Adresserna skickas i kroppen så att de inte hamnar i loggar. En adress kan ge två träffar: en egen kontakt och en delad från en nivå ovanför.
Behörighet
contacts:readLäsa kontakter – personen bakom nyckeln måste vara alla medlemmar.
Kropp
JSON, Content-Type: application/json. Okända fält ger 422.
emailsarray<string>krävs- Upp till 100 adresser.minst 1 · högst 100 st
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 Kontakterna som finns.
dataarray<object>krävsdata[].idstringkrävs- Kontaktens id.
data[].emailstringkrävs- E-postadressen (gemener). Ändras aldrig: samtycken och spärrar gäller adressen.
data[].first_namestring | nullkrävsdata[].last_namestring | nullkrävsdata[].companystring | nullkrävsdata[].phonestring | nullkrävs- I internationellt format (E.164), t.ex. +46701234567.
data[].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 data[].fieldsobject<string | number | boolean>krävs- Egna fält efter nyckel (se GET /fields). Känsliga fält, som personnummer, skickas aldrig ut.
data[].tagsarray<string>krävsdata[].sourcestringkrävs- Hur kontakten kom in: manual, import, form, api …
data[].consentobjectkrävsdata[].consent.atstring (tid, ISO 8601) | nullkrävs- När samtycket gavs.
data[].consent.sourcestring | nullkrävs- Hur personen samtyckte, med egna ord.
data[].suppressionobject | nullkrävs- Arbetsytans spärr på adressen. En spärrad adress får aldrig utskick, oavsett status.
data[].suppression.reasonstringkrävs- unsubscribed, bounced, complained, manual eller imported.
data[].suppression.created_atstring (tid, ISO 8601)krävs- När adressen spärrades.
data[].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.
data[].created_atstring (tid, ISO 8601)krävs- När kontakten skapades.
data[].updated_atstring (tid, ISO 8601)krävs- När kontakten senast ändrades.
data[].unsubscribed_atstring (tid, ISO 8601) | nullkrävs- När personen avregistrerade sig.
Fel
- 400
- bad_request
- 429
- rate_limited