Adds a prospect to the system. If an existing prospect is already found matching the information recieved, it will be updated.
| From Body | Type | Description |
|---|---|---|
| Club | Int32 | Optional. Id of the home club for the prospect. Requires a default salesperson be set up for the club |
| CommunicationPreference | String | Optional. Must match the short description of an existing communication preference or be "appointment" |
| String | Optional. Email address of prospect | |
| EnquiryType | String | Optional. Must be "email" for membership enquiry, or "guest pass" for guest pass enquiry |
| EthnicOriginId | Int16 | Optional. See EthnicOrigins |
| FirstName | String | Optional. First Name of the prospect |
| Gender | String | Optional. "M" or "F". Defaults to "M" |
| Goals | String | Optional. Comma separated list of values matching existing goals. Non-matching values are ignored |
| HomeTel | String | Optional. Home number of prospect |
| Interests | String | Optional. Comma separated list of values matching existing member interests. Non-matching values are ignored |
| MarketingSource | String | Optional. Must match the short description of an existing marketing source |
| MobileTel | String | Optional. Mobile number of prospect |
| OriginDate | DateTime | Optional. Date and time of the enquiry |
| PreferredAppointmentDateTime | DateTime | Optional. Required if communication preference is "appointment" or enquiryType is "Guest pass" |
| Salesperson | Int32 | Optional. |
| Status | String | Optional. Must match an existing prospect status |
| Surname | String | Optional. Surname of the prospect |
| Title | String | Optional. Title of the prospect |
{
"Title": "Mr",
"FirstName": "John",
"Surname": "Tester",
"MobileTel": "07865471238",
"HomeTel": "01123874423",
"Email": "test@test.com",
"EnquiryType": "Email",
"MarketingSource": "Web Site",
"Status": "Hot Prospect",
"Interests": "Steam, Cafe Bar",
"Goals": "Tone Up, Reduce Stress",
"Club": 5,
"Salesperson": null,
"OriginDate": "2025-11-02T03:34:12.2146258+00:00",
"CommunicationPreference": "Telephone",
"PreferredAppointmentDateTime": "2025-11-02T03:34:12.2146258+00:00",
"Gender": "Male",
"EthnicOriginId": null
}
No object is returned by this request
refUser where firstName = Club Name and lastName = Default_Salesperson.
Then add an entry to xUserGroup for the user who should be part of the salesperson group, and add an entry to xUserClubJob, where jobId = 0 and clubId = Club Id.
activity_regarding records must also be configured:| Bundle(s) |
|---|
| Prospecting |