User Input (Object)

address_line1
Type: string

Address information (part 1) of the user
age_verified
Type: boolean

Whether age is verified or not
age_verified_status
Type: boolean

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.
allow_multiple
Type: boolean

Whether multiple check-ins are allowed for the user or not
allow_push_notifications
Type: boolean

Whether the user has allowed push notifications or not
anniversary
Type: string

Anniversary of the user, in YYYY-MM-DD format. This field gets updated in the database only if the user did not set it at time of sign-up.
apn_token
Type: string

Apple Push Notification (APN) token
avatar_remote_url
Type: string

Avatar URL of the user profile image
birthday
enum
const:
YYYY-MM-DD

Birthday 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, the API returns a 200 response, but the birthday is not updated.
city
Type: string

City where the user lives
email
Type: string

Email address of the user
external_source
Type: string

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.
external_source_id
Type: string

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.
favourite_locations
Type: string

Favorite locations of the user (comma-separated for multiple locations)
first_name
Type: string

First name of the user
gcm_token
Type: string

Google Cloud Messaging (GCM) or FCM token
gender
Type: string

Gender of the user. Valid values are "male", "female", or "declined".
last_name
Type: string

Last name of the user
marketing_email_subscription
Type: boolean

Whether the user has subscribed to receive marketing emails or not. This is mandatory if Explicit Opt-in is enabled in the Punchh platform.
marketing_pn_subscription
Type: boolean

Whether the user has subscribed to receive marketing push notifications or not
phone
Type: string

Phone number of the user
preferred_locale
Type: string

Preferred locale of the user
privacy_policy
Type: boolean
profile_field_answers
Type:

Answers given by the user while filling in the user profile. The user submits answers to profile field questions that are configured in the Punchh platform. A total of 25 answers can be submitted. The keys range from 'upf0' to 'upf24'. If questions have multiple answers, the values should be separated by a | character (pipe).

Properties: 3
secondary_email
Type: string

Secondary email address of the user
state
Type: string

State where the user lives
terms_and_conditions
Type: boolean

Whether the user has agreed to the terms and conditions to use the app as per the configuration
title
Type: string

Title of the user. Possible values are Mr., Mrs., Miss, Ms., and Dr.
unsubscribed
Type: boolean

Whether the user has unsubscribed from marketing email notifications
user_relations
Type:

The object 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 user_relations object in the response.

Properties: 4
work_zip_code
Type: string

Zip code of the user's office
zip_code
Type: string

Zip code where the user lives

Examples

{
  "address_line1": "ADDRESS_GOES_HERE",
  "anniversary": null,
  "avatar_remote_url": "URL_GOES_HERE",
  "birthday": "1993-01-01",
  "city": "Columbus",
  "email": "test@example.com",
  "first_name": "FIRST_NAME_GOES_HERE",
  "age_verified": true,
  "privacy_policy": true,
  "gender": "female",
  "last_name": "LAST_NAME_GOES_HERE",
  "state": "Ohio",
  "zip_code": "43016",
  "allow_multiple": true,
  "favourite_locations": "",
  "marketing_email_subscription": true,
  "marketing_pn_subscription": true,
  "profile_field_answers": {
    "upf0": "Coffee|Tea|Lemonade",
    "upf1": "Pasta|Pizza|Hamburger",
    "upf2": "Movies|Music|Sports"
  },
  "secondary_email": "test@example.com",
  "terms_and_conditions": true,
  "title": "",
  "user_relations": [
    {
      "relation": "spouse",
      "name": "SPOUSE_NAME_GOES_HERE",
      "birthday": "1999-01-01"
    }
  ],
  "work_zip_code": "",
  "preferred_locale": "",
  "phone": "1111111111",
  "unsubscribed": true,
  "allow_push_notifications": true,
  "apn_token": "APN_TOKEN_GOES_HERE",
  "gcm_token": "GCM_TOKEN_GOES_HERE",
  "external_source": "customer_id",
  "external_source_id": "11111111111111111111"
}

User (Object)

User Relation Attributes (Object)