Create Calendars

    Creates a calendar for a logged-in user account.

    API Type

    Service API

    Request URL

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

    HTTP Method

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

    Request Body

    Property Type Required Description
    name String Y Calendar name
    description String N Calendar description
    invitationUserList List N Calendar attendees
        email String Y Attendee’s email address
        actionType String Y Request type
    ● insert: Create calendars
        roleId Integer 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

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

    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": "b6e780ec-4779-4027-8219-a0dfeb2841f5"
    }