API reference

v1 · Public

Color design

Accept color design service requests from your website, including reference photos. Each submission appears in EquityPOS under Communications → Color design and notifies users with support or color design access.

POST/color-design

Request body (multipart/form-data)

bash
curl -X POST https://equitypos.com/api/v1/public/color-design \
  -H "Authorization: Bearer YOUR_KEY" \
  -H "Accept: application/json" \
  -F "name=Aisha Hassan" \
  -F "email=aisha@example.com" \
  -F "phone=+960 123 4567" \
  -F "subject=Color Design Services — Aisha Hassan" \
  -F "address=Hulhumale Phase 2, Male" \
  -F "islandArea=Kaafu Atoll" \
  -F "expectedPaintingDate=July 2026" \
  -F "paintType=Interior" \
  -F "buildingType=Apartment" \
  -F "productPreference=Low VOC" \
  -F "budgetMvr=15000" \
  -F 'colorStyles=["Coastal & island","Modern neutral"]' \
  -F "message=Prefer warm whites in the living room." \
  -F "summary=Interior repaint for a 3-bedroom apartment..." \
  -F "files=@/path/to/room1.jpg" \
  -F "files=@/path/to/room2.jpg"
  • Required fields: name, email, phone, subject, address, expectedPaintingDate, paintType, buildingType, budgetMvr, colorStyles (JSON array of style labels), and summary.
  • Optional fields: islandArea, productPreference, and message (designer notes).
  • Photos use field name files (repeat for multiple). Up to 5 images, max 5 MB each. Allowed types: JPEG, PNG, WebP, HEIC, GIF.
  • Enable the Color design module under Company Settings → Modules and use the same Authorization: Bearer location API key as other public endpoints.

Response

json
{
  "data": {
    "id": "01H...",
    "subject": "Color Design Services, Aisha Hassan",
    "name": "Aisha Hassan",
    "email": "aisha@example.com",
    "phone": "+960 123 4567",
    "photos": [
      {
        "key": "color-design-requests/.../room1.jpg",
        "name": "room1.jpg",
        "type": "image/jpeg",
        "size": 245120,
        "url": "/api/files/download?key=..."
      }
    ],
    "createdAt": "2026-06-10T12:00:00.000Z"
  }
}

Returns 201 Created on success. Validation errors return 400 with a details object when field validation fails.