POST/projects/api/v3/projects/:projectId/workflows.json
Applies a workflow to a project
Body Params
Request contains information of a workflow to be created or updated.
- Name
workflow- Type
- object
- Description
- Workflow contains all the information returned from a workflow.
- Name
workflowOptions- Type
- object
Responses
- Code
- 201
- Type
- object
- Schema
- Description
- 201 Created
Response contains information about a specific workflow.
- Code
- 400
- Type
- object
- Schema
- Description
- 400 Bad Request
ErrorResponse defines how []Error should be marshaled to JSON.
- Code
- 403
- Type
- object
- Schema
- Description
- 403 Forbidden
ErrorResponse defines how []Error should be marshaled to JSON.
201 Created
Response
{
"included": {
"companies": {
"additionalProp": {
"accounts": 0,
"addressOne": "string",
"addressTwo": "string",
"budgetDistribution": [
{
"companyId": 0,
"count": 0,
"from": 0,
"to": 0
}
],
"canSeePrivate": true,
"cid": "string",
"city": "string",
"clientManagedBy": {
"id": 0,
"meta": {},
"type": "string"
},
"clients": 0,
"collaborators": 0,
"companyNameUrl": "string",
"companyUpdate": {
"id": 0,
"meta": {},
"type": "string"
},
"contacts": 0,
"countryCode": "string",
"createdAt": "string",
"emailOne": "string",
"emailThree": "string",
"emailTwo": "string",
"fax": "string",
"id": 0,
"industry": {
"id": 0,
"meta": {},
"type": "string"
},
"industryId": 0,
"isOwner": true,
"logoUrl": "string",
"name": "string",
"phone": "string",
"privateNotes": "string",
"privateNotesText": "string",
"profileText": "string",
"profitability": {
"billable": 0,
"billableTime": 0,
"cost": 0,
"expenses": 0,
"loggedTime": 0,
"nonBillableTime": 0,
"profit": 0
},
"state": "string",
"stats": {
"projectCount": 0,
"taskCompleteCount": 0,
"taskCount": 0,
"unreadEmailCount": 0
},
"status": "string",
"tags": [
{
"id": 0,
"meta": {},
"type": "string"
}
],
"updatedAt": "string",
"website": "string",
"zip": "string"
}
},
"projects": {
"additionalProp": {}
},
"stages": {
"additionalProp": {
"color": "string",
"createdAt": "string",
"createdBy": 0,
"deletedAt": "string",
"deletedBy": 0,
"displayOrder": 0,
"id": 0,
"name": "string",
"showCompletedTasks": true,
"taskIds": [
0
],
"updatedAt": "string",
"updatedBy": 0,
"workflow": {
"id": 0,
"meta": {},
"type": "string"
}
}
},
"teams": {
"additionalProp": {
"id": 0,
"name": "string",
"teamLogo": "string",
"teamLogoColor": "string",
"teamLogoIcon": "string"
}
},
"users": {
"additionalProp": {
"avatarUrl": "string",
"canAddProjects": true,
"company": {
"id": 0,
"meta": {},
"type": "string"
},
"companyId": 0,
"companyRoleId": 0,
"deleted": true,
"email": "string",
"firstName": "string",
"id": 0,
"isAdmin": true,
"isClientUser": true,
"isServiceAccount": true,
"lastName": "string",
"lengthOfDay": 0,
"meta": {},
"teams": [
{
"id": 0,
"meta": {},
"type": "string"
}
],
"timezone": "string",
"title": "string",
"type": "string",
"userCost": 0,
"userRate": 0,
"workingHour": {
"id": 0,
"meta": {},
"type": "string"
},
"workingHoursId": 0
}
}
},
"meta": {
"averageSpend": 0,
"limit": 0,
"nextCursor": "string",
"page": {
"count": 0,
"hasMore": true,
"pageOffset": 0,
"pageSize": 0
},
"prevCursor": "string",
"totalCapacity": 0
},
"workflow": {
"createdAt": "string",
"createdBy": 0,
"defaultWorkflow": true,
"id": 0,
"lockdown": {
"id": 0,
"meta": {},
"type": "string"
},
"name": "string",
"projectIds": [
0
],
"projectSpecific": true,
"stages": [
{
"id": 0,
"meta": {},
"type": "string"
}
],
"status": "string",
"updatedAt": "string",
"updatedBy": 0
}
}