Here, you can learn how to inactivate a person who is no longer an active user. We will inactivate a private person, Rhys Davey, who no longer uses any services and does not wish to maintain an active customer record.
The personId of Rhys Davey who we want to inactivate isID-3204.
Since the person requested to inactivate their account, the reason can be set as OTHER.
The inactivation is effective from June 15th 2023. The date format: YYYY-MM-DD.
You can use different values for the processReason parameter. See below:
The processReason for private person:
MERGER,
DEATH,
OTHER,
LEFT_FOR_COMPETITOR,
DATA_RETENTION_PERIOD_END.
The processReason for legal person:
MERGER,
LIQUIDATION,
OTHER,
LEFT_FOR_COMPETITOR,
DATA_RETENTION_PERIOD_END.
To inactivate a person, make the following API call.
Below is an example request body of the API call to inactivate a person.
Below you find an example response body to the API call above.
The person's status is changed to INACTIVE.
Person inactivation is not permanent and person can be to PENDING status and later to ACTIVE status.
https://person-api.sandbox.tuumplatform.com/api/v2/persons/ID-3204/inactivate/start
Learn more about the endpoint in the Tuum developer portal.