Skip to content

Agency API

Manage agency profile, branding, and real-time updates.


Get Agency Details

http
GET /api/v1/agencies/{agencyId}

Update Agency Profile

http
PUT /api/v1/agencies/{agencyId}

Update Agency Brand Color

http
PUT /api/v1/agencies/{agencyId}/brand-color

Request Body:

json
{
  "brandColor": "#FF5733"
}

WebSocket Updates

Connect to receive real-time agency events.

ws://localhost:8080/ws?agency_id={agencyId}

Event payload example:

json
{
  "type": "BRAND_COLOR_UPDATE",
  "agency_id": "cm1234567890",
  "payload": {
    "brand_color": "#FF5733"
  },
  "timestamp": "2026-02-05T12:00:00Z"
}
Event TypeDescription
BRAND_COLOR_UPDATEFires when brand color changes

Unified API Documentation