POST api/Inquiries

Method that accepts HTTP POST requests to submit new inquiries. NOTE: if using XML format, fields MUST BE ORDERED ALPHABETICALLY.

Request Information

URI Parameters

None.

Body Parameters

Inquiry data to be submitted.

Inquiry

Name	Description	Type	Additional information
PartnerCode	Unique code assigned to individual partners.	string	Required Max length: 20
FirstName	First name	string	Required Max length: 50
LastName	Last name	string	Required Max length: 50
Email1	Primary email address	string	Required Max length: 50
Email2	Secondary email address	string	Max length: 50
Address1	Primary address	string	Max length: 100
Address2	Additional address details	string	Max length: 100
City	City of residence	string	Max length: 100
State	State of residence	string	Max length: 10
ZipCode	Zip Code	string	Max length: 10
Country	Country	string	Max length: 20
Phone1	Primary phone	string	Required
Phone2	Secondary phone	string	None.
Type	The Type of inquiry	string	Max length: 50
Channel	Channel through which inquiry was received	string	Max length: 50
Source	Source through which inquiry was received	string	Max length: 50
Vendor	Vendor through which inquiry was received	string	Max length: 50
SourceCampaign	Campaign that generated inquiry	string	Max length: 50
SourceDetails	Additional details associated with source of inquiry	string	Max length: 50
SourceInquiryId	Field to contain any inquiry specific identifiers assigned from the source of the lead	string	Max length: 50
Notes	Notes to be included with inquiry	string	Max length: 500
Notes2	Secondary notes to be included with inquiry	string	Max length: 500
Notes3	Tertiary notes to be included with inquiry	string	Max length: 500
Employer	Employer	string	Max length: 50
CurrentProfession	Current profession	string	Max length: 50
WorkExperience	Work Experience - years of work experience	string	Max length: 50
ConsentFlag	Consent to be contacted: true/false	boolean	None.
Age	Age	string	Max length: 10
Income	Income	string	Max length: 20
DesiredAppointmentTime	Requested appointment time in this format: 01/01/2017 1:00 PM NOTE: Day and Month fields must have 2 digits and Time field range is 1:00 through 12:59 followed by AM or PM. Exactly one whitespace between date and time fields, exactly one white space between minutes field and AM\|PM.	string	Matching regular expression pattern: ^(0[1-9]\|1[012])[- /.](0[1-9]\|[12][0-9]\|3[01])[- /.](19\|20)\d\d( )([1-9]\|1[012])[:]([0-5][0-9]( )[A\|P][M])$
MilitaryAffiliation	Does Inquiry have any military affiliation?	boolean	None.
PreferredContactMethod	Instructions for preferred method of contact: e.g. Phone or Email	string	Matching regular expression pattern: Chat\|Email\|Phone\|Text
Location	Location is used for location or type of service: e.g. location where a program may be offered	string	None.
ProgramOfInterest	Program of interest: this is a code associated with the program in question	string	Max length: 100
UpdatedProgramOfInterest		string	Max length: 100
FullProgramName	Full program name: this is the full, user-friendly name of the program in question	string	Max length: 100
MostRecentSchool	Name of inquiry's most recent school - high school or college	string	Max length: 100
HighestEDULevel	Highest level of education attained	string	Max length: 100
HighSchoolGraduationYear	Year in which inquiry graduated from high school	string	Max length: 20
Term	School term in which the prospected is interested	string	Max length: 50
EducationalGoals	Any specific educational goals to be discussed	string	Max length: 500
CareerGoals	Any specific career goals to be discussed	string	Max length: 500
StartTimeline	General desired start timeline: 09/01/2017. Note 2 digits are required for Day and Month fields (leading 0's if necessary).	string	Matching regular expression pattern: ^(0[1-9]\|1[012])[- /.](0[1-9]\|[12][0-9]\|3[01])[- /.](19\|20)\d\d$
FinancialAssistance	Does Inquiry require financial assistance?	boolean	None.
ExternalSystemId	Any external or third-party ID associated with the inquiry. E.G. a SalesForce ID	string	Max length: 100
IntegrityContactRep	Identifier for the IC Rep to which a lead record is assigned. Typically would use email address.	string	Max length: 100
VelocifyDateAdded		string	Max length: 100
VelocifyDateModified		string	Max length: 100
FirstAssignment		string	Max length: 100
FirstContactAttempt		string	Max length: 100
LastContactAttempt		string	Max length: 100
LeadActionCount		integer	None.
CreateToFirstContactAttempt		integer	None.
TotalContactAttempts		integer	None.
OriginalRequest		string	None.

Request Formats

application/json, text/json

Sample:

{
  "PartnerCode": "sample string 1",
  "FirstName": "sample string 2",
  "LastName": "sample string 3",
  "Email1": "sample string 4",
  "Email2": "sample string 5",
  "Address1": "sample string 6",
  "Address2": "sample string 7",
  "City": "sample string 8",
  "State": "sample string 9",
  "ZipCode": "sample string 10",
  "Country": "sample string 11",
  "Phone1": "sample string 12",
  "Phone2": "sample string 13",
  "Type": "sample string 14",
  "Channel": "sample string 15",
  "Source": "sample string 16",
  "Vendor": "sample string 17",
  "SourceCampaign": "sample string 18",
  "SourceDetails": "sample string 19",
  "SourceInquiryId": "sample string 20",
  "Notes": "sample string 21",
  "Notes2": "sample string 22",
  "Notes3": "sample string 23",
  "Employer": "sample string 24",
  "CurrentProfession": "sample string 25",
  "WorkExperience": "sample string 26",
  "ConsentFlag": true,
  "Age": "sample string 28",
  "Income": "sample string 29",
  "DesiredAppointmentTime": "sample string 30",
  "MilitaryAffiliation": true,
  "PreferredContactMethod": "sample string 32",
  "Location": "sample string 33",
  "ProgramOfInterest": "sample string 34",
  "UpdatedProgramOfInterest": "sample string 35",
  "FullProgramName": "sample string 36",
  "MostRecentSchool": "sample string 37",
  "HighestEDULevel": "sample string 38",
  "HighSchoolGraduationYear": "sample string 39",
  "Term": "sample string 40",
  "EducationalGoals": "sample string 41",
  "CareerGoals": "sample string 42",
  "StartTimeline": "sample string 43",
  "FinancialAssistance": true,
  "ExternalSystemId": "sample string 45",
  "IntegrityContactRep": "sample string 46",
  "VelocifyDateAdded": "sample string 47",
  "VelocifyDateModified": "sample string 48",
  "FirstAssignment": "sample string 49",
  "FirstContactAttempt": "sample string 50",
  "LastContactAttempt": "sample string 51",
  "LeadActionCount": 52,
  "CreateToFirstContactAttempt": 53,
  "TotalContactAttempts": 54,
  "OriginalRequest": "sample string 55"
}

application/xml, text/xml

Sample:

<Inquiry xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/InquiriesService.Models.DTO">
  <Address1>sample string 6</Address1>
  <Address2>sample string 7</Address2>
  <Age>sample string 28</Age>
  <CareerGoals>sample string 42</CareerGoals>
  <Channel>sample string 15</Channel>
  <City>sample string 8</City>
  <ConsentFlag>true</ConsentFlag>
  <Country>sample string 11</Country>
  <CreateToFirstContactAttempt>53</CreateToFirstContactAttempt>
  <CurrentProfession>sample string 25</CurrentProfession>
  <DesiredAppointmentTime>sample string 30</DesiredAppointmentTime>
  <EducationalGoals>sample string 41</EducationalGoals>
  <Email1>sample string 4</Email1>
  <Email2>sample string 5</Email2>
  <Employer>sample string 24</Employer>
  <ExternalSystemId>sample string 45</ExternalSystemId>
  <FinancialAssistance>true</FinancialAssistance>
  <FirstAssignment>sample string 49</FirstAssignment>
  <FirstContactAttempt>sample string 50</FirstContactAttempt>
  <FirstName>sample string 2</FirstName>
  <FullProgramName>sample string 36</FullProgramName>
  <HighSchoolGraduationYear>sample string 39</HighSchoolGraduationYear>
  <HighestEDULevel>sample string 38</HighestEDULevel>
  <Income>sample string 29</Income>
  <IntegrityContactRep>sample string 46</IntegrityContactRep>
  <LastContactAttempt>sample string 51</LastContactAttempt>
  <LastName>sample string 3</LastName>
  <LeadActionCount>52</LeadActionCount>
  <Location>sample string 33</Location>
  <MilitaryAffiliation>true</MilitaryAffiliation>
  <MostRecentSchool>sample string 37</MostRecentSchool>
  <Notes>sample string 21</Notes>
  <Notes2>sample string 22</Notes2>
  <Notes3>sample string 23</Notes3>
  <OriginalRequest>sample string 55</OriginalRequest>
  <PartnerCode>sample string 1</PartnerCode>
  <Phone1>sample string 12</Phone1>
  <Phone2>sample string 13</Phone2>
  <PreferredContactMethod>sample string 32</PreferredContactMethod>
  <ProgramOfInterest>sample string 34</ProgramOfInterest>
  <Source>sample string 16</Source>
  <SourceCampaign>sample string 18</SourceCampaign>
  <SourceDetails>sample string 19</SourceDetails>
  <SourceInquiryId>sample string 20</SourceInquiryId>
  <StartTimeline>sample string 43</StartTimeline>
  <State>sample string 9</State>
  <Term>sample string 40</Term>
  <TotalContactAttempts>54</TotalContactAttempts>
  <Type>sample string 14</Type>
  <UpdatedProgramOfInterest>sample string 35</UpdatedProgramOfInterest>
  <VelocifyDateAdded>sample string 47</VelocifyDateAdded>
  <VelocifyDateModified>sample string 48</VelocifyDateModified>
  <Vendor>sample string 17</Vendor>
  <WorkExperience>sample string 26</WorkExperience>
  <ZipCode>sample string 10</ZipCode>
</Inquiry>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'Inquiry'.

Response Information

Resource Description

Response data structure containing ID, timestamp, status and any additional information regarding the inquiry request.

Response

Name	Description	Type	Additional information
Receipt	GUID - unique ID serving as a receipt for the inquiry	string	None.
TimeStamp	Date/time on which inquiry was received	date	None.
Status	Status of inquiry	string	None.
Message	Any additional details relating to the inquiry, including error information	string	None.
ReceivedInquiry		Inquiry	None.

Response Formats

application/json, text/json

Sample:

{
  "Receipt": "sample string 1",
  "TimeStamp": "2025-04-03T22:49:23.7301167+00:00",
  "Status": "sample string 2",
  "Message": "sample string 3",
  "ReceivedInquiry": {
    "PartnerCode": "sample string 1",
    "FirstName": "sample string 2",
    "LastName": "sample string 3",
    "Email1": "sample string 4",
    "Email2": "sample string 5",
    "Address1": "sample string 6",
    "Address2": "sample string 7",
    "City": "sample string 8",
    "State": "sample string 9",
    "ZipCode": "sample string 10",
    "Country": "sample string 11",
    "Phone1": "sample string 12",
    "Phone2": "sample string 13",
    "Type": "sample string 14",
    "Channel": "sample string 15",
    "Source": "sample string 16",
    "Vendor": "sample string 17",
    "SourceCampaign": "sample string 18",
    "SourceDetails": "sample string 19",
    "SourceInquiryId": "sample string 20",
    "Notes": "sample string 21",
    "Notes2": "sample string 22",
    "Notes3": "sample string 23",
    "Employer": "sample string 24",
    "CurrentProfession": "sample string 25",
    "WorkExperience": "sample string 26",
    "ConsentFlag": true,
    "Age": "sample string 28",
    "Income": "sample string 29",
    "DesiredAppointmentTime": "sample string 30",
    "MilitaryAffiliation": true,
    "PreferredContactMethod": "sample string 32",
    "Location": "sample string 33",
    "ProgramOfInterest": "sample string 34",
    "UpdatedProgramOfInterest": "sample string 35",
    "FullProgramName": "sample string 36",
    "MostRecentSchool": "sample string 37",
    "HighestEDULevel": "sample string 38",
    "HighSchoolGraduationYear": "sample string 39",
    "Term": "sample string 40",
    "EducationalGoals": "sample string 41",
    "CareerGoals": "sample string 42",
    "StartTimeline": "sample string 43",
    "FinancialAssistance": true,
    "ExternalSystemId": "sample string 45",
    "IntegrityContactRep": "sample string 46",
    "VelocifyDateAdded": "sample string 47",
    "VelocifyDateModified": "sample string 48",
    "FirstAssignment": "sample string 49",
    "FirstContactAttempt": "sample string 50",
    "LastContactAttempt": "sample string 51",
    "LeadActionCount": 52,
    "CreateToFirstContactAttempt": 53,
    "TotalContactAttempts": 54,
    "OriginalRequest": "sample string 55"
  }
}

application/xml, text/xml

Sample:

<Response xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/InquiriesService.Models.DTO">
  <Message>sample string 3</Message>
  <Receipt>sample string 1</Receipt>
  <ReceivedInquiry>
    <Address1>sample string 6</Address1>
    <Address2>sample string 7</Address2>
    <Age>sample string 28</Age>
    <CareerGoals>sample string 42</CareerGoals>
    <Channel>sample string 15</Channel>
    <City>sample string 8</City>
    <ConsentFlag>true</ConsentFlag>
    <Country>sample string 11</Country>
    <CreateToFirstContactAttempt>53</CreateToFirstContactAttempt>
    <CurrentProfession>sample string 25</CurrentProfession>
    <DesiredAppointmentTime>sample string 30</DesiredAppointmentTime>
    <EducationalGoals>sample string 41</EducationalGoals>
    <Email1>sample string 4</Email1>
    <Email2>sample string 5</Email2>
    <Employer>sample string 24</Employer>
    <ExternalSystemId>sample string 45</ExternalSystemId>
    <FinancialAssistance>true</FinancialAssistance>
    <FirstAssignment>sample string 49</FirstAssignment>
    <FirstContactAttempt>sample string 50</FirstContactAttempt>
    <FirstName>sample string 2</FirstName>
    <FullProgramName>sample string 36</FullProgramName>
    <HighSchoolGraduationYear>sample string 39</HighSchoolGraduationYear>
    <HighestEDULevel>sample string 38</HighestEDULevel>
    <Income>sample string 29</Income>
    <IntegrityContactRep>sample string 46</IntegrityContactRep>
    <LastContactAttempt>sample string 51</LastContactAttempt>
    <LastName>sample string 3</LastName>
    <LeadActionCount>52</LeadActionCount>
    <Location>sample string 33</Location>
    <MilitaryAffiliation>true</MilitaryAffiliation>
    <MostRecentSchool>sample string 37</MostRecentSchool>
    <Notes>sample string 21</Notes>
    <Notes2>sample string 22</Notes2>
    <Notes3>sample string 23</Notes3>
    <OriginalRequest>sample string 55</OriginalRequest>
    <PartnerCode>sample string 1</PartnerCode>
    <Phone1>sample string 12</Phone1>
    <Phone2>sample string 13</Phone2>
    <PreferredContactMethod>sample string 32</PreferredContactMethod>
    <ProgramOfInterest>sample string 34</ProgramOfInterest>
    <Source>sample string 16</Source>
    <SourceCampaign>sample string 18</SourceCampaign>
    <SourceDetails>sample string 19</SourceDetails>
    <SourceInquiryId>sample string 20</SourceInquiryId>
    <StartTimeline>sample string 43</StartTimeline>
    <State>sample string 9</State>
    <Term>sample string 40</Term>
    <TotalContactAttempts>54</TotalContactAttempts>
    <Type>sample string 14</Type>
    <UpdatedProgramOfInterest>sample string 35</UpdatedProgramOfInterest>
    <VelocifyDateAdded>sample string 47</VelocifyDateAdded>
    <VelocifyDateModified>sample string 48</VelocifyDateModified>
    <Vendor>sample string 17</Vendor>
    <WorkExperience>sample string 26</WorkExperience>
    <ZipCode>sample string 10</ZipCode>
  </ReceivedInquiry>
  <Status>sample string 2</Status>
  <TimeStamp>2025-04-03T22:49:23.7301167+00:00</TimeStamp>
</Response>