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

    Edit Sharing

    Edits participants who have permission to use the calendar.

    API Type

    Service API

    Request URL

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

    HTTP Method

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

    Request

    Parameter Type Required Description
    calendarId String Y Calendar ID to edit participants of
    invitationMapListJson String N Information about calendar participants.
    It is converted to a JSON string before being passed.
        email String N Participant's email address
         userId String N Participant ID
        actionType String N Request type
    ● insert
    ● update
    ● delete
         roleId String N 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

    {
        "calendarId": "3142",
        "invitationMapListJson": [{
            "email": "user01@example.com",
            "userId": "16937001",
            "actionType": "update",
            "roleId": "3"
        }]
    }
    

    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 list of result values returned by the "Get a Calendar" API call.
    Modified or removed users are included in the list; added users are excluded from the list.

    Response Example

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