espocrm/schema/metadata/streamDefs.json

{
    "$schema": "https://json-schema.org/draft/2020-12/schema",
    "$id": "https://www.espocrm.com/schema/metadata/streamDefs.json",
    "title": "pdfDefs",
    "description": "Stream definitions for a scope.",
    "type": "object",
    "properties": {
        "followingUsersField": {
            "type": "string",
            "description": "A field (of a link-multiple type) that store users which should automatically follow a record. If not set, then the assignedUsers field is checked for existence and then used. E.g. for the Meeting, it's the users field."
        },
        "subscribersCleanup": {
            "type": "object",
            "properties": {
                "enabled": {
                    "type": "boolean",
                    "description": "Enables the cleanup of subscribers."
                },
                "dateField": {
                    "type": "string",
                    "description": "A date (or date-time) field that stores a value after which followers will automatically unfollow a record."
                },
                "statusList": {
                    "type": "array",
                    "items": {
                        "type": "string"
                    },
                    "description": "A list of statuses records should have to be eligible for the subscribers cleanup. "
                }
            },
            "description": "Subscribers cleanup."
        },
        "bypassAssignedUserFollow": {
            "type": "boolean",
            "description": "Assigned users won't follow the record when they get assigned to it. If enabling, consider also enabling `forceAssignmentNotificator` in notificationDefs – otherwise, the assignee won't receive any notification. As of v10.0."
        },
        "allowInternalNotes": {
            "type": "boolean",
            "description": "Allow internal notes. As of v10.0."
        }
    }
}