API docs by Redocly

New Western API v1 (1.0.0)

Download OpenAPI specification:

New Western API v1

Submit a New Lead

Endpoint Overview: This endpoint enables you to securely submit new leads to the New Western Lead Ingestion System. Upon submission, leads are automatically queued for review and assigned to a qualified agent, who will contact the lead promptly.

Authentication: An active API key is required to invoke this endpoint. For inquiries regarding API key provisioning, please reach out to the NW Tech Team.

Request Requirements: Ensure your request body aligns with the defined schema and includes all mandatory fields. Requests that fail validation will be rejected. Properly formatted JSON payloads improve processing efficiency and expedite lead assignments.

Authorizations:
api_key
Request Body schema: application/json
object
leadType
required
string
Enum: "Seller" "Investor" "Agent" "Wholesaler"

Lead Type

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "leadType": "Seller"
}

Response samples

Content type
application/json
{
  • "leadId": "string"
}