WebmeticDocs

E-Mail oder Rufnummer eines Kontakts freischalten (Credits)

POST
/contacts/reveal

Schaltet für einen Kontakt aus einer vorherigen Suche E-Mail (inkl. LinkedIn) und/oder Rufnummern frei. Berechnet werden Credits je Datenart, nur für tatsächlich gelieferte Daten; was das Konto bereits freigeschaltet hat, kostet nichts erneut. Die Kosten je Aktion liefert /contacts/credits.

Authentifizierung

APIKeyHeader
headerAuthorization<token>

Request-Body

application/json
  1. body
contact_id*Contact Id

contact_id aus der Suche (opak, z. B. v1.abc)

request_id?|

Veraltet, wird ignoriert: Kontakt-Kennungen sind dauerhaft, die Suche des Kontos wird serverseitig geprüft

reveal_email?Reveal Email

E-Mail und LinkedIn freischalten (kostet Credits)

Standardfalse
reveal_phone?Reveal Phone

Rufnummern freischalten (kostet Credits)

Standardfalse

Response-Body

Freigeschaltete Daten. Bereits freigeschaltete Daten desselben Kontos kosten nichts erneut

application/json
  1. response
contact*

Die freigeschalteten Daten

from_cache?From Cache

true: das Ergebnis lag schon vor und wurde nicht neu abgefragt

Standardfalse
credits_used*Credits Used

Credits, die dieser Aufruf verbraucht hat

credits_remaining*Credits Remaining

Credits des Kontos nach dem Aufruf

Beispielanfrage
curl -X POST 'https://hub.webmetic.de/contacts/reveal' \  -H 'Content-Type: application/json' \  -d '{  "contact_id": "v1.q7Rk2mXv9TnL4w",  "reveal_email": true}'
Beispielantwort
{  "contact": {    "contact_id": "v1.abc",    "email": "anna.beispiel@bergquell.example",    "linkedin": "https://www.linkedin.com/in/anna-beispiel"  },  "from_cache": true,  "credits_used": 0,  "credits_remaining": 0}