Create a Lead

POST /v1/leads

Create a new lead. RentSimple validates the payload, attaches it to your company, and triggers the AI leasing agent to send the first message over the lead’s preferred channel.

Request body

Field	Type	Required	Description
`companyCode`	string	yes	Your RentSimple company identifier
`firstName`	string	no	Lead’s first name
`lastName`	string	no	Lead’s last name
`email`	string	conditional	Lead’s email. Required if `phone` is not provided
`phone`	string	conditional	Lead’s phone number (E.164). Required if `email` is not provided
`message`	string	no	Free-text inquiry from the lead, included in the first outreach
`source`	string	no	Where the lead came from (e.g. `Facebook`, `Zillow`, `Website`)

Reach the lead somewhere. At least one of email or phone is required. RentSimple needs a channel to contact the lead.

Example

Request


curl -X POST https://rentsimple.ai/api/v1/leads \
  -H "Authorization: Bearer $RENTSIMPLE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "companyCode": "aB3xY7",
    "firstName": "Jordan",
    "lastName": "Lee",
    "email": "jordan.lee@example.com",
    "phone": "+14155550123",
    "message": "Is the 2-bed at 14 Elm still available for July 1?",
    "source": "Website"
  }'

Response — 200 OK


{
  "message": "OK"
}

Errors

Status	Message	Cause
`401`	Unauthorized	Missing or invalid API key
`400`	Invalid companyCode	`companyCode` is missing or does not resolve
`400`	Invalid payload	Neither `email` nor `phone` was provided
`400`	Missing agent channel priority	No reply channel could be selected for the agent
`400`	Missing agent email	Email outreach selected but the agent has no email
`400`	Missing agent phone	Text outreach selected but the agent has no phone