TaskListItem

One follow-up task in the task list: the task itself, the record it hangs off, and who and what it is about.

  • createdUtc
    Type: stringFormat: date-time
    required

    When the task was filed (UTC).

  • dueDateUtc
    Type: stringFormat: date-time
    required

    The instant the task is due (UTC). A task is overdue once this instant has passed.

  • id
    Type: string
    required

    The task identifier — pass it to the complete, cancel, reopen, move and replace endpoints of the record the task hangs off.

  • overdue
    Type: boolean
    required

    True when the due instant has passed.

  • subject
    Type:
    required

    The record the task hangs off. type is contact, company or prospect — change the task through that record's task endpoints with this id — or offer for a task you filed on an offer you received, whose id is the offer at /api/v1/offers/{id} and whose name is the offer's title. Tasks on received offers are read-only over this API for now.

    Properties: 3
  • type
    Type: enum
    required

    The kind of follow-up: call, meeting, email.

    values
    callmeetingemail
  • assignee
    Type: nullable

    The team member the task is assigned to; omitted when unassigned.

    Properties: 2
  • company
    Type: nullable

    The company the task is about, when one is known; omitted on a received offer.

    Properties: 3
  • completedUtc
    Type: null | stringFormat: date-time

    When the task was completed (UTC); set only on completed tasks (the done7 window).

  • contact
    Type: nullable

    The person the task is about, when one is known; omitted on a received offer.

    Properties: 3
  • note
    Type: null | string

    The words kept on the task; omitted when it has none.

  • project
    Type: nullable

    The project a prospect's task belongs to; omitted on other tasks and on a received offer, whose project you see only as the offer.

    Properties: 3
Propstreet Documentation