Update a custom field
PATCH /projects/{projectIdOrKey}/customFields/{customFieldId}
PATCH
/projects/{projectIdOrKey}/customFields/{customFieldId}
Authorizations
Section titled “Authorizations ”Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters ” projectIdOrKey
required
string
customFieldId
required
integer format: int64
Request Body required
Section titled “Request Body required ”object
name
string
description
string
required
boolean
applicableIssueTypes
Array<integer>
min
number format: double
max
number format: double
initialValue
string
unit
string
initialValueType
integer format: int32
initialDate
string format: date
allowInput
boolean
allowAddItem
boolean
items
Array<string>
Responses
Section titled “ Responses ”The request has succeeded.
Custom field definition.
object
id
required
integer format: int64
typeId
required
Custom field type code.
- 1: Text
- 2: TextArea
- 3: Numeric
- 4: Date
- 5: SingleList
- 6: MultipleList
- 7: CheckBox
- 8: RadioButton
number
name
required
string
description
required
string
required
required
boolean
applicableIssueTypes
required
Array<integer>
allowAddItem
required
boolean
items
required
Array<object>
Custom field list item.
object
id
required
integer format: int64
name
required
string
displayOrder
required
integer format: int32
default
Section titled “default ”An unexpected error response.
Error response wrapper returned by all Backlog API error responses.
object
errors
required
Array<object>
Individual error detail returned by the Backlog API.
object
message
required
Error message.
string
code
required
Error code.
- 1: InternalError
- 2: LicenceError
- 3: LicenceExpiredError
- 4: AccessDeniedError
- 5: UnauthorizedOperationError
- 6: NoResourceError
- 7: InvalidRequestError
- 8: SpaceOverCapacityError
- 9: ResourceOverflowError
- 10: TooLargeFileError
- 11: AuthenticationError
- 12: RequiredMFAError
- 13: TooManyRequestsError
integer format: int32
moreInfo
required
Additional information about the error.
string