ApiKeys7

AppointmentConfirmation2

Appointments25

AppointmentTypes10

AutomatedEmailTemplates4

BillableItems5

Breeds5

BulkClientExport2

BulkPatientExport2

CareQueue2

CaseMilestones6

Cases5

ChatExport1

ClientAccount1

ClientCredit2

ClientExport3

Clients6

ClientStatement1

ClinicalAddenda2

ClinicConfig41

ClinicSettings2

Clocking6

Compliance1

ConsentDocuments2

DeaBooks10

DeaExport2

DentalCharts9

DeviceFormHandoffs4

DevicePush3

Devices5

DeviceSelf1

DiagnosisTerms1

DischargeSignOff2

Disclaimers7

DiscountCodes7

Drafts7

EdgePrinters3

EdgePrintJobs2

EmailVerification2

EmergencyIntake2

Erx6

Estimates30

ExamTemplates6

Expenses6

Featurebase2

FeatureFlags1

Flowboard10

FormHandoffs6

GroupCodes7

GroupVisits6

Health1

HomeAgain4

HospitalStays18

IntegrationCredentials18

InternalPrescribing1

InternalWidget1

Inventory25

InventoryApprovals5

InventoryLocations7

Invoices29

JourneyMilestones6

Kiosk4

LabPanels5

Labs21

LineItemNotes5

LocationClosures4

Locations11

Logos7

MedicationRequests7

MentorMetrics5

MessageAttachments4

Metrics31

NpsAnalytics3

NvsIntegration11

OnlineBookingReadiness1

Partners6

PatientGroups9

PatientMasses6

PatientProblems4

PatientRecordExport3

Patients21

Payments22

PaymentTokens5

Pep5

Pharmacies5

Phones2

PriceRules6

Printers7

PrintJobs4

PtoRequests6

PublicDevicePairing1

PublicEmailUnsubscribe2

PublicFileLinks2

PublicFormHandoffs1

PublicNps2

PublicPriceList5

PublicQuestionnaires4

PublicSmsConsent2

PurchaseOrders11

QiEvents9

QuestionnaireResponses7

Questionnaires18

RabiesTags10

RdvmPortal22

Recordings9

RecurringExpenses5

ReferralMessages2

Referrals20

Reminders14

Reports2

RetailItems11

Roles6

RoomDayAssignments3

RxGovernance26

SavedReports5

ScheduleItems10

ServiceCatalog5

Shifts5

ShiftSwaps8

SlotConfigurations6

SmsConsent9

Species5

StaffAvailability1

Subscriptions10

SurgicalRecords11

TagAssignments4

Tags5

TelnyxCallControl1

Templates16

TenantKnowledge5

TimeEntries5

Transparency3

Users14

Vaccinations12

VaccineAdministration3

VaccineCertificateRecords6

VaccineCertificates2

VaccineTypes5

Vendors6

Vitals2

VitalTypes6

Widget18

WidgetChatbot4

WorkItemRules5

WorkTasks13

AppointmentTypes

POST /appointment-types

Changed on Oct 11, 2026

Request

Base URL
https://api.clinicos.vet/backend/business
Auth
HTTP bearer
TypeScript
https://skmtc.dev/clinicos/apis/pawthosx-business-api-v1/docs/appointment-types/post.ts
A function with typed inputs. Its response is checked against the schema.

Request body

namestring

descriptionstring nullable

colorstring nullable

requiresSurgeryRoomboolean

isGroupVisitboolean

isCompassionCareboolean

allowOnlineBookingboolean

Whether clients may self-book this type online (ITE-430).

excludeFromAutomatedFormsboolean

Never send automated forms or confirmations for this type (ITE-1292).

defaultFlowIdstring nullable

Chronicle workflow id to start when an appointment of this type is opened.

examTemplateIdstring nullable

Exam template the chronicle exam step renders for this type (PAW-741). Overrides each provider's personal default. Omit/empty = no override.

noteFormatstring nullable

Generated-note format for visits of this type (PAW-744). Must be a known SoapNoteFormats id. Omit/empty = standard SOAP note.

autoGenerateSoapboolean

Auto-start SOAP generation when the treatment plan is converted to an invoice (PAW-675). Defaults on when omitted.

autoGenerateDischargeboolean

Auto-start discharge generation when the SOAP note is approved (PAW-675). Defaults on when omitted.

locationIdsstring[] nullable

Location IDs that can accommodate this appointment type (Location Intents).

Response

idstring

namestring

descriptionstring nullable

colorstring nullable

isActiveboolean

requiresSurgeryRoomboolean

isGroupVisitboolean

isCompassionCareboolean

allowOnlineBookingboolean

Whether clients may self-book this type online (ITE-430).

excludeFromAutomatedFormsboolean

Never send automated forms or confirmations for this type (ITE-1292).

defaultFlowIdstring nullable

Id of the chronicle workflow to start when an appointment of this type is opened. Null falls back to the entity default (appointment-default).

examTemplateIdstring nullable

Id of the exam template the chronicle exam step renders for this type (PAW-741). Overrides the provider's personal default; null falls through to that default, then to the standard 7-system view.

noteFormatstring nullable

Generated-note format for visits of this type (PAW-744). Null = standard four-section SOAP note. Ids come from the code-defined SoapNoteFormats registry (e.g. "quick-visit").

autoGenerateSoapboolean

Auto-start SOAP generation when the treatment plan is converted to an invoice (PAW-675).

autoGenerateDischargeboolean

Auto-start discharge generation when the SOAP note is approved (PAW-675).

createdAtstring date-time

updatedAtstring date-time

locationIdsstring[]

Location IDs that can accommodate this appointment type (Location Intents).

Changes

Oct 11, 2026f7ab358172d0 Revision changes
- info
  added the new optional request property (media type: application/json)
- info
  added the new optional request property (media type: text/json)
- info
  added the new optional request property (media type: application/*+json)
- info
  added the optional property to the response with the status (media type: text/plain)
- info
  added the optional property to the response with the status (media type: application/json)
- info
  added the optional property to the response with the status (media type: text/json)
Aug 26, 2026a57456aa87b0 Revision changes
- info
  added the new optional request property (media type: application/json)
- info
  added the new optional request property (media type: text/json)
- info
  added the new optional request property (media type: application/*+json)
- info
  added the optional property to the response with the status (media type: text/plain)
- info
  added the optional property to the response with the status (media type: application/json)
- info
  added the optional property to the response with the status (media type: text/json)

Operation history (3 revisions)

POST /appointment-types

Request

Request body

Response 200OK

Changes

Response