User Input (Object)

Address of the user

Whether age is verified or not. Possible values: true, false

Whether or not the user has undergone age verification. Possible Values: true, false. The value is set to true if the user's age is verified; otherwise, it is set to false. The response returns this parameter in sign-in, sign-up, and user update APIs if the age verification is enabled for the business in the Punchh platform. Contact your Punchh representative to update this Punchh platform configuration setting.

Anniversary of the user, in YYYY-MM-DD format

Date of birth of the user, in YYYY-MM-DD format. This field gets updated in the database only if the user did not set it initially during sign-up. Due to fraud protections, guests are permitted to update their birthdays only once. Subsequent attempts to modify the birthday parameter using the API will fail. In such a case, even though the API returns a 200 response, the user's birthday is not updated in Punchh.

ID of the business to which the user is added

Whether the user is a business migration user. Possible values: true, false

Gift card number

City where the user lives

Favorite location of the user if the user is an eClub guest

New email address of the user

External source name (third-party IDP). Possible values for external_source are salesforce, customer_id, mparticle, azure, aws_cognito, auth0, and ext_idp. If you are using a different one, please reach out to your implementation manager to add a new value. The values are case-sensitive. This is a required parameter if you want to update the access token for an external IDP user.

ID of the customer in the mentioned external source name (external_source), a unique identifier generated by the third-party IDP (GUID format). This is a required parameter if you want to update the access token for an external IDP user.

First name of the user

Gender of the user

ID that identifies the user

Last name of the user

Whether the user has subscribed to receive marketing emails or not. Possible values: true, false

Whether the user has subscribed to marketing push notifications or not. Possible values: true, false

Old membership number from the incumbent loyalty program

Value of points from the incumbent loyalty program

Password of the user's account

Password re-typed by the user for confirmation

Phone number of the user

Preferred locale of the user

Favorite location IDs of the user

Whether the user has agreed to the privacy policy to use the app as per the configuration or not

Custom profile fields to be updated. For details, see Updating Custom Profile Fields With the Punchh Platform API.

Secondary email address of the user

State where the user lives

Whether the terms and conditions of a business have been accepted by the user or not. Possible values: true, false

Whether the user is allowed to switch the environment in the mobile application or not. Possible values: true, false

Salutation as selected by the user. Possible values: Mr., Miss, Mrs., Ms., Dr., Rev.

Contains information about the relationship details of a user, for example, spouse and kid information. If the user account does not have relationship details, the API returns an empty object in the response.

Zip code where the user lives