v2

PUT /promoters/:id
Update an existing promoter

Params

Param name Description
id
required

Promoter ID to update

Validations:

  • Must be a String
promoter
required

Promoter attributes to update

Validations:

  • Must be a Hash
promoter[name]
optional

First name

Validations:

  • Must be a String
promoter[lastname]
optional

Last name

Validations:

  • Must be a String
promoter[matriname]
optional

Second last name

Validations:

  • Must be a String
promoter[company]
optional

Whether the promoter is a company

Validations:

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

Company name

Validations:

  • Must be a String
promoter[email]
optional

Email address

Validations:

  • Must be a String
promoter[phone_number]
optional

Phone number

Validations:

  • Must be a String
promoter[phone_number_extension]
optional

Phone extension

Validations:

  • Must be a String
promoter[mobile_number]
optional

Mobile number

Validations:

  • Must be a String
promoter[gender]
optional

Gender

Validations:

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

Date of birth (YYYY-MM-DD)

Validations:

  • Must be a String
promoter[nationality]
optional

Nationality key (e.g. mexican)

Validations:

  • Must be a String
promoter[tax_number]
optional

RFC / tax number

Validations:

  • Must be a String
promoter[base_commission]
optional

Base commission percentage

Validations:

  • Must be a String
promoter[country]
optional

Country code

Validations:

  • Must be a String
promoter[subsidiary_id]
optional

Associated subsidiary UUID

Validations:

  • Must be a String
promoter[is_financial_entity]
optional

Whether the promoter is a financial entity

Validations:

  • Must be one of: true, false, 1, 0.

Examples

# Request body:
{
  'promoter': {
    'email': 'test.updated@example.com',
    'base_commission': '3.0'
  }
}

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

Errors

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