Update Appointments Rescheduled History
Purpose
To update the rescheduled details of appointments.
Request Details
Request URL
{api-domain}/crm/{version}/Appointments_Rescheduled_History__s
Header
Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52
Scope
scope=ZohoCRM.modules.appointments_rescheduled_history.{operation_type}
Possible operation types
ALL - Full access to appointments rescheduled history data
UPDATE - Update appointments rescheduled history data
Sample Request
Copiedcurl "https://www.zohoapis.com/crm/v5/Appointments_Rescheduled_History__s"
-X PUT
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
Request JSON Keys
- idstring, mandatory
Denotes the distinctive ID of the rescheduled history record which has to be updated. To get this ID, make a GET Appointments Rescheduled History API call.
- Rescheduled_Timestring, optional
Represents the date and time at which the appointment was rescheduled.
- Rescheduled_ByJSON object, optional
Contains the name and ID of the user who rescheduled the appointment. You can fetch the user details from the GET Users API.
- Rescheduled_Fromstring, optional
Represents the date and time from which the appointment was rescheduled.
- Rescheduled_Tostring, optional
Represents the date and time to which the appointment was rescheduled.
You can also pass the record ID in the request. Example: {api-domain}/crm/v5/Appointments_Rescheduled_History__s/{record_id}
You can update a maximum of 100 appointments rescheduled history records per API call.
Except for the Appointment_Name key you can update all other Request JSON keys from the Add Appointments Rescheduled History API.
Sample Input
Copied{
"data": [
{
"id": "5545974000002324198",
"Rescheduled_By": {
"name": "Patricia Boyle",
"id": "5545974000001170042"
},
"Rescheduled_From": "2023-04-11T12:30:00+05:30",
"Rescheduled_To": "2023-04-11T12:45:00+05:30",
"Rescheduled_Time": "2023-04-07T17:25:13+05:30"
}
]
}
Possible Errors
- INVALID_DATAHTTP 400
You have specified an invalid record ID.
Solution: Make a GET Appointments Rescheduled History API call to get valid IDs. - INVALID_DATAHTTP 400
You have specified an invalid ID in the Rescheduled_By key.
Solution: Make a GET Appointments API call and provide a valid rescheduled user and appointment ID. - INVALID_DATAHTTP 400
The Rescheduled_Time key has a time greater than the current time.
Solution: The Rescheduled_Time value should be lesser than the current time. - INVALID_MODULEHTTP 400
You have given an invalid module name in the request URL.
Solution: You can use only Appointments_Rescheduled_History__s in the request URL. - INVALID_REQUEST_METHODHTTP 400
You have given an invalid http request method type.
Solution: Use only PUT method in the request URL to access this API. - MANDATORY_NOT_FOUNDHTTP 400
You have failed to specify the record ID which has to be updated.
Solution:Make a GET Appointments Rescheduled History API call to get valid IDs. - INVALID_TOKENHTTP 401
You have used an invalid oauth token.
Solution: The access token you used has expired. Kindly refresh your token and retry. - OAUTH_SCOPE_MISMATCHHTTP 401
You created the grant token using the wrong oauth scope.
Solution: Use either ZohoCRM.modules.appointments_rescheduled_history.UPDATE or ZohoCRM.modules.appointments_rescheduled_history.ALL scope to create a new valid grant token. - NO_PERMISSIONHTTP 403
You do not have permission to update any appointments rescheduled history records.
Solution: Contact your system administrator. - INVALID_URL_PATTERNHTTP 404
Check if you are trying to access the correct URL.
Solution: You have given an invalid request URL. Use only /Appointments_Rescheduled_History__s endpoint in the request URL. - INTERNAL_ERRORHTTP 500
Internal Server Error
Solution: Unexpected and unhandled exception in the server. Please contact our support team.
Sample Response
Copied{
"data": [
{
"code": "SUCCESS",
"details": {
"Modified_Time": "2023-04-11T11:25:41+05:30",
"Modified_By": {
"name": "Patricia Boyle",
"id": "5545974000000393001"
},
"Created_Time": "2023-04-07T17:26:30+05:30",
"id": "5545974000002324198",
"Created_By": {
"name": "Patricia Boyle",
"id": "5545974000000393001"
}
},
"message": "record updated",
"status": "success"
}
]
}