POST Api/DigitalConsent/Send

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
PresaleId	integer	Required Range: inclusive between 1 and 2147483647
RetailerId	integer	Required Range: inclusive between 1 and 2147483647
PlanId	integer	Required Range: inclusive between 1 and 2147483647
IsConcessionEligible	boolean	Required
FirstName	string	Required String length: inclusive between 0 and 100
LastName	string	Required String length: inclusive between 0 and 100
DeliveryChannel	string	Required
Email	string	None.
PhoneNumber	string	String length: inclusive between 0 and 20
Address	string	Required String length: inclusive between 0 and 255
StateCode	string	Required String length: inclusive between 0 and 4
ConcessionTypeID	integer	None.
ConcessionTypeName	string	None.
FuelType	string	Required
NMI	string	String length: inclusive between 0 and 20
MIRN	string	String length: inclusive between 0 and 20
Solar	boolean	None.
LifeSupport	boolean	None.
MoveInDate	date	None.
GasMoveInDate	date	None.
CompassComparisonSnapshotDetailId	integer	Required

Request Formats

application/json, text/json

Sample:

{
  "PresaleId": 1,
  "RetailerId": 1,
  "PlanId": 1,
  "IsConcessionEligible": true,
  "FirstName": "sample string 1",
  "LastName": "sample string 2",
  "DeliveryChannel": "sample string 3",
  "Email": "sample string 4",
  "PhoneNumber": "sample string 5",
  "Address": "sample string 6",
  "StateCode": "sample string 7",
  "ConcessionTypeID": 1,
  "ConcessionTypeName": "sample string 8",
  "FuelType": "sample string 9",
  "NMI": "sample string 10",
  "MIRN": "sample string 11",
  "Solar": true,
  "LifeSupport": true,
  "MoveInDate": "2026-09-15T11:31:36.1975263+00:00",
  "GasMoveInDate": "2026-09-15T11:31:36.1975263+00:00",
  "CompassComparisonSnapshotDetailId": 1
}

application/xml, text/xml

Sample:

<SendDigitalConsentRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GoSwitch.CustomerTools.Models.DigitalConsent">
  <Address>sample string 6</Address>
  <CompassComparisonSnapshotDetailId>1</CompassComparisonSnapshotDetailId>
  <ConcessionTypeID>1</ConcessionTypeID>
  <ConcessionTypeName>sample string 8</ConcessionTypeName>
  <DeliveryChannel>sample string 3</DeliveryChannel>
  <Email>sample string 4</Email>
  <FirstName>sample string 1</FirstName>
  <FuelType>sample string 9</FuelType>
  <GasMoveInDate>2026-09-15T11:31:36.1975263+00:00</GasMoveInDate>
  <IsConcessionEligible>true</IsConcessionEligible>
  <LastName>sample string 2</LastName>
  <LifeSupport>true</LifeSupport>
  <MIRN>sample string 11</MIRN>
  <MoveInDate>2026-09-15T11:31:36.1975263+00:00</MoveInDate>
  <NMI>sample string 10</NMI>
  <PhoneNumber>sample string 5</PhoneNumber>
  <PlanId>1</PlanId>
  <PresaleId>1</PresaleId>
  <RetailerId>1</RetailerId>
  <Solar>true</Solar>
  <StateCode>sample string 7</StateCode>
</SendDigitalConsentRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ResultOfSendDigitalConsentResponse

Name	Type	Additional information
Success	boolean	None.
Message	string	None.
ErrorMessage	Collection of string	None.
Value	SendDigitalConsentResponse	None.

Response Formats

application/json, text/json

Sample:

{
  "Success": true,
  "Message": "sample string 2",
  "ErrorMessage": [
    "sample string 1",
    "sample string 2"
  ],
  "Value": {
    "DigitalConsentId": 1,
    "DigitalConsentToken": "sample string 2",
    "DigitalConsentExpiresAt": "2026-09-15T11:31:36.2443878+00:00"
  }
}

application/xml, text/xml

Sample:

<ResultOfSendDigitalConsentResponsevoWXilkT xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GoSwitch.CustomerTools.Models.Common.Returns">
  <ErrorMessage xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </ErrorMessage>
  <Message>sample string 2</Message>
  <Success>true</Success>
  <Value xmlns:d2p1="http://schemas.datacontract.org/2004/07/GoSwitch.CustomerTools.Models.DigitalConsent">
    <d2p1:DigitalConsentExpiresAt>2026-09-15T11:31:36.2443878+00:00</d2p1:DigitalConsentExpiresAt>
    <d2p1:DigitalConsentId>1</d2p1:DigitalConsentId>
    <d2p1:DigitalConsentToken>sample string 2</d2p1:DigitalConsentToken>
  </Value>
</ResultOfSendDigitalConsentResponsevoWXilkT>