Person Update

PATCH /v1/api/people/:id

This API endpoint allows the update of existing people. It enables clients to modify person details based on specific criteria provided in the request payload.

Clients can send a PUT or PATCH request to this endpoint with appropriate parameters, including the person ID to be updated and the new details to be applied, such as personal data, address and client data.

The endpoint ensures flexibility by allowing partial updates, enabling clients to modify only the necessary fields without having to resend the entire person details.

Upon successful update, the client application will receive a confirmation response containing the updated person details, including any changes made.

In case of errors or conflicts during the update process, the response structure is designed to provide detailed information on the issue encountered, facilitating efficient error handling and resolution.

Request

Path Parameters

id stringrequired

application/json

Body

firstName stringnullable

Nome.

lastName stringnullable

Sobrenome.

email stringnullable

Email.

phone stringnullable

Telefone.

cpf stringnullable

CPF.

passport stringnullable

Passaporte.

dob stringnullable

Data de nascimento.

country stringnullable

País de origem.

registrationSource stringnullable

Origem de cadastro.

addressStreetName stringnullable

Rua.

addressNumber stringnullable

Número.

addressZipCode stringnullable

CEP.

addressAdditionalInformation stringnullable

Complemento.

addressDistrict stringnullable

Bairro.

addressCity stringnullable

Cidade.

addressState stringnullable

Estado.

ageGroup nullable

Possible values: [ADULT, CHILD, null]

Adulto ou criança.

loyaltyLevel stringnullable

Nível fidelidade.

loyaltyOptIn booleannullable

Opt-in fidelidade.