OptimusZapp Developer PlatformCopy Anchor Link

OptimusZapp is a multi-tenant WhatsApp CPaaS and CRM platform. Host applications integrate via the REST API and embedded iframe surfaces (with outbound Standard Webhooks planned per ADR-0005).

Core ConceptsCopy Anchor Link

OptimusZapp isolates data across a 5-layer tenancy hierarchy:

1. Organizations: The top-level billing entity and developer account.
2. Providers: Applications registered to an organization (e.g., Optimus Gym CRM, Real Estate CRM).
3. Workspaces: Specific branches or brands within an organization. All contacts, conversations, and messages are strictly scoped to a workspace.
4. Users & Contacts:
   • Users: Team members with assigned roles within a workspace.
   • Contacts: Customers and message recipients identified by phone number.
5. Inboxes: The WhatsApp phone lines registered via Cloud API (WABA, phone number, access token).

REST API OverviewCopy Anchor Link

The OptimusZapp Public API base URL is https://api.optimuszapp.com/v1: every endpoint path in these docs and in the API reference is relative to it, e.g. GET /contacts/{id} is https://api.optimuszapp.com/v1/contacts/{id}. Call it from your servers over HTTPS; the host serves only the API — the dashboard and embedded screens open on the brand hosts in the launch URLs it returns.

Response EnvelopeCopy Anchor Link

Public endpoints conform to the standard response envelope:

Success Response:

{
  "success": true,
  "data": { ... }
}

Error Response:

{
  "success": false,
  "error": "Human readable error description",
  "code": "ERROR_CODE"
}

Branch on code, not on the error text. request_id will be introduced in API5 alongside the X-Request-Id response header (the API does not return it today). See Errors for every code and what a 500 contains.

API ReferenceCopy Anchor Link

Explore the available endpoints:

• Get Contact by ID: Retrieve a contact record by UUID.