dashboard_delete_user

Delete a User

Marks a deactivated user for deletion from the Punchh platform

Note: Before deleting the user, deactivate the user via the Deactivate a User API.

The number of days within which Punchh will delete a user can be configured for a business in the Punchh platform. The default value is set to 7 days. Contact your Punchh representative to update this configuration. After an API call is made to delete a user, the system waits for the configured number of days before actually deleting the user. For example, if the configured days to delete the user is 7 days, the system will delete the user on the 8th day (i.e., after waiting a full 7 days).

Note: Once a guest is marked for deletion, there is no API available to reverse the action.

When deleting a user, include one of the following deletion reasons:

  • delete_general
  • delete_test_data
  • anonymize_forget_me
  • anonymize_inactivity

If you don’t include a reason, the system does not fully delete the user’s data; instead it anonymizes the user's account email to "@archive.com" and retains the user's data. Although there are multiple reasons for both deletion and anonymization, the operation for each is the same. The reason is used solely for documentation and tracking purposes.

Delete

Deletes the user and all associated transaction data permanently:

  • We recommend this option when deleting a test user or some other valid reason for also purging transaction history

  • 'General' and 'Test Data' sub-reasons have the same functionality. It is important to provide the accurate reason for analysis purposes.

{"reason": "delete_general"} Use this option to permanately delete a guest account.

{"reason": "delete_test_data"}

Anonymize

Deletes all of the user's PII (personally identifiable information), while keeping anonymized transaction data for reporting integrity. This is in compliance with GDPR/CCPA standards:

  • We recommend this option by default to keep accurate transaction history for valid guests while still respecting their privacy

  • 'Forget Me' and 'Inactivity' sub-reasons have the same functionality. It is important to provide the accurate reason for analysis purposes.

{"reason": "anonymize_forget_me"}

{"reason": "anonymize_inactivity"}

Headers
  • Authorization
    Type: string
    required

    Bearer token for admin authorization, who is making a call on behalf of the customer. Send the API key in the following format: "Authorization: Bearer BUSINESS_ADMIN_KEY_GOES_HERE".

Body
application/json
  • reason
    Type: string

    Reason for deletion: delete_general, delete_test_data, anonymize_forget_me, anonymize_inactivity

  • user_id
    Type: string
    required

    User ID of the guest in the Punchh system that will be deleted. You can get this value from the User object.

Responses
  • 200
    Type: object
    • message
      Type: string
  • 404
    Type: object
    • errors
      Type: object
  • 422
    Type: object
    • error
      Type: string
delete/api2/dashboard/users
{
  "message": "string"
}