Count and price a list

POST

/api/v1/leads/quote

curl --request POST \
  --url https://digize.com/api/v1/leads/quote \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: 5f1c2a8e-3b7d-4c55-9a0e-1f2d3c4b5a69' \
  --header 'x-api-key: <x-api-key>' \
  --data '{ "type": "new_homeowners", "zips": [], "radius": null, "movedWithinDays": 30, "ages": [], "minIncome": 0, "homeownership": "any", "children": "any", "industries": [], "employees": [], "phones": false, "emails": false }'

• Digize

How many records LeadsPlease has for some filters and what they’d cost. Buying needs the criteriaId it returns.

Needs the crm:write permission.

Authorizations

• apiKey
• bearer

Parameters

Header Parameters

Idempotency-Key

string

>= 1 characters <= 255 characters

Makes the request safe to send again: for 24 hours the same key and request answer the first response without repeating the change.

Example

5f1c2a8e-3b7d-4c55-9a0e-1f2d3c4b5a69

Request Body^required

Media typeapplication/json

object

type

required

string

Allowed values: new_homeowners new_movers consumers businesses

zips

Array<string>

default: <= 500 items

radius

Any of:

object

object

miles

required

number

>= 0.5 <= 100

label

required

string

>= 1 characters <= 120 characters

lat

required

number

>= -90 <= 90

lng

required

number

>= -180 <= 180

null

null

movedWithinDays

Any of:

number

number

Allowed value: 30

number

number

Allowed value: 60

number

number

Allowed value: 90

ages

Array<string>

default:

Allowed values: 18-24 25-34 35-44 45-54 55-64 65+

minIncome

Any of:

number

number

0

number

number

Allowed value: 50

number

number

Allowed value: 75

number

number

Allowed value: 100

number

number

Allowed value: 150

homeownership

string

default: any

Allowed values: any owners renters

children

string

default: any

Allowed values: any with without

industries

Array<string>

default:

Allowed values: offices tech coworking medical real_estate fitness salons hotels

employees

Array<string>

default:

Allowed values: 1-9 10-49 50-249 250+

phones

boolean

emails

boolean

Responses

200

Done

Media typeapplication/json

object

criteriaId

required

LeadsPlease’s saved search, which buying the list orders from.

string

count

required

number

perRecord

required

In cents a record, with add-ons.

number

total

required

In cents.

number

minimum

required

The smallest order LeadsPlease takes, in cents.

number

weekly

required

New homeowners and movers: about how many new records a week brings.

number | null

weeklyCost

required

number | null

Example ^generated

{
  "criteriaId": "example",
  "count": 1,
  "perRecord": 1,
  "total": 1,
  "minimum": 1,
  "weekly": 1,
  "weeklyCost": 1
}

400

What was sent isn’t valid (invalid).

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}

401

No key, or one that’s unknown, off or expired.

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}

403

The key doesn’t have the permission this needs.

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}

404

Nothing has that id (not_found).

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}

409

A request with the same Idempotency-Key is still running (conflict).

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}

422

The Idempotency-Key was used with a different request.

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}

429

Over the rate limit; see retry-after.

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}