Contents

Update Custom Field

Updates Custom Field.

Role

Administrator
Project Administrator

Method

PATCH

URL

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

URL parameters

Parameter NameTypeDescription
projectIdOrKeyStringProject ID or Project Key
idNumberCustom Field ID

Form parameters

Content-Type:application/x-www-form-urlencoded
Parameter NameTypeDescription
nameStringName
applicableIssueTypes[]
(複数指定可)
NumberType ID to enable Custom fields
empty=enable for all issue types
descriptionStringDescription
requiredBooleanTrue to make the Custom field required

Added parameters (Number)

Parameter NameTypeDescription
minNumberminimum value
maxNumbermaximum value
initialValueNumberinitial value
unitStringunit

Added parameters (Date)

Parameter NameTypeDescription
minStringminimum (yyyy-MM-dd)
maxStringmaximum (yyyy-MM-dd)
initialValueTypeNumber1:today, 2: today + initialShift, 3:specified day
initialDateStringinitial (yyyy-MM-dd)
initialShiftNumberdate differences

Added parameters (List)

Parameter NameTypeDescription
items[]
(複数指定可)
Stringlist
allowInputBooleantrue to allow add list
allowAddItemBooleantrue 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,
    "projectId": 5,
    "typeId": 1,
    "name": "Attribute for Bug",
    "description": "",
    "required": false,
    "applicableIssueTypes": [1]
}