UPDATE Master Tasks

API documentation for updating master tasks, including endpoint details, parameters, permissions, and response examples.

Update Master Task

Update an existing master task with new information such as name, description, favorite status, position assignments, and color.

Permissions

Minimum Role Required: Supervisor

Users with Supervisor and above roles can update master tasks that belong to their company.

API Endpoint

Method: PATCH

URL: {baseUrl}/api/v2/master-tasks/{taskId}?access_token={token}

Parameters

ParameterTypeRequiredDescription
namestringoptionalThe name of the master task
descriptionstringoptionalDescription of the master task
favoritebooleanoptionalWhether the task is marked as favorite
positionIdsarray of intoptionalArray of position IDs associated with the task
colorstringoptionalColor code for the task (hex format)

Request Example

{
    "name": "Write API documentation -> edited"
}

Response Example

{
    "status": 1,
    "data": {
        "id": "01k6d0xksd04t0ztrhbzqettb0",
        "companyId": 11,
        "name": "Write API documentation -> edited",
        "description": "",
        "favorite": false,
        "color": "#B0BFC5",
        "positionIds": [
            62580
        ],
        "createdBy": 39737,
        "createdAt": "2025-09-30T09:58:05+00:00",
        "updatedBy": 2,
        "updatedAt": "2025-09-30T14:19:32+00:00",
        "deletedBy": null,
        "deletedAt": null
    },
    "metadata": [],
    "token": "token",
    "error": null
}

Response Fields

FieldTypeDescription
statusintegerResponse status (1 for success)
dataobjectUpdated master task data
data.idstringUnique identifier for the master task
data.companyIdintegerID of the company the task belongs to
data.namestringName of the master task
data.descriptionstringTask description
data.favoritebooleanFavorite status
data.colorstringTask color in hex format
data.positionIdsarrayArray of associated position IDs
data.createdByintegerID of user who created the task
data.createdAtstringCreation timestamp
data.updatedByintegerID of user who last updated the task
data.updatedAtstringLast update timestamp
data.deletedByintegerID of user who deleted the task (null if not deleted)
data.deletedAtstringDeletion timestamp (null if not deleted)
metadataarrayAdditional metadata
tokenstringAccess token
errorstringError message (null on success)
Language
Credentials
Query
Click Try It! to start a request and see the response here!