Update task

post

{backendUrlScheme}://{backendUrlHost}/api/public/task/update

This endpoint can be used to update a task. You must provide a session ID in the header and a task ID in the body.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

taskId

string

ID of the task to update

tagIds

array of strings | null

Task tag IDs

tagIds

name

string

Task name, status cannot be completed or cancelled

locationId

string

Task location ID, status should be open or concept

clientId

string

Task client ID, status cannot be completed or cancelled

groupIds

array of strings | null

Group IDs

groupIds

billingClientId

string

Task billing client ID, status cannot be completed or cancelled

duration

number

Task duration, duration in ms, status cannot be completed or cancelled

clientReference

string | null

Task client reference, status cannot be completed or cancelled

description

string | null

Task description, status cannot be completed or cancelled

checklistIds

array of strings | null

Task checklist IDs, status cannot be completed or cancelled

checklistIds

expirationDate

int64 | null

Task expiration date, Unix timestamp in ms, status cannot be completed or cancelled

requireAvailability

boolean | null

Require to plan the task within an availability, status cannot be completed or cancelled

maxRescheduleTime

int64 | null

Maximum time period before the scheduled task start time during which a client is allowed to reschedule.

maxUnscheduleTime

int64 | null

Maximum time period before the scheduled task start time during which a client is allowed to unschedule.

minPlannedDate

int64 | null

Task minimum planned date, Unix timestamp in ms, status cannot be completed or cancelled

planningRange

number | null

Task planning range in ms, status cannot be completed or confirmed. Supported values: Fixed: 0, XXS (15 min): 900000, XS (30 min): 1800000, S (60 min): 3600000, M (90 min): 5400000, L (120 min): 7200000, XL (150 min): 9000000, XXL (180 min): 10800000, Unlimited: 86400000, status cannot be completed or cancelled

url

string | null

User provided URL, status cannot be completed or cancelled

filePaths

array of strings | null

A list of file paths. You can get a file path by uploading a file through the create file endpoint, status cannot be completed or cancelled

filePaths

props

object

Custom fields, status cannot be completed or cancelled

Headers

bsy-sid

string

required

Session ID

Responses

200Task updated successfully

400Bad request, missing required fields or invalid data

401Unauthorized access, invalid or missing session ID