Sign in

v1

latestOpenAPI 3.0.02026-07-26254134307.1 KB
Contacts

Create teammate contact

Create a contact for a teammate.

Required scope: contacts:write

post/teammates/{teammate_id}/contacts

Path parameters

teammate_idstring required

The teammate ID. Alternatively, you can supply an email as a resource alias.

Request body

namestring

Contact name

descriptionstring

Contact description

avatarstring binary

Binary data of avatar. Must use Content-Type: multipart/form-data if specified. See example or read more about Attachments. Max 25 MB.

linksstring[]

List of all the links of the contact

group_namesstring[]

List of all the group names the contact belongs to. It will automatically create missing groups. ⚠️ Deprecated. Use list_names instead.

list_namesstring[]

List of all the contact list names the contact belongs to. It will automatically create missing groups

custom_fieldsCustomFieldParameter

An object whose key is the name property defined for the custom field in the Front UI. The value of the key must use the same type specified for the custom field, as described in https://dev.frontapp.com/reference/custom-fields

Example request

{
  "custom_fields": {
    "city": "London, UK",
    "isVIP": true,
    "renewal_date": 1525417200,
    "sla_time": 90,
    "owner": "leela@planet-express.com",
    "replyTo": "inb_55c8c149",
    "Job Title": "firefighter"
  },
  "handles": [
    {
      "handle": "dwight@limitlesspaper.com",
      "source": "email"
    }
  ]
}

Response

A contact

idstring

Unique identifier of the contact

namestring

Contact name

descriptionstring

Contact description

avatar_urlstring

URL of the contact's avatar

linksstring[]

List of all the links of the contact

custom_fieldsCustomFieldParameter

An object whose key is the name property defined for the custom field in the Front UI. The value of the key must use the same type specified for the custom field, as described in https://dev.frontapp.com/reference/custom-fields

is_privateboolean

Whether or not the contact is individual

Example response

{
  "_links": {
    "self": "https://yourCompany.api.frontapp.com/contacts/crd_3cgz4ge\"",
    "related": {
      "notes": "https://yourCompany.api.frontapp.com/contacts/crd_3cgz4ge/notes",
      "conversations": "https://yourCompany.api.frontapp.com/contacts/crd_3cgz4ge/conversations"
    }
  },
  "id": "crd_3cgz4ge",
  "name": "Dwight Schrute",
  "description": "Assistant to the regional manager",
  "avatar_url": "https://yourCompany.api.frontapp.com/contacts/crd_3cgz4ge/avatar-1673436467707",
  "groups": [
    {
      "_links": {
        "self": "https://yourCompany.api.frontapp.com/contact_lists/grp_3j342",
        "related": {
          "contacts": "https://yourCompany.api.frontapp.com/contact_lists/grp_3j342/contacts",
          "owner": "https://yourCompany.api.frontapp.com/teammates/tea_e35u"
        }
      },
      "id": "grp_3j342",
      "name": "Party Planning Committee"
    }
  ],
  "lists": [
    {
      "_links": {
        "self": "https://yourCompany.api.frontapp.com/contact_lists/grp_3j342",
        "related": {
          "contacts": "https://yourCompany.api.frontapp.com/contact_lists/grp_3j342/contacts",
          "owner": "https://yourCompany.api.frontapp.com/teammates/tea_e35u"
        }
      },
      "id": "grp_3j342",
      "name": "Party Planning Committee"
    }
  ],
  "handles": [
    {
      "handle": "dwight@limitlesspaper.com",
      "source": "email"
    }
  ],
  "custom_fields": {
    "city": "London, UK",
    "isVIP": true,
    "renewal_date": 1525417200,
    "sla_time": 90,
    "owner": "leela@planet-express.com",
    "replyTo": "inb_55c8c149",
    "Job Title": "firefighter"
  },
  "is_private": true
}