Skip to main content
New to Corsair? See API access, authentication, and error handling.

Account

credits

account.credits Get the credit balance, cards left and price per card. Risk: read
Input: empty object Balance in EUR, cards left at the regular and foreign price, and the price per card. Output

get

account.get Get the account, user, API key metadata and balance. Risk: read
Input: empty object Output

Cards

cancel

cards.cancel Cancel a card that has not been printed yet; it cannot be restored. Risk: destructive
Input Only while cancelable is true; answers with the new status. Output

create

cards.create Print and post a real postcard to each recipient; the account is billed per card. Risk: destructive
Input Prints, posts and bills a real card per recipient with a live key. motive_id is required; content is required when the motive allows text.
Output

createFromTemplate

cards.createFromTemplate Print and post a real postcard from a saved template; the account is billed per card. Risk: destructive
Input Same as cards.create, using a saved template’s motive, text and font.
Output

get

cards.get Get one card and its status. Risk: read
Input Output

list

cards.list List cards, filtered by status, delivery date or motive. Risk: read
Input Output

previewFit

cards.previewFit Check whether card text fits at a font and size, without creating a card. Risk: read
Input
Output

Contacts

create

contacts.create Create a contact with a postal address. Risk: write
Input Output

delete

contacts.delete Delete a contact. Risk: destructive
Input Output

get

contacts.get Get one contact by id. Risk: read
Input Output

list

contacts.list List contacts (postcard recipients), with filters and paging. Risk: read
Input search matches first name, last name, company or city. include: "groups" adds group_ids to each contact. Output

update

contacts.update Update a contact; fields left out stay as they are. Risk: write
Input Output

Groups

create

groups.create Create a contact group. Risk: write
Input Output

delete

groups.delete Delete a group. Risk: destructive
Input Output

get

groups.get Get one group by id. Risk: read
Input Output

list

groups.list List contact groups. Risk: read
Input Output

update

groups.update Rename a group or change its external id. Risk: write
Input Output

Motives

get

motives.get Get one motive and what text fields it allows. Risk: read
Input Output

list

motives.list List the postcard motives (front designs) the account can use. Risk: read
Input Output

Templates

get

templates.get Get one saved template by id. Risk: read
Input Output

list

templates.list List saved Echtpost postcard templates. Risk: read
Input GET /templates. The body is a JSON array. A row is stored only when id is a number. source is stored as a string so a new enum value does not fail the parse. Output