CoPulse developers
API reference
Integrate CoPulse with CRMs, automation platforms, and custom backends. All operational traffic goes through the API server — authenticate with project-scoped API keys, not dashboard JWT.
Available APIs
Quick start
- Create a project in CoPulse and open Setup → Integrations → API Keys.
- Generate a key with the scopes you need (e.g.
outbound:message). - Call
POST /api/v1/integrations/...withAuthorization: Bearer cp_live_…. - Poll
GET /api/v1/integrations/outbound/requests/:requestIdfor delivery status.
Base URL in production:
https://copulse.app/api/v1/integrations/.
Local dev typically proxies through http://localhost:8080/api/.
Response envelope
All integration endpoints return a consistent JSON shape:
{
"success": true,
"data": { ... },
"error": null
}
On failure, success is false and error contains a message (and often a code).