Contacts

A contact is a person/entity with whom you have communicated.

A contact has several handles to send messages to it. A handle has a source to identify which inbox can send message to this contact:

SourceDescriptionExample
emailAn email address[email protected]
phoneA phone number+123445678900
twitterA twitter handlecalculon
facebookA Facebook user ID
intercomAn Intercom user ID
smoochA Smooch user ID
customCustom handle provided in the Recieve custom messages endpoint

Each pair handle/source is unique. If you want to move an existing handle from one contact to an other, you need to delete it from the first one and add it to the other one.

📘

Contact alias

You can use a contact source/handle pair as an alias for its ID. A contact ID alias follows the pattern alt:{source}:{handle}

Search Parameters

Contacts support search queries via parameter named q

NameTypeDescription
updated_beforenumber (optional)Timestamp of the max date of the last update
updated_afternumber (optional)Timestamp of the min date of the last update

Example Contact Object

{
  "_links": {
    "self": "https://api2.frontapp.com/contacts/crd_55c8c149",
    "related": {
      "notes": "https://api2.frontapp.com/contacts/crd_55c8c149/notes",
      "conversations": "https://api2.frontapp.com/contacts/crd_55c8c149/conversations",
      "owner": "https://api2.frontapp.com/teams/tim_55c8c149"
    }
  },
  "id": "crd_55c8c149",
  "name": "Calculon",
  "description": "#vip #robot #RIP",
  "avatar_url": "http://example.com/calculon.jpg",
  "is_spammer": true,
  "links": [
    "http://example.com"
  ],
  "handles": [
    {
      "handle": "@calculon",
      "source": "twitter"
    }
  ],
  "groups": [
    {
      "_links": {
        "self": "https://api2.frontapp.com/contacts/grp_55c8c149",
        "related": {
          "contacts": "https://api2.frontapp.com/contact_groups/grp_55c8c149/contacts",
          "owner": "https://api2.frontapp.com/teams/tim_55c8c149"
        }
      },
      "id": "grp_55c8c149",
      "name": "Customers",
      "is_private": false
    }
  ],
  "updated_at": 0,
  "custom_fields": {
    "job title": "engineer",
    "custom field name": "your value"
  },
  "is_private": false
}