Create project

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

Creates and saves a new project in database

Body Params

dto

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

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

Responses

Response body

object

blocked

boolean

Is the project blocked

blockedReason

string

Is the project blocked reason

client

object

assignedCsm

string

assignedCsmId

int32

assignedSalesRep

string

city

string

clientArr

number

country

string

dispositionId

int32

externalId

string

helpScoutId

string

hubspotId

string

int32

inceptionDate

date

intercomId

string

lastModifiedDate

date-time

lastTouchDate

date

logoUrl

string

name

string

nextRenewalDate

date-time

nps

int32

pipedriveId

string

salesforceAccountId

string

salesforceId

string

segment

string

segmentId

int32

state

string

status

string

street

string

successScore

int32

terminatedDate

date

timezone

string

usageId

string

uuid

string

zip

string

zohoId

string

createdBy

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

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

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

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

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

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

Language

Credentials

Header


xxxxxxxxxx
1
curl --request POST \
2
     --url https://api.clientsuccess.com/v2/project \
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