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