Change direct mail settings

PATCH

/api/v1/mail/settings

curl --request PATCH \
  --url https://digize.com/api/v1/mail/settings \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: 5f1c2a8e-3b7d-4c55-9a0e-1f2d3c4b5a69' \
  --header 'x-api-key: <x-api-key>' \
  --data '{ "returnAddress": { "name": "example", "street": "example", "city": "example", "state": "", "zip": "" }, "defaults": { "piece": "postcard_4x6", "mailClass": "first_class" }, "leads": { "importToCrm": true, "ownerId": "example", "skipCustomers": true }, "spending": { "monthlyLimit": 1, "alertEmails": [ "hello@example.com" ] } }'

• Digize

Saves some sections of the direct mail settings.

Needs the settings: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

returnAddress

object

name

required

string

<= 60 characters

street

required

string

<= 100 characters

city

required

string

<= 60 characters

state

required

Any of:

string

string

string

string

/^[A-Z]{2}$/

zip

required

Any of:

string

string

string

string

/^\d{5}(-\d{4})?$/

defaults

object

piece

required

string

Allowed values: postcard_4x6 postcard_5x8 postcard_6x11 letter

mailClass

required

string

Allowed values: first_class marketing

leads

object

importToCrm

required

boolean

ownerId

required

Any of:

string

string

<= 64 characters

null

null

skipCustomers

required

boolean

spending

object

monthlyLimit

required

Any of:

integer

integer

<= 100000000

null

null

alertEmails

required

Array<string>

<= 20 items

Responses

200

Done

Media typeapplication/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

string

/^[A-Z]{2}$/

zip

required

Any of:

string

string

string

string

/^\d{5}(-\d{4})?$/

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

string

<= 64 characters

null

null

skipCustomers

required

boolean

spending

required

object

monthlyLimit

required

Any of:

integer

integer

<= 100000000

null

null

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

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