TimelineNoteCreate

Fields

4 fields

ends_on

string (date) or null

starts_on · required

string (date)

suite_name

string or null

text · required

string

Raw schema (JSON)

{
  "additionalProperties": false,
  "properties": {
    "ends_on": {
      "anyOf": [
        {
          "format": "date",
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Ends On"
    },
    "starts_on": {
      "format": "date",
      "title": "Starts On",
      "type": "string"
    },
    "suite_name": {
      "anyOf": [
        {
          "maxLength": 500,
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Suite Name"
    },
    "text": {
      "maxLength": 280,
      "title": "Text",
      "type": "string"
    }
  },
  "required": [
    "starts_on",
    "text"
  ],
  "title": "TimelineNoteCreate",
  "type": "object"
}

Used by endpoints

One endpoint sends or returns this schema, on its own or inside another schema.

• POST /api/v1/projects/{project_id}/timeline-notes — Create Timeline Note

Used by schemas

No other schema contains this one.

More details

• Specification: OpenAPI JSON