Pular para o conteúdo
Esc
↑↓navegar↵abrir⌘Jpré-visualizar

Start a verification

Starts deep verification of the target’s contacts, one run per 50,000 of them. Contacts verified before are skipped unless recheck is true, and a contact already being verified never joins a second run. Paid plans only; billed per verified address on the monthly invoice.

POST/verifications
Autorização
AuthorizationToken Bearer · headerobrigatório

A BillionSend API key (bs_…).

Corpo da requisição
obrigatórioapplication/json
targetVerificationTargetobrigatório
Mostrar propriedades
Exatamente um de:
object
kindstringobrigatório
Valores permitidos:contacts
contact_idsstring<uuid>[]obrigatório

Contacts of the team, by id

mín. 1 itens · máx. 50000 itens
object
kindstringobrigatório
Valores permitidos:segment
segment_idstring<uuid>obrigatório

Every contact in this segment

object
kindstringobrigatório
Valores permitidos:broadcast
broadcast_idstring<uuid>obrigatório

The broadcast's audience: the contacts it would mail, leaving out everyone who unsubscribed

recheckboolean

Verify contacts verified before too; by default they are skipped

Respostas
200

The runs started

objectstringobrigatório
Valores permitidos:verification_start
runsobject[]obrigatório

The runs started, one per 50,000 contacts

Mostrar propriedades
Array de object
idstring<uuid>obrigatório
totalintegerobrigatório
contactsintegerobrigatório

Contacts that joined a run

already_verifiedintegerobrigatório

Contacts skipped because they were verified before (pass recheck to include them)

in_runintegerobrigatório

Contacts skipped because a run already holds them

401

Missing, malformed, unknown or revoked API key

statusCodenumberobrigatório
namestringobrigatório
messagestringobrigatório
403

The team is on the Free plan (plan_limit_reached)

statusCodenumberobrigatório
namestringobrigatório
messagestringobrigatório
404

The segment or broadcast is not one of the team's

statusCodenumberobrigatório
namestringobrigatório
messagestringobrigatório
422

Nothing left to verify, too many contacts at once, or a validation error

statusCodenumberobrigatório
namestringobrigatório
messagestringobrigatório
429

Over the rate limit (rate_limit_exceeded, with Retry-After)

statusCodenumberobrigatório
namestringobrigatório
messagestringobrigatório
503

Deep verification is not available right now

statusCodenumberobrigatório
namestringobrigatório
messagestringobrigatório
Experimentar
Servidor
Autorização
Corpoapplication/json
Requisição
curl -X POST 'https://api.billionsend.com/verifications' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "target": {
    "kind": "contacts",
    "contact_ids": [
      "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    ]
  },
  "recheck": true
}'
Resposta
{
  "object": "verification_start",
  "runs": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "total": 0
    }
  ],
  "contacts": 0,
  "already_verified": 0,
  "in_run": 0
}

Esta página foi útil?