v2

PUT /prospections/:id
Update an existing prospection

Params

Param name Description
id
required

Prospection ID to update

Validations:

  • Must be a String
prospection
required

Prospection attributes to update

Validations:

  • Must be a Hash
prospection[prospect_id]
optional

Associated prospect UUID

Validations:

  • Must be a String
prospection[society_id]
optional

Associated society UUID

Validations:

  • Must be a String
prospection[initial_amount]
optional

Initial investment amount

Validations:

  • Must be a String
prospection[currency]
optional

Currency

Validations:

  • Must be one of: mxn, usd.
prospection[interest_rate]
optional

Annual interest rate

Validations:

  • Must be a String
prospection[includes_external_rate]
optional

Whether rate includes an external reference

Validations:

  • Must be one of: true, false, 1, 0.
prospection[external_rate_label]
optional

Label for the external rate reference

Validations:

  • Must be a String
prospection[interest_rate_floor]
optional

Minimum interest rate floor

Validations:

  • Must be a String
prospection[interest_rate_ceiling]
optional

Maximum interest rate ceiling

Validations:

  • Must be a String
prospection[type_of]
optional

Type of prospection

Validations:

  • Must be one of: promissory_note.
prospection[status]
optional

Current status

Validations:

  • Must be one of: in_process, standby, expired, disinterested, completed, rejected.
prospection[start_date]
optional

Start date (YYYY-MM-DD)

Validations:

  • Must be a String
prospection[end_date]
optional

Expected end date (YYYY-MM-DD)

Validations:

  • Must be a String
prospection[promissory_duration_months]
optional

Duration in months

Validations:

  • Must be a Integer
prospection[minimum_term_months]
optional

Minimum term in months

Validations:

  • Must be a Integer
prospection[commentary]
optional

Additional notes or commentary

Validations:

  • Must be a String

Examples

# Request body:
{
  'prospection': {
    'status': 'standby',
    'interest_rate': '11.0',
    'commentary': 'Updated via API'
  }
}

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

Errors

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