The Rumicat API has two parts. A public endpoint for collecting subscribers, and a private API for managing newsletters. Both work with simple HTTP requests. Public APIThe subscribe endpoint is public. No API key needed. Use it to connect signup forms on your website, Shopify store, or anywhere else. SubscribeAdd a subscriber to your publication.
Body:
Your publication slug is the last part of your Rumicat URL. You can find it in Settings. The endpoint always returns After subscribing, the subscriber gets a confirmation email. Submitting the same email again re-sends the confirmation link. This is intentional. Someone might forget they already subscribed, or they might not have seen the first email. Either way, they just typed in their email and expect something to happen. Re-sending makes sure they're not left confused. The welcome email only sends once, on first confirmation. Even if someone submits their email multiple times and confirms again, they won't get a second welcome. Nobody wants duplicate emails in their inbox. For custom integrations (like Shopify), you can embed this in your form handler. The endpoint supports CORS, so it works from any domain. Private APIThe private API requires an API key. Use it to create newsletters, send them, and look up subscriber data. Get Your API KeyGo to rumicat.com/settings/api and click "Generate new key." Give it a name (like the tool you're connecting), copy the key, and store it somewhere safe. You won't see it again. Your key looks like this: Include it in every request as a header:
Create a NewsletterSend your content as HTML. We convert it to our editor format automatically. Images from external URLs are downloaded and hosted on our CDN.
Body:
The response includes a dashboard_url that links directly to the editor where you can review the draft. It also includes a Send ItOnce your draft is ready, send it to all subscribers:
Or schedule it for later by including a body:
Sending runs the same checks as the dashboard: content moderation, email verification, spam check. If something's flagged, you'll get a clear error telling you what to fix. Preview FirstWant to see what it looks like before sending? Send a test email to your own inbox:
No body needed. The preview goes to the email address of the publication owner. Look Up a SubscriberCheck the status of a subscriber by email.
If the email is not on your list:
If they exist:
The Other Endpoints
Supported HTMLKeep it simple. These tags work:
Everything else gets stripped. The result looks identical to creating content in the editor. ErrorsAll errors return a JSON object with a code and a message. Common ones:
That's ItIf you run into anything, reach out at rumicat@nternet.company. |
The Rumicat API has two parts. A public endpoint for collecting subscribers, and a private API for managing newsletters. Both work with simple HTTP requests. Public APIThe subscribe endpoint is public. No API key needed. Use it to connect signup forms on your website, Shopify store, or anywhere else. SubscribeAdd a subscriber to your publication.
Body:
Your publication slug is the last part of your Rumicat URL. You can find it in Settings. The endpoint always returns After subscribing, the subscriber gets a confirmation email. Submitting the same email again re-sends the confirmation link. This is intentional. Someone might forget they already subscribed, or they might not have seen the first email. Either way, they just typed in their email and expect something to happen. Re-sending makes sure they're not left confused. The welcome email only sends once, on first confirmation. Even if someone submits their email multiple times and confirms again, they won't get a second welcome. Nobody wants duplicate emails in their inbox. For custom integrations (like Shopify), you can embed this in your form handler. The endpoint supports CORS, so it works from any domain. Private APIThe private API requires an API key. Use it to create newsletters, send them, and look up subscriber data. Get Your API KeyGo to rumicat.com/settings/api and click "Generate new key." Give it a name (like the tool you're connecting), copy the key, and store it somewhere safe. You won't see it again. Your key looks like this: Include it in every request as a header:
Create a NewsletterSend your content as HTML. We convert it to our editor format automatically. Images from external URLs are downloaded and hosted on our CDN.
Body:
The response includes a dashboard_url that links directly to the editor where you can review the draft. It also includes a Send ItOnce your draft is ready, send it to all subscribers:
Or schedule it for later by including a body:
Sending runs the same checks as the dashboard: content moderation, email verification, spam check. If something's flagged, you'll get a clear error telling you what to fix. Preview FirstWant to see what it looks like before sending? Send a test email to your own inbox:
No body needed. The preview goes to the email address of the publication owner. Look Up a SubscriberCheck the status of a subscriber by email.
If the email is not on your list:
If they exist:
The Other Endpoints
Supported HTMLKeep it simple. These tags work:
Everything else gets stripped. The result looks identical to creating content in the editor. ErrorsAll errors return a JSON object with a code and a message. Common ones:
That's ItIf you run into anything, reach out at rumicat@nternet.company. |