Skip to main content

Person Update

PATCH 
/v1/api/people/:id

This endpoint allows clients to modify an existing person's details by sending a PATCH request with the person ID and the fields to be updated, such as personal data, address, and loyalty fields.

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 response will contain the updated person details.

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

    First 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

    Address 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

    Whether the person is enabled or not.

Responses​

Successful update response.

Schema
    firstName stringnullable

    First 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

    Address 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

    Creation date.

    enabled booleannullable

    Default value: true

    Whether the person is enabled or not.

Loading...