Skip to content
digizeDocs

Set up a mailing

POST
/api/v1/mail/mailings
curl --request POST \
  --url https://digize.com/api/v1/mail/mailings \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: 5f1c2a8e-3b7d-4c55-9a0e-1f2d3c4b5a69' \
  --header 'x-api-key: <x-api-key>' \
  --data '{ "name": "example", "listId": "example", "piece": "postcard_4x6", "color": true, "mailClass": "first_class", "design": { "template": "classic", "headline": "example", "body": "example", "offer": "example", "code": "example", "link": "example" }, "mailDay": "example", "send": true }'

Sets up a postcard or letter to everyone on a LeadsPlease list, as a draft or sent to Click2Mail, which charges the workspace’s Click2Mail account and prints it the day before its mail date.

Needs the crm:write permission. It can’t be undone.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

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
name
required
string
>= 1 characters <= 80 characters
listId
required
string
>= 1 characters <= 64 characters
piece
required
string
Allowed values: postcard_4x6 postcard_5x8 postcard_6x11 letter
color
boolean
default: true
mailClass
required
string
Allowed values: first_class marketing
design
required
object
template
required
string
Allowed values: classic bold fresh
headline
required
string
<= 60 characters
body
required
string
<= 240 characters
offer
required
string
<= 44 characters
code
required
string
<= 16 characters
link
required
string
<= 60 characters
mailDay
required

The day it goes to USPS, on the workspace’s calendar, such as 2026-11-02.

string
/^\d{4}-\d{2}-\d{2}$/
send
required

Send it to Click2Mail now, rather than keep it as a draft.

boolean

Responses

Section titled “Responses”

201

Section titled “201”

Done

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

Click2Mail’s job number.

string | null
jobStatus
required
string | null
piece
required
string
Allowed values: postcard_4x6 postcard_5x8 postcard_6x11 letter
color
required
boolean
mailClass
required
string
Allowed values: first_class marketing
design
required
object
template
required
string
Allowed values: classic bold fresh
headline
required
string
<= 60 characters
body
required
string
<= 240 characters
offer
required
string
<= 44 characters
code
required
string
<= 16 characters
link
required
string
<= 60 characters
listId
required
string
listName
required
string
automatic
required
boolean
recipients
required
number
status
required
string
Allowed values: draft scheduled printing in_transit delivered cancelled failed
error
required
string | null
cost
required

In cents: printing and postage.

number
costQuoted
required
boolean
createdBy
required
string
createdAt
required
string format: date-time
submittedAt
required
Any of:
string format: date-time
mailDate
required
string format: date-time
tracking
required
object
inTransit
required
number
delivered
required
number
returned
required
number
responses
required
object
visits
required
number
orders
required
number
revenue
required
number

Example 

{
  "piece": "postcard_4x6",
  "mailClass": "first_class",
  "design": {
    "template": "classic"
  },
  "status": "draft"
}

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"
  }
}