---
title: "Create a new event."
method: POST
path: "/Ams/{ClientID}/Events"
tags: ["Ams"]
---

# Create a new event.

`POST /Ams/{ClientID}/Events`

## Request

- Base URL: `https://ws.yourmembership.com`
- URL: `https://ws.yourmembership.com/Ams/{ClientID}/Events`
- Auth: HTTP basic
- TypeScript: <https://skmtc.dev/yourmembership/apis/ym-rest-services/docs/Ams/:ClientID/Events/post.ts> (a function with typed inputs; its response is checked against the schema)

Create a new event.

## Path parameters

- `ClientID` integer, required

## Request body `application/x-www-form-urlencoded`

- object
  - `EventId` integer
  - `Active` boolean
  - `ActivateOn` string, date-time
  - `Name` string
  - `StartDate` string, date-time
  - `StartTime` string
  - `EndDate` string, date-time
  - `EndTime` string
  - `DisplayDate` string
  - `DisplayTime` string
  - `DateTimeOffset` number, double
  - `DateTimeOffsetDST` boolean
  - `Comments` string
  - `Description` string
  - `Logo` string
  - `LogoName` string
  - `LogoPath` string
  - `LogoThumbPath` string
  - `RemoveLogo` boolean
  - `Registration` string
  - `Recurrence` string
  - `Location` string
  - `Contact` string
  - `Visibility` string
  - `ParentEventId` integer
  - `UpdateSeries` boolean
  - `Categories` string
  - `Groups` string
  - `AllowGroupAdminEdit` boolean
  - `IsLegacyEvent` boolean
  - `RelatedProducts` string
  - `EventGuid` string
  - `UseLegacyDetailsPage` boolean
  - `UseLegacyRegisterPage` boolean
  - `AllowInsuranceOffer` boolean
  - `OfferEventInsurance` boolean
  - `VirtualAddOnEnabled` boolean
  - `VirtualMeetingsConfigured` boolean
  - `IsVirtual` boolean
  - `VirtualMeetingType` string
  - `VirtualMeetingId` integer
  - `VirtualUserId` string
  - `CanUserChangeAtEventAllowed` boolean
  - `ZoomUserSettings` string
  - `PageSize` integer
  - `PageNumber` integer
  - `FeaturedFlagAvailable` boolean
  - `Featured` boolean
  - `MemberID` integer
  - `ResponseStatus` string
  - `BypassCache` boolean
  - `DateCached` string, date-time
  - `Device` string

## Response `200`

Success

- EventResponse: EventResponse
  - `EmailValid` boolean
  - `EventId` integer
  - `Active` boolean
  - `ActivateOn` string, date-time
  - `Name` string
  - `StartDate` string, date-time
  - `StartTime` string
  - `EndDate` string, date-time
  - `EndTime` string
  - `DisplayDate` string
  - `DisplayTime` string
  - `DateTimeOffset` number, double
  - `DateTimeOffsetDST` boolean
  - `Comments` string
  - `Description` string
  - `Logo` string
  - `LogoName` string
  - `LogoPath` string
  - `LogoThumbPath` string
  - `RemoveLogo` boolean
  - `Registration` EventRegistration: EventRegistration
    - `Active` boolean
    - `Private` boolean
    - `MaxRegistrants` integer
    - `RegisterBy` string, date-time
    - `ReminderDays` integer
    - `MemberTypes` integer[]
    - `RsvpVisibility` integer
    - `PrimaryFormID` integer
    - `AddlFormID` integer
    - `AutoApprove` boolean
    - `MultipleRegistrations` boolean
    - `AllowIncompleteStatus` boolean
    - `ForceAllRequiredItems` boolean
    - `ShowCFOnAddlReg` boolean
    - `Instructions` string
    - `ProcessorId` integer
    - `EnableMultiProcessor` boolean
    - `RequireUniqueEmail` boolean
    - `UseDefaultThxPage` boolean
    - `ThxNote` string
    - `AdminRecipients` string
    - `AdminRecipient` string[]
    - `NotificationBody` string
    - `Info` EventRegistrationInfo: EventRegistrationInfo
      - `NonCancelledCount` integer
      - `InProgressCount` integer
    - `AllowCEUs` boolean
    - `OnlineCheckInEnable` boolean
    - `OnlineCheckInSecure` boolean
    - `OnlineRegistrationOpensEnable` boolean
    - `EnableWaitlist` boolean
    - `WaitlistMessage` string
    - `WaitlistConfirmMessage` string
    - `AutoLinkRegistrantToCdb` boolean
    - `OpenOnlineRegistrationDateTime` string, date-time
  - `Recurrence` EventRecurrence: EventRecurrence
    - `Active` boolean
    - `Cancel` boolean
    - `EndsBy` string, date-time
    - `Type` string
    - `Daily` DailyRecurrence: DailyRecurrence
      - `Every` integer
    - `Weekly` WeeklyRecurrence: WeeklyRecurrence
      - `Every` integer
      - `DayOfWeek` string[]
    - `Monthly` MonthlyRecurrence: MonthlyRecurrence
      - `OnDay` boolean
      - `Day` DaySpec: DaySpec
        - `Months` integer
        - `DayOfMonth` integer
      - `Week` WeekSpec: WeekSpec
        - `Months` integer
        - `WeekOfMonth` string
        - `DayOfWeek` string
  - `Location` EventLocation: EventLocation
    - `Name` string
    - `Presenter` string
    - `Address1` string
    - `Address2` string
    - `City` string
    - `State` string
    - `Province` string
    - `Country` Country: Country
      - `countryId` string
      - `countryCode` string
      - `countryName` string
      - `numberOfLocations` integer
      - `taxShipping` boolean
      - `taxDues` boolean
      - `locationLabel` string
    - `PostalCode` string
    - `GoogleMaps` boolean
  - `Contact` EventContact: EventContact
    - `Name` string
    - `Email` string
    - `Phone` string
  - `Visibility` EventVisibility: EventVisibility
    - `CustomUrl` string
    - `SignedInMembersOnly` boolean
    - `SiteWideCalendars` boolean
    - `CommunityCalendars` boolean
  - `ParentEventId` integer
  - `UpdateSeries` boolean
  - `Categories` integer[]
  - `Groups` integer[]
  - `AllowGroupAdminEdit` boolean
  - `IsLegacyEvent` boolean
  - `RelatedProducts` integer[]
  - `EventGuid` string
  - `UseLegacyDetailsPage` boolean
  - `UseLegacyRegisterPage` boolean
  - `AllowInsuranceOffer` boolean
  - `OfferEventInsurance` boolean
  - `VirtualAddOnEnabled` boolean
  - `VirtualMeetingsConfigured` boolean
  - `IsVirtual` boolean
  - `VirtualMeetingType` string
  - `VirtualMeetingId` integer
  - `VirtualUserId` string
  - `CanUserChangeAtEventAllowed` boolean
  - `ZoomUserSettings` UserSettings: UserSettings
    - `ScheduleMeeting` UserSettingsScheduleMeeting: UserSettingsScheduleMeeting
      - `HostVideo` boolean
      - `ParticipantsVideo` boolean
      - `AudioType` string
      - `JoinBeforeHost` boolean
      - `ForcePersonalMeetingIDJoinBeforeHostPassword` boolean
      - `GenerateRequirePasscodeForParticipantsByPhone` boolean
      - `UsePersonalMeetingIDWhenSchedulingMeeting` boolean
      - `UsePersonalMeetingIDWhenStartingInstantMeeting` boolean
      - `RequirePasscodeForSchedulingNewMeetings` boolean
      - `RequirePasswordForScheduledMeetings` boolean
      - `DefaultPasswordForScheduledMeetings` string
      - `RequirePasswordForInstantMeetings` boolean
      - `RequirePasswordForPersonalMeetingIDMeetings` string
      - `PersonalMeetingIDPassword` string
      - `EmbedPasswordInJoinLink` boolean
      - `PersonalMeeting` boolean
    - `Feature` UserSettingsFeature: UserSettingsFeature
      - `MeetingCapacity` integer
      - `LargeMeeting` boolean
      - `large_meeting_capacity` integer
      - `Webinar` boolean
      - `WebinarCapacity` integer
      - `ChinaMeeting` boolean
      - `IndiaMeeting` boolean
      - `ZoomPhone` boolean
  - `PageSize` integer
  - `PageNumber` integer
  - `FeaturedFlagAvailable` boolean
  - `Featured` boolean
  - `MemberID` integer
  - `ClientID` integer
  - `ResponseStatus` ResponseStatus: ResponseStatus
    - `ErrorCode` string
    - `Message` string
    - `StackTrace` string
    - `Errors` ResponseError[]
      - `ErrorCode` string
      - `FieldName` string
      - `Message` string
      - `Meta` DictionaryStringString: Dictionary<String,String>
    - `Meta` DictionaryStringString: Dictionary<String,String>
  - `BypassCache` boolean
  - `DateCached` string, date-time
  - `Device` string

---

[API](https://skmtc.dev/yourmembership/apis/ym-rest-services.md) - [All operations](https://skmtc.dev/yourmembership/apis/ym-rest-services/llms.txt) - [OpenAPI document](https://skmtc.dev/yourmembership/apis/ym-rest-services/revisions/8d8a2e7e7d56?raw)