{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/frontapp/json-schema/frontapp-contact-schema.json",
  "title": "Contact",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/frontapp-contacts-api-openapi.yml#/components/schemas/Contact",
  "properties": {
    "name": {
      "type": "string",
      "description": "Contact name"
    },
    "description": {
      "type": "string",
      "description": "Contact description"
    },
    "avatar": {
      "type": "string",
      "description": "Binary data of avatar. Must use `Content-Type: multipart/form-data` if specified. See [example](https://gist.github.com/hdornier/e04d04921032e98271f46ff8a539a4cb) or read more about [Attachments](https://dev.frontapp.com/docs/attachments-1).  Max 25 MB.",
      "format": "binary"
    },
    "links": {
      "type": "array",
      "description": "List of all the links of the contact",
      "items": {
        "type": "string"
      }
    },
    "group_names": {
      "type": "array",
      "description": "List of all the group names the contact belongs to. It will automatically create missing groups. ⚠️ Deprecated. Use `list_names` instead.",
      "items": {
        "type": "string"
      }
    },
    "list_names": {
      "type": "array",
      "description": "List of all the contact list names the contact belongs to. It will automatically create missing groups",
      "items": {
        "type": "string"
      }
    },
    "custom_fields": {
      "description": "Custom fields for this contact. If you want to keep all custom fields the same when updating this resource, do not include any custom fields in the update. If you want to update custom fields, make sure to include all custom fields, not just the fields you want to add or update. If you send only the custom fields you want to update, the other custom fields will be erased. You can retrieve the existing custom fields before making the update to note the current fields.",
      "$ref": "#/$defs/CustomFieldParameter"
    }
  },
  "$defs": {
    "CustomFieldParameter": {
      "type": "object",
      "description": "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"
    }
  }
}