Custom Profile Fields allow a business or brand to customize their user sign-up and overall experience. When engaging the Punchh API to update Custom Profile Fields, there are some key things to note.
When creating Custom Profile Fields with the API, ensure the following:
Include the “profile_field_answers” parameter within the user object.
Sending profile_field_answers will overwrite any existing values, so when updating one custom profile field, if there is a need to keep any other profile fields the same, they need to be included in the request.
When editing your user’s answers, refer to the Punchh Platform Settings > Profile Fields.
With the Punchh API, you can only edit each field based on its original placement on this page. Each item is referred to as a line named “upf” and a number indicating which line you are editing. These IDs are from upf0-upf24 for a max of 25 possible profile fields. The below screenshot provides a visual of these fields and their identification.
Note: You cannot use the platform API and edit custom profile fields by their associated “code” field. This field is used only in Online Ordering and Mobile APIs.
For any responses with multiple answers, separate each answer with a pipe. ( | For example: blue | red | pink )
Once Profile Fields have been edited, you’ll see your custom fields on the guest’s timeline under Edit Profile.