Skip to main content
PATCH
/
preApprovals
Update multiple Pre Approvals
curl --request PATCH \
  --url https://commerce.driv.ly/api/preApprovals \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "updatedAt": "<string>",
  "createdAt": "<string>",
  "customer": 123,
  "title": "<string>",
  "status": "Processing",
  "firstName": "<string>",
  "middleInitial": "<string>",
  "lastName": "<string>",
  "suffix": "JR",
  "address": "<string>",
  "city": "<string>",
  "state": "AA",
  "zip": "<string>",
  "phone": "<string>",
  "email": "<string>",
  "income": "<string>",
  "ipAddress": "<string>",
  "userAgent": "<string>",
  "isp": "<string>",
  "sessionId": "<string>",
  "resend": "<string>",
  "AppId": 123,
  "segmentationBand": "Excellent (750-900)",
  "Name": "<string>",
  "Score": "<string>",
  "Status": "<string>",
  "CreateDate": "<string>",
  "DealerName": "<string>",
  "Email": "<string>",
  "AppMobileNo": "<string>",
  "IsFullFileReportAvilable": true,
  "estimatedInterestRate": "<string>",
  "estimatedLoanTerm": "<string>",
  "lead": 123,
  "UserName": "<string>",
  "ProductId": 123,
  "QuickProductId": 123,
  "StatusId": 123,
  "IsQqPass": 123,
  "IsQuickQualifyXpress": true,
  "IsLeadFormReport": true,
  "IsQr": true,
  "RemoveOperator": true,
  "IsQScan": true,
  "QuickScanStatus": "<string>"
}
'
{
  "message": "<string>",
  "errors": [
    "<string>"
  ],
  "docs": [
    {
      "updatedAt": "<string>",
      "createdAt": "<string>",
      "customer": 123,
      "title": "<string>",
      "status": "Processing",
      "firstName": "<string>",
      "middleInitial": "<string>",
      "lastName": "<string>",
      "suffix": "JR",
      "address": "<string>",
      "city": "<string>",
      "state": "AA",
      "zip": "<string>",
      "phone": "<string>",
      "email": "<string>",
      "income": "<string>",
      "ipAddress": "<string>",
      "userAgent": "<string>",
      "isp": "<string>",
      "sessionId": "<string>",
      "resend": "<string>",
      "AppId": 123,
      "segmentationBand": "Excellent (750-900)",
      "Name": "<string>",
      "Score": "<string>",
      "Status": "<string>",
      "CreateDate": "<string>",
      "DealerName": "<string>",
      "Email": "<string>",
      "AppMobileNo": "<string>",
      "IsFullFileReportAvilable": true,
      "estimatedInterestRate": "<string>",
      "estimatedLoanTerm": "<string>",
      "lead": 123,
      "UserName": "<string>",
      "ProductId": 123,
      "QuickProductId": 123,
      "StatusId": 123,
      "IsQqPass": 123,
      "IsQuickQualifyXpress": true,
      "IsLeadFormReport": true,
      "IsQr": true,
      "RemoveOperator": true,
      "IsQScan": true,
      "QuickScanStatus": "<string>"
    }
  ]
}
Make sure you install our SDK first. You can find out how, and more here.
import { SDK } from '@drivly/commerce'
import type { preApprovals } from '@drivly/commerce'

const sdk = new SDK(...)

const preApprovals = await sdk.preApprovals.unknown()

Authorizations

​
Authorization
string
header
required

Query Parameters

​
sort
string

sort by field

​
where
Where clause · object
required

pass a where query to constrain returned documents (complex type, see documentation)

Example:
{
  "or": [
    { "color": { "equals": "mint" } },
    {
      "and": [
        { "color": { "equals": "white" } },
        { "featured": { "equals": false } }
      ]
    }
  ]
}
​
limit
number

limit the returned documents to a certain number

​
page
number

get a specific page of documents

​
depth
number

number of levels to automatically populate relationships and uploads

​
locale
string

retrieves document(s) in a specific locale

​
fallback-locale
string

specifies a fallback locale if no locale value exists

Body

application/json
​
updatedAt
string
required
​
createdAt
string
required
​
customer
​
title
string | null
​
status
enum<string> | null
Available options:
Processing,
Error,
Processed,
Needs Info
​
firstName
string | null
​
middleInitial
string | null
​
lastName
string | null
​
suffix
enum<string> | null
Available options:
JR,
SR,
II,
III,
IV
​
address
string | null
​
city
string | null
​
state
enum<string> | null
Available options:
AA,
AE,
AK,
AL,
AR,
AS,
AZ,
CA,
CO,
CT,
DC,
DE,
FL,
FM,
GA,
GU,
HI,
IA,
ID,
IL,
IN,
KS,
KY,
LA,
MA,
MD,
ME,
MH,
MI,
MN,
MO,
MP,
MS,
MT,
NC,
ND,
NE,
NH,
NJ,
NM,
NV,
NY,
OH,
OK,
OR,
PA,
PR,
PW,
RI,
SC,
SD,
TN,
TX,
UT,
VA,
VI,
VT,
WA,
WI,
WV,
WY,
AP
​
zip
string | null
​
phone
string | null
​
email
string | null
​
income
string | null
​
ipAddress
string | null
​
userAgent
string | null
​
isp
string | null
​
sessionId
string | null
​
resend
string | null
​
AppId
number | null
​
segmentationBand
enum<string> | null
Available options:
Excellent (750-900),
Good (700-749),
Fair (650-699),
Fair (600-649),
OK (550-599),
Lower (300-549),
Unknown,
NS
​
Name
string | null
​
Score
string | null
​
Status
string | null
​
CreateDate
string | null
​
DealerName
string | null
​
Email
string | null
​
AppMobileNo
string | null
​
IsFullFileReportAvilable
boolean | null
​
estimatedInterestRate
string | null
​
estimatedLoanTerm
string | null
​
lead
​
UserName
string | null
​
ProductId
number | null
​
QuickProductId
number | null
​
StatusId
number | null
​
IsQqPass
number | null
​
IsQuickQualifyXpress
boolean | null
​
IsLeadFormReport
boolean | null
​
IsQr
boolean | null
​
RemoveOperator
boolean | null
​
IsQScan
boolean | null
​
QuickScanStatus
string | null

Response

200 - application/json

ok

​
message
string
​
errors
string[]
​
docs
PreApproval · object[]