Skip to main content

ContactDTO

CRM lead contact information object, as returned when reading a lead (in contacts). When writing a contact in a create/update body, use ContactRequestDTO instead.

idint64

Contact ID (null when creating)

Example: 1001
namestringrequired

Contact name (required)

Example: John Doe
fields object[]

Contact custom field values.

  • Array [
  • idint64

    Field ID this value belongs to

    Example: 1
    valuestring

    Simple value (as text)

    Example: VIP
    valueListstring[]

    Multiple values (for multi-select fields).

    Example: ["VIP","New"]
    valueTypeValueType

    Field value type enum.

    Possible values: [STREET, DISTRICT, DEFAULT]

    Default value: DEFAULT
    Example: DEFAULT
    typestring

    Field type (lowercased, e.g. text, select)

    Example: select
    infoTypeInfoType

    Which entity a field/value belongs to.

    • LED — the lead
    • CONTACT — the contact

    Possible values: [LED, CONTACT]

    Example: LED
    longitudedouble

    Geo coordinate: longitude (for location fields)

    Example: 69.2401
    latitudedouble

    Geo coordinate: latitude (for location fields)

    Example: 41.2995
    numbernumber

    Value for NUMBER fields. Populated instead of value.

    Example: 1500.5
    currencyIdint64

    Currency ID, present when the NUMBER field's format is CURRENCY.

    Example: 24
  • ]
  • typeContactType

    Contact type enum.

    Possible values: [SIMPLE, TELEGRAM, INSTAGRAM, WEBSITE, FACEBOOK, OTHER, CALL_PBX, MARKETPLACE, GOOGLE_SHEETS, WEB_FORM, WAZZUP, AMO_CRM, TELEGRAM_BUSINESS]

    Default value: SIMPLE
    Example: TELEGRAM
    accountIdstring

    Account ID (if available)

    Example: acc123
    usernamestring

    Username

    Example: johndoe
    phonesstring[]required

    Phone numbers (required, non-empty).

    Possible values: >= 1

    Example: ["+998901234567"]
    receiverIdstring

    Receiver ID (if available)

    Example: rec123
    ContactDTO
    {
    "id": 1001,
    "name": "John Doe",
    "fields": [
    {
    "id": 1,
    "value": "VIP",
    "valueList": [
    "VIP",
    "New"
    ],
    "valueType": "DEFAULT",
    "type": "select",
    "infoType": "LED",
    "longitude": 69.2401,
    "latitude": 41.2995,
    "number": 1500.5,
    "currencyId": 24
    }
    ],
    "type": "TELEGRAM",
    "accountId": "acc123",
    "username": "johndoe",
    "phones": [
    "+998901234567"
    ],
    "receiverId": "rec123"
    }