Skip to main content

Send eCards Instantly via API

Use the Share eCard Endpoint to email or generate shareable links with full branding and customization.

Tim Badolato avatar
Written by Tim Badolato
Updated over 2 weeks ago

📘 Explore full API documentation:
API Docs – Share eCard Endpoint

The Share eCard Endpoint (POST /pub/ecard-actions/send-ecard) allows you to send an eCard directly to a recipient's email or create a shareable link with a single API call. It supports advanced customization through the overrideProps object, where you can tailor the design, branding, and content of the eCard—including logos, colors, social links, and embedded media.

Key Features:

  • Send by email or generate shareable links (type: "email" or "ecard_copy_link")

  • Schedule delivery with sendAt (ISO 8601 format)

  • Notify Sender when the Recipient opens the email with opennotification flag

  • Include dynamic content with mergeTags - to be used in the template or for tracking additional values in the ecard logs

  • Customize eCard design and envelope presentation via overrideProps

Authentication:
API token is required and available from your developer dashboard.

Production Endpoint:

https://app.ecardwidget.com/v2/api/pub/ecard-actions/send-ecard

Response Codes and Messages

Always returns status code 200 and the following string.

Code String

Message

wouldexceedlimit

"You tried to send {var1} emails but this account only has {var2} emails remaining for this billing period. Please upgrade your account or contact the website admin."

postmarkErrs

Dependent on the number of errors versus recipients. Messages about specific Postmark errors.

toomany

"You entered too many recipients!"

tooshort

"You forgot to add recipients to your ecard. Make sure you click the plus button next to the recipients field."

einvalid

"Your email address is invalid."

finvalid

"One of your recipients email addresses is invalid."

limitReached

"Unable to send! You've sent more than {var1} emails in the last {var2} seconds."

blocked

"1" (Indicates a block without informing the sender). False positive to confuse spammers.

spammer

"Something went wrong! Please contact us."

ListLen(optOutList)

"Your email was sent successfully but the following emails have requested to not receive emails."

shopifyPreCheckout

Returns preCheckoutStatID or 0.

success

"1"

Default

"Your request failed! Please try again."


The above documentation provides a clear and precise breakdown of the email sending API for eCardWidget. Remember to adjust the {var1} and {var2} placeholders based on the specific scenario when implementing this API.

📘 Explore full API documentation:
API Docs – Share eCard Endpoint

Did this answer your question?