Create an Event

POST

/api/Event

POST

/api/Event

curl -X POST https://api.virtuoussoftware.com/api/Event \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "name": "<string>",
  "eventType": "<string>",
  "startDateTime": "<dateTime>",
  "endDateTime": "<dateTime>",
  "timeZone": "<string>",
  "communicationId": "<integer>",
  "locationName": "<string>",
  "description": "<string>",
  "specialInstructions": "<string>",
  "inviteOnly": "<boolean>",
  "rsvpRequired": "<boolean>",
  "tables": [
    "<string>",
    "<string>"
  ],
  "meals": [
    "<string>",
    "<string>"
  ],
  "address1": "<string>",
  "address2": "<string>",
  "city": "<string>",
  "state": "<string>",
  "postal": "<string>",
  "country": "<string>",
  "eventbriteId": "<string>",
  "customFields": [
    {
      "name": "<string>",
      "value": "<string>",
      "displayName": "<string>"
    },
    {
      "name": "<string>",
      "value": "<string>",
      "displayName": "<string>"
    }
  ]
}'

{
  "id": "<integer>",
  "eventViewUrl": "<string>",
  "name": "<string>",
  "eventType": "<string>",
  "locationName": "<string>",
  "displayAddress": "<string>",
  "geocodeAddress": "<string>",
  "startDateTime": "<string>",
  "endDateTime": "<string>",
  "timeZone": "<string>",
  "description": "<string>",
  "specialInstructions": "<string>",
  "inviteOnly": "<boolean>",
  "rsvpRequired": "<boolean>",
  "totalInvites": "<integer>",
  "totalRsvps": "<integer>",
  "totalAttended": "<integer>",
  "totalGifts": "<integer>",
  "totalGiving": "<string>",
  "communicationId": "<integer>",
  "createDateTimeUtc": "<dateTime>",
  "createdByUser": "<string>",
  "modifiedDateTimeUtc": "<dateTime>",
  "modifiedByUser": "<string>",
  "eventContactsUrl": "<string>",
  "generosityEventContacts": [
    {
      "id": "<integer>",
      "eventContactUrl": "<string>",
      "contactId": "<integer>",
      "contactUrl": "<string>",
      "displayName": "<string>",
      "firstName": "<string>",
      "avatarUrl": "<string>",
      "primaryPhone": "<string>",
      "primaryEmail": "<string>"
    },
    {
      "id": "<integer>",
      "eventContactUrl": "<string>",
      "contactId": "<integer>",
      "contactUrl": "<string>",
      "displayName": "<string>",
      "firstName": "<string>",
      "avatarUrl": "<string>",
      "primaryPhone": "<string>",
      "primaryEmail": "<string>"
    }
  ],
  "tables": [
    "<string>",
    "<string>"
  ],
  "meals": [
    "<string>",
    "<string>"
  ],
  "eventInvitationsUrl": "<string>",
  "customFields": [
    {
      "name": "<string>",
      "value": "<string>",
      "displayName": "<string>"
    },
    {
      "name": "<string>",
      "value": "<string>",
      "displayName": "<string>"
    }
  ]
}

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.

namestringOptional

eventTypestringOptional

startDateTimestringOptional

endDateTimestringOptional

timeZonestringOptional

communicationIdstringOptional

locationNamestringOptional

descriptionstringOptional

specialInstructionsstringOptional

inviteOnlystringOptional

rsvpRequiredstringOptional

tableslist of stringsOptional

mealslist of stringsOptional

address1stringOptional

address2stringOptional

citystringOptional

statestringOptional

postalstringOptional

countrystringOptional

eventbriteIdstringOptional

customFieldslist of objectsOptional

Response

idstringOptional

eventViewUrlstringOptional

namestringOptional

eventTypestringOptional

locationNamestringOptional

displayAddressstringOptional

geocodeAddressstringOptional

startDateTimestringOptional

endDateTimestringOptional

timeZonestringOptional

descriptionstringOptional

specialInstructionsstringOptional

inviteOnlystringOptional

rsvpRequiredstringOptional

totalInvitesstringOptional

totalRsvpsstringOptional

totalAttendedstringOptional

totalGiftsstringOptional

totalGivingstringOptional

communicationIdstringOptional

createDateTimeUtcstringOptional

createdByUserstringOptional

modifiedDateTimeUtcstringOptional

modifiedByUserstringOptional

eventContactsUrlstringOptional

generosityEventContactslist of objectsOptional

tableslist of stringsOptional

mealslist of stringsOptional

eventInvitationsUrlstringOptional

customFieldslist of objectsOptional

Errors

400

Bad Request Error