Skip to main content

Overview

A Profile is a reusable, named bundle of custom attributes — plus a badge color and authoring defaults — that you attach to a record to extend and segment it. Profiles are a shared feature: contacts, organizations, and users all adopt them. Assigning a profile to a contact gives that contact the profile’s attribute schema and applies its defaults. A contact can hold several profiles at once, reflecting different roles (a Customer, a Member, a Student). For the bigger picture, see the Customer Data overview.
Profiles is one shared feature surfaced per object type. This is its canonical reference; the per-object behaviour (on contacts, organizations, and users) all flows from here.

Where to find it

Profiles live under Customer Data → Profiles, grouped by type — Contacts, Organizations, Users.

Properties

PropertyTypeRequiredDescription
titlestringYesDisplay name (e.g. Customer Profile).
slugstringYesIdentifier — unique per object type.
descriptionstringNoOptional description.
badge_colorstringNoA color for the profile’s badge, for visual grouping.
typeenumYesleads, contacts, vendors, organizations, or users — used for grouping and segmentation.
object_typestringYesThe host object the profile applies to (contacts, organizations, users).
attributesarrayNoThe attributes this profile bundles.

Attributes

A profile bundles a validated set of attributes for its object type. When a record adopts the profile, it gains those attributes — so the same contact can carry Customer fields and Member fields by adopting both profiles.

Authoring defaults

Beyond attributes, a profile carries authoring defaults applied to records that adopt it:

Behaviour & rules

  • Multiple profiles per record — a contact, organization, or user can adopt several profiles; their attributes combine.
  • Slug is unique per object type — the same slug can exist for a contacts profile and an organizations profile.
  • Renames propagate — changing a profile’s title, slug, or badge color updates the profile shown on every record that adopted it.
  • Relationship scoping — a custom relationship can target a specific profile, so a link applies only to records of that profile.

Seeds

Profiles travel between environments as structural Seeds. A profile carries its title, slug, type, object type, and the attributes it bundles (referenced by slug):
[
  {
    "object_type": "profiles",
    "data": {
      "title": "Customer Profile",
      "slug": "customer-profile",
      "type": "contacts",
      "object_type": "contacts",
      "attributes": ["pet_name", "favorite_book", "monthly_expenses"]
    }
  }
]

Governance & permissions

Only a super admin or Master can create, edit, and delete profiles.

API access

Profiles have full CRUD, plus operations to read and set a profile’s default workflow, and to attach or detach profiles on a contact or user. See the API reference.

Contacts

Contacts that adopt profiles.

Organizations

Organizations also adopt profiles.

Attributes

The fields a profile bundles.

Custom Relationships

Relationships scoped to a profile.