Project Field

Update ProjectField Value

PUT

Replaces the current value of a ProjectField for a specific Project within your Workspace.

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

Path parameters

projectIdstringRequired
The unique identifier of the Project that contains this ProjectField
fieldIdstringRequired
The unique identifier or short ID of this ProjectField

Request

This endpoint expects an object.
value
stringOptional
The new value to be set for this ProjectField.

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.
PUT
1curl -X PUT /api/data/projects/projectId/fields/fieldId \
2 -H "Authorization: Bearer <token>" \
3 -H "Content-Type: application/json" \
4 -d '{}'
200
Updated
1{
2 "error": {
3 "technicalError": "technicalError",
4 "additionalErrors": [
5 "additionalErrors"
6 ],
7 "message": "message"
8 },
9 "success": true,
10 "hasError": true,
11 "statusCode": "Continue"
12}