API Service Documentation

Command: event_set

Creates a new event in the Events Calendar.

Example Request:
service?ai_token=XXXXXXXX&ai_command=event_set&mode=insert&event_title=Test+Title&event_description=This is my event description&beg_date=2018-03-22&beg_time=12:00&end_time=13:00&is_repeating=1&repeat_period=1&repeat_units=weeks&series_end_date=2018-04-30&repeat_dows=Mon,Wed,Fri&event_color=FF00FF&event_location=Location name here&tags=tag1,tag2

Request

NameTypeRequiredExample
modeStringYinsert/update

'insert' or 'update'

event_idStringN123456

Event id to update (leave empty for inserts)

owner_idIntegerN5
event_titleStringNEXAMPLE TITLE
event_descriptionStringNDescription goes here!
all_dayStringN0 or 1 (times will be ignored for all-day events)
beg_dateDateN2018-03-16
end_dateDateN2018-03-16
beg_timeTimeN11:00am

All times in CST

end_timeTimeN12:00pm

All times in CST

is_repeatingIntegerN1
repeat_periodIntegerN1
repeat_unitsStringNdays/weeks/months/years

@param repeat_dows Array or String N Mon,Wed,Fri Case sensitive csv string or array

series_end_dateDateN2018-04-30
event_colorStringNFFFF00
event_locationStringNEvent Location Name
tagsStringNtag1,tag2
privacyStringNprivate/public
for_lead_idIntegerNlead_id of lead this event is associated with

Response

NameTypeExample
statusInteger0
status_messageStringEvent Creation Successful
event_idInteger1001