Enroll Guests via WiFi

Enrolls guests for eClub using WiFi as the acquisition channel. If both location_id and store_number are provided, store_number will be preferred.

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

client
Type: string

Client key of the business
location_id
Type: integer

ID of the location where the user enrolls via WiFi
store_number
Type: integer

Store number of the location where the user enrolls via WiFi
user
Type: object

Responses

application/json
application/json

post/api2/wifi/users

curl https://SERVER_NAME_GOES_HERE.punchh.com/api2/wifi/users \
  --request POST \
  --header 'Authorization: Bearer BUSINESS_ADMIN_KEY_GOES_HERE' \
  --header 'Content-Type: application/json' \
  --data '{
  "client": "CLIENT_GOES_HERE",
  "location_id": 311031,
  "store_number": 4,
  "user": {
    "email": "test@example.com",
    "first_name": "FIRST_NAME_GOES_HERE",
    "last_name": "LAST_NAME_GOES_HERE",
    "phone": "1111111111",
    "address_line1": "ADDRESS_GOES_HERE",
    "state": "California",
    "zip_code": "94040",
    "birthday": "1999-01-01",
    "marketing_email_subscription": "1"
  }
}'

Show Schema

{}

The user was added to the business as a WiFi-enrolled guest. If this call is made accidentally for a user that already exists in the business, the record will be skipped and the response will still be 202 accepted.