Direct mail settings

GET

/api/v1/mail/settings

const url = 'https://digize.com/api/v1/mail/settings';
const options = {method: 'GET', headers: {'x-api-key': '<x-api-key>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

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

The return address, a new mailing’s defaults, importing LeadsPlease lists into the CRM, and the monthly spending limit.

Needs the crm:read permission.

Authorizations

apiKey
bearer

Responses

200

Done

application/json

object

returnAddress

required

object

name

required

string

<= 60 characters

street

required

string

<= 100 characters

city

required

string

<= 60 characters

state

required

Any of:

string
string

string

zip

required

Any of:

string
string

string

defaults

required

object

piece

required

string

Allowed values: postcard_4x6 postcard_5x8 postcard_6x11 letter

mailClass

required

string

Allowed values: first_class marketing

leads

required

object

importToCrm

required

boolean

ownerId

required

Any of:

string
null

string

<= 64 characters

skipCustomers

required

boolean

spending

required

object

monthlyLimit

required

Any of:

integer
null

integer

<= 100000000

alertEmails

required

Array<string>

<= 20 items

Example

{
  "returnAddress": {
    "state": "",
    "zip": ""
  },
  "defaults": {
    "piece": "postcard_4x6",
    "mailClass": "first_class"
  }
}

400

What was sent isn’t valid (invalid).

application/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.

application/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.

application/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).

application/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.

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