For AI agents: the complete documentation index is available at https://docs.clickmax.io/en/llms.txt, the full documentation bundle is available at https://docs.clickmax.io/en/llms-full.txt, and this page is available as Markdown at https://docs.clickmax.io/en/reference/fields.md.
  • English
  • 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.

    FieldTypeConstraintRequired
    nametextYes
    emailemail5–255 characters, email formatNo
    telephonetextmax. 20, digits only with optional + (^\+?\d+$)No
    instagramtextNo
    tagIdslist of tagsIDs (UUID) of existing tagsNo
    customFieldValueslistcustom field valuesNo

    Contact — edit

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

    FieldTypeConstraintRequired
    nametextNo
    emailemail5–255 characters, email formatNo
    telephonetextmax. 20, ^\+?\d+$No
    addressobjectaddressNo
    citytextNo
    statetextNo
    professiontextNo
    languagetextNo
    genderIdentityenummale, female, otherNo
    documenttextNo
    birthdaydatedate (YYYY-MM-DD)No
    isSmsbooleanNo
    instagramtextNo
    telegramUsernametextNo
    linkedintextNo
    twitterXtextNo
    tiktoktextNo
    youtubetextNo
    whatsappNumbertextNo
    originenumcontact originNo
    observationstextNo

    Opportunity — create card

    Fields accepted when creating an opportunity in a pipeline.

    FieldTypeConstraintRequired
    leadIdslistIDs (UUID) of contactsYes
    pipelineIdUUIDdestination pipelineYes
    stageIdUUIDdestination stageYes
    titletextNo
    valueinteger≥ 0 (in cents)No
    probabilityinteger0–100No
    attendantIdslistIDs (UUID) of attendantsNo
    productIdslistIDs (UUID) of productsNo
    offerIdslistIDs (UUID) of offersNo
    companyIdUUIDlinked companyNo
    funnelIdUUIDsource funnelNo
    priorityenumurgent, high, medium, low, noneNo
    temperatureenumhot, warm, cold, frozenNo
    expectedClosingDatetext (date)expected closing dateNo
    origintextopportunity origin (defaults to ManualCreated)No
    referredBytextreferred byNo
    isRecurringbooleanrecurring opportunityNo
    customFieldValueslistcustom field valuesNo

    Custom field — configuration

    Fields accepted when creating a custom field in the CRM.

    FieldTypeConstraintRequired
    entityTypeenumleads, opportunitiesYes
    fieldNametext1–100 charactersYes
    displayNametext1–200 charactersYes
    fieldTypeenumsee the table belowYes
    descriptiontextmax. 500 charactersNo
    requiredbooleanNo
    uniquebooleanNo
    defaultValueanydefault valueNo
    optionslistlabel/value pairs (for selection)No
    formulatextexpression (formula type)No
    ordernumberdisplay orderNo
    groupNametextmax. 100 charactersNo
    showInListbooleanshow in the listNo
    showInDetailbooleanshow in the detail viewNo
    showInCreatebooleanshow on creationNo
    showOnCardbooleanshow on the cardNo
    pinnedbooleanpinNo
    filterablebooleanallow filteringNo

    Custom field types (fieldType)

    ValueDescription
    textShort text
    textareaLong text
    numberNumber
    currencyMonetary value
    percentagePercentage
    dateDate
    booleanTrue/false
    selectSingle selection
    multi_selectMultiple selection
    radioSingle option (radio)
    ratingRating
    linkLink
    fileFile
    formulaFormula
    jsonJSON

    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.