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

    Modify Schedules

    Modifies a schedule in a calendar.

    API Type

    Service API

    Request URL

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

    HTTP Method

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

    Request

    Parameter Type Required Description
    calendarId String Y Calendar ID
    scheduleIcalString String Y iCalendar data (refer to iCalendar Data Format in the "Schedule" section)

    Request Example

    {
        "calendarId": "defaultCalendarId",
        "scheduleIcalString": "BEGIN:VCALENDAR
    VERSION:2.0
    PRODID:Naver Calendar
    CALSCALE:GREGORIAN
    BEGIN:VTIMEZONE
    TZID:Asia/Seoul
    BEGIN:STANDARD
    DTSTART:19700101T000000
    TZNAME:GMT+09:00
    TZOFFSETFROM:+0900
    TZOFFSETTO:+0900
    END:STANDARD
    END:VTIMEZONE
    BEGIN:VEVENT
    SEQUENCE:0
    CLASS:PUBLIC
    TRANSP:OPAQUE
    UID:6E12DA93-8B43-4576-9A8A-31B4BDC8BDCF_xell_1409882048@example.com
    DTSTART;TZID=Asia/Seoul:20140905T110000
    DTEND;TZID=Asia/Seoul:20140905T120000
    SUMMARY:Sample of weekly repeating
    DESCRIPTION:Description area
    LOCATION:Here
    RRULE:FREQ=WEEKLY;BYDAY=FR;INTERVAL=1;UNTIL=20141030T120000
    ORGANIZER;CN=Gildong Hong:mailto:admin@example.com
    ATTENDEE;ROLE=REQ-PARTICIPANT;PARTSTAT=NEEDS-ACTION;CN=participants:mailto:user01@example.com
    CREATED:20140905T015408Z
    LAST-MODIFIED:20140905T015408Z
    DTSTAMP:20140905T015409Z
    END:VEVENT
    END:VCALENDAR"
    }
    

    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 Values are as follows:
    ● Schedule process type
    ● The calendar ID where a schedule is modified

    Response Example

    {"result":"success","returnValue":{"processType":"modify","calendarId":"3"}}