Afya-Health
  1. Appointment Schedule
Afya-Health
  • Auth
    • Login
      POST
    • Signup
      POST
  • ForgotPassword
    • Verify OTP
      POST
    • ForgotPassword
      POST
    • ResetPassword
      POST
  • Profile
    • Get User Profile
      GET
    • Update user profile
      POST
  • Family Members
    • Add Family Member
      POST
    • Update Family Members
      PUT
    • Delete Family Member
      DELETE
  • Address
    • Get User address
      GET
    • Add Address
      POST
    • Update address
      PUT
    • Delete Address
      DELETE
  • Languages
    • List AppLabels
      GET
    • Add/Update Label
      POST
    • List Languages
      GET
  • Products
    • Get Products
      GET
    • Create Product
      POST
    • Update Product
      PUT
    • Delete Product
      DELETE
    • Update product items
      PUT
  • Permissions
    • Get Permissions
  • Config
    • List Practice Config
    • Add Update Config
    • List Master Config
    • Add Update Master Config
  • Appointment Schedule
    • Create Schedule
      POST
    • Update Schedule
      PUT
    • Delete Schedule
      DELETE
    • Get Schedule by ID
      GET
    • Get Schedule list
      GET
  • Test Tags
    • Get Test Tags
    • Create Test Tag
    • Update Test Tag
    • Delete Test Tag
  • Test Parameters
    • Get Test Parameters
    • Create Test Parameters
    • Update Test Parameters
    • Delete Test Parameters
  • Category
    • Get Category
    • Create Category
    • Update Category
    • Delete Category
  • Device
    • Register Device
  • File
    • Upload File
  • Appointment
    • Create Appointment Order
    • Get Appointments List
    • Update Appointment Status
    • Get Appointment by ID
    • Get Appointment Slots
    • GetStartJourneyDirection
  • Reports
    • Upload Report
    • List All Reports
    • List Reports By Appointment
    • Delete Report
    • Update Report File
  • Staff
    • Add Staff Member
    • List Staff Member
    • Update Staff Member
    • Delete Staff Member
    • Get Staff member by ID
  • Patient
    • List Patients
    • Add Patient
    • Update Patient
    • Delete Patient
    • Get patient by ID
  • Notifications
    • List User Notifications
    • Update Notification read status
  1. Appointment Schedule

Update Schedule

Developing
PUT
/api/service/v1/appointment/schedule/{id}

Request

Path Params
id
string 
required
Header Params
Accept
string 
optional
Example:
application/json
Content-Type
string 
optional
Example:
application/json
practice-code
string 
optional
Example:
DEFAULT
Authorization
string 
optional
Example:
{{token}}
Body Params application/json
user
string 
required
name
string 
required
start
string 
required
end
null 
required
services
array[string]
required
timezone
string 
required
schedules
array [object {5}] 
required
day
integer 
required
isOn
boolean 
required
startTime
string 
required
endTime
string 
required
breaks
array [object {2}] 
required
override_dates
array [object {3}] 
required
date
string 
optional
start_time
string 
optional
end_time
string 
optional
Example
{
    "user" : "677bb5bd4291b96cd0623eea",
    "name" : "update THis is my Schedule name",
    "start" : "2024-12-19",
    "end" : null,
    "is_active" : true,
    "services": ["6790d7c19975d85c7b447c53"],
    "timezone" : "Asia/Kolkata",
    "schedules" : [
        {
            "day" : 1,
            "isOn" : true,
            "startTime" : "09:00",
            "endTime" : "15:00",
            "breaks" : [
                {
                    "start" : "10:00",
                    "end" : "11:00"
                }
            ] 

        },
        {
            "day" : 2,
            "isOn" : true,
            "startTime" : "09:00",
            "endTime" : "15:00",
            "breaks" : [
                {
                    "start" : "10:00",
                    "end" : "11:00"
                }
            ] 

        },
        {
            "day" : 3,
            "isOn" : true,
            "startTime" : "09:00",
            "endTime" : "15:00",
            "breaks" : [
                {
                    "start" : "14:00",
                    "end" : "15:00"
                }
            ] 

        },
        {
            "day" : 4,
            "isOn" : true,
            "startTime" : "09:00",
            "endTime" : "15:00",
            "breaks" : [
                {
                    "start" : "10:00",
                    "end" : "11:00"
                }
            ] 

        },
        {
            "day" : 5,
            "isOn" : true,
            "startTime" : "09:00",
            "endTime" : "15:00",
            "breaks" : [
                {
                    "start" : "10:00",
                    "end" : "11:00"
                }
            ] 

        },
        {
            "day" : 6,
            "isOn" : true,
            "startTime" : "09:00",
            "endTime" : "15:00",
            "breaks" : [
                {
                    "start" : "10:00",
                    "end" : "11:00"
                }
            ] 

        },
        {
            "day" : 7,
            "isOn" : true,
            "startTime" : "09:00",
            "endTime" : "15:00",
            "breaks" : [
                {
                    "start" : "10:00",
                    "end" : "11:00"
                }
            ] 

        }
        
    ],
    "override_dates" : [
        {
            "date" : "2024-12-30",
            "start_time": "13:00",
            "end_time": "14:00"
        }
    ]


}

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request PUT 'https://afyahealth.doctodoor.com:5600/api/service/v1/appointment/schedule/' \
--header 'Accept: application/json' \
--header 'practice-code: DEFAULT' \
--header 'Authorization: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjY3YjJkZmZlNWJmMjdlMzk1NTUzMjE0MyIsImVtYWlsIjoiZGVlcC5tYXJzb25pYUBwbGVuYXJ0ZWNoLmNvbSIsInN1YiI6IjY3YjJkZmZlNWJmMjdlMzk1NTUzMjE0MyIsImlhdCI6MTc0MTc4MjA4NCwiZXhwIjoxNzQ5NTU4MDg0fQ.KAMsweSbJPDxpLijKdjgp3YEFauw8KYLLumCBpqQfAA' \
--header 'Content-Type: application/json' \
--data-raw '{
    "user" : "677bb5bd4291b96cd0623eea",
    "name" : "update THis is my Schedule name",
    "start" : "2024-12-19",
    "end" : null,
    "is_active" : true,
    "services": ["6790d7c19975d85c7b447c53"],
    "timezone" : "Asia/Kolkata",
    "schedules" : [
        {
            "day" : 1,
            "isOn" : true,
            "startTime" : "09:00",
            "endTime" : "15:00",
            "breaks" : [
                {
                    "start" : "10:00",
                    "end" : "11:00"
                }
            ] 

        },
        {
            "day" : 2,
            "isOn" : true,
            "startTime" : "09:00",
            "endTime" : "15:00",
            "breaks" : [
                {
                    "start" : "10:00",
                    "end" : "11:00"
                }
            ] 

        },
        {
            "day" : 3,
            "isOn" : true,
            "startTime" : "09:00",
            "endTime" : "15:00",
            "breaks" : [
                {
                    "start" : "14:00",
                    "end" : "15:00"
                }
            ] 

        },
        {
            "day" : 4,
            "isOn" : true,
            "startTime" : "09:00",
            "endTime" : "15:00",
            "breaks" : [
                {
                    "start" : "10:00",
                    "end" : "11:00"
                }
            ] 

        },
        {
            "day" : 5,
            "isOn" : true,
            "startTime" : "09:00",
            "endTime" : "15:00",
            "breaks" : [
                {
                    "start" : "10:00",
                    "end" : "11:00"
                }
            ] 

        },
        {
            "day" : 6,
            "isOn" : true,
            "startTime" : "09:00",
            "endTime" : "15:00",
            "breaks" : [
                {
                    "start" : "10:00",
                    "end" : "11:00"
                }
            ] 

        },
        {
            "day" : 7,
            "isOn" : true,
            "startTime" : "09:00",
            "endTime" : "15:00",
            "breaks" : [
                {
                    "start" : "10:00",
                    "end" : "11:00"
                }
            ] 

        }
        
    ],
    "override_dates" : [
        {
            "date" : "2024-12-30",
            "start_time": "13:00",
            "end_time": "14:00"
        }
    ]


}'

Responses

🟢200Success
application/json
Body
error
boolean 
required
status_code
integer 
required
message
string 
required
data
object 
required
services
array [object {8}] 
required
buffer_minutes
integer 
required
is_deleted
integer 
required
override_dates
array [object {6}] 
required
schedules
array [object {8}] 
required
user
object 
required
name
string 
required
start
string 
required
end
null 
required
timezone
string 
required
created_at
string 
required
updated_at
string 
required
id
string 
required
Examples
{
    "error": false,
    "status_code": 200,
    "message": "Schedule updated successfully.",
    "data": {
        "services": [],
        "is_active": false,
        "buffer_minutes": 0,
        "is_deleted": 0,
        "override_dates": [
            {
                "date": "2024-12-30T00:00:00.000Z",
                "start_time": "13:00",
                "end_time": "14:00",
                "created_at": "2025-03-03T09:45:44.811Z",
                "updated_at": "2025-03-03T09:45:44.811Z",
                "id": "67c57a483a2066574759b271"
            }
        ],
        "schedules": [
            {
                "day": 1,
                "isOn": true,
                "startTime": "09:00",
                "endTime": "15:00",
                "breaks": [
                    {
                        "start": "10:00",
                        "end": "11:00",
                        "created_at": "2025-03-03T09:45:44.813Z",
                        "updated_at": "2025-03-03T09:45:44.813Z",
                        "id": "67c57a483a2066574759b264"
                    }
                ],
                "created_at": "2025-03-03T09:45:44.817Z",
                "updated_at": "2025-03-03T09:45:44.817Z",
                "id": "67c57a483a2066574759b263"
            },
            {
                "day": 2,
                "isOn": true,
                "startTime": "09:00",
                "endTime": "15:00",
                "breaks": [
                    {
                        "start": "10:00",
                        "end": "11:00",
                        "created_at": "2025-03-03T09:45:44.817Z",
                        "updated_at": "2025-03-03T09:45:44.817Z",
                        "id": "67c57a483a2066574759b266"
                    }
                ],
                "created_at": "2025-03-03T09:45:44.817Z",
                "updated_at": "2025-03-03T09:45:44.817Z",
                "id": "67c57a483a2066574759b265"
            },
            {
                "day": 3,
                "isOn": true,
                "startTime": "09:00",
                "endTime": "15:00",
                "breaks": [
                    {
                        "start": "14:00",
                        "end": "15:00",
                        "created_at": "2025-03-03T09:45:44.817Z",
                        "updated_at": "2025-03-03T09:45:44.817Z",
                        "id": "67c57a483a2066574759b268"
                    }
                ],
                "created_at": "2025-03-03T09:45:44.817Z",
                "updated_at": "2025-03-03T09:45:44.817Z",
                "id": "67c57a483a2066574759b267"
            },
            {
                "day": 4,
                "isOn": true,
                "startTime": "09:00",
                "endTime": "15:00",
                "breaks": [
                    {
                        "start": "10:00",
                        "end": "11:00",
                        "created_at": "2025-03-03T09:45:44.817Z",
                        "updated_at": "2025-03-03T09:45:44.817Z",
                        "id": "67c57a483a2066574759b26a"
                    }
                ],
                "created_at": "2025-03-03T09:45:44.817Z",
                "updated_at": "2025-03-03T09:45:44.817Z",
                "id": "67c57a483a2066574759b269"
            },
            {
                "day": 5,
                "isOn": true,
                "startTime": "09:00",
                "endTime": "15:00",
                "breaks": [
                    {
                        "start": "10:00",
                        "end": "11:00",
                        "created_at": "2025-03-03T09:45:44.817Z",
                        "updated_at": "2025-03-03T09:45:44.817Z",
                        "id": "67c57a483a2066574759b26c"
                    }
                ],
                "created_at": "2025-03-03T09:45:44.817Z",
                "updated_at": "2025-03-03T09:45:44.817Z",
                "id": "67c57a483a2066574759b26b"
            },
            {
                "day": 6,
                "isOn": true,
                "startTime": "09:00",
                "endTime": "15:00",
                "breaks": [
                    {
                        "start": "10:00",
                        "end": "11:00",
                        "created_at": "2025-03-03T09:45:44.817Z",
                        "updated_at": "2025-03-03T09:45:44.817Z",
                        "id": "67c57a483a2066574759b26e"
                    }
                ],
                "created_at": "2025-03-03T09:45:44.817Z",
                "updated_at": "2025-03-03T09:45:44.817Z",
                "id": "67c57a483a2066574759b26d"
            },
            {
                "day": 7,
                "isOn": true,
                "startTime": "09:00",
                "endTime": "15:00",
                "breaks": [
                    {
                        "start": "10:00",
                        "end": "11:00",
                        "created_at": "2025-03-03T09:45:44.817Z",
                        "updated_at": "2025-03-03T09:45:44.817Z",
                        "id": "67c57a483a2066574759b270"
                    }
                ],
                "created_at": "2025-03-03T09:45:44.817Z",
                "updated_at": "2025-03-03T09:45:44.817Z",
                "id": "67c57a483a2066574759b26f"
            }
        ],
        "user": {
            "roles": [
                "677bb5bd4291b96cd0623e9e"
            ],
            "is_master_admin": 1,
            "is_temporary_password": 0,
            "is_deleted": 0,
            "is_active": 1,
            "deleted_at": null,
            "language_code": "en",
            "first_name": "Deep Provider",
            "middle_name": "",
            "last_name": "Local",
            "full_name": "Deep Provider  Local",
            "email": "deep.marsonia@plenartech.com",
            "created_at": "2025-01-06T10:51:41.439Z",
            "updated_at": "2025-02-27T06:45:20.400Z",
            "family_members": [
                {
                    "name": "test1",
                    "gender": "male",
                    "birth_date": "2000-01-01T00:00:00.000Z",
                    "id": "679217b51c4f6665b1c096e0"
                }
            ],
            "birth_date": "2000-01-01T00:00:00.000Z",
            "country_code": "+91",
            "gender": "male",
            "image": "67b44b3de1c5fa73ee81bbb4",
            "phone_primary": "934856796",
            "id": "677bb5bd4291b96cd0623eea"
        },
        "name": "update THis is my Schedule name",
        "start": "2024-12-19T00:00:00.000Z",
        "end": null,
        "timezone": "Asia/Kolkata",
        "created_at": "2025-03-03T09:45:00.460Z",
        "updated_at": "2025-03-03T09:45:44.818Z",
        "id": "67c57a1c3a2066574759b215"
    }
}
Previous
Create Schedule
Next
Delete Schedule
Built with