POST api/HpProMessaging/SendClientOrGroupEmail

Request Information

URI Parameters

None.

Body Parameters

HpProMessagesDTO
NameDescriptionTypeAdditional information
Date

string

None.

Email

string

None.

Organization

string

None.

AgentName

string

None.

AgentPhone

string

None.

AgentEmail

string

None.

ClientPhone

string

None.

LeadId

integer

None.

CountryId

integer

None.

LocationContextId

integer

None.

PresentationTypeId

integer

None.

PresentationSubTypeId

integer

None.

SelectedGroupCodeId

integer

None.

SelectedGroupCode

string

None.

IsClientText

boolean

None.

IsTraining

boolean

None.

ClientLastName

string

None.

ClientFirstName

string

None.

ClientGender

string

None.

PhoneList

Collection of PhoneNumbersDTO

None.

ReferralsList

Collection of ReferralsListDTO

None.

CreditUnionInstitution

string

None.

PresentationGuid

string

None.

SponsorshipReferralGuid

string

None.

smsInfo

string

None.

LanguageId

integer

None.

Request Formats

application/json, text/json

Sample:
{
  "Date": "sample string 1",
  "Email": "sample string 2",
  "Organization": "sample string 3",
  "AgentName": "sample string 4",
  "AgentPhone": "sample string 5",
  "AgentEmail": "sample string 6",
  "ClientPhone": "sample string 7",
  "LeadId": 1,
  "CountryId": 1,
  "LocationContextId": 1,
  "PresentationTypeId": 1,
  "PresentationSubTypeId": 1,
  "SelectedGroupCodeId": 1,
  "SelectedGroupCode": "sample string 8",
  "IsClientText": true,
  "IsTraining": true,
  "ClientLastName": "sample string 11",
  "ClientFirstName": "sample string 12",
  "ClientGender": "sample string 13",
  "PhoneList": [
    {
      "Name": "sample string 1",
      "PhoneNo": "sample string 2",
      "Checked": true
    },
    {
      "Name": "sample string 1",
      "PhoneNo": "sample string 2",
      "Checked": true
    }
  ],
  "ReferralsList": [
    {
      "FirstName": "sample string 1",
      "LastName": "sample string 2",
      "City": "sample string 3",
      "isFromWillKit": true,
      "isActivated": true,
      "State": "sample string 6",
      "StateObj": {
        "StateId": 1,
        "Name": "sample string 2",
        "StateCode": "sample string 3",
        "Lattitude": "sample string 4",
        "Longitude": "sample string 5",
        "CountryId": 1,
        "StateWithCodeName": "sample string 2, sample string 3",
        "IsStatePaused": true
      },
      "Phone": "sample string 7",
      "RelToSponsor": "sample string 8",
      "Occupation": "sample string 9",
      "SignificantOther": "sample string 10",
      "isFavorite": true,
      "Notes": "sample string 12",
      "AlreadyExist": true,
      "BranchOfService": "sample string 14",
      "CompleteGroup": {
        "Id": 1,
        "GroupName": "sample string 2",
        "GroupCode": "sample string 3",
        "PresentationTypeId": 4,
        "CountryId": 5
      },
      "GroupId": 15,
      "GroupCode": "sample string 16",
      "SelectedBenefits": [
        "sample string 1",
        "sample string 2"
      ],
      "SendSponsorshipVideo": true
    },
    {
      "FirstName": "sample string 1",
      "LastName": "sample string 2",
      "City": "sample string 3",
      "isFromWillKit": true,
      "isActivated": true,
      "State": "sample string 6",
      "StateObj": {
        "StateId": 1,
        "Name": "sample string 2",
        "StateCode": "sample string 3",
        "Lattitude": "sample string 4",
        "Longitude": "sample string 5",
        "CountryId": 1,
        "StateWithCodeName": "sample string 2, sample string 3",
        "IsStatePaused": true
      },
      "Phone": "sample string 7",
      "RelToSponsor": "sample string 8",
      "Occupation": "sample string 9",
      "SignificantOther": "sample string 10",
      "isFavorite": true,
      "Notes": "sample string 12",
      "AlreadyExist": true,
      "BranchOfService": "sample string 14",
      "CompleteGroup": {
        "Id": 1,
        "GroupName": "sample string 2",
        "GroupCode": "sample string 3",
        "PresentationTypeId": 4,
        "CountryId": 5
      },
      "GroupId": 15,
      "GroupCode": "sample string 16",
      "SelectedBenefits": [
        "sample string 1",
        "sample string 2"
      ],
      "SendSponsorshipVideo": true
    }
  ],
  "CreditUnionInstitution": "sample string 14",
  "PresentationGuid": "sample string 15",
  "SponsorshipReferralGuid": "sample string 16",
  "smsInfo": "sample string 17",
  "LanguageId": 1
}

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

boolean

Response Formats

application/json, text/json

Sample:
true