Get a mailing

GET

/api/v1/mail/mailings/{id}

curl --request GET \
  --url https://digize.com/api/v1/mail/mailings/example \
  --header 'x-api-key: <x-api-key>'

• Digize

One direct mail campaign: its piece, design, list, recipients, Click2Mail job and status, and what it cost. Null if there’s no such mailing.

Needs the crm:read permission.

Authorizations

• apiKey
• bearer

Parameters

Path Parameters

id

required

string

>= 1 characters <= 64 characters

Responses

200

Done

Media typeapplication/json

Any of:

object

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

string format: date-time

null

null

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

null

null

Example

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

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

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