Pre Consultation Forms

Function-calling namespace: preConsultationForms

Base URL: https://api.aivida.in
Engine endpoint: POST /api
Auth: Stack token middleware enabled in optional mode.
Send token in header: x-stack-access-token: <access_token> (or Authorization: Bearer <access_token>).
In optional mode: no token is allowed; invalid token is rejected with 401.

`create`

Source: backend/endpoints/pre-consultation-forms/create

Input Fields

Field	Type	Required	Constraints
`appointmentId`	`string`	Yes	-
`stackUserId`	`string`	Yes	-
`departmentName`	`string`	Yes	-
`answers`	`object`	Yes	-
`status`	`string`	Yes	-
`submittedAt`	`integer`	No	unix-ms timestamp; nullable
`createdAt`	`integer`	No	unix-ms timestamp; nullable
`updatedAt`	`integer`	No	unix-ms timestamp; nullable

Example Request

curl -X POST https://api.aivida.in/api \
  -H "Content-Type: application/json" \
  -H "x-stack-access-token: <access_token_optional>" \
  -d '{
  "namespace": "preConsultationForms",
  "apiName": "create",
  "data": {
    "appointmentId": "appointment_123",
    "stackUserId": "stackuser_123",
    "departmentName": "value",
    "answers": {},
    "status": "scheduled"
  }
}'

Example Response

{ "status": "ok", "data": {} }

`delete`

Source: backend/endpoints/pre-consultation-forms/delete

Input Fields

Field	Type	Required	Constraints
`id`	`string`	Yes	-
`organizationId`	`string`	Yes	-

Example Request

curl -X POST https://api.aivida.in/api \
  -H "Content-Type: application/json" \
  -H "x-stack-access-token: <access_token_optional>" \
  -d '{
  "namespace": "preConsultationForms",
  "apiName": "delete",
  "data": {
    "id": "id_123",
    "organizationId": "org_123"
  }
}'

Example Response

{ "status": "ok", "data": {} }

`getById`

Source: backend/endpoints/pre-consultation-forms/get-by-id

Input Fields

Field	Type	Required	Constraints
`id`	`string`	Yes	-
`organizationId`	`string`	Yes	-

Example Request

curl -X POST https://api.aivida.in/api \
  -H "Content-Type: application/json" \
  -H "x-stack-access-token: <access_token_optional>" \
  -d '{
  "namespace": "preConsultationForms",
  "apiName": "getById",
  "data": {
    "id": "id_123",
    "organizationId": "org_123"
  }
}'

Example Response

{ "status": "ok", "data": {} }

`listByOrganization`

Source: backend/endpoints/pre-consultation-forms/list-by-organization

Input Fields

Field	Type	Required	Constraints
`organizationId`	`string`	Yes	-
`page`	`integer`	No	-
`pageSize`	`integer`	No	-

Example Request

curl -X POST https://api.aivida.in/api \
  -H "Content-Type: application/json" \
  -H "x-stack-access-token: <access_token_optional>" \
  -d '{
  "namespace": "preConsultationForms",
  "apiName": "listByOrganization",
  "data": {
    "organizationId": "org_123"
  }
}'

Example Response

{ "status": "ok", "data": {} }

`update`

Source: backend/endpoints/pre-consultation-forms/update

Input Fields

Field	Type	Required	Constraints
`id`	`string`	Yes	-
`organizationId`	`string`	Yes	-
`appointmentId`	`string`	No	nullable
`stackUserId`	`string`	No	nullable
`departmentName`	`string`	No	nullable
`answers`	`object`	No	nullable
`status`	`string`	No	nullable
`submittedAt`	`integer`	No	unix-ms timestamp; nullable
`createdAt`	`integer`	No	unix-ms timestamp; nullable
`updatedAt`	`integer`	No	unix-ms timestamp; nullable

Example Request

curl -X POST https://api.aivida.in/api \
  -H "Content-Type: application/json" \
  -H "x-stack-access-token: <access_token_optional>" \
  -d '{
  "namespace": "preConsultationForms",
  "apiName": "update",
  "data": {
    "id": "id_123",
    "organizationId": "org_123"
  }
}'

Example Response

{ "status": "ok", "data": {} }

Pre Consultation Answers Pre Consultation Question Templates