Guides
Start typing to search…

Update an event (PUT)

This API allows you to update any event from the alumni platform.

Call

In this call, you can update specific fields about an event using the event schema. Making it possible to update just one field of the complete schema of fields.

Fields

  • Name* (string): The new event’s name.
  • isFeatured (Boolean): if true, the event will be tagged as featured when published. The default value is false.
  • isVolunteering (Boolean): if true, the event information will display that it is a volunteering event. The default value is false.
  • isOnlineWebinar (Boolean): if true, the event will display as an online event, and “location” will not be required anymore but “webinarUrl” will. The default value is false
  • webinarUrl (string): The URL where the event will be hosted (if it is an online event). This field is required only if “isOnlineWebinar” is true.
  • location (object): This object consists of each piece of information that conforms to the event’s location (if it is not an online webinar).
    • streetName (string): The event location’s street name.
    • streetNumber (string): The event location’s street number.
    • postalCode (string): The event location’s postal code.
    • city* (string): the event location’s city.
    • state* (string): the event location’s state.
    • country* (string): the event location’s country.
  • locationPhoneNumber (string): The event location’s phone number.
  • locationWebUrl (string): The event location’s webpage URL.
  • startDate* (date-time): The date and time the event will start. This field expects the format: yyyy-MM-dd'T'HH:mm:ss.SSS'Z (2023-04-28T17:06:41.784Z). Only future dates can be used (later than the current date).
  • endDate* (date-time): The date and time the event will end. This field expects the format: yyyy-MM-dd'T'HH:mm:ss.SSS'Z (2023-04-28T17:06:41.784Z). Only dates that are the same or after the startDate are accepted.
  • isRSVPRequired (Boolean): if true, the system will show that RSVP is required to go to the event. The default value is false.
  • resgistrationDeadline (date-time): The date and time when registration (RSVP) to the event is closed. This field expects the format: yyyy-MM-dd'T'HH:mm:ss.SSS'Z (2023-04-28T17:06:41.784Z). Only future dates and no later than StartDate can be used.
  • organizerGuids* (array of strings): The people responsible for organizing the event’s userRosourceGuids. One event can have multiple organizers.
  • individualGuids (array of strings): The individual invitees’ userResourceGuids.
  • eventImageUrl* (string): The event’s image URL. The URL provided must redirect to a publicly available image which will be added to the Alumni system for later use.
  • shortDescription* (string): The event’s short description. No minimum number of characters is required but there is a maximum of 300.
  • Description* (string): The event’s description. No minimum or maximum number of characters is configured.
  • eventType* (string): The event’s type, the accepted values are “PRIVATE” and “GLOBAL” for private and global events accordingly.
  • isAttendanceShown (Boolean): If true, the people who have RSVP’d as “attending” will be visible to everyone on the platform. The default value is false.
  • Publish (Boolean): If true, the event will be published as soon as it is created in the platform, if false the event will be saved as a draft in the Alumni platform. The default value is false.

Notes

  • Only populate the fields that will be updated.
  • The eventResourceGuid can be found on the return of other APIs such as "Create a new event", "Search events" and "Return a list of users".
  • The eventResourceGuid is on the CRM view of the event page URL:

Response

This API will return the updated event's full schema in JSON.

Example

{
  "resourceGuid": "aa19675e-fe02-4aaf-956a-6dade8b6057e",
  "name": "Documentation Event",
  "imagePublicId": "documentation/sharedimages/imageName",
  "imageCropProperties": null,
  "isRSVPRequired": false,
  "isSponsored": false,
  "eventType": "GLOBAL",
  "status": "DRAFT",
  "shortDescription": "Lorem ipsum dolor sit amet",
  "startDate": "2023-10-01T07:00:00.000Z",
  "endDate": "2023-10-01T07:25:00.000Z",
  "organizerGuids": [
    "9530c460-660b-4ad5-80ce-2353ca8c83fd"
  ],
  "location": {
    "city": null,
    "continent": null,
    "country": "Venezuela",
    "countryCode": "VE",
    "location": "Avenida Venezuela, Caracas, Distrito Capital, Venezuela",
    "latitude": 10.4879974,
    "longitude": -66.8715295,
    "postalCode": "",
    "streetName": "Avenida Venezuela",
    "streetNumber": "",
    "placeId": "EjdBdmVuaWRhIFZlbmV6dWVsYSwgQ2FyYWNhcywgRGlzdHJpdG8gQ2FwaXRhbCwgVmVuZXp1ZWxhIi4qLAoUChIJE6MAN-FYKowRVi93gl45XOISFAoSCQdIgs2tWCqMEYOEmQquLt2T",
    "state": "Distrito Capital",
    "additionalDetails": null,
    "locationPhoneNumber": "",
    "locationWebUrl": "",
    "name": "Avenida Venezuela"
  },
  "isOnlineWebinar": false,
  "timeZone": "Etc/GMT",
  "webinarUrl": null,
  "description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit.",
  "isPublic": false,
  "isFeatured": false,
  "isAttendanceShown": false,
  "isQuestionsAndAnswersShown": false,
  "isCommentsSectionShown": true,
  "isVolunteering": false,
  "groups": [],
  "individualGuids": null,
  "registrationDeadline": null,
  "numberOfAttendingInvitees": null,
  "numberOfMaybeInvitees": null,
  "numberOfNotAttendingInvitees": null,
  "myRsvpStatus": null,
  "tenantId": "CUSTOMER_ALUMNI_STG"
}

API URL: https://gateway.alumni-stage.com/api/v2/event/eventResourceGuid

*Use gateway-us for the United States region and gateway-uk for the UK region. For the Frankfurt region, simply use gateway.

Expected Return

An error in case the system could not update the event on the platform or a success message in case the event was successfully updated along with the event's full schema json.

Updated 24 days ago