Ban a User

Bans a user in the Punchh system to disallow check-ins, redemptions, emails, etc.

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
required

Reason that the guest is being banned. This is required for auditing and tracking purposes.
user_id
Type: string
required

User ID of the guest in the Punchh system that will be banned. You can get this value from the User object.
ban_all_associated_devices
Type: boolean

Optional boolean parameter. When set to true, all device IDs linked to the banned user are blocked. This prevents future logins from those devices. If anyone, including the banned user under a new account, attempts to log in from a blocked device, the login API (/api2/mobile/users/login) returns a 422 response with a customizable "Device Banned" message.

Responses

application/json
application/json

post/api2/dashboard/users/ban

curl https://SERVER_NAME_GOES_HERE.punchh.com/api2/dashboard/users/ban \
  --request POST \
  --header 'Authorization: Bearer BUSINESS_ADMIN_KEY_GOES_HERE' \
  --header 'Content-Type: application/json' \
  --data '{
  "user_id": "111111111",
  "reason": "Fraudulent activity",
  "ban_all_associated_devices": false
}'

Show Schema

{}