Create task type

post

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

This endpoint can be used to create a task type. In the request you provide a session ID in the header and task type details in the body.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

categoryId

string

Task type category ID (required)

name

string

required

Task type name (required)

description

string | null

Task type description

groupIds

array of strings | null

Group IDs

groupIds

defaultTaskName

string | null

Default task name

defaultTaskDescription

string | null

Default task description

checklistIds

array of strings | null

Default checklist IDs

checklistIds

defaultTaskDuration

int64 | null

Default task duration in milliseconds

requireSignature

boolean | null

If true, a recipient signature is required to complete/close the task

defaultMinPlanDays

integer | null

Default minimum days after creation before scheduling is allowed

defaultMinPlannedDate

int64 | null

Default earliest schedulable date as a Unix timestamp

defaultPlanningRange

int64 | null

Default arrival tolerance window (milliseconds)

issueTypeIds

array of strings | null

Issue type IDs

issueTypeIds

defaultBillingClientId

string | null

Default billing client ID

filePaths

array of strings | null

File paths to attach

filePaths

defaultTagIds

array of strings | null

Default tag IDs

defaultTagIds

createAccess

array of strings | null

Who can create a task

createAccess

requestSuggestionAccess

array of strings | null

Who can request scheduling suggestions

requestSuggestionAccess

requestExtraTimeslotsAccess

array of strings | null

Who can request extra scheduling timeslots

requestExtraTimeslotsAccess

maxDeltaTravelTime

int64 | null

Maximum allowed increase in route travel time (milliseconds)

maxTravelTimeFromBase

int64 | null

Maximum travel time from base to first appointment (milliseconds)

maxTravelTimeToBase

int64 | null

Maximum travel time from last appointment to base (milliseconds)

maxRescheduleTime

int64 | null

Max time before task start when rescheduling is allowed (milliseconds)

maxUnscheduleTime

int64 | null

Max time before task start when unscheduling is allowed (milliseconds)

ignoreTravelTime

boolean | null

If true, ignore travel time in scheduling rules

defaultRequireAvailability

boolean | null

Default 'require availability' setting for tasks created with this task type. If true, tasks must, by default, be scheduled within defined availabilities

archived

boolean

Defaults to false

Whether the task type is archived

Headers

bsy-sid

string

required

Session ID

Responses

200Task type created successfully

400Bad request, invalid task type details

401Unauthorized access, invalid or missing session ID