Reveal leads
Reveals leads from an audience and returns them in full. Costs 1 chip per lead you have not revealed before. Revealing a lead again is free. You must send max_chips, the most you are willing to spend.
This call can spend chips. Send an Idempotency-Key header so a retry never charges twice.
bearerAuthAuthorizationBearer <API key>Create a key in the app under Developers. Keys start with dcd_live_.
id*stringAudience id. Starts with aud_.
^aud_Idempotency-Key?stringUnique string for this request. Repeat the call with the same key within 24 hours and you get the original result, marked with the header Idempotent-Replayed: true, without being charged or building twice. Reusing a key with a different request is a 409. A request that failed can be retried with the same key.
1 <= length <= 255application/json- body
Reveal leads. Spends 1 chip per lead you have not revealed before.
count?integerReveal the next N leads that are not revealed yet, up to 1000. Send this or lead_ids.
1 <= value <= 1000lead_ids?array<>Specific leads to reveal, up to 1000. Send this or count.
1 <= items <= 1000max_chips*integerThe most chips you are willing to spend. If revealing would cost more, nothing is revealed and you get max_chips_exceeded. Leads you already revealed are free.
1 <= value <= 9007199254740991Success.
application/json- response
leads*array<>The revealed leads, in full.
chips_charged*integerChips spent by this call.
0 <= value <= 9007199254740991balance*integerChips left after this call.
0 <= value <= 9007199254740991request_id*stringId of the request that produced this response. A replayed idempotent response keeps the original id.
curl -X POST 'https://api.diced.si/v1/audiences/aud_7GhT2kLm9QpX4sWv1bNc8ZrY/reveal' \ -H 'Authorization: Bearer dcd_live_your_key' \ -H 'Idempotency-Key: 9b2f6c1e-4d7a-4f0b-8e3a-1c5d2e7f9a04' \ -H 'Content-Type: application/json' \ -d '{ "count": 10, "max_chips": 10}'{ "leads": [ { "id": "string", "first_name": "string", "last_name": "string", "email": "string", "emails": [ "string" ], "business_email": "string", "phone": "string", "mobile_phone": "string", "direct_phone": "string", "linkedin_url": "string", "address": { "line1": "string", "line2": "string", "city": "string", "state": "string", "zip": "string", "country": "string" }, "demographics": { "gender": "male", "age_range": "18-24", "married": true, "children": true, "income_range": "<20k", "net_worth": "<0", "homeowner": true }, "job": { "title": "string", "seniority": "c_suite", "department": "administrative" }, "company": { "name": "string", "domain": "string", "phone": "string", "industry": "string", "size": "1-10", "revenue": "<1m", "sic": "string", "naics": "string", "city": "string", "state": "string", "country": "string" }, "intent": { "level": "high", "topic": { "id": "string", "name": "string", "category": "string" }, "last_active": "string" }, "household": { "property1": "string", "property2": "string" }, "updated_at": "string" } ], "chips_charged": 0, "balance": 0, "request_id": "string"}