Note: The API is limited to Enterprise Customers only. The feature is new and is under active development. We welcome any questions or feedback you may have. Feel free to reach out to us at [email protected].
View more API Endpoints
Endpoint URL
POST https://app.ecardwidget.com/widget/{widget_id}/email/{ecard_id}?locale={locale_type}Request Parameters
Parameter | Description | Type | Example |
| ID of the eCard widget. | int | 6785 |
| ID of the ecard being sent. | int | 21218 |
| Locale for translations. Optional. | string | "en" |
| Name of the sender. | string | "Billy" |
| Email address of the sender. | string | |
| Subscription status of the sender. | bool | false |
| Preference to receive open notifications. | bool | false |
| Personal message from the sender. | string | "asdf as fsaddsfa" |
| Array of recipient details (name & email). | array |
|
Response Codes and Messages
Always returns status code 200 and the following string.
Code String | Message |
| "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." |
| Dependent on the number of errors versus recipients. Messages about specific Postmark errors. |
| "You entered too many recipients!" |
| "You forgot to add recipients to your ecard. Make sure you click the plus button next to the recipients field." |
| "Your email address is invalid." |
| "One of your recipients email addresses is invalid." |
| "Unable to send! You've sent more than {var1} emails in the last {var2} seconds." |
| "1" (Indicates a block without informing the sender). False positive to confuse spammers. |
| "Something went wrong! Please contact us." |
| "Your email was sent successfully but the following emails have requested to not receive emails." |
| Returns |
| "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.