Create a Field

post

https://api.rocketlane.com/api/1.0/fields

Query Params

includeFields

array of strings

This query parameter allows you to specify which field properties should be returned in the response body by selecting from the drop down. To get the relevant field properties, use comma separated values. If this field is left blank, the default properties are returned.

includeFields

includeAllFields

boolean

This query parameter allows you to specify if all the field properties should be returned in the response body. If the field is left blank, the default field properties are returned.

Body Params

fieldLabel

string

required

The fieldLabel is the name of the field.

fieldDescription

string

The description of the field.

fieldType

string

enum

required

This defines type of the field. Refer Custom Fields for further information

objectType

string

enum

required

This defines type of object that is associated with the field. This could be TASK, PROJECT or USER.

Allowed:

fieldOptions

array of objects

The fieldOptions params define the value and label for the different options available for SINGLE_CHOICE and MULTIPLE_CHOICE fields.

fieldOptions

ratingScale

string

enum

The number of stars in the Rating Scale when Field Type is RATING.

Allowed:

enabled

boolean

Defaults to true

This depicts if the field is enabled or not. Only those fields which are enabled will reflect in the account.

private

boolean

This depicts if the field is private or not.

Responses

Language

Credentials

Header

URL

Response

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

application/json

201The resource was successfully created in the database.

400This error typically happens when the request payload contains an error. If you want to make sure that the request's parameters are named correctly and are the right data types, you can examine the request's syntax.

401You see this error when trying to access this resource without being authenticated. Check the API request header to make sure it is not empty and has a valid api-key that you acquired from the Rocketlane API Settings tab.