Modify Calendars

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

    API Type

    Service API

    Request URL

    https://apis.worksmobile.com/r/{API_ID}/calendar/v2/users/me/calendarList/{calendarId}

    HTTP Method

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

    Path Parameters

    Parameter Type Required Description
    calendarId String Y Calendar ID

    Request Body

    Property Type Required Description
    name String Y Calendar name
    description 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

    {
      "name": "Modify test calendar name",
      "description": "Modify test calendar description",
      "shared": true
    }
    

    Response

    Property Type Required Description
    result String Y API request result
    code Integer Y HTTP status code
    returnValue String Y Calendar ID

    Response Example

    {
        "result": "success",
        "code": 200,
        "returnValue": "4d0e9d19-aa61-4e70-ac69-7cdac8a074fd"
    }