HLF Website Sync Service - API Contract

POST /api/v1/website-sync/api/v1/website-sync/:mentorId/sync-visibility

Sync a mentor's visibility state to the HLF website

Public

Request Example

{
  "is_visible": false,
  "reason": "pause_activated"
}

Response Example

{
  "mentor_id": "mentor-042",
  "is_visible": false,
  "synced_at": "2026-03-26T08:31:00Z",
  "website_record_id": "hlf-mentor-00042",
  "sync_status": "success"
}

POST /api/v1/website-sync/api/v1/website-sync/:mentorId/hide

Hide a mentor's profile from the HLF website

Public

Request Example

{
  "hidden_reason": "pause_activated"
}

Response Example

{
  "mentor_id": "mentor-042",
  "website_record_id": "hlf-mentor-00042",
  "is_visible": false,
  "hidden_at": "2026-03-26T08:31:00Z",
  "sync_status": "success"
}

POST /api/v1/website-sync/api/v1/website-sync/:mentorId/restore

Restore a mentor's profile visibility on the HLF website

Public

Request Example

{
  "restored_by": "coordinator-007"
}

Response Example

{
  "mentor_id": "mentor-042",
  "website_record_id": "hlf-mentor-00042",
  "is_visible": true,
  "restored_at": "2026-04-15T09:01:00Z",
  "sync_status": "success"
}

GET /api/v1/website-sync/api/v1/website-sync/:mentorId/status

Check the current sync status for a mentor on the website

Public

Response Example

{
  "mentor_id": "mentor-042",
  "website_record_id": "hlf-mentor-00042",
  "is_visible": false,
  "last_synced_at": "2026-03-26T08:31:00Z",
  "sync_status": "success",
  "website_status": "hidden"
}

Additional Metadata

{
  "contract_summary": {
    "total_contracts": 410,
    "total_endpoints": 2416,
    "api_styles_used": [
      "rest"
    ]
  },
  "generated_at": "2026-03-26T06:55:53.316Z"
}