Create a Field

post

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

Create a custom field for PROJECT, TASK, USER, or COMPANY object types. fieldType NOTE is allowed for PROJECT and COMPANY. For NOTE fields, optional fieldOptions are stored as tags.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

The Create a field API allows users to create a new field in your Rocketlane account. This endpoint provides a way for developers to add field related details, including the field label, description, field type and field options in case it is a SINGLE_CHOICE, MULTIPLE_CHOICE, or NOTE type field. For NOTE fields, optional fieldOptions are stored as tags on the field and returned as fieldOptions in responses. fieldType NOTE is allowed for PROJECT and COMPANY object types. You can also enable or disable the field and set its privacy setting.

To customise the response, utilise the includeFields parameter, and it will return the created field object in the response body.

📘
The order of the field options will be preserved as provided during field creation.

In case, any issues arise or further assistance is required, please refer to the error handling section or reach out to our support team at [email protected] for a prompt resolution.

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

Allowed:

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, USER, BUDGET or COMPANY.

Allowed:

fieldOptions

array of objects

The fieldOptions params define the label and color for options on SINGLE_CHOICE and MULTIPLE_CHOICE fields. For NOTE fields, fieldOptions are stored as tags on the field and returned as fieldOptions in responses. The same applies when adding, updating, or deleting options on NOTE 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

The order of the field options will be preserved as provided during field creation.

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.