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

Permissions needed: EDIT_APPOINTMENTS\nUpdate a singular a appointment. Cant do partial updates of resource

", "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

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

Appointment Create/Update Request Body

", "schema": [ { "name": "clinic_id", "kind": "optional", "type": "integer", "description": "Clinic Id.", "example": 1 }, { "name": "vet_id", "kind": "optional", "type": "integer", "description": "Vet Id.", "example": 1 }, { "name": "patient_id", "kind": "optional", "type": "integer", "description": "Pet id", "example": 1 }, { "name": "visit_type_id", "kind": "optional", "type": "integer", "description": "Id of the VisitType", "example": 1 }, { "name": "datetime_start_utc", "kind": "optional", "type": "string", "description": "Start Date in UTC ISO Zulu format", "example": "2022-06-16T13:42:38Z" }, { "name": "datetime_end_utc", "kind": "optional", "type": "string", "description": "End Date in UTC ISO Zulu format", "example": "2022-06-16T14:42:38Z" }, { "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": "optional", "type": "array", "description": "Reminder notifications", "modelRef": "#/paths/~1api~1v1~1appointments/post/requestBody/content/application~1json/schema/properties/reminder_notifications/items", "customType": "items[]", "schema": [] }, { "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": "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": "recurrence_update_mode", "kind": "optional", "type": "string", "description": "Recurrence update mode", "enum": [ "this", "this_and_following", "all" ] }, { "name": "requires_payment_deposit", "kind": "optional", "type": "boolean", "description": "" }, { "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": "", "modelRef": "#/paths/~1api~1v1~1appointments/post/responses/200/content/application~1json/schema/properties/data", "customType": "data", "schema": [] } ], "isExpanded": true } ] } ], "hasXCodeSamples": false, "examples": { "languages": [ { "id": "W7pdN41AY19rjIotswi71", "language": "curl", "label": "cURL", "code": "curl --request PUT \\\n --url https://developer.digitail.io/api/v1/appointments/{id} \\\n --header 'accept: application/json'" }, { "id": "yHailkM_LhLq_SFNsZVT2", "language": "javascript", "label": "javascript", "code": "var myHeaders = new Headers();\nmyHeaders.append(\"accept\", \"application/json\");\nmyHeaders.append(\"content-type\", \"application/json\");\n\nvar requestOptions = {\n method: 'PUT',\n headers: myHeaders,\n redirect: 'follow'\n};\n\nfetch(\"https://developer.digitail.io/api/v1/appointments/{id}\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));" }, { "id": "wPc_jzfYx-WVSA-Nm49Pz", "language": "ruby", "label": "Ruby", "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://developer.digitail.io/api/v1/appointments/{id}\")\n\nhttps = Net::HTTP.new(url.host, url.port)\nhttps.use_ssl = true\n\nrequest = Net::HTTP::Put.new(url)\nrequest[\"accept\"] = \"application/json\"\nrequest[\"content-type\"] = \"application/json\"\n\nresponse = https.request(request)\nputs response.read_body\n" }, { "id": "6nkNxz32L1igGBb4b8iLf", "language": "python", "label": "Python", "code": "import requests\nimport json\n\nurl = \"https://developer.digitail.io/api/v1/appointments/{id}\"\n\npayload = {}\nheaders = {\n 'accept': 'application/json',\n 'content-type': 'application/json'\n}\n\nresponse = requests.request(\"PUT\", url, headers=headers, data=payload)\n\nprint(response.text)\n" } ], "selectedLanguageId": "W7pdN41AY19rjIotswi71" }, "results": { "languages": [ { "id": "30H2Dcu0Oba_Ak4sGkVxv", "language": "200", "code": "// successful operation\n{\n \"data\": {}\n}" } ], "selectedLanguageId": "30H2Dcu0Oba_Ak4sGkVxv" } }, "children": [ { "text": "" } ] }