Create task

post https://api.clientsuccess.com/v2/task

Creates and saves a new task in database

Body Params

dto

assignedToEmployee

object

The DTO of employee entity

attributes

string

Contains attributes of task in comma-separated form

clientId

int32

Id of client

completed

boolean

The completion status of current task

completedByEmployee

object

The DTO of employee entity

completedTime

string

The completed date of current task. This is UTC format of time which always contains 'T' on the middle and 'Z' on the end, such as 2021-12-03T10:15.30.101Z

createdTime

string

The created date of current task. This is UTC format of time which always contains 'T' on the middle and 'Z' on the end, such as 2021-12-03T10:15:30.101Z

creator

object

The DTO of employee entity

description

string

length between 0 and 8000

The description of current task

dueDate

date

The due date of current task. A date without a TZ in the ISO-8601 calendar system, such as 2021-12-03

files

array of objects

The attached files to task

files

futureTask

boolean

groupBy

object

int32

The id of task

links

array of objects

The attached links to task

links

milestone

object

The DTO of milestone entity

modifiedBy

object

The DTO of employee entity

modifiedTime

string

The modified date of current task. This is UTC format of time which always contains 'T' on the middle and 'Z' on the end, such as 2021-12-03T10:15:30.101Z

name

string

length between 0 and 1000

The name of current task

notes

array of objects

The task note

notes

ownedByEmployee

object

The DTO of employee entity

priority

object

project

object

The DTO of project entity

recurring

boolean

Is this task recurring

recurringTaskConfig

object

schedulerType

string

status

object

tags

array of objects

The tag of task

tags

taskBaseId

int32

taskTemplateId

int32

The template id of task

teammateIds

array of int32s

The list of teammates, that will be assigned to current task

teammateIds

teammates

array of objects

Task teammates

teammates

tenantId

int32

The tenant of task

uuid

string

The uuid of task

watcherIds

array of int32s

The list of watchers, that will be assigned to current task

watcherIds

watchers

array of objects

Task watchers

watchers

zapierRequest

boolean

Responses

Response body

object

assignedToEmployee

object

The DTO of employee entity

avatar

string

The avatar of employee

companyName

string

The companyName of employee

companyUrl

string

The companyUrl of employee

external

boolean

The external flag

firstName

string

The firstName of employee

int32

The id of employee

lastName

string

The lastName of employee

tenantId

int32

The tenant id of employee

user

object

The DTO of user entity

uuid

string

The uuid of employee

attributes

string

Contains attributes of task in comma-separated form

clientId

int32

The client of task

completed

boolean

The completion status of current task

completedByEmployee

object

The DTO of employee entity

avatar

string

The avatar of employee

companyName

string

The companyName of employee

companyUrl

string

The companyUrl of employee

external

boolean

The external flag

firstName

string

The firstName of employee

int32

The id of employee

lastName

string

The lastName of employee

tenantId

int32

The tenant id of employee

user

object

The DTO of user entity

uuid

string

The uuid of employee

completedTime

string

The completed date of current task. This is UTC format of time which always contains 'T' on the middle and 'Z' on the end, such as 2021-12-03T10:15.30.101Z

createdTime

string

The created date of current task. This is UTC format of time which always contains 'T' on the middle and 'Z' on the end, such as 2021-12-03T10:15:30.101Z

creator

object

The DTO of employee entity

avatar

string

The avatar of employee

companyName

string

The companyName of employee

companyUrl

string

The companyUrl of employee

external

boolean

The external flag

firstName

string

The firstName of employee

int32

The id of employee

lastName

string

The lastName of employee

tenantId

int32

The tenant id of employee

user

object

The DTO of user entity

uuid

string

The uuid of employee

description

string

length between 0 and 8000

The description of current task

dueDate

date

The due date of current task. A date without a TZ in the ISO-8601 calendar system, such as 2021-12-03

files

array of objects

The attached files to task

files

object

attachmentType

object

clientId

int32

The client of task

createdByEmployee

object

The DTO of employee entity

createdTime

string

The created date of current task. This is UTC format of time which always contains 'T' on the middle and 'Z' on the end, such as 2021-12-03T10:15:30.101Z

icon

string

The icon of attachment

int32

The id of task

modifiedByEmployee

object

The DTO of employee entity

modifiedTime

string

The created date of current task attachment. This is UTC format of time which always contains 'T' on the middle and 'Z' on the end, such as 2021-12-03T10:15:30.101Z

name

string

The name of attachment

taskBaseId

int32

taskBaseUuid

string

tenantId

int32

The tenant of task

url

string

The url of attachment

uuid

string

The uuid of task

visibleToExternalEmployee

boolean

The visible to external employee flag

futureTask

boolean

groupBy

object

name

string

totalCount

int32

value

string

int32

The id of task

links

array of objects

The attached links to task

links

object

attachmentType

object

clientId

int32

The client of task

createdByEmployee

object

The DTO of employee entity

createdTime

string

The created date of current task. This is UTC format of time which always contains 'T' on the middle and 'Z' on the end, such as 2021-12-03T10:15:30.101Z

icon

string

The icon of attachment

int32

The id of task

modifiedByEmployee

object

The DTO of employee entity

modifiedTime

string

The created date of current task attachment. This is UTC format of time which always contains 'T' on the middle and 'Z' on the end, such as 2021-12-03T10:15:30.101Z

name

string

The name of attachment

taskBaseId

int32

taskBaseUuid

string

tenantId

int32

The tenant of task

url

string

The url of attachment

uuid

string

The uuid of task

visibleToExternalEmployee

boolean

The visible to external employee flag

milestone

object

The DTO of milestone entity

completedDate

date

Completed date of milestone

createdBy

object

The DTO of employee entity

createdDateTime

date-time

Created date time of milestone

dueDate

date

Due date of milestone

milestoneTemplateId

int32

The milestone template id

modifiedBy

object

The DTO of employee entity

modifiedDateTime

date-time

Created date time of milestone

name

string

The milestone name

projectUuid

string

The project uuid

startDate

date

Start date of milestone

status

string

The milestone status used for project dashboard

COMPLETED MILESTONE_BEHIND ON_TRACK TASK_BEHIND

tenantId

int32

The tenant id

uuid

string

The milestone uuid

modifiedBy

object

The DTO of employee entity

avatar

string

The avatar of employee

companyName

string

The companyName of employee

companyUrl

string

The companyUrl of employee

external

boolean

The external flag

firstName

string

The firstName of employee

int32

The id of employee

lastName

string

The lastName of employee

tenantId

int32

The tenant id of employee

user

object

The DTO of user entity

uuid

string

The uuid of employee

modifiedTime

string

The modified date of current task. This is UTC format of time which always contains 'T' on the middle and 'Z' on the end, such as 2021-12-03T10:15:30.101Z

name

string

length between 0 and 1000

The name of current task

notes

array of objects

The task note

notes

object

createdEmployee

object

The DTO of employee entity

createdTime

string

The note created time

int32

The note id

modifiedTime

string

The note modified time

note

string

The note note

subject

string

The note subject

tenantId

int32

The tenant id

uuid

string

The note uuid

visibleToExternalEmployee

boolean

The visible to external employee flag

ownedByEmployee

object

The DTO of employee entity

avatar

string

The avatar of employee

companyName

string

The companyName of employee

companyUrl

string

The companyUrl of employee

external

boolean

The external flag

firstName

string

The firstName of employee

int32

The id of employee

lastName

string

The lastName of employee

tenantId

int32

The tenant id of employee

user

object

The DTO of user entity

uuid

string

The uuid of employee

priority

object

code

string

int32

project

object

The DTO of project entity

blocked

boolean

Is the project blocked

blockedReason

string

Is the project blocked reason

client

object

createdBy

object

The DTO of employee entity

createdDateTime

date-time

Created date time of project

description

string

The project description

dueDate

date

Due date of project

milestones

array of objects

Project milestones

milestones

object

completedDate

date

Completed date of milestone

countCompletedTasks

int32

The completed task count

countTotalTasks

int32

The total task count

createdBy

object

The DTO of employee entity

createdDateTime

date-time

Created date time of milestone

dueDate

date

Due date of milestone

milestoneTemplateId

int32

The milestone template id

modifiedBy

object

The DTO of employee entity

modifiedDateTime

date-time

Created date time of milestone

name

string

The milestone name

projectUuid

string

The project uuid

startDate

date

Start date of milestone

status

string

The milestone status used for project dashboard

COMPLETED MILESTONE_BEHIND ON_TRACK TASK_BEHIND

taskId

int32

tenantId

int32

The tenant id

uuid

string

The milestone uuid

modifiedBy

object

The DTO of employee entity

modifiedDateTime

date-time

Created date time of project

name

string

The project name

onHold

boolean

Is the project on hold

onHoldReason

string

Is the project on hold reason

ownedBy

object

The DTO of employee entity

primary

boolean

Is the project primary

startDate

date

Start date of project

status

string

The project status

tenantId

int32

The tenant id

uuid

string

The project uuid

recurring

boolean

Is this task recurring

recurringTaskConfig

object

daysOfWeek

array of strings

daysOfWeek

displayFutureTasks

boolean

endDate

date

neverExpired

boolean

repeatTimes

int32

startDate

date

taskBaseUuid

string

timePeriodType

string

DAILY MONTHLY QUARTERLY WEEKLY YEARLY

timePeriodTypeUnits

int32

schedulerType

string

ENGAGEMENT_CALL ENGAGEMENT_GOOGLE_CALENDAR_EVENT ENGAGEMENT_MEETING TASK

status

object

description

string

int32

tags

array of objects

The tag of task

tags

object

int32

The id of task

label

string

The label of tag

uuid

string

The uuid of task

taskBaseId

int32

taskTemplateId

int32

The template id of task

teammates

array of objects

Task teammates

teammates

object

avatar

string

The avatar of employee

companyName

string

The companyName of employee

companyUrl

string

The companyUrl of employee

external

boolean

The external flag

firstName

string

The firstName of employee

int32

The id of employee

lastName

string

The lastName of employee

tenantId

int32

The tenant id of employee

user

object

The DTO of user entity

uuid

string

The uuid of employee

tenantId

int32

The tenant of task

uuid

string

The uuid of task

watchers

array of objects

Task watchers

watchers

object

avatar

string

The avatar of employee

companyName

string

The companyName of employee

companyUrl

string

The companyUrl of employee

external

boolean

The external flag

firstName

string

The firstName of employee

int32

The id of employee

lastName

string

The lastName of employee

tenantId

int32

The tenant id of employee

user

object

The DTO of user entity

uuid

string

The uuid of employee

zapierRequest

boolean

Language

Credentials

Header


xxxxxxxxxx
1
curl --request POST \
2
     --url https://api.clientsuccess.com/v2/task \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json'

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

application/json

201Created

400Bad Request

403Forbidden

404Not Found

500Internal Server Error