Skip to main content

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

Body

    firstName stringnullable

    Name.

    lastName stringnullable

    Last name.

    email stringnullable

    Email.

    phone stringnullable

    Phone.

    cpf stringnullable

    CPF.

    passport stringnullable

    Passport.

    dob stringnullable

    Date of birth.

    country stringnullable

    Country of origin.

    registrationSource stringnullable

    Registration source.

    addressStreetName stringnullable

    Street.

    addressNumber stringnullable

    Addresss number.

    addressZipCode stringnullable

    Zip code.

    addressAdditionalInformation stringnullable

    Address complement.

    addressDistrict stringnullable

    Neighborhood.

    addressCity stringnullable

    City.

    addressState stringnullable

    State.

    ageGroup nullable

    Possible values: [ADULT, CHILD, null]

    Classification of the age group (Adult or Child).

    loyaltyLevel stringnullable

    Loyalty level.

    loyaltyOptIn booleannullable

    Loyalty opt-in.

    id stringrequired

    Id.

    enabled booleannullable

    Default value: true

    Wheter the person is enabled or not.

Responses​

UpdatePersonResponse()

Schema
    firstName stringnullable

    Name.

    lastName stringnullable

    Last name.

    email stringnullable

    Email.

    phone stringnullable

    Phone.

    cpf stringnullable

    CPF.

    passport stringnullable

    Passport.

    dob stringnullable

    Date of birth.

    country stringnullable

    Country of origin.

    registrationSource stringnullable

    Registration source.

    addressStreetName stringnullable

    Street.

    addressNumber stringnullable

    Addresss number.

    addressZipCode stringnullable

    Zip code.

    addressAdditionalInformation stringnullable

    Address complement.

    addressDistrict stringnullable

    Neighborhood.

    addressCity stringnullable

    City.

    addressState stringnullable

    State.

    ageGroup nullable

    Possible values: [ADULT, CHILD, null]

    Classification of the age group (Adult or Child).

    loyaltyLevel stringnullable

    Loyalty level.

    loyaltyOptIn booleannullable

    Loyalty opt-in.

    id stringnullable

    Id.

    creationDate stringnullable

    Data de criação.

    enabled booleannullable

    Default value: true

    Wheter the person is enabled or not.

Loading...