Update Custom Field

Updates Custom Field.

Role

Administrator
Project Administrator

Method

PATCH

URL

/api/v2/projects/:projectIdOrKey/customFields/:id

URL Parameters

Parameter Name Type Description
projectIdOrKey String Project ID or Project Key
id Number Custom Field ID

Form Parameters

Request Header

Content-Type:application/x-www-form-urlencoded
Parameter Name Type Description
name (Required) String Name
applicableIssueTypes[] Number Type ID to enable Custom fields
empty=enable for all issue types
description String Description
required Boolean True to make the Custom field required

Added parameters (Number)

Parameter Name Type Description
min Number minimum value
max Number maximum value
initialValue Number initial value
unit String unit

Added parameters (Date)

Parameter Name Type Description
min String minimum (YYYY-MM-DD)
max String maximum (YYYY-MM-DD)
initialValueType Number 1:today, 2: today + initialShift, 3:specified day
initialDate String initial (YYYY-MM-DD)
initialShift Number date differences

Added parameters (List)

Parameter Name Type Description
items[] String list
allowInput Boolean true to allow add list
allowAddItem Boolean true to allow add list

Response Example

Status Line / Response Header

HTTP/1.1 200 OK
Content-Type:application/json;charset=utf-8

Response Body

{
    "id": 2,
    "typeId": 1,
    "name": "Attribute for Bug",
    "description": "",
    "required": false,
    "applicableIssueTypes": [1]
}