Model mailruns

Permissions

User Group	Create?	Read?	Update?	Delete?
admin	x	x	x	x
owner	x	x	x	x
user	x	x
all

Fields

Name	Type	Link	Maps To	Default	Indexed?	Unique?
__v	Number
_deleted	Boolean			false	x
_id	ObjectID			[Function]
_owner_id	ObjectID	User	_owner		x
_updated_by_id	ObjectID	User	_updated_by		x
code	String				x	x
createdAt	Date
data	Mixed
end_time	Date
failed_reader_ids	Array of ObjectID			[Function]
name	String
queued_reader_ids	Array of ObjectID			[Function]
sent_reader_ids	Array of ObjectID			[Function]
start_time	Date			Tue Nov 04 2025 00:53:27 GMT+0000 (Coordinated Universal Time)
state	String
touchbasetransactional_id	ObjectID	touchbasetransactional
updatedAt	Date

Field Details

__v

{
  "path": "__v",
  "instance": "Number",
  "options": {},
  "validators": []
}

_deleted

{
  "path": "_deleted",
  "instance": "Boolean",
  "options": {
    "default": false,
    "index": true
  },
  "validators": [],
  "defaultValue": false
}

_id

{
  "path": "_id",
  "instance": "ObjectID",
  "options": {
    "auto": true,
    "type": "ObjectId"
  },
  "validators": [],
  "defaultValue": "[Function]"
}

_owner_id

{
  "path": "_owner_id",
  "instance": "ObjectID",
  "options": {
    "link": "User",
    "map_to": "_owner",
    "index": true
  },
  "validators": []
}

_updated_by_id

{
  "path": "_updated_by_id",
  "instance": "ObjectID",
  "options": {
    "link": "User",
    "map_to": "_updated_by",
    "index": true
  },
  "validators": []
}

code

{
  "path": "code",
  "instance": "String",
  "options": {
    "index": true,
    "unique": true
  },
  "validators": []
}

createdAt

{
  "path": "createdAt",
  "instance": "Date",
  "options": {
    "immutable": true
  },
  "validators": []
}

data

{
  "path": "data",
  "instance": "Mixed",
  "options": {},
  "validators": []
}

end_time

{
  "path": "end_time",
  "instance": "Date",
  "options": {},
  "validators": []
}

failed_reader_ids

{
  "path": "failed_reader_ids",
  "instance": "Array",
  "options": {
    "type": [
      {
        "link": "reader",
        "map_to": "sent"
      }
    ]
  },
  "validators": [],
  "defaultValue": "[Function]",
  "arrayType": "ObjectID"
}

name

{
  "path": "name",
  "instance": "String",
  "options": {},
  "validators": []
}

queued_reader_ids

{
  "path": "queued_reader_ids",
  "instance": "Array",
  "options": {
    "type": [
      {
        "link": "reader",
        "map_to": "queued"
      }
    ]
  },
  "validators": [],
  "defaultValue": "[Function]",
  "arrayType": "ObjectID"
}

sent_reader_ids

{
  "path": "sent_reader_ids",
  "instance": "Array",
  "options": {
    "type": [
      {
        "link": "reader",
        "map_to": "sent"
      }
    ]
  },
  "validators": [],
  "defaultValue": "[Function]",
  "arrayType": "ObjectID"
}

start_time

{
  "path": "start_time",
  "instance": "Date",
  "options": {
    "default": "2025-11-04T00:53:27.966Z"
  },
  "validators": [],
  "defaultValue": "2025-11-04T00:53:27.966Z"
}

state

{
  "path": "state",
  "instance": "String",
  "options": {
    "enum": [
      "due",
      "running",
      "complete",
      "cancelled",
      "paused",
      "failed"
    ]
  },
  "validators": [
    {
      "message": "`{VALUE}` is not a valid enum value for path `{PATH}`."
    }
  ]
}

Validators

: `{VALUE}` is not a valid enum value for path `{PATH}`.

touchbasetransactional_id

{
  "path": "touchbasetransactional_id",
  "instance": "ObjectID",
  "options": {
    "link": "touchbasetransactional"
  },
  "validators": []
}

updatedAt

{
  "path": "updatedAt",
  "instance": "Date",
  "options": {},
  "validators": []
}