Contact

A contact is a record in Front Contact Manager.

Properties

Property

Type

Description

id

String

ID of the contact.

name

String (optional)

Name of the contact.

description

String (optional)

Description of the contact.

groupIds

Array of Contact Group IDs

IDs of the groups the contact belongs to.

handles

Array of Contact Handles

Handles used by the contact.

customAttributes

Array of Custom Attributes

Custom attributes.

Contact Group

Contacts can be organized by group.

Property

Type

Description

id

String

ID of the group.

name

String

Name of the group.

Contact Handle

A handle represents a way to communicate with the contact. A handle can have multiple types:

  • email for emails
  • phone for text messages and phone call
  • twitter for Twitter
  • custom for Custom channels
  • facebook for Facebook Messenger
  • intercom for Intercom
  • smooch for Smooch
  • frontChat for Front Chat
  • whatsapp for Whatsapp
  • googlePlay for Google Play reviews

Property

Type

Description

handle

String

Handle used to send and receive messages.

type

String

Type of the handle.

Custom attributes

Front Contact Manager supports user-defined attributes on each contacts. Each Custom Attribute has a type which defines the type of its value:

  • string for a String
  • datetime for a Date
  • boolean for a Boolean
  • number for a Number
  • teammateId for the ID of a teammate

Property

Type

Description

id

String

ID of the attribute.

name

String

Human readable name.

type

String

Type of the attribute.

value

Variable

Value of the attribute.