dashboard_eclub_guest_upload

eClub Guest Upload

​

Allows you to upload a list of eClub guests along with their details

eClub Update

Use the eClub Guest Upload API to update the user information as well. The eClub user information that can be updated and other eClub settings are configured in the Punchh platform. This determines which parameters in the user object can be updated. The eClub user information can also be updated manually via the Punchh platform. Contact your Punchh representative to update these Punchh platform configuration settings.

Note:

1. If the "Explicit-Opt in" flag is enabled, marketing_email_subscription is a required parameter. The value can be 0 / 1 / true / false. The values 'true' and 'false' are string, and 0 and 1 can be a string or an integer.

2. If the business has “source” defined in the Punchh platform, only the source configured in the Punchh platform is considered valid in the API request and the user is created. If a “source” that is not configured for the business is passed in the API request, an error message is returned. If no “source” is passed, the user gets created (as an earlier functionality) as it is a non-mandatory parameter.

3. If active_registration is sent as 'false' but send_compliance_sms is sent as 'true' in the API request, this call will be treated as a bulk upload and no campaigns or compliance/opt-in SMS will be triggered for the user uploaded through this API call.

4. Either email or phone can be sent in the API request. The schema indicates that both are required; however if one is sent, then the other is not required.

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

  • Accept
    Type: string
    required

    Advertises which content types the client is able to understand

  • Content-Type
    Type: string
    required

    Set this header to application/json.

Body
application/json
  • source
    Type: string

    Name of the source from where guests are coming. The source for eClub widgets is defined in the Punchh platform. Contact your Punchh representative to update this Punchh platform configuration.

  • store_number
    Type: string
    required

    Store number of the location

  • user
    Type: object
Responses
  • 200
    Type: object
  • 400

    Invalid data

  • 401
    Type: object
    • error
      Type: string
  • 404

    Location not found based on store_number

  • 422

    Error returned in case of Invalid source

post/api2/dashboard/eclub_guests
{}