POST api/Lead/GetMessageForLeadTextAppointment

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
LeadFirstName	string	None.
AgentFirstName	string	None.
SponsorFullName	string	None.
GroupName	string	None.
AgentPhoneNumber	string	None.
ApptDate	string	None.
ApptDateInDayFormat	string	None.
ApptTodayOrDateFormat	string	None.
ApptTime	string	None.
ApptFromTime	string	None.
ApptToTime	string	None.
AgentName	string	None.
TextAppointmentTypeId	LeadTextApptTypeEnum	None.
AppointmentDateTime	date	None.
AppointmentEndingDateTime	date	None.
LeadId	string	None.
GroupId	integer	None.
ConfirmingUpcomingAppointmentId	integer	None.
ConfirmingUpcomingAppointmentDateTime	date	None.
ConfirmingUpcomingAppointmentType	integer	None.
CountryId	integer	None.
StateId	integer	None.
LeadOriginId	integer	None.
SecurityKeyword	string	None.
StateCode	string	None.
State	string	None.

Request Formats

application/json, text/json

Sample:

{
  "LeadFirstName": "sample string 1",
  "AgentFirstName": "sample string 2",
  "SponsorFullName": "sample string 3",
  "GroupName": "sample string 4",
  "AgentPhoneNumber": "sample string 5",
  "ApptDate": "today",
  "ApptDateInDayFormat": "today",
  "ApptTodayOrDateFormat": "today",
  "ApptTime": "6:25pm",
  "ApptFromTime": "6:25pm",
  "ApptToTime": "6:25pm",
  "AgentName": "sample string 6",
  "TextAppointmentTypeId": 12,
  "AppointmentDateTime": "2026-02-03T18:25:50.0128458-08:00",
  "AppointmentEndingDateTime": "2026-02-03T18:25:50.0128458-08:00",
  "LeadId": "sample string 7",
  "GroupId": 8,
  "ConfirmingUpcomingAppointmentId": 1,
  "ConfirmingUpcomingAppointmentDateTime": "2026-02-03T18:25:50.0128458-08:00",
  "ConfirmingUpcomingAppointmentType": 1,
  "CountryId": 1,
  "StateId": 1,
  "LeadOriginId": 1,
  "SecurityKeyword": "sample string 9",
  "StateCode": "sample string 10",
  "State": "sample string 11"
}

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

LeadTextApptMessageResponseDTO

Name	Type	Additional information
Message	string	None.
AttachIdBadge	boolean	None.
AttachDocumentType	AttachDocumentTypeEnum	None.
Message1	string	None.

Response Formats

application/json, text/json

Sample:

{
  "Message": "sample string 1",
  "AttachIdBadge": true,
  "AttachDocumentType": 0,
  "Message1": "sample string 3"
}