Skip to main content

LeadNoteDTO

Lead note object — the response row of GET /v1/open-api/lead-note/{leadId}/list, POST /v1/open-api/lead-note/filter and POST /v1/open-api/lead-event/filter. The write body of POST .../list accepts only the subset in LeadNoteSaveRequestDTO.

idint64

Note ID (null when creating)

Example: 7001
isPinboolean

Whether the note is pinned.

Default value: false
Example: false
textstringrequired

Note text. Required, length 1–500.

Possible values: non-empty and <= 500 characters

Example: Client requested a callback
typeLeadNoteType

Lead note type enum.

  • SIMPLE — ordinary note
  • SMS — a sent SMS
  • PHONE — a phone call note

Possible values: [SIMPLE, SMS, PHONE]

Default value: SIMPLE
Example: SIMPLE
leadIdint64nullable

ID of the lead the note belongs to. Response only — ignored if sent in a request. The only way to attribute a note to a lead when it comes back from a company-wide POST /v1/open-api/lead-event/filter or POST /v1/open-api/lead-note/filter (no leadIds in the request).

Example: 26801
createdBy objectnullable

Employee who wrote the note. Response only — ignored if sent in a request. Filter with createdByIds.

idint32

Employee ID

Example: 201
fullNamestring

Employee full name

Example: David Wilson
createdTimestampint64nullable

Time the note was written, epoch seconds. Response only.

Example: 1730000000
deletedBy objectnullable

Employee who deleted the note — pairs with deletedTimestamp. null when not deleted.

idint32

Employee ID

Example: 201
fullNamestring

Employee full name

Example: David Wilson
deletedTimestampint64nullable

Deletion time (epoch seconds); null when not deleted.

Example: null
deletedboolean

true when the note is soft-deleted.

Example: false
files object[]nullable

Files attached to the note. null when the caller path does not load files (GET /v1/open-api/lead-event/filter's note rows); an empty array means no files attached. Populated on GET .../list and POST /v1/open-api/lead-note/filter.

  • Array [
  • absolutePathstringnullable

    Presigned URL to the full-size file

    Example: https://minio.uysot.uz/uysot/files/201/avatar.png?X-Amz-Expires=3600
    thumbAbsolutePathstringnullable

    Presigned URL to the thumbnail rendition

    Example: https://minio.uysot.uz/uysot/files/201/avatar_thumb.png?X-Amz-Expires=3600
    smallestAbsolutePathstringnullable

    Presigned URL to the smallest rendition

    Example: https://minio.uysot.uz/uysot/files/201/avatar_small.png?X-Amz-Expires=3600
  • ]
  • createdByIdint32nullabledeprecated

    Deprecated — use createdBy.id.

    Example: 95
    LeadNoteDTO
    {
    "id": 7001,
    "isPin": false,
    "text": "Client requested a callback",
    "type": "SIMPLE",
    "leadId": 26801,
    "createdBy": {
    "id": 201,
    "fullName": "David Wilson"
    },
    "createdTimestamp": 1730000000,
    "deletedBy": {
    "id": 201,
    "fullName": "David Wilson"
    },
    "deletedTimestamp": null,
    "deleted": false,
    "files": [
    {
    "absolutePath": "https://minio.uysot.uz/uysot/files/201/avatar.png?X-Amz-Expires=3600",
    "thumbAbsolutePath": "https://minio.uysot.uz/uysot/files/201/avatar_thumb.png?X-Amz-Expires=3600",
    "smallestAbsolutePath": "https://minio.uysot.uz/uysot/files/201/avatar_small.png?X-Amz-Expires=3600"
    }
    ]
    }