Help Center

View Categories

FAQ – cmercury API

1. What can I do with the cmercury API?

The cmercury API lets you automate email marketing tasks such as creating lists, syncing user data, sending triggered campaigns, and pulling performance reports—all in real time.

2. Where do I find the API documentation?

You can access the complete developer guide here:

https://cmercuryapi.readme.io/reference/getting-started-with-your-api

3. How do I generate an API key?

  • Go to your cmercury Dashboard → Settings → API Key tab
  • Click “Create API Key”, give it a name, and then Generate
  • Click the eye icon to view/copy the token securely

Tip: Use different keys for different apps (e.g., CRM, mobile app).

4. Can I manage or delete an API key?

Yes. Under Settings → API Keys, you can:

  • Copy your token
  • Delete a key to revoke access

⚠️ Deleting a key permanently disables access for that integration.

5. Is cmercury API secure?

Yes. All API calls are authenticated via secure X-Token headers and transmitted over HTTPS.

6. Can I use cmercury API with Postman?

Absolutely! You can:

Import our Postman Collection

Test over 50+ API request types

7. How do I find IDs like List ID or Segment ID?

You can locate them within your cmercury dashboard:

Mailing List ID: Lists → Manage List

Segment ID: Lists → Segments

Attribute ID: View inside selected Segment

Trigger ID: Email → Triggers

8. What are some popular use cases?

Syncing leads from CRM (e.g., Zoho, HubSpot)

Triggering emails from 3rd-party forms or shops

Automating campaigns via actions/events

Pulling reports for engagement, conversions, etc.

9. What’s the API format and method?

RESTful API using HTTPS & JSON

Use POST for all API functions

Include your X-Token in the request headers

Batching is not supported

10. Can I integrate with other platforms like Zapier?

Yes! Use platforms like Zapier to easily connect cmercury with 100+ apps such as:

  • Google Sheets / Forms
  • Shopify / WooCommerce
  • CRMs like Salesforce or Zoho

11. What is a transactional email API?

A transactional email API allows an application to automatically trigger an email when a specific event occurs, such as a customer registration, order, payment, password reset or account notification.

12. What is the difference between transactional email and marketing email?

Transactional email is generally triggered by an individual customer or application event, while marketing email is typically designed for promotional, engagement or communication campaigns sent to an audience.

13. Can cmercury send transactional emails through an API?

Yes. cmercury’s Transactional Mailer allows applications to trigger transactional emails through an API based on application events.

14. Can cmercury send emails with dynamic customer information?

Yes. cmercury’s Dynamic Content Mailer allows businesses to use templates containing dynamic content and trigger them from their applications through the API.

15. Can cmercury automate welcome emails?

Yes. cmercury’s Automation module currently supports a Welcome Series for customer onboarding and lifecycle communication.

16. Why can transactional emails experience delivery delays?

Email delivery can be influenced by factors including sending reputation, IP infrastructure, authentication, sending patterns and the type of email traffic being sent. This is why transactional email requires more than simply having an API that can trigger an email.

17. Does cmercury separate transactional and marketing email infrastructure?

Yes. cmercury now manages IP pools separately according to email type, including regular campaigns, automation emails and API or transactional emails. This is designed to prevent transactional/API sending from being dependent on the performance associated with regular campaign traffic.