v2

POST /prospects
Create a new prospect

Params

Param name Description
prospect
required

Prospect attributes

Validations:

  • Must be a Hash
prospect[name]
required

First name

Validations:

  • Must be a String
prospect[lastname]
required

Last name

Validations:

  • Must be a String
prospect[matriname]
optional

Second last name

Validations:

  • Must be a String
prospect[company]
optional

Whether the prospect is a company

Validations:

  • Must be one of: true, false, 1, 0.
prospect[company_name]
optional

Company name (required when company is true)

Validations:

  • Must be a String
prospect[email]
optional

Email address

Validations:

  • Must be a String
prospect[phone_number]
optional

Phone number

Validations:

  • Must be a String
prospect[phone_number_extension]
optional

Phone extension

Validations:

  • Must be a String
prospect[mobile_number]
optional

Mobile number

Validations:

  • Must be a String
prospect[gender]
optional

Gender

Validations:

  • Must be one of: male, female, other.
prospect[dob]
optional

Date of birth (YYYY-MM-DD)

Validations:

  • Must be a String
prospect[contact_date]
optional

Contact date (YYYY-MM-DD)

Validations:

  • Must be a String
prospect[nationality]
optional

Nationality key (e.g. mexican)

Validations:

  • Must be a String
prospect[promoter_id]
optional

Associated promoter UUID

Validations:

  • Must be a String
prospect[street]
optional

Street name

Validations:

  • Must be a String
prospect[street_number]
optional

Street number

Validations:

  • Must be a String
prospect[street_number_internal]
optional

Interior number

Validations:

  • Must be a String
prospect[postal_code]
optional

Postal code

Validations:

  • Must be a String
prospect[city]
optional

City

Validations:

  • Must be a String
prospect[state]
optional

State

Validations:

  • Must be a String
prospect[country]
optional

Country code

Validations:

  • Must be a String
prospect[suburb]
optional

Suburb / colony

Validations:

  • Must be a String
prospect[commentary]
optional

Additional notes

Validations:

  • Must be a String

Examples

# Request body:
{
  'prospect': {
    'name': 'Test',
    'lastname': 'Prospect',
    'email': 'test.prospect@example.com',
    'phone_number': '5512345678',
    'gender': 'male',
    'dob': '1990-06-15',
    'contact_date': '2026-05-07',
    'nationality': 'mexican',
    'promoter_id': 'promoter-uuid',
    'commentary': 'First contact via referral'
  }
}

# Response (201 Created): same structure as GET /prospects/:id

Errors

Code Description
400 Bad Request
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error