GEgetaptly
Tasks

Create a task

Creates a task. When aptletInstanceId is set, the task is also mirrored as a checklist entry on that card.

The task is attributed to an acting user who must belong to the company. With a delegate token the user is taken from the token. With an API key (no associated user), supply userId in the body — it must belong to the company or the request is rejected.

post/api/tasks

Request

Request body

userIdstring

Acting user the task is attributed to (createdBy/updatedBy). Required with API-key auth (must belong to the company); ignored with a delegate token, which supplies the user itself.

titlestring required
assigneeIdstring required

User id the task is assigned to.

dueAtstring date-time required
typestring required

Follow-up type — one of email|comment|sms|voice|card|note|task|logActivity.

notestring

Task description.

statusstring

One of backlog|notStarted|inProgress|onHold|completed.

prioritystring

One of asap|high|medium|low.

logTypestring

Required when type is "logActivity".

aptletInstanceIdstring

Card id — when set the task is mirrored onto the card checklist, and its aptletUuid is taken from the card (a supplied one is ignored). 404 if the card doesn't exist.

aptletUuidstring

Board UUID. Taken from the card instead when aptletInstanceId is set.

channelIdstring
streamIdstring
fieldIdstring

Checklist array field on the card (defaults to "checklist").

attachmentIdsstring[]
referencesobject[]

Response

Task created.

taskIdstring

Changes

No recorded changes to this operation across all 1 revision of this API.