Click2Mail's prices

GET

/api/v1/mail/prices

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

• Digize

What each piece costs to print and mail, by class, as Click2Mail quotes the workspace’s account; rough prices until Click2Mail is connected.

Needs the crm:read permission.

Authorizations

• apiKey
• bearer

Responses

200

Done

Media typeapplication/json

object

pieces

required

object

key

additional properties

object

key

additional properties

number

letterColor

required

number

marketingMinimum

required

number

deliveryDays

required

object

key

additional properties

array

>= 2 items <= 2 items

quoted

required

boolean

Example ^generated

{
  "pieces": {
    "additionalProperty": {
      "additionalProperty": 1
    }
  },
  "letterColor": 1,
  "marketingMinimum": 1,
  "deliveryDays": {
    "additionalProperty": [
      "example"
    ]
  },
  "quoted": true
}

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