CoPulse API Reference

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

  1. Create a project in CoPulse and open Setup → Integrations → API Keys.
  2. Generate a key with the scopes you need (e.g. outbound:message).
  3. Call POST /api/v1/integrations/... with Authorization: Bearer cp_live_….
  4. Poll GET /api/v1/integrations/outbound/requests/:requestId for 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).