--- title: Create an Appointment slug: create-an-appointment docTags: createdAt: 2026-04-21T15:22:49.957Z --- { "id": "xWordX51mqtv7-WOdnUnd", "type": "api-oas-v2", "data": { "method": "POST", "url": "https://developer.digitail.io/api/v1/appointments", "servers": [ { "url": "https://developer.digitail.io/api/v1/appointments", "description": "Sandbox server (uses test data)" }, { "url": "https://vet.digitail.io/api/v1/appointments", "description": "Production server (uses live data)" } ], "name": "Create an Appointment", "description": "

Permissions needed: CREATE_APPOINTMENTS\nCreate Appointment \n \n Start Date and End Date is set as is format(2022-10-20 10:09

), no alterations are done, so queries will return the exact date and time that was set. \n - Status enum is visible under the appointments change status method \n - record_id, room_id and examination_id must be set as null if not used.

", "contentType": "application/json", "request": { "pathParameters": [], "headerParameters": [ { "name": "accept", "type": "string", "kind": "optional", "description": "Generated from available response content types", "enum": [ "application/json" ], "default": "application/json" } ], "queryParameters": [ { "kind": "optional", "name": "include", "type": "string", "description": "

Additional info to include. You can use multiple, comma separated. Options: patient,patient.species,patient.breed,patient.crossBreed,patient.owners,patient.owners.appDownloadNotification,patient.owners.clients,room,event,\nclinic,clinic.rooms,vet,vet.vetRolesAll,requests,notes,visitType,paymentDeposits.paymentLinks

" } ], "bodyDataParameters": [ { "kind": "required", "name": "body", "type": "appointmentrequestbodystore", "description": "

Appointment Create/Update Request Body

", "schema": [ { "name": "clinic_id", "kind": "required", "type": "integer", "description": "Clinic Id", "example": 1 }, { "name": "vet_id", "kind": "required", "type": "integer", "description": "Vet Id", "example": 1 }, { "name": "patient_id", "kind": "required", "type": "integer", "description": "Pet id", "example": 1 }, { "name": "visit_type_id", "kind": "required", "type": "integer", "description": "Id of the VisitType", "example": 1 }, { "name": "observations", "kind": "optional", "type": "string", "description": "Observations", "example": "" }, { "name": "status", "kind": "optional", "type": "integer", "description": "

1 - Pending Client Approval 2 - Pending Clinic Approval 3 - Rescheduled Clinic Approval 4 - Rescheduled Client Approval 5 - Confirmed 6 - Canceled By Client 7 - Canceled By Clinic' 8 - Automatically Created' 9 - No Show

", "example": 1, "enum": [ "1", "2", "3", "4", "5", "6", "7", "8", "9" ] }, { "name": "notification_message", "kind": "optional", "type": "string", "description": "Notification message", "example": "" }, { "name": "reminder_notifications", "kind": "required", "type": "array", "description": "Reminder notifications. Send an empty array for none.", "example": "[{\"id\":1,\"period\":1,\"periodType\":0,\"notificationType\":0},{\"id\":2,\"period\":1,\"periodType\":1,\"notificationType\":0}]", "itemType": "object", "customType": "object[]", "schema": [ { "name": "id", "kind": "optional", "type": "integer", "description": "", "example": 1 }, { "name": "period", "kind": "optional", "type": "integer", "description": "

Reminder will be sent X days/weeks/months (period_type) before the appointment

", "example": 2 }, { "name": "period_type", "kind": "optional", "type": "integer", "description": "", "example": 2, "enum": [ "0", "1", "2" ] }, { "name": "notification_type", "kind": "optional", "type": "integer", "description": "", "example": 1, "enum": [ "0", "1", "2" ] } ] }, { "name": "record_id", "kind": "optional", "type": "integer", "nullable": true, "description": "

Record ID - set null if not used

", "example": "" }, { "name": "room_id", "kind": "optional", "type": "integer", "nullable": true, "description": "

Room ID - set null if not used

", "example": "" }, { "name": "examination_id", "kind": "optional", "type": "integer", "nullable": true, "description": "

Examination ID - set null if not used

", "example": "" }, { "name": "printable_file_ids", "kind": "optional", "type": "array", "description": "Consent forms", "example": "[1,2]", "itemType": "integer", "customType": "integer[]", "itemExample": "", "itemDefault": "" }, { "name": "video_link", "kind": "optional", "type": "string", "nullable": true, "description": "Video link", "example": "" }, { "name": "datetime_start_utc", "kind": "required", "type": "string", "description": "Start Date in UTC ISO Zulu format", "example": "2022-06-16T13:42:38Z" }, { "name": "datetime_end_utc", "kind": "required", "type": "string", "description": "End Date in UTC ISO Zulu format", "example": "2022-06-16T14:42:38Z" }, { "name": "service_package_ids", "kind": "optional", "type": "array", "description": "Service package ids", "example": "[1,2]", "itemType": "integer", "customType": "integer[]", "itemExample": "", "itemDefault": "" }, { "name": "user_note", "kind": "optional", "type": "string", "description": "Notes introduced by the pet parent", "example": "Daisy has not been feeling well" }, { "name": "recurrence", "kind": "optional", "type": "string", "nullable": true, "description": "recurrence defined by RFC 5545", "example": "FREQ=DAILY;COUNT=10" }, { "name": "source", "kind": "optional", "type": "integer", "description": "

0 - Added by clinic 1 - Requested via Web 2 - Requested via App

" }, { "name": "requires_payment_deposit", "kind": "optional", "type": "boolean", "description": "" }, { "name": "pet_parent", "kind": "optional", "type": "object", "description": "", "example": "", "schema": [ { "name": "id", "kind": "optional", "type": "integer", "description": "" }, { "name": "email", "kind": "optional", "type": "string", "description": "" }, { "name": "send_email", "kind": "optional", "type": "boolean", "description": "" }, { "name": "name", "kind": "optional", "type": "string", "description": "" }, { "name": "last_name", "kind": "optional", "type": "string", "description": "" }, { "name": "phone", "kind": "optional", "type": "string", "description": "Phone number in E.164 format", "example": "+16175551212" }, { "name": "send_sms", "kind": "optional", "type": "boolean", "description": "" }, { "name": "address", "kind": "optional", "type": "string", "description": "" }, { "name": "address_2", "kind": "optional", "type": "string", "description": "" } ] }, { "name": "pet", "kind": "optional", "type": "object", "description": "", "example": "", "schema": [ { "name": "nickname", "kind": "optional", "type": "string", "description": "" }, { "name": "species_id", "kind": "optional", "type": "integer", "description": "" }, { "name": "breed_id", "kind": "optional", "type": "integer", "description": "" }, { "name": "birthday_is_estimated", "kind": "optional", "type": "boolean", "description": "" }, { "name": "birthdate", "kind": "optional", "type": "string", "description": "", "example": "1990-01-01" }, { "name": "gender", "kind": "optional", "type": "string", "description": "", "enum": [ "male", "female", "unknown" ] }, { "name": "hormonal_status", "kind": "optional", "type": "integer", "description": "", "enum": [ "0", "1", "2" ] } ] }, { "name": "drop_off", "kind": "optional", "type": "object", "nullable": true, "description": "

Drop-off scheduling data. Required when visit type has drop-off enabled.

", "example": "", "schema": [ { "name": "time", "kind": "optional", "type": "string", "description": "

Drop-off time in HH

format

", "example": "09:00" }, { "name": "vet_id", "kind": "optional", "type": "integer", "description": "

Vet ID who handles the drop-off

", "example": 1 } ] } ], "isExpanded": true } ], "formDataParameters": [], "oAuthParameters": [ { "id": "passport", "name": "passport", "kind": "optional", "type": "oauth2", "description": "Laravel passport oauth2 security.", "oauth2Flows": { "authorizationCode": { "authorizationUrl": "https://digitail.test/oauth/authorize", "tokenUrl": "https://digitail.test/oauth/token", "refreshUrl": "https://digitail.test/oauth/token" } } }, { "id": "Bearer", "name": "Bearer", "kind": "optional", "type": "http", "scheme": "bearer" } ], "cookieParameters": [] }, "responses": [ { "statusCode": "200", "description": "successful operation", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "schema": [ { "name": "data", "kind": "optional", "type": "object", "description": "", "example": "", "schema": [ { "name": "id", "kind": "optional", "type": "integer", "description": "", "example": 1 }, { "name": "event_id", "kind": "optional", "type": "integer", "nullable": true, "description": "", "example": "" }, { "name": "clinic_id", "kind": "optional", "type": "integer", "description": "", "example": 1 }, { "name": "room_id", "kind": "optional", "type": "integer", "nullable": true, "description": "", "example": "" }, { "name": "guest", "kind": "optional", "type": "boolean", "description": "", "example": false }, { "name": "pet_id", "kind": "optional", "type": "integer", "nullable": true, "description": "", "example": 1 }, { "name": "record_id", "kind": "optional", "type": "integer", "nullable": true, "description": "", "example": "" }, { "name": "generated_record", "kind": "optional", "type": "object", "nullable": true, "description": "

Record created from this appointment. Only present when externalRefRecord is included; carries has_quick_soap.

", "complexType": "allOf", "complexItems": [ { "name": "data", "description": "", "modelRef": "#/paths/~1api~1v1~1records/post/responses/201/content/application~1json/schema/properties/data", "schema": [] } ], "schema": [] }, { "name": "status", "kind": "optional", "type": "string<1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9>", "description": "

1 - Pending Client Approval 2 - Pending Clinic Approval 3 - Rescheduled Clinic Approval 4 - Rescheduled Client Approval 5 - Confirmed 6 - Canceled By Client 7 - Canceled By Clinic' 8 - Automatically Created' 9 - No Show

", "example": "1", "enum": [ "1", "2", "3", "4", "5", "6", "7", "8", "9" ] }, { "name": "datetime", "kind": "optional", "type": "string", "description": "", "example": "2022-06-16 15:12:38" }, { "name": "end_datetime", "kind": "optional", "type": "string", "description": "", "example": "2022-06-16 15:42:38" }, { "name": "datetime_start_utc", "kind": "optional", "type": "string", "description": "", "example": "2023-12-01T09:00:00.000000Z", "format": "date-time" }, { "name": "datetime_end_utc", "kind": "optional", "type": "string", "description": "", "example": "2023-12-01T10:00:00.000000Z", "format": "date-time" }, { "name": "observations", "kind": "optional", "type": "string", "nullable": true, "description": "", "example": "" }, { "name": "user_note", "kind": "optional", "type": "string", "nullable": true, "description": "", "example": "" }, { "name": "pet_name", "kind": "optional", "type": "string", "nullable": true, "description": "", "example": "" }, { "name": "owner_name", "kind": "optional", "type": "string", "nullable": true, "description": "", "example": "" }, { "name": "patient", "kind": "optional", "type": "object", "description": "", "modelRef": "#/paths/~1api~1v1~1pets/post/responses/201/content/application~1json/schema/properties/data", "customType": "data", "schema": [] }, { "name": "room", "kind": "optional", "type": "object", "nullable": true, "description": "", "modelRef": "#/paths/~1api~1v1~1tasks/get/responses/200/content/application~1json/schema/properties/data/items/properties/room", "customType": "room", "schema": [] }, { "name": "event", "kind": "optional", "type": "object", "nullable": true, "description": "A scheduled event in a clinic. Viewable on the calendar.", "example": "", "schema": [ { "name": "id", "kind": "optional", "type": "integer", "description": "", "example": 1 }, { "name": "address_id", "kind": "optional", "type": "integer", "description": "", "example": 1 }, { "name": "clinic_id", "kind": "optional", "type": "integer", "description": "", "example": 1 }, { "name": "capacity", "kind": "optional", "type": "integer", "description": "", "example": 25 }, { "name": "date", "kind": "optional", "type": "string", "description": "", "example": "2022-06-16 15:12:38", "format": "date-time" }, { "name": "name", "kind": "optional", "type": "string", "description": "", "example": "Event Name" }, { "name": "preferences", "kind": "optional", "type": "string", "description": "", "enum": [ "capacity-based", "schedule-based" ] }, { "name": "appointments_number", "kind": "optional", "type": "integer", "description": "", "example": 5 }, { "name": "visit_types", "kind": "optional", "type": "array", "description": "", "modelRef": "#/paths/~1api~1v1~1records/post/responses/201/content/application~1json/schema/properties/data/properties/visit_types/items", "customType": "items[]", "schema": [] } ] }, { "name": "vet", "kind": "optional", "type": "object", "description": "", "modelRef": "#/paths/~1api~1v1~1vets~1%7Bid%7D/get/responses/200/content/application~1json/schema/properties/data", "customType": "data", "schema": [] }, { "name": "owner_email", "kind": "optional", "type": "string", "nullable": true, "description": "", "example": "" }, { "name": "owner_phone", "kind": "optional", "type": "string", "nullable": true, "description": "", "example": "" }, { "name": "reminder_notifications", "kind": "optional", "type": "object", "description": "", "example": "[{\"id\":1,\"period\":1,\"periodType\":0,\"notificationType\":0},{\"id\":2,\"period\":1,\"periodType\":1,\"notificationType\":0}]", "schema": [] }, { "name": "newRequests", "kind": "optional", "type": "array", "description": "", "example": "", "itemType": "object", "customType": "object[]", "itemExample": "", "itemDefault": "" }, { "name": "consentForms", "kind": "optional", "type": "array", "description": "", "example": "", "itemType": "object", "customType": "object[]", "itemExample": "", "itemDefault": "" }, { "name": "video_link", "kind": "optional", "type": "string", "nullable": true, "description": "", "example": "https://example.com/1234235345.mp4" }, { "name": "notification_message", "kind": "optional", "type": "string", "description": "" }, { "name": "cancellation_reason", "kind": "optional", "type": "string", "nullable": true, "description": "" }, { "name": "recurrence", "kind": "optional", "type": "string", "nullable": true, "description": "recurrence defined by RFC 5545", "example": "FREQ=DAILY;COUNT=10" }, { "name": "has_google_cal_error", "kind": "optional", "type": "boolean", "nullable": true, "description": "" }, { "name": "duration", "kind": "optional", "type": "integer", "description": "" }, { "name": "occasion", "kind": "optional", "type": "string", "nullable": true, "description": "" }, { "name": "token", "kind": "optional", "type": "string", "description": "" }, { "name": "visit_type_id", "kind": "optional", "type": "integer", "nullable": true, "description": "" }, { "name": "visit_type", "kind": "optional", "type": "object", "nullable": true, "description": "", "modelRef": "#/paths/~1api~1v1~1records/post/responses/201/content/application~1json/schema/properties/data/properties/visit_types/items", "customType": "items", "schema": [] }, { "name": "last_confirmed_at", "kind": "optional", "type": "string", "nullable": true, "description": "", "example": "2023-12-01T09:00:00.000000Z", "format": "date-time" }, { "name": "confirmed_by", "kind": "optional", "type": "string", "nullable": true, "description": "", "example": "client", "enum": [ "client", "staff" ] }, { "name": "confirmation_source", "kind": "optional", "type": "string", "nullable": true, "description": "", "example": "sms_reminder", "enum": [ "phone", "sms_reminder", "email_reminder", "pet_portal", "public_calendar", "crm" ] }, { "name": "reconfirmed", "kind": "optional", "type": "boolean", "description": "", "example": false }, { "name": "is_reschedulable", "kind": "optional", "type": "boolean", "nullable": true, "description": "" }, { "name": "is_cancelable", "kind": "optional", "type": "boolean", "nullable": true, "description": "" }, { "name": "drop_off", "kind": "optional", "type": "object", "nullable": true, "description": "

Drop-off scheduling data. Present when dropOff is included.

", "example": "", "schema": [ { "name": "id", "kind": "optional", "type": "integer", "description": "", "example": 1 }, { "name": "time", "kind": "optional", "type": "string", "description": "

Drop-off time in HH

format

", "example": "09:00" }, { "name": "vet_id", "kind": "optional", "type": "integer", "description": "", "example": 1 }, { "name": "appointment_id", "kind": "optional", "type": "integer", "description": "", "example": 1 }, { "name": "vet", "kind": "optional", "type": "object", "nullable": true, "description": "

Vet resource, present when dropOff.vet is included

", "example": "", "schema": [] }, { "name": "datetime", "kind": "optional", "type": "string", "nullable": true, "description": "

Full UTC datetime computed from appointment date + drop-off time

", "example": "2023-12-01T09:00:00Z" } ] } ] } ], "isExpanded": true } ] } ], "hasXCodeSamples": false, "examples": { "languages": [ { "id": "ltRN3u6hi4-Aa-rcbLb9h", "language": "curl", "label": "cURL", "code": "curl --request POST \\\n --url https://developer.digitail.io/api/v1/appointments \\\n --header 'accept: application/json' \\\n --header 'content-type: application/json' \\\n --data '{\n \"clinic_id\": 1,\n \"vet_id\": 1,\n \"patient_id\": 1,\n \"visit_type_id\": 1,\n \"reminder_notifications\": [\n {}\n ],\n \"datetime_start_utc\": \"2022-06-16T13:42:38Z\",\n \"datetime_end_utc\": \"2022-06-16T14:42:38Z\"\n }'" }, { "id": "mbQPtcufede2FZbyrND7r", "language": "javascript", "label": "javascript", "code": "var myHeaders = new Headers();\nmyHeaders.append(\"accept\", \"application/json\");\nmyHeaders.append(\"content-type\", \"application/json\");\n\nvar raw = JSON.stringify({\n \"clinic_id\": 1,\n \"vet_id\": 1,\n \"patient_id\": 1,\n \"visit_type_id\": 1,\n \"reminder_notifications\": [\n {}\n ],\n \"datetime_start_utc\": \"2022-06-16T13:42:38Z\",\n \"datetime_end_utc\": \"2022-06-16T14:42:38Z\"\n});\n\nvar requestOptions = {\n method: 'POST',\n headers: myHeaders,\n body: raw,\n redirect: 'follow'\n};\n\nfetch(\"https://developer.digitail.io/api/v1/appointments\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));" }, { "id": "y0onI_RDuv1eq4VmFqIRI", "language": "ruby", "label": "Ruby", "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://developer.digitail.io/api/v1/appointments\")\n\nhttps = Net::HTTP.new(url.host, url.port)\nhttps.use_ssl = true\n\nrequest = Net::HTTP::Post.new(url)\nrequest[\"accept\"] = \"application/json\"\nrequest[\"content-type\"] = \"application/json\"\nrequest.body = JSON.dump({\n \"clinic_id\": 1,\n \"vet_id\": 1,\n \"patient_id\": 1,\n \"visit_type_id\": 1,\n \"reminder_notifications\": [\n {}\n ],\n \"datetime_start_utc\": \"2022-06-16T13:42:38Z\",\n \"datetime_end_utc\": \"2022-06-16T14:42:38Z\"\n})\n\nresponse = https.request(request)\nputs response.read_body\n" }, { "id": "9g3UQKoDFhuaUddXqCWtD", "language": "python", "label": "Python", "code": "import requests\nimport json\n\nurl = \"https://developer.digitail.io/api/v1/appointments\"\n\npayload = json.dumps({\n \"clinic_id\": 1,\n \"vet_id\": 1,\n \"patient_id\": 1,\n \"visit_type_id\": 1,\n \"reminder_notifications\": [\n {}\n ],\n \"datetime_start_utc\": \"2022-06-16T13:42:38Z\",\n \"datetime_end_utc\": \"2022-06-16T14:42:38Z\"\n})\nheaders = {\n 'accept': 'application/json',\n 'content-type': 'application/json'\n}\n\nresponse = requests.request(\"POST\", url, headers=headers, data=payload)\n\nprint(response.text)\n" } ], "selectedLanguageId": "ltRN3u6hi4-Aa-rcbLb9h" }, "results": { "languages": [ { "id": "response-0-200", "language": "200", "code": "// successful operation\n{\n \"data\": {\n \"id\": 1,\n \"event_id\": 0,\n \"clinic_id\": 1,\n \"room_id\": 0,\n \"guest\": false,\n \"pet_id\": 1,\n \"record_id\": 0,\n \"generated_record\": {},\n \"status\": \"1\",\n \"datetime\": \"2022-06-16 15:12:38\",\n \"end_datetime\": \"2022-06-16 15:42:38\",\n \"datetime_start_utc\": \"2023-12-01T09:00:00.000000Z\",\n \"datetime_end_utc\": \"2023-12-01T10:00:00.000000Z\",\n \"observations\": \"\",\n \"user_note\": \"\",\n \"pet_name\": \"\",\n \"owner_name\": \"\",\n \"patient\": {},\n \"room\": {},\n \"event\": {\n \"id\": 1,\n \"address_id\": 1,\n \"clinic_id\": 1,\n \"capacity\": 25,\n \"date\": \"2022-06-16 15:12:38\",\n \"name\": \"Event Name\",\n \"preferences\": \"\",\n \"appointments_number\": 5,\n \"visit_types\": [\n \"\"\n ]\n },\n \"vet\": {},\n \"owner_email\": \"\",\n \"owner_phone\": \"\",\n \"reminder_notifications\": {},\n \"newRequests\": [\n {}\n ],\n \"consentForms\": [\n {}\n ],\n \"video_link\": \"https://example.com/1234235345.mp4\",\n \"notification_message\": \"\",\n \"cancellation_reason\": \"\",\n \"recurrence\": \"FREQ=DAILY;COUNT=10\",\n \"has_google_cal_error\": false,\n \"duration\": 0,\n \"occasion\": \"\",\n \"token\": \"\",\n \"visit_type_id\": 0,\n \"visit_type\": {},\n \"last_confirmed_at\": \"2023-12-01T09:00:00.000000Z\",\n \"confirmed_by\": \"client\",\n \"confirmation_source\": \"sms_reminder\",\n \"reconfirmed\": false,\n \"is_reschedulable\": false,\n \"is_cancelable\": false,\n \"drop_off\": {\n \"id\": 1,\n \"time\": \"09:00\",\n \"vet_id\": 1,\n \"appointment_id\": 1,\n \"vet\": {},\n \"datetime\": \"2023-12-01T09:00:00Z\"\n }\n }\n}" } ], "selectedLanguageId": "response-0-200" } }, "children": [ { "text": "" } ] }