Consultation Management

Create, update, and manage consultation services

POST
/consultations
Create Consultation
Create a new consultation service

Request Body

Request
{
  "title": "Personal Fitness Consultation",
  "description": "One-on-one fitness consultation",
  "duration": 60,
  "sessionType": "OneToOne",
  "maxCapacity": 1,
  "deliveryMode": "Online",
  "timezone": "America/New_York",
  "language": "English",
  "category": "Health & Fitness",
  "subcategory": ["Personal Training"],
  "tags": ["fitness", "health"],
  "ruleSetId": "ARS_123456",
  "pricingId": "PR_789012"
}

Response

Response (200 OK)
{
  "data": {
    "id": "con_123456",
    "referenceId": "ByF-CON-09F989",
    "title": "Personal Fitness Consultation",
    "duration": 60,
    "sessionType": "OneToOne",
    "currentStatus": "Pending",
    "visibility": "Hidden",
    "createdAt": "2025-10-07T19:10:32.535Z"
  },
  "message": "Consultation created successfully",
  "success": true
}
GET
/consultations
List Consultations
Get all consultations with filtering

Query Parameters

Query Parameters
page=1&limit=20&status=Active

Response

Response (200 OK)
{
  "data": {
    "consultations": [
      {
        "id": "con_123456",
        "referenceId": "ByF-CON-09F989",
        "title": "Personal Fitness Consultation",
        "duration": 60,
        "currentStatus": "Approved",
        "visibility": "Published",
        "category": "Health & Fitness"
      }
    ],
    "pagination": {
      "page": 1,
      "limit": 20,
      "total": 1
    }
  },
  "message": "Consultations retrieved successfully",
  "success": true
}
GET
/consultations/{id}
Get Consultation Details
Get detailed information about a specific consultation

Response

Response (200 OK)
{
  "data": {
    "id": "con_123456",
    "referenceId": "ByF-CON-09F989",
    "title": "Personal Fitness Consultation",
    "description": "One-on-one fitness consultation",
    "duration": 60,
    "sessionType": "OneToOne",
    "maxCapacity": 1,
    "deliveryMode": "Online",
    "currentStatus": "Approved",
    "visibility": "Published",
    "category": "Health & Fitness",
    "pricing": {
      "basePrice": 100.00,
      "currency": "USD"
    }
  },
  "message": "Consultation retrieved successfully",
  "success": true
}
PUT
/consultations/{id}
Update Consultation
Update an existing consultation

Request Body

Request
{
  "title": "Updated Fitness Consultation",
  "description": "Updated description",
  "duration": 75,
  "category": "Health & Fitness",
  "tags": ["fitness", "health", "wellness"]
}

Response

Response (200 OK)
{
  "data": {
    "id": "con_123456",
    "title": "Updated Fitness Consultation",
    "duration": 75,
    "updatedAt": "2025-10-08T10:30:00Z"
  },
  "message": "Consultation updated successfully",
  "success": true
}