Events: Create or Update

Updated June 14, 2023 15:52

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

IgnoreWarnings Boolean

The warnings to be ignored or considered. (Note: This is a query 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 (Required) String

The name of the event.

StartDate (Required) DateTime

The start date and time of the event.

EndDate (Required) 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 (Required) 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 (Required) 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 (Required) 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 (Required) 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 (Required) Object

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

EventComment Object Array

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 to be added to the Event.

CustomFields Object

The custom fields for an event. Required when any custom field is present for an event

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.

EventParent Object {EventId, EventNumber, EventName }

For Adding Sub event EventParent object is used. This parameter is mandatory while creating a sub-event. This will give event number with a hyphen as the output as 123-1

EventId (mandatory) = Id of the parent event.

EventNumber (mandatory) = Number of the parent event.

EventName (Optional) = Name of the parent event.

All event contacts should be formatted as below.

Parameter

ContactType (Required) 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.

ExtendedBlockTime Boolean

If the ExtendedBlockTime value is provided as true, then blocking time for the venues while creating the event will be 20 mins instead of 5 mins.

JSON

Params:
IgnoreWarnings=true 

Request Body:
{
    "EventName": "AAPT - John's Birthday Party",
    "EventPax": 0,
    "EventType": {
        "Id": 160,
        "Name": "Birthday"
    },
    "StartDate": "19/01/2020 10:29",
    "StartTime": "2020-01-18T23:29:00.000Z",
    "EndDate": "20/01/2020 11:22",
    "EndTime": "2020-01-20T00:22:00.000Z",
    "EventStatus": {
        "Type": "Queued",
        "Position": 4,
        "TextColour": "#0000ff",
        "Color": "#00ff00",
        "Inactive": false,
        "Id": 100012743,
        "Name": "Equeued",
        "Colour": "#00ff00"
    },
    "EventCoordinator": {
        "PriavaUserId": 100013083,
        "Inactive": false,
        "Id": 100013083,
        "Name": " 2e9b7941-8ba3-4c81-9171-d3664f9bfbaa",
        "APIUserType": ""
    },
    "Contact": {
        "Firstname": "jiten",
        "Anonymised": false,
        "Email": "jiten.prithiani@olethia.com",
        "Organisation": "AAPT",
        "Phone": "+91-7777777777",
        "Lastname": "prithiani",
        "Inactive": "",
        "GDPRProcessed": false,
        "ContactId": 100557456,
        "Deleted": false,
        "Pseudonymised": false,
        "JobTitle": "",
        "DisplayField": "jiten prithiani - AAPT"
    },
    "ContactType": {
        "Position": 1,
        "Inactive": false,
        "Id": 10000007460,
        "Name": "Seeds Contact Types"
    },
    "EventSource": {
        "Id": 6,
        "Name": "Website"
    },
    "CustomFields": {
        "RegistrationNumber":"G-120672"
    },
    "EventContact": {
        "ContactType": {
            "Position": 1,
            "Inactive": false,
            "Id": 10000007460,
            "Name": "Seeds Contact Types"
        },
        "ContactId": 100557456
    },
    "EventComment":[{
        "CommentType": {
            "Id": 8
        },
        "Comment": "This is general comment"
        }
    ],
    "VenueBlockId": [
        37056
    ],
    "EventPaxBreakdown": [],
    "EventParent": {
        "EventId": 101970451,
        "EventNumber": "3299",
        "EventName": "John's Birthday Party"
    }
   "ExtendedBlockTime":false
}

Response:

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

Was this article helpful?

Have more questions? Submit a request