Guides

Custom Fields

Suggest Edits

You can create account-specific custom fields for tasks, projects, and users in your Rocketlane account to provide additional information, such as a "priority" field with a range of priority level choices.

In addition to the default field types Rocketlane offers, you can select the field type for the custom fields you create. Once custom fields are created, you cannot change the field type. You have the option to always remove an old custom field and replace it with a new one with the changed field type.

Custom field types available in Rocketlane

Field TypeDefinition
TEXTAn arbitrary, relatively short string of text
MULTI_LINE_TEXTAn arbitrary, relatively long string of text
YES_OR_NOGives users a boolean choice between yes or no
DATEUsed to record the date of occurrence of an event
(the format for the date field is: YYYY-MM-DD)
SINGLE_CHOICEA selection of a single option from a defined list of options
(i.e., mutually exclusive selections)
MULTIPLE_CHOICEA selection of one or more options from a defined list of options
(i.e., mutually inclusive selections)
SINGLE_USEROnly one team member can be picked
MULTIPLE_USERMultiple team members can be picked
RATINGThis option allows the team members to rate the specific custom field based on the total rating scale provided

(Only available for project fields)
NUMBERA number with a defined level of precision

Examples of Response for the Get all fields API

  • Example of response body for a search request returning a YES_OR_NO field type:
{
    "fieldId":11,
    "fieldLabel":"Billable",
    "objectType":"TASK"
}
  • Example of response body for a search request returning a SINGLE_CHOICE field type:
{
    "fieldId":12,
    "fieldLabel":"Priority",
    "objectType":"TASK",
    "fieldOptions":[
        {
            "optionValue":1,
            "optionLabel":"Low"
        },
        {
            "optionValue":2,
            "optionLabel":"Medium"
        },
        {
            "optionValue":3,
            "optionLabel":"High"
        }
    ]
}

Examples of Requests and Responses for Assigning Custom Field Values

Example of Text field type request and response body for updating a resource

Request:

{
    "fields":[
        {
            "fieldId":12,
            "fieldValue":"Rocketlane Onboarding Project"
        }
    ]
}

Response:

{
    "fieldId":215,
    "fieldLabel":"Project alias Name",
    "fieldValue":"Rocketlane APIs"
}

Example of Multiline Text field type request and response body for updating a resource

Request:

{
    "fields":[
        {
            "fieldId":13,
            "fieldValue":"This is a long content.\n It can be split in to multiple lines as well"
        }
    ]
}

Response:

{
    "fieldId":216,
    "fieldLabel":"Project Notes",
    "fieldValue":"MultiLine text line 1\nMultiLine text line 2"
}

Example of Number field type request and response body for updating a resource

Request:

{
    "fields":[
        {
            "fieldId":14,
            "fieldValue":10000.0
        }
    ]
}

Response:

{
    "fieldId":217,
    "fieldLabel":"Setup Fee",
    "fieldValue":10000.0
}

Example of Yes/No field type request and response body for updating a resource

Request:

{
    "fields":[
        {
            "fieldId":15,
            "fieldValue":true
        }
    ]
}

Response:

{
    "fieldId":218,
    "fieldLabel":"Enterprise Customer",
    "fieldValue":true
}

Example of Date field type request and response body for updating a resource

Request:

{
    "fields":[
        {
            "fieldId":16,
            "fieldValue":"2023-07-19"
        }
    ]
}

Response:

{
    "fieldId":219,
    "fieldLabel":"Launch Date",
    "fieldValue":"2023-07-19"
}

Example of Single Choice field type request and response body for updating a resource

For single choice field, optionValue refers the unique identifier for each option and optionLabel refers to the name of each option added for that custom field.

Let us consider an example of a single choice field Priority and the options for the field are Low, Medium and High. The table below shows the mapping between the optionLabel and its corresponding optionValue

optionLabeloptionValue
Low1
Medium2
High3

Request:

{
    "fields":[
        {
            "fieldId":17,
            "fieldValue":1
        }
    ]
}

Response:

{
    "fieldId":17,
    "fieldLabel":"Priority",
    "fieldValue":1
}

Example of Multiple Choice field type request and response body for updating a resource

For multiple choice field, optionValue refers the unique identifier for each option and optionLabel refers to the name of each option added for that custom field.

Let us consider an example of a multiple choice field Region and the options for the field are USA, UK, Canada and India. The table below shows the mapping between the optionLabel and its corresponding optionValue

optionLabeloptionValue
USA1
UK2
Canada3
India4

Request:

{
    "fields":[
        {
            "fieldId":18,
            "fieldValue":[
                1,
                4
            ]
        }
    ]
}

Response:

{
    "fieldId":221,
    "fieldLabel":"Region",
    "fieldValue":[
        1,
        2
    ]
}

Example of Single user field type request and response body for updating a resource

For single user fields, fieldValue is userId of the user you want to assign to that particular field.

Request:

{
    "fields":[
        {
            "fieldId":19,
            "fieldValue":300
        }
    ]
}

Response:

{
    "fieldId":19,
    "fieldLabel":"CSM",
    "fieldValue":300
}

Example of Multi user field type request and response body for updating a resource

For multi user fields, fieldValue is an array of the userIds you want to assign to that particular field

Request:

{
    "fields":[
        {
            "fieldId":20,
            "fieldValue":[
                323,
                355
            ]
        }
    ]
}

Response:

{
    "fieldId":223,
    "fieldLabel":"Support Team",
    "fieldValue":[
        323,
        355
    ]
}

Updated 7 months ago