Schedule Session

This API allows you to schedule a remote support session at a convenient time for both the technician and the customer.

Required OAuth Scope
ZohoLens.sessionapi.CREATE

Endpoint
POST /api/v2/lens_session/schedule

Parameters

Parameter	Type	Description
mode	string	Required. Set to "SCHEDULE" for scheduled sessions.
title	string	Required. Title of the scheduled session.
notes	string	Optional. Description or notes for the session.
customer_email	string	Required. Email address of the customer to whom the session will be scheduled.
schedule_time	long	Required. Scheduled start time in milliseconds since epoch.
schedule_upto	long	Required. Estimated session end time in milliseconds since epoch.
utc_offset	string	Required. UTC offset of the customer's time zone (e.g., "+05:30").
time_zone	string	Required. Customer's time zone (e.g., "Asia/Kolkata").
reminder	int	Required. Time in minutes before the session to send a reminder.
department_id	long	Required. ID of the department in which the session is to be scheduled.

Notes:

Ensure that the schedule_time and schedule_upto are provided in milliseconds since the Unix epoch.
The utc_offset should reflect the customer's local time zone offset from UTC.
The reminder parameter specifies how many minutes before the session the reminder should be sent.

Sample Request

Copiedcurl --location --request POST 'https://lens.zoho.com/api/v2/lens_session/schedule' \
  --header 'Authorization: Zoho-oauthtoken {access_token}' \
  --header 'Content-Type: application/json' \
  --data-raw '{
    "mode": "SCHEDULE",
    "title": "Support Session",
    "notes": "Assisting with Hardware installation",
    "customer_email": "customer@example.com",
    "schedule_time": 1683038400000,
    "schedule_upto": 1683042000000,
    "utc_offset": "+05:30",
    "time_zone": "Asia/Kolkata",
    "reminder": 15,
    "department_id": 123456789
  }'

Sample Response

Copied{
  "representation": {
    "statue": "ok",
    "schedule_id": "215*****************",
    "technician_url": "https://lens.zoho.com/lens-schedule?digest=4a0bc***********************&og=RUF********************&role=V&schedule_id=215****************&x-com-zoho-lens-orgid={zsoid}",
    "customer_url": "https://lens.zoho.com/lens-schedule?digest=4a0bc*****************&og=RUF***********************&role=A&schedule_id=215*******************&x-com-zoho-lens-orgid={zsoid}"
  },
  "resource_type":"/api/v2/lens_session/schedule"
}