sso_update_user_information

Update User Information

​

Updates details in the user profile, such as first name, last name, birthday, anniversary, or change password.

Note: 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.

Headers
  • x-pch-digest
    Type: string
    required

    The signature for the API call

  • Content-Type
    Type: string
    required

    Set this header to application/json.

  • Accept
    Type: string
    required

    Advertises which content types the client is able to understand

  • User-Agent
    Type: string
    required

    For details, see User Agent.

  • Authorization
    Type: string
    required

    You may pass the access_token instead of the authentication_token in Online Ordering endpoints to authorize the request. It must be supplied as Bearer ACCESS_TOKEN_GOES_HERE. Note: When authentication is performed using Advanced Authentication, you must include the id_token in the id-token header and the access_token in the Authorization header. See Access Punchh APIs Using Access and ID tokens

  • id-token
    Type: string

    A token that contains identity information about the authenticated user. It is used to verify the user’s identity and is required only when authentication is performed using Advanced Authentication. This token alone does not grant access to Punchh APIs. To access the APIs, you must include the id_token in the id-token header and the access_token in the Authorization header. See Access Punchh APIs Using Access and ID tokens

Body
application/json
  • authentication_token
    Type: string

    The authentication token of the user. You can retrieve this from the response of a successful sign-in API call or through the SSO process.

  • client
    Type: string
    required

    Client key of the business

  • user
    Type: User Input (Object)
Responses
  • 200
    Type: User (Object)
    • access_token
      Type: string

      Security token that identifies the user

    • address_line1
      Type: string

      Address information (part 1) of the user

    • age_verified_status
      Type: boolean

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

    • 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
      Format: dateenum
      const:  
      YYYY-MM-DD

      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.

      • YYYY-MM-DD
    • authentication_token
      Type: string

      The authentication token of the user. You can retrieve this from the response of a successful sign-in API call or through the SSO process.

    • avatar_remote_url
      Type: string

      Avatar URL of the user profile image

    • birthday
      Format: dateenum
      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 at time of sign-up.

      • YYYY-MM-DD
    • city
      Type: string

      City where the user lives

    • communicable_email
      Type: string

      Email address where emails should be sent

    • created_at
      Format: date-timeenum
      const:  
      YYYY-MM-DDThh:mm:ssZ

      Date/time when the user was created in the system, in ISO 8601 format

      • YYYY-MM-DDThh:mm:ssZ
    • email
      Type: string
      required

      Email address of the user

    • email_unsubscribe
      Type: string

      Unsubscribed email address of the user

    • email_verified
      Type: boolean

      Whether the email address is verified or not

    • expiration_date
      Format: dateenum
      const:  
      YYYY-MM-DD

      This value will be returned only if "Account re-evaluation strategy" is set to Guest Inactivity. All other cases return a NULL value.

      • YYYY-MM-DD
    • facebook_signup
      Type: boolean

      Indicates whether the user signed up using Facebook. This parameter returns true the first time a user signs up using Facebook. For all subsequent logins, it returns a false value.

    • favourite_locations
      Type: string

      List of the user's favorite locations

    • favourite_store_numbers
      Type: string

      List of store numbers of the user's favorite locations

    • fb_uid
      Type: integer

      Unique Facebook ID of the user

    • first_name
      Type: string

      First name of the user

    • gender
      Type: string

      Gender of the user

    • id
      Type: integer

      Unique ID of the user

    • 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

    • marketing_pn_subscription
      Type: boolean

      Whether the user has subscribed to receive marketing push notifications or not

    • migrate_status
      Type: boolean

      Whether the user has been migrated or not

    • mindbody_client_id
    • passcode_configured
      Type: boolean

      Whether the passcode has been configured or not

    • phone
      Type: string

      Phone number of the user

    • preferred_locale
      Type: string

      Preferred locale of the user

    • profile_field_answers
      Type: Profile Field Answers (Object)

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

    • referral_code
      Type: string

      The user's referral code. The user can share this referral code to refer others to join the business loyalty program. When a referred user signs up and enters the shared referral code, this referral_code must be passed in the invite_code request parameter when calling the Create New User API.

    • referral_path
      Type: string

      URL that points to the referred path

    • 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 used for the user (e.g., Mr., Mrs., etc.)

    • updated_at
      Format: date-timeenum
      const:  
      YYYY-MM-DDThh:mm:ssZ

      Date/time when the user was updated in the system, in ISO 8601 format

      • YYYY-MM-DDThh:mm:ssZ
    • user_as_barcode
      Type: integer

      Unique user ID in barcode format

    • user_as_qrcode
      Type: string

      Unique user ID in QR code format

    • user_code
      Type: string
    • user_id
      Type: integer

      Unique user ID

    • user_joined_at
      Format: date-timeenum
      const:  
      YYYY-MM-DDThh:mm:ssZ

      Sign-up anniversary date of the user, in YYYY-MM-DDThh:mm:ssZ format

      • YYYY-MM-DDThh:mm:ssZ
    • user_relations
      Type: array User Relations (Array Object)[]

      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.

    • wants_menu_notifications
      Type: boolean

      Whether the user wants to receive menu notifications or not

    • work_zip_code

      Zip code of the user's office

    • zip_code
      Type: string

      Zip code of the user

  • 401
  • 412

    Sending invalid Signature

  • 422

    Sending invalid Entity

put/api/auth/users
{
  "address_line1": "string",
  "anniversary": "YYYY-MM-DD",
  "avatar_remote_url": "string",
  "birthday": "YYYY-MM-DD",
  "city": "string",
  "created_at": "YYYY-MM-DDThh:mm:ssZ",
  "email": "string",
  "email_verified": true,
  "fb_uid": 1,
  "first_name": "string",
  "gender": "string",
  "id": 1,
  "last_name": "string",
  "state": "string",
  "updated_at": "YYYY-MM-DDThh:mm:ssZ",
  "zip_code": "string",
  "allow_multiple": true,
  "authentication_token": "string",
  "favourite_locations": "string",
  "favourite_store_numbers": "string",
  "marketing_email_subscription": true,
  "marketing_pn_subscription": true,
  "passcode_configured": true,
  "profile_field_answers": {
    "upf0": "string",
    "upf1": "string",
    "upf2": "string"
  },
  "referral_code": "string",
  "referral_path": "string",
  "secondary_email": "string",
  "terms_and_conditions": true,
  "title": "string",
  "user_as_barcode": 1,
  "user_as_qrcode": "string",
  "user_code": "string",
  "user_id": 1,
  "user_relations": [
    {
      "id": 1,
      "name": "string",
      "relation": "string",
      "birthday": "YYYY-MM-DD"
    }
  ],
  "wants_menu_notifications": true,
  "work_zip_code": null,
  "mindbody_client_id": null,
  "preferred_locale": "string",
  "phone": "string",
  "migrate_status": true,
  "email_unsubscribe": "string",
  "allow_push_notifications": true,
  "facebook_signup": true,
  "communicable_email": "string",
  "access_token": "string",
  "expiration_date": "YYYY-MM-DD",
  "user_joined_at": "YYYY-MM-DDThh:mm:ssZ",
  "age_verified_status": true
}