Appointments Rescheduled History APIs

Appointments Rescheduled History holds the rescheduled data of all the appointments. It works as a tracker within the Appointments module, which helps you to record the reschedule activity. You can fetch, create, update and delete the records in the rescheduled history using Appointment Rescheduled History APIs.

Get Appointments Rescheduled History

Purpose

To get appointments rescheduled history data.

Endpoints

Request Details

Request URL

{api-domain}/crm/{version}/Appointments_Rescheduled_History__s

To fetch the rescheduled history of a specific appointment
{api-domain}/crm/{version}/Appointments__s/{appointment_id}/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
READ - Get appointments rescheduled history data

Parameters
  • fieldsstring, mandatory when fetching all the rescheduled history data

    To list all the rescheduled history data with respect to the fields that you specify in this parameter. Note that you can include a maximum of 50 field API names in this parameter. The GET Fields API will give you the existing field API names in the Appointments Rescheduled History module.
    Possible values: Multiple field API names, comma separated. For example: Rescheduled_From,Rescheduled_To.

  • pageinteger, optional

    To get the list of rescheduled history from the respective pages. The default value is 1.
    Possible values: Positive integer values only.

  • per_pageinteger, optional

    To get the list of appointments rescheduled history available per page. The default and the maximum possible value is 200.
    Possible values: Positive integer values only.

  • sort_orderstring, optional

    To sort the appointments rescheduled history in either ascending or descending order.
    Possible values: asc - ascending order, desc - descending order. The default value is 'desc'.

  • sort_bystring, optional

    To sort the rescheduled history based on the fields like Rescheduled_From, Created_Time, and Modified_Time. The default field is 'id'.

Note

  • sort_order applies to given sort_by field.
  • Appointment Rescheduled History API tracks only the recent 20 rescheduled details of an appointment.
  • The rescheduled history will not have the current appointment time, which is the last rescheduled time of the appointment. You can fetch the last rescheduled time from the GET Appointments API. 'No Content' response will be thrown if the reschedule count of the specific appointment is 1.

Sample Request

Copiedcurl "https://crm.zoho.com/crm/v5/Appointments__s/5545974000002323027/Appointments_Rescheduled_History__s?fields=Rescheduled_To, Rescheduled_By,Reschedule_Reason"
-X GET
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"

Possible Errors

  • INVALID_DATAHTTP 400

    You have specified either an incorrect or a deleted appointment ID in the request URL.
    Solution: Make a GET Appointments API call and provide a valid appointment ID.

  • INVALID_MODULEHTTP 400

    You have given an invalid module name in the request URL.
    Solution: Use Appointments_Rescheduled_History__s in the request URL. You can also use Appointments__s along with this module, when fetching the rescheduled history of a particular appointment.

  • INVALID_REQUEST_METHODHTTP 400

    You have given an invalid http request method type.
    Solution: Use only the GET method in the request URL to access this API.

  • REQUIRED_PARAM_MISSINGHTTP 400

    You failed to specify the field API names in the parameter.
    Solution: It is mandatory to specify the field API names when you want to get the rescheduled history data of all the appointments.

  • 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.READ or ZohoCRM.modules.appointments_rescheduled_history.ALL scope to create a new valid grant token.

  • NO_PERMISSIONHTTP 403

    You do not have permission to get any data of appointments rescheduled history.
    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. Refer to the endpoints section above and provide a valid URL.

  • INTERNAL_ERRORHTTP 500

    Internal Server Error
    Solution: Unexpected and unhandled exception in the server. Please contact our support team.

Sample Response

Copied{
    "data": [
        {
            "Rescheduled_To": "2023-04-10T16:00:00+05:30",
            "id": "5545974000002323058",
            "Reschedule_Reason": "By Team"
        },
        {
            "Rescheduled_To": "2023-04-07T14:00:00+05:30",
            "id": "5545974000002323051",
            "Reschedule_Reason": "By Team"
        },
        {
            "Rescheduled_To": "2023-04-07T13:30:00+05:30",
            "id": "5545974000002323044",
            "Reschedule_Reason": "By Customer"
        }
    ],
    "info": {
        "per_page": 200,
        "next_page_token": null,
        "count": 3,
        "page": 1,
        "previous_page_token": null,
        "page_token_expiry": null,
        "more_records": false
    }
}