Skip to content
digizeDocs

Mail each week's new records

POST
/api/v1/leads/lists/{id}/auto-mail
curl --request POST \
  --url https://digize.com/api/v1/leads/lists/example/auto-mail \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: 5f1c2a8e-3b7d-4c55-9a0e-1f2d3c4b5a69' \
  --header 'x-api-key: <x-api-key>' \
  --data '{ "on": true }'

Turns on or off sending each weekly delivery’s new records the list’s latest mailing, through Click2Mail.

Needs the crm:write permission.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
id
required
string
>= 1 characters <= 64 characters

Header Parameters

Section titled “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 Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
on
required
boolean

Example generated

{
  "on": true
}

Responses

Section titled “Responses”

200

Section titled “200”

Done

Media typeapplication/json
object
id
required
string
name
required
string
orderNumber
required

LeadsPlease’s id for the order.

string | null
filters
required
object
type
required
string
Allowed values: new_homeowners new_movers consumers businesses
zips
required
Array<string>
default: <= 500 items
radius
required
Any of:
object
miles
required
number
>= 0.5 <= 100
label
required
string
>= 1 characters <= 120 characters
lat
required
number
>= -90 <= 90
lng
required
number
>= -180 <= 180
movedWithinDays
required
Any of:
number
Allowed value: 30
ages
required
Array<string>
default:
Allowed values: 18-24 25-34 35-44 45-54 55-64 65+
minIncome
required
Any of:
number
0
homeownership
required
string
default: any
Allowed values: any owners renters
children
required
string
default: any
Allowed values: any with without
industries
required
Array<string>
default:
Allowed values: offices tech coworking medical real_estate fitness salons hotels
employees
required
Array<string>
default:
Allowed values: 1-9 10-49 50-249 250+
phones
required
boolean
emails
required
boolean
environment
required
string
Allowed values: live test
count
required
number
cost
required

In cents: the order and every weekly delivery.

number
status
required
string
Allowed values: building ready expired failed
error
required
string | null
standing
required

New records arrive every week.

boolean
autoMail
required
boolean
lastAdded
required
number
refreshedAt
required
Any of:
string format: date-time
nextRefreshAt
required
Any of:
string format: date-time
weeklyProblem
required
string | null
crmTag
required
string | null
importedAt
required
Any of:
string format: date-time
importing
required
boolean
purchasedBy
required
string
purchasedAt
required
string format: date-time
expiresAt
required
string format: date-time

Example 

{
  "filters": {
    "type": "new_homeowners",
    "zips": [],
    "radius": null,
    "movedWithinDays": 30,
    "ages": [],
    "minIncome": 0,
    "homeownership": "any",
    "children": "any",
    "industries": [],
    "employees": [],
    "phones": false,
    "emails": false
  },
  "environment": "live",
  "status": "building"
}

400

Section titled “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

Section titled “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

Section titled “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

Section titled “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

Section titled “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

Section titled “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

Section titled “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"
  }
}