v2

Params

Param name Description
id
required

Prospect ID to update

Validations:

  • Must be a String

prospect
required

Prospect attributes to update

Validations:

  • Must be a Hash

prospect[name]
optional

First name

Validations:

  • Must be a String

prospect[lastname]
optional

Last name

Validations:

  • Must be a String

prospect[matriname]
optional

Second last name

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[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[commentary]
optional

Additional notes

Validations:

  • Must be a String

Examples

# Request body:
{
  'prospect': {
    'commentary': 'Updated via API'
  }
}

# Response (200 OK): same structure as GET /prospects/:id

Errors

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