POST api/Finicity/SendConnectEmail?consumerId={consumerId}&customerId={customerId}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
consumerId

string

Required

customerId

string

Required

Body Parameters

ConnectEmailConfig
NameDescriptionTypeAdditional information
email

ConnectEmailOptions

None.

webhookData

WebhookData

None.

Request Formats

application/json, text/json

Sample:
{
  "email": {
    "to": "sample string 1",
    "supportPhone": "sample string 2",
    "firstName": "sample string 3",
    "signature": "sample string 4"
  },
  "webhookData": {
    "requesterEmail": "sample string 1",
    "loanId": "sample string 2",
    "loanNumber": "sample string 3",
    "customerFullName": "sample string 4"
  }
}

application/xml, text/xml

Sample:
<FinicityController.ConnectEmailConfig xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GSWebAPI.Controllers">
  <email>
    <firstName>sample string 3</firstName>
    <signature>sample string 4</signature>
    <supportPhone>sample string 2</supportPhone>
    <to>sample string 1</to>
  </email>
  <webhookData>
    <customerFullName>sample string 4</customerFullName>
    <loanId>sample string 2</loanId>
    <loanNumber>sample string 3</loanNumber>
    <requesterEmail>sample string 1</requesterEmail>
  </webhookData>
</FinicityController.ConnectEmailConfig>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.