• Venue and event management in the cloud

How Can We Help?


Events: Create or Update

In this article


Create or Update

POST /v2/event/save

This API creates an event with a unique event number and its associated details. This same API allows you to update an existing event e.g. change the status or the coordinator of an event.


Parameter
EventNumber    String

The unique number of the Event. Required when an event is to be updated. If empty, a new event will be created.

EventName    String

The name of the event.

StartDate    DateTime

The start date and time of the event.

EndDate   DateTime

The end date and time of the event

EventPax    Long

The number of persons (PAX) which will be attending or present at the event.

EventPaxBreakdown    Object Array

The number of persons (PAX) according to the Breakdowns which will be attending or present at the event.

Note: Either of the EventPax or EventPaxBreakdown are allowed at a time.

EventType    Object { Id, Name }

The type of event that is available in your Priava account. The event type must exist in your Priava Account. Passed in JSON format where:

Id = the ID of the event type.
Name = the name of the event type.

EventStatus    Object { Id, Name }

The status of an event that is available in your Priava account. The event status must exist in your Priava Account. Passed in JSON format where:

Id = the ID of the event status.
Name = the name of the event status.

EventCoordinator    Object { Id, Name }

The event coordinator to be assigned with the event as available in your Priava account. The event coordinator must be an existing Priava User. Passed in JSON format where:

Id = the ID of the sales coordinator.
Name = the name of the sales coordinator.

EventSource    Object { Id, Name }

The event source for an event as available in your Priava account. The event source must exist in your Priava Account. Passed in JSON format where;

Id = the ID of the event source.
Name = the name of the event source.

EventContact    Object

The primary contact which is to be associated with the event in JSON format.

EventComment    String

The comment(s) to be added to the event.

CustomFields    Object

The custom fields for an organisation.

VenueBlockId (Optional)    String

The booking block reserved for this event to be associated with the event being created or updated. Refer to the Block Venues API for more details.


All event contacts should be formatted as below.

Parameter
ContactType    Object { Id, Name }

The type of contact that is being added. This contact type must exist in your Priava account. Passed in JSON format where;

Id = the ID of the contact type.
Name = the name of the contact type.

ContactId (optional)    Long

The ID of the Contact to be added. Contacts – Get API can be used to fetch contacts. Note: If the ContactId is provided, the contact details provided will be ignored.

Firstname    String

The contact’s first name. 

Lastname    String

The contact’s last name. 

Email    String

The contact's primary email address. 

Phone   String

The contact's phone number. 

Mobile (optional)    String

The contact's mobile/cellular number.  

PrimaryPhone    String

Specifies the primary phone number for the contact. The only accepted values are:

P for the Phone number.
M for the Mobile/Cellular number. The primary phone by default is Phone.

Organisation (optional)    String

The name of the organisation the contact is associated with. The organisation must exist in your Priava Account.

Address (optional)    Object Array (0 to 3 addresses allowed)

The array of addresses (up to 3) for this contact. Passed in JSON format where;

AddressType = either POSTAL, BUSINESS or OTHER.
AddressLine1 = Line 1 of the address.
AddressLine2 = Line 2 of the address.
AddressLine3 = Line 3 of the address.
Suburb = The Suburb for the address.
State = The State or County.
Postcode = The Postal or Zip code.
Country = The Country of the address.

All event contacts should be formatted as below.  

Parameter
CommentType    Object { Id, Name }

The type of comment being added. This comment type must exist in your Priava account. Passed in JSON format where;

Id = the ID of the comment type.
Name = the name of the comment type.

Comment    String

The comment text to be added to the event.  

  

{
   "EventNumber": "",
   "EventName": "Test Birthday Party",
   "StartDate": "25/02/2019 15:00:00",
   "EndDate": "26/02/2019 17:30:00",
   "EventPax": null,
   "EventPaxBreakdown": [{
      "TypeId": 223,
      "Value": 15
   }],
   "EventType": {
      "Id": 1,
      "Name": "Birthday"
   },
   "EventStatus": {
      "Id": 100015253,
      "Name": "Room Hire"
   },
   "EventCoordinator": {
      "Id": 100009714,
      "Name": "karan mohnani"
   },
   "EventSource": {
      "Id": 1,
      "Name": "Website"
   },
   "EventContact": {
      "ContactType": {
         "Id": 28,
         "Name": "Debtor"
      },
      "ContactId": "100339987",
      "Firstname": "Demo",
      "Lastname": "Test",
      "Email": "test@demo.com",
      "EmailOther": "test@demo1.com",
      "Phone": "8189898989",
      "Mobile": "7789890431",
      "PrimaryPhone": "P",
      "Organisation": "Test",
      "Department": "DENT",
      "DebtorNo": "123",
      "PersonalInformationConsent": true,
      "Title": "Mr",
      "JobTitle": "DEV",
      "ExternalRefNo": "5050",
      "MarketingOptOut": true,
      "Inactive": false,
      "Address": [{
            "AddressType": "BUSINESS",
            "AddressLine1": "BUSINESS Address 1",
            "AddressLine2": "BUSINESS Address 2",
            "AddressLine3": "BUSINESS Address 3",
            "Suburb": "Australian Capital",
            "State": "Queensland",
            "Postcode": "112098",
            "Country": "Australia",
            "IsPrimary": false
         },
         {
            "AddressType": "POSTAL",
            "AddressLine1": "POSTAL Address 1",
            "AddressLine2": "POSTAL Address 2",
            "AddressLine3": "POSTAL Address 3",
            "Suburb": "Australian Capital",
            "State": "Queensland",
            "Postcode": "112098",
            "Country": "Australia",
            "IsPrimary": false
         },
         {
            "AddressType": "OTHER",
            "AddressLine1": "OTHER Address 1",
            "AddressLine2": "OTHER Address 2",
            "AddressLine3": "OTHER Address 3",
            "Suburb": "Australian Capital",
            "State": "Queensland",
            "Postcode": "112098",
            "Country": "Australia",
            "IsPrimary": true
         }
      ]
   },
   "EventComment": [{
      "CommentType": {
         "Id": 100007381,
         "Name": "Letter text"
      },
      "Comment": "This is general comment"
   }],
   "VenueBlockId": [],
   "CustomFields": {
      "NewDD1Test": "Tests"
   }

}
Response:
{
   "success": true,
   "result": {
      "EventNumber": "2693"
   }
}