API ReferenceProject Field

Update ProjectField Value

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.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

projectIdstringRequiredformat: "uuid"
The unique identifier of the Project that contains this ProjectField
fieldIdstringRequired
The unique identifier or short ID of this ProjectField

Headers

x-integration-namestringOptional
The name of the calling system passed along as a header parameter

Request

The new information for this ProjectField
valuestringOptional
The new value to be set for this ProjectField.

Response

Success
errorobject or null
If the API call failed, this will contain information about the error that occurred.
successboolean or null

True if the API call succeeded; false otherwise.

hasErrorboolean or null
True if the API call failed.
statusCodeenum or null
The HTTP code of the response.