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
get
account.get
Get the account, user, API key metadata and balance.
Risk: read
account full type
account full type
user full type
user full type
api_key full type
api_key full type
balance full type
balance full type
Cards
cancel
cards.cancel
Cancel a card that has not been printed yet; it cannot be restored.
Risk: destructive
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
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.
font full type
font full type
notifications full type
notifications full type
recipients full type
recipients full type
font full type
font full type
createFromTemplate
cards.createFromTemplate
Print and post a real postcard from a saved template; the account is billed per card.
Risk: destructive
Same as cards.create, using a saved template’s motive, text and font.
recipients full type
recipients full type
font full type
font full type
get
cards.get
Get one card and its status.
Risk: read
Output
font full type
font full type
list
cards.list
List cards, filtered by status, delivery date or motive.
Risk: read
Output
cards full type
cards full type
previewFit
cards.previewFit
Check whether card text fits at a font and size, without creating a card.
Risk: read
font full type
font full type
Contacts
create
contacts.create
Create a contact with a postal address.
Risk: write
Output
delete
contacts.delete
Delete a contact.
Risk: destructive
Output
get
contacts.get
Get one contact by id.
Risk: read
Output
list
contacts.list
List contacts (postcard recipients), with filters and paging.
Risk: read
search matches first name, last name, company or city. include: "groups" adds group_ids to each contact.
Output
contacts full type
contacts full type
update
contacts.update
Update a contact; fields left out stay as they are.
Risk: write
Output
Groups
create
groups.create
Create a contact group.
Risk: write
Output
delete
groups.delete
Delete a group.
Risk: destructive
Output
get
groups.get
Get one group by id.
Risk: read
Output
list
groups.list
List contact groups.
Risk: read
Output
groups full type
groups full type
update
groups.update
Rename a group or change its external id.
Risk: write
Output
Motives
get
motives.get
Get one motive and what text fields it allows.
Risk: read
Output
list
motives.list
List the postcard motives (front designs) the account can use.
Risk: read
Output
motives full type
motives full type
Templates
get
templates.get
Get one saved template by id.
Risk: read
Output
font full type
font full type
list
templates.list
List saved Echtpost postcard templates.
Risk: read
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
templates full type
templates full type