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

Estimate a verification

How many of the target’s contacts were never verified and what verifying them would cost. Changes nothing.

POST/verifications/estimate
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

Respostas
200

The counts and the estimated cost

objectstringobrigatório
Valores permitidos:verification_estimate
totalintegerobrigatório

Contacts the target names

unverifiedintegerobrigatório

Of them, never verified: what a start would verify (verified ones are skipped)

in_runintegerobrigatório

Of the unverified, already being verified

grant_remainingintegerobrigatório

Free verification credit left this quota month, which a run uses first

estimated_centsintegerobrigatório

What verifying the unverified would cost past the credit, in cents

401

Missing, malformed, unknown or revoked API key

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

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
Experimentar
Servidor
Autorização
Corpoapplication/json
Requisição
curl -X POST 'https://api.billionsend.com/verifications/estimate' \
  -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"
    ]
  }
}'
Resposta
{
  "object": "verification_estimate",
  "total": 0,
  "unverified": 0,
  "in_run": 0,
  "grant_remaining": 0,
  "estimated_cents": 0
}

Esta página foi útil?