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

    Create Calendars

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

    API Type

    Service API

    Request URL

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

    HTTP Method

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

    Request

    Parameter Type Required Description
    name String Y Calendar name
    desc String N Calendar description
    invitationMapListJson String N Calendar participant information. It is converted to a JSON string before being passed.
        email String Y Participant's email address
        actionType String Y Request type
    ●insert
    ●update
    ●delete
        roleId String Y Role type
    ● 6: Delegator (delegater). It corresponds to Manage events on behalf of master in the Calendar service.
    ● 2: Admin (staff). It corresponds to Manage calendar and events in the Calendar service.
    ● 3: Member (member). It corresponds to Manage events in the Calendar service.
    ● 4: Associate member (half_member). It corresponds to Inquire event details in the Calendar service.
    ● 8: Delegation of time lookups (timelookup_only_delegater). It corresponds to Show only the time of the event in the Calendar service.

    Request Example

    {
        "invitationMapListJson": "[{ \"email\": \"user01@example.com\", \"actionType\": \"insert\", \"roleId\": \"2\" }]"
        "name": "Calendar name",
        "desc": "Calendar description"
    }
    

    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 calendar ID created

    Response Example

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