Update field by Id

put

https://api.rocketlane.com/api/1.0/fields/{fieldId}

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

The Update field by Id API enables users to update and alter project-specific data based on the fieldId, which is a unique identifier. Developers can update field related information, including the label, description, etc. This API returns the updated field object.

By making requests to this endpoint and incorporating the necessary updates in the request body, users can seamlessly manage and maintain up-to-date field related information in their Rocketlane applications.

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

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.

Path Params

fieldId

int64

required

≥ 0

Defaults to 1

The field's unique, system-generated identifier, which can be used to identify the field globally.

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

The fieldLabel is the name of the field.

fieldDescription

string

The description of the field.

enabled

boolean

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

200The requested action was successfully executed.

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.

404If we were unable to locate the resource you were looking for or the proper API endpoint you were looking for, this error would show up.