Create a solicitation record

post

https://extapiai2-1602d:8443/api/v1/gateway/solicitation

Creates a solicitation record

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

The solicitation request payload

campaignEndDate

date-time

length ≤ 10

The campaign ending date

campaignStartDate

date-time

length ≤ 10

The campaign starting date

addressLine1

string

length ≤ 100

The address line 1

addressLine2

string

length ≤ 100

The address line 2

branchCode

string

length ≤ 50

The branch code

brand

string

required

length ≤ 50

The brand of the solicitation

businessAddressLine1

string

length ≤ 100

The business address line 1

businessAddressLine2

string

length ≤ 100

The business address line 2

businessCity

string

length ≤ 50

The business city

businessName

string

length ≤ 50

The business name

businessPhone

string

length ≤ 10

The business phone

businessPostalCode

string

length ≤ 5

The business postal code

businessState

string

length ≤ 2

The business state

businessSuite

string

length ≤ 10

The business suite

campaignCode

string

length ≤ 10

The campaign code

campaignName

string

length ≤ 100

The campaign name

campaignType

string

enum

length ≤ 50

Defaults to ITA

The campaign type, Invitation to Apply (ITA) or Pre-qualified (PRE)

Allowed:

city

string

length ≤ 50

The city

dob

date-time

length ≤ 10

The date of birth

string

length ≤ 100

The email

externalId

string

length ≤ 50

The clients external identifier for this solicitation

firstName

string

length ≤ 50

The first name

homePhone

string

length ≤ 10

The home phone

lastName

string

length ≤ 50

The last name

middleInitial

string

length ≤ 1

The middle initial

mobilePhone

string

length ≤ 10

The mobile phone

officerCode

string

length ≤ 50

The officer code

postalCode

string

length ≤ 5

The postal code

productId

string

required

length ≤ 50

The product id

reservationCode

string

length ≤ 12

The unique reservation code, one will be generated if not provided

ssn

string

length ≤ 9

The SSN

stateOrProvince

string

length ≤ 2

The state/province

subBrandId

string

The sub brand

taxId

string

length ≤ 9

The business tax id

workPhone

string

length ≤ 10

The work phone

Responses

Language

Credentials

OAuth2

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201Solicitation record was created

400Request data is invalid

409The solicitation record already exists