Create task

post

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

This endpoint can be used to create a task. A client and location can also be set in this request. If successful, a task ID will be returned to the caller.

Body Params

name

string

Task name

taskTypeId

string

required

Task type ID

locationId

string

required

Task location ID

clientId

string

Task client ID

groupIds

array of strings

Group IDs

groupIds

description

string

Task description

status

string

enum

Task status - open or concept

Allowed:

checklistIds

array of strings

Task checklist IDs

checklistIds

tagIds

array of strings

Task tag IDs

tagIds

url

string

User provided URL

filePaths

array of strings

A list of file paths. You can get a file path by uploading a file through the create file endpoint

filePaths

plannedDate

int64

Task planned date, Unix Timestamp in ms

requireAvailability

boolean

Require to plan the task within an availability

minPlannedDate

int64

Task minimum planned date, Unix Timestamp in ms

maxRescheduleTime

int64

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

maxUnscheduleTime

int64

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

expirationDate

int64

Task expiration date, Unix Timestamp in ms

duration

number

Task duration in ms

plannedForUserId

string

Task planned for user ID

billingClientId

string

Task billing client ID

clientReference

string

Task client reference

createdByUserId

string

User ID of task creator

props

object

Custom fields

Headers

bsy-sid

string

required

Session ID

Responses

Language

URL

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Task created successfully

400Bad request, missing required fields or invalid data

401Unauthorized access, invalid or missing session ID