Task Field

Create Task Field

POST

Creates a new TaskFields for a specific Project within your Workspace.

A TaskField is a custom field defined within your Workspace for a specific Project. You can define TaskFields for any integration purpose that is important to your business. Each TaskField has a data type as well as options in how it is handled. TaskFields can be edited for each Task inside this Project.

Path parameters

projectIdstringRequired
The unique identifier of the Project within which to create this TaskField

Request

This endpoint expects an object.
name
stringOptional
The name of the TaskField
type
stringOptional

The type of this TaskField. Valid types are the following:

  • Text
  • Number
  • Date
  • Checkbox
  • Currency
  • Dropdown

Response

This endpoint returns an object
error
objectOptional
If the API call failed, this will contain information about the error that occurred.
success
booleanOptional
True if the API call succeeded; false otherwise.
hasError
booleanOptional
True if the API call failed.
statusCode
enumOptional
The HTTP code of the response.
data
objectOptional
Returns the id of a specific ChangeSet
POST
1curl -X POST /project-api/public/projects/projectId/tasks/fields \
2     -H "Authorization: Bearer <token>" \
3     -H "Content-Type: application/json" \
4     -d '{}'
200Successful
1{
2  "error": {
3    "message": "message"
4  },
5  "success": true,
6  "hasError": true,
7  "statusCode": "Continue",
8  "data": {
9    "changeSetId": "changeSetId",
10    "id": "id"
11  }
12}
Built with