Add or Update Event
addOrUpdateEvent
POST
[PlatformAddress]/api/1.0/event?action=addOrUpdateEvent
Add or update event details.
Request Body
Name | Type | Description |
---|---|---|
businessUnitId | integer | Required when business unit defined in event's account |
eventType | string | Required when adding an event. Value must be 12. The value cannot be changed for an existing event. |
title | string | Required when adding an event. The title of the event. Max Length: 140 |
timezone | string | Required when adding an event. The timezone of the event. (Datatype = timestamp) |
startDateTime | string | When adding an event. The start date & time of the event. |
endDateTime | string | When adding an event. The end date & time of the event. The value must be on or after startDateTime. (Datatype = timestamp) |
capacity | integer | The maximum number of attendees who can register for the event. A value of 0 (zero) represents no limit. |
budget | number | A budget amount assigned to the event. (Datatype = float) |
costCenterId | integer | A cost center assigned to the event. The value is an identifier of a cost center in the account, which must be assignable to events. |
primaryContactUserId | integer | The primary contact user of the event. The value is an identifier of a user in the account. |
Example Request
This action call accepts the parameters of an event and will;
1) Add a new event to the account
2) Update an existing event in the account when the id parameter is provided.
NOTE: This action call only supports “Record Event Details” type events (i.e. eventType value of 12).
Returns
Property | Description | Type |
---|---|---|
success | Whether or not the action succeeded (i.e. the event as added or updated). | boolean |
id | The event’s unique identifier. The value will be null on failure. | integer |
code | The event’s unique code. The value will be null on failure. | string |
Last updated