Cards

Create a card (custom)

post/cards

Request

  • Base URL: https://api.echtpost.de/v2
  • URL: https://api.echtpost.de/v2/cards
  • Auth: one of:
    • OAuth 2 (authorization code, authorization URL https://my.echtpost.de/oauth/authorize, token URL https://my.echtpost.de/oauth/token, scopes: mcp)
    • API key in header X-Api-Key
    • HTTP bearer

Request body

motive_idinteger required
contentstring required

Card text. Use {anrede} as a per-recipient salutation placeholder (casing ignored).

content_psstring

Optional P.S., printed as a single footer line.

content_verticalstring
deliver_atstring

Delivery date. Accepts: ISO 8601 date (YYYY-MM-DD), today, asap (alias for today), tomorrow, or N-days-from-now (e.g. 5-days-from-now). Must resolve to a weekday that is not a printer holiday. Must be at most 90 days in the future. Omitting this field schedules the card for the next available business day.

qr_code_urlstring
deduplicate_recipientsboolean
recipient_idsinteger[]
group_idsinteger[]
simulate'insufficient_funds'

Sandbox only. Instead of creating the card, force a simulated error so API clients can test their error handling. insufficient_funds returns HTTP 402 with the normal insufficient-funds body. Ignored with a live key.

Response

Created

idstring uuid
account_idinteger
user_idinteger
motive_idinteger
template_idinteger nullable
status'pending' | 'scheduled' | 'sent' | 'canceled'
type'CardSingle' | 'CardMulti'
contentstring
content_psstring nullable
content_verticalstring nullable
contacts_countinteger
deliver_atstring date-time nullable
qr_code_urlstring nullable
cancelableboolean
created_atstring date-time
updated_atstring date-time

Changes

No recorded changes to this operation across all 1 revision of this API.