Objects

The Contact object comprises the following fields

Workflow:

JSON

{
  "phone": "5551234567",
  "name": "John Doe",
  "first_name": "John",
  "last_name": "Doe",
  "email": "[email protected]",
  "street": "123 Maple Street",
  "city": "Springfield",
  "zipcode": "12345",
  "url": "https://www.johndoewebsite.com",
  "icon": "https://www.johndoewebsite.com/icon.png",
  "source": "UNIQUE12356",
  "descr": "This is a sample description for John Doe.",
  "custom1": "Custom field 1 data",
  "custom2": "Custom field 2 data",
  "custom3": "Custom field 3 data",
  "custom4": "Custom field 4 data",
  "custom5": "Custom field 5 data",
  "group": [ "46","48"],
  "action": [ "23", "26" ],
  "create_time": "11/22/2024 12:53pm CDT",
  "update_time": "04/15/2025 01:15am CDT",
  "sent_time": "02/22/2025 06:27pm CDT"
}

Basic contact fields (can be imported)

• phone - Phone number, will be used as rupid by default
• name - Full contact name
• first_name - First name of contact
• last_name - Last name of contact
• email - Email address of contact
• street - Street address of contact
• city - City name of contact
• zipcode - Zip/postal code of contact
• county - 2-digit country code of contact (e.g. "US" )
• url - General purpose url (e.g. http://acme.com )
• icon - Contact specific icon url
• descr - General purpose description
• question - General purpose question

Reference fields (can be imported)

• source - Source is mostly to keep unique reference in your system
• custom1 - General purpose custom fields (1-5) to be used in message placeholders or shorturls
• custom2
• custom3
• custom4
• custom5

System fields

• group - List of groups this contact belongs to, during import a group is created automatically
• action - List of projects this contact has been contacted in
• reaction - List of projects this contact replied to
• create_time - Time the contact was first created/imported (ISO 8601 format)
• update_time - Last time the contcat was manually updated (ISO 8601 format)
• sent_time - Last time the contact received a message or sent a message (ISO 8601 format)
• flags - Contains all of the tags applied to the contact, both defined by you and system tags. Here are the reserved system tags:
  • dnd - Do Not Disturb (system-applied and non-removable tag when the contact has opted out with a STOP request)
  • bad - Opt-Out (user-applied and removable tag when a contact has opted out using language other than a STOP request)
  • landline - This number has been checked against the landline database and is a landline
  • unreachable - After several messages with failed deliveries, this contact is deemed unreachable
  • replied - The contact has replied
  • rude - The contact used profanity or was otherwise marked as rude
  • tester - This contact has been sent test texts
  • optin - This contact has opted in to keyword or form for receiving texts