This API will soon be deprecated. Please use another API.

    Modify Calendars

    Modifies a calendar associated with a logged-in user's account.

    API Type

    Service API

    Request URL

    https://apis.worksmobile.com/{API ID}/calendar/modifyCalendar

    HTTP Method

    POST (Content-Type: application/json; charset=UTF-8)

    Request

    Parameter Type Required Description
    calendarId String Y The calendar ID to be modified
    name String Y Calendar name
    desc String N Calendar description
    shared Boolean N Calendar sharing setting.
    It works only when the calendar is shared.
    • true (or empty value): No changes.
    • false: Stop sharing the calendar.

    Request Example

    {
      "calendarId": "1868022",
      "name": "Calendar name - modified",
      "desc": "Calendar description - modified"
    }
    

    Response

    It returns the value of the "returnValue" property which contains the results when the API call succeeds.

    Property Type Required Description
    result String Y API call success
    returnValue String Y The modified calendar ID

    Response Example

    {
      "result": "success",
      "returnValue": "3854"
    }