Skip to main content
PUT
Update a Task

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
integer
required

The task identifier.

Body

application/json
taskType
string
required

The type of task. Use List Task Types for valid values.

task
string
required

The task to be completed.

dueDateTime
string<date-time>
required

The due date and time of the task, local to the user. It is normalized the same way as when a task is created.

description
string

Optional. A description of the task. Cleared when left out.

Maximum string length: 4000
contactId
integer

Optional. The contact this task is regarding. Cleared when left out, unless you can't view the task's current contact.

Required range: x >= 1
contactIndividualId
integer

Optional. The contact individual (a person in the contact's household) this task is regarding. Requires contactId, and the individual must belong to that contact. Cleared when left out.

Required range: x >= 1

Response

OK

id
integer
taskType
string
task
string
description
string | null
dueDateTime
string

The due date of the task in the current user's time zone.

dueDateTimeUtc
string<date-time>

The due date of the task in UTC. Read responses return it without a trailing Z; treat the value as UTC.

taskStatus
enum<string>

The task status. Voided is set by Virtuous only and can't be set or changed through the API.

Available options:
NotStarted,
InProgress,
Blocked,
Completed,
Dismissed,
Voided
taskStatusDisplayName
string

The display name of the task status, such as In Progress.

taskKind
enum<string>

The kind of task: Reminder (a regular task), Project (a communication task), Grant, or GiftAsk. Only Reminder tasks can be edited with Update a Task.

Available options:
Reminder,
Project,
Grant,
GiftAsk
taskKindDisplayName
string

The display name of the task kind, such as Communication Task.

resolutionDateTimeUtc
string<date-time> | null

When the task was completed or dismissed, in UTC (returned without a trailing Z). Null while the task is unresolved.

isResolved
boolean

Whether the task has been completed or dismissed.

isPastDue
boolean

Whether the task is unresolved and past its due date. Use this value rather than comparing dueDateTimeUtc yourself, because due dates are normalized to a fixed time of day.

contactId
integer | null
contactIndividualId
integer | null

The contact individual this task is regarding. Null when the task has none or you can't view the task's contact.

contact
string | null
contactUrl
string<uri> | null
createDateTimeUtc
string<date-time>
modifiedDateTimeUtc
string<date-time>
createdByUser
string
createdByAvatarUrl
string | null
modifiedByUser
string