Events

Update an event. Roles: admin, group member.

Changed on
put/api/events/{eventId}

Request

  • Base URL
    https://api.mobilecoach.org (the document declares no server; this is the origin it was published from)
  • URL
    https://api.mobilecoach.org/api/events/{eventId}
  • Auth
    AuthToken (a scheme the document does not define)

Path parameters

eventIdinteger required

Request body

membershipIdinteger required
attendanceTypeCode'IN_PERSON' | 'VIRTUAL' required
registrationTypeCode'OPEN' | 'REGISTRATION' | 'REGISTRATION_WITH_RSVP' | 'TICKETED' required
titlestring required
descriptionstring
bodystring
locationstring
contactLabelstring
startDateTimestring date-time required
endDateTimestring date-time required
registrationOpenDateTimestring date-time
registrationCloseDateTimestring date-time
timeZoneIdstring required
allDayboolean required
publishedboolean required
unlistedboolean required
allowViewRegistrationsboolean required
registrationTicketingEnabledboolean required
dependentRegistrationEnabledboolean required
cancelledboolean required
imageUuidstring uuid
contactUrlstring
confirmationNotificationsEnabledboolean required
emailConfirmationBodystring
creditsnumber
reminder1Minutesinteger
reminder2Minutesinteger
emailRemindersEnabledboolean required
registrationsMaxinteger
registrationsMaxWarningThresholdinteger
groupIdinteger
assetIdsinteger[]
tagIdsinteger[]
mergePolicy'DELETE' | 'DELETE_UNREGISTERED_AND_ABANDON_REGISTERED' | 'ABANDON'
updateSeriesboolean

Response

OK

successboolean
errorstring

Changes

  • 6e5d224eed9bRevision changes
    • warning

      added the new AGE enum value to the // response property for the response status

    • warning

      added the new GREATER_THAN_OR_EQUALS enum value to the // response property for the response status

    • warning

      added the new LESS_THAN_OR_EQUALS enum value to the // response property for the response status

  • 36f72442f0a1Revision changes
    • breaking

      the // request property's maxLength was decreased to 255

    • info

      added the optional property /// to the response with the status