Getting Started

The OptiPub API gives you programmatic access to the OptiPub platform — manage subscribers, send messages, create content, build segments, and automate your publishing workflows.

The API follows REST conventions. Resources are accessed via standard HTTP methods (GET, POST, PUT, DELETE) and all responses are returned as JSON.

Base URL

https://{APP_DOMAIN}/api/3.2

Replace {APP_DOMAIN} with your OptiPub application domain (e.g. yourapp.app.optipub.com).

Authentication

Include your API key in the Authorization header of every request:

Authorization: Bearer YOUR_API_KEY

See Creating an API Key for setup instructions.

What Can You Do?

AreaExamples
Subscribers & SegmentsLook up subscribers, manage segment membership, import and export lists
MessagingCreate and send emails, schedule sends, view delivery statistics
ContentCreate and publish articles, manage pages and templates
MarketingBuild landing pages, manage funnels, work with pricing plans
Auto RespondersSet up automated emails triggered by subscriber events

Next Steps

StepDescription
Creating an API KeyGenerate credentials for API access
Using the APILearn about pagination, sorting, filtering, and field selection

Resources

  • Slack — Your dedicated Slack channel is the fastest way to get help from the OptiPub team.
  • Reddit — Join the conversation at r/optipub.
  • Tutorials — Check out the platform guides for step-by-step walkthroughs.
  • AI Integration — Connect your AI editor directly to OptiPub via MCP.