dashboard_ban_user

Ban a User

​

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

Query Parameters
  • 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.

  • reason
    Type: string
    required

    Reason that the guest is being banned. This is required for auditing and tracking purposes.

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".

Responses
  • 202
    Type: object
  • 401
    Type: object
    • error
      Type: string
post/api2/dashboard/users/ban
{}