Using this API, you can schedule a remote support sessions.

POST /api/v2/session/schedule


OAuth Scope

ZohoAssist.sessionapi.CREATE


Request JSON

  • Parameters
    Description
  • mode
    Required
    Session type. For scheduled sessions, the value should be SCHEDULE.
  • title
    Required
    Title of the scheduled session
  • notes
    Optional
    Schedule session description.
  • customer_email
    Required
    The customer's email address to whom the session will be scheduled.
  • schedule_time
    Required
    Time (in milliseconds) when the session is scheduled.
  • schedule_upto
    Required
    Estimated session end time (in milliseconds).
  • utc_offset
    Required
    Coordinated Universal Time in the respective time zone.
  • time_zone
    Required
    The time zone in which the session is scheduled.
  • reminder
    Required
    A reminder time for joining the session.
  • department_id
    Required
    Department in which the session is to be scheduled.
RequestResponse
Copiedcurl --location --request POST 'https://assist.zoho.com/api/v2/session/schedule' \
--header 'Authorization: Zoho-oauthtoken {access_token}' \
--header 'Content-Type: application/json' \
--data-raw '{"mode":"SCHEDULE","title":"{session_title}","notes":"","customer_email":"{email_id}","schedule_time":{timestamp},"reminder":0,"utc_offset":"+05:30","time_zone":"Asia/Kolkata","identity":"","department_id":"{department_id}"}'
CopiedHTTP/1.1200 OK
{
  "representation": {
    "statue": "ok",
    "schedule_id": "215*****************",
    "technician_url": "https://assist.zoho.com/assist-schedule?digest=4a0bc***********************&og=RUF********************&role=V&schedule_id=215****************&x-com-zoho-assist-orgid={zsoid}",
    "customer_url": "https://assist.zoho.com/assist-schedule?digest=4a0bc*****************&og=RUF***********************&role=A&schedule_id=215*******************&x-com-zoho-assist-orgid={zsoid}"
  },
  "resource_type": "/api/v2/session/schedule"
}