#Fields

Reference for the fields accepted by the CRM forms and API when you create or edit a contact, an opportunity or a custom field. Each table lists the field name, the type, the constraint and whether it is required.

Role required: creating or editing contacts and creating opportunities requires the Owner, Admin, Editor or Attendant role in the workspace — the Viewer, Finance and Guest roles cannot perform those writes. When creating an opportunity, an Attendant also has to be assigned to the destination pipeline. Creating custom fields only requires being an authenticated workspace member. See what each role covers in Permissions.

Plan: the CRM is included in every plan; the contact volume is capped by your plan — see Contact limit.

#Contact — create

Fields accepted when adding a contact manually.

#Contact — edit

Fields accepted when updating a contact. All are optional; sending null clears the field.

#Contact origin (origin)

The origin records where the contact entered your base. It is written on first touch and shows up in the Contact Origin column of the contact list, in the contact profile and in the Entry channels card. The same values are available as the Origin condition in filters, segments, automation conditionals and funnel conditionals.

#Contact sub-origin (subOrigin)

The sub-origin details the origin when the same module captures in more than one way. When the contact has a sub-origin, that is what the Contact Origin column shows, next to the origin badge. In specialist mode it has its own Sub-origin column, and in filters and segments it exists as the Sub-origin condition (or Origin or sub-origin, which searches both fields at once).

When the origin is Integrations, the sub-origin is the name of the platform that sent the contact: ActiveCampaign, Asaas, Braip, Cartpanda, Eduzz, Greenn, Guru, Hotmart, HotWebinar, Hubla, Kiwify, Kommo, Manychat, Monetizze, Pagarme, PerfectPay, Principia, Stripe, Ticto, TMB, VStage, Vunel, WebinarKit or Yampi.

#Opportunity — create card

Fields accepted when creating an opportunity in a pipeline.

#Custom field — configuration

Fields accepted when creating a custom field in the CRM.

#Custom field types (fieldType)

#Related

• API reference — endpoints that accept these fields.
• Permissions — the role required for each write.
• Import contacts — bulk loading these fields.
• Error codes — validation responses.

#If it didn't work

• You hit your plan's ceiling when saving a contact → Contact limit.
• A field or button is unavailable → your role does not allow the action; see No permission.
• A value was rejected in validation → check the constraint in the table and the Error codes.