events.createEvent

Syntax

int events.createEvent ( int vhost, string name, array additionalInfo = array() )

Argument Info

Name	Type	Required	Default value	Description
vhost	int	Required	none	The vhost ID that you want the event to be a member of.
name	string	Required	none	The name you want the event to have.
additionalInfo	array	Optional	array()

additionalInfo

additionalInfo is an array that consists of the information to store in your event.

Name	Type	Required	Default	Possible Values	Description
email	string	no		email@example.com	Email address for uploading media to event.
description	string	no		string	A description of the event (searchable).
logo	int	no	0	5000333	A media ID for the event logo.
url	string	no		http://example.com	The url for the event.
createdBy	int	no	1	4155555	The UID of the user who created the event.
note	string	no		string	Some text about the event (not searchable).
geo_longitude	float	no	0	-52.44	The longitude of the event.
geo_latitude	float	no	0	62.86	The latitude of the event.
moderationStatus	string	no	unmoderated	unmoderated, accepted, denied, deleted, notdenied, moderated, all	Moderation status when created.
address	string	no		string	The address of the event.
city	string	no		Toronto	A city the event is associated with.
country	string	no		CA, US	The 2-letter country code.
state	string	no		ON	The 2-letter state/province code.
postalcode	string	no		M1M1M1	A valid postal code.
other	array	no		{'key': 'value'}	Additional information about the event.
custom1	string	no		string	A searchable custom field.
startDate	timestamp	no	0000-00-00 00:00:00	2012-02-15 00:00:00	Event start date and time.
endDate	timestamp	no	0000-00-00 00:00:00	2012-03-25 14:10:11	Event end date and time.
parentGroup	int	no	0	9499	The ID of the parent event (0 for top-level).

Response

The response contains the ID of the newly created event.

Name	Type	Description
result	INT	The ID of the newly created event.

Return Values

Field	Description	Possible Values