Skip to main content
POST
/
referral-requests
Create a referral request
curl --request POST \
  --url https://www.renovationfind.com/rest-api-v1/referral-requests \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "firstName": "John",
  "lastName": "Doe",
  "emailTo": "john@example.com",
  "phone": "5551234567",
  "sendGift": false,
  "renewal": false
}
'
{
  "success": true,
  "message": "Duplicate request detected. Skipped."
}

Authorizations

​
Authorization
string
header
required

JWT token issued from the RenovationFind Manager Portal

Query Parameters

​
skipDuplicates
boolean
default:true

If true, silently skips when a duplicate email/phone already exists for this vendor.

Body

application/json
​
firstName
string
required

First name of the customer

Example:

"John"

​
lastName
string
required

Last name of the customer

Example:

"Doe"

​
emailTo
string<email>

Customer email address

Example:

"john@example.com"

​
phone
string

Customer phone number

Example:

"5551234567"

​
sendGift
boolean
default:false

Whether to send a gift with the referral request

​
renewal
boolean
default:false

Whether this is a renewal referral request

Response

Duplicate detected and skipped (when skipDuplicates=true)

​
success
boolean
Example:

true

​
message
string