Hello 👋 How can we help?

Customer fields and format

Written by Konstantine
Updated 1 month ago

This is the list of the customer fields you can send to HelpCrunch with add customer method.

User structure:

user_id: string – needed for user update / optional for new user – unique user ID, there are a lot of tricks here, please check the user authentication mode section to be sure you do everything right
email: string – optional – must be a valid email, not unique
name: string – optional – any string, not unique
company: string – optional – any string, not unique
phone: string – optional – any string, not unique, no checks for number
source: string – optional – url string, not unique, it’s the web page on your site what your customer opened first
referrer: string – optional – url string, not unique, it’s about the web page from which the user came to your application
first_seen: string – optional – date string, in “YYYY-MM-DD HH:MM:SS” format, it’s when your customer first appeared at your project
heard_from: string – optional – date string, in “YYYY-MM-DD HH:MM:SS” format, last time when your customer messaged you
blocked: string – optional – boolean, block email from that customer
unsubscribed: string – optional – boolean, do not send auto-messages to this customer
status: string – optional – number (1 – new, 2 – open, 3 – pending, 4 – hold, 5 – no communication, 6 – resolved, 7 – rejected)
custom_data: object – optional – an object with random key/value pairs, where value cannot be another object or array, be aware that all keys your pass there will appear as filters in your HelpCrunch account’s advanced search. Read more about it in the custom data section
tags: array – optional – array of objects with required string parameter “name” (case sensitive) and optional string parameter color (like “#FF0000”). Example { “name”: “Bug”, “color”: “#FF0000” }

Did this answer your question?