Update profile

patch

https://rivage.immo/api/v1/profiles/{id}

Updates an existing profile with new contact information or contract associations.

Only include the fields that need to be updated.

Contract Associations

Can be managed through the profile_contracts_attributes array, which supports:

Adding relationships
Updating relationships
Removing relationships

Important: The profile's nature cannot be updated once set. Attempting to change it will result in a 422 error.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

string

required

Profile unique identifier

Body Params

integer

Unique identifier

reference

string

Profile reference code

first_name

string

Given name of the individual

last_name

string

Family name of the individual

birth_date

string

Birth date of the individual

birth_city

string

Birth city of the individual

birth_country

string

Birth country of the individual

company_name

string

Company name when the profile represents an organization

string

Email address for electronic communication

phone_number

string

Contact telephone number

civility

string

enum

Civility title for the individual (M., Mme, Autre, M. et Mme.). Optional field.

Allowed:

nature

string

enum

The role of the profile. Cannot be changed once set. When creating a profile with a
leasing_contract_id, defaults to physical_tenant. When creating with a management_contract_id,
defaults to landlord. Can be used as a filter parameter in the index endpoint.

supplier_status

string

enum

For supplier profiles (syndic, inventory_agent, contractor, photographer),
indicates their business status. Can be used as a filter parameter in the index endpoint.

Allowed:

address_attributes

object

Address information for the profile

Responses

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200profile updated

422invalid request