PUT/projects/api/v3/customfields/{customFieldId}.json

Update an existing custom field.

Updates an existing custom field.

Path Params

  • Name
    customFieldId
    Type
    integer
    required
    Description

Body Params

Request contains information of a custom field to be created or updated.

    • Name
      customfield
      Type
      object
      Description
      CustomField contains all the information returned from a custom field.

    Responses

    • Code
      200
      Type
      object
      Schema
      Description
      200 OK
      Response contains information about a specific customfield.
    • Code
      400
      Type
      object
      Schema
      Description
      400 Bad Request
      ErrorResponse defines how []Error should be marshaled to JSON.
    • Code
      403
      Type
      object
      Schema
      Description
      403 Forbidden
      ErrorResponse defines how []Error should be marshaled to JSON.
    • Code
      404
      Description
      404 Not Found No Data
    • Code
      409
      Type
      object
      Schema
      Description
      409 Conflict
      ErrorResponse defines how []Error should be marshaled to JSON.

    Examples

    200 OK

    Response
    {
  "count": 0,
  "customfield": {
    "createdAt": "string",
    "createdBy": 0,
    "createdByUserId": 0,
    "currencyCode": "string",
    "deleted": true,
    "deletedAt": "string",
    "deletedBy": 0,
    "deletedByUserId": 0,
    "description": "string",
    "entity": "string",
    "formula": "string",
    "groupId": 0,
    "id": 0,
    "isPrivate": true,
    "name": "string",
    "project": {
      "id": 0,
      "meta": {},
      "type": "string"
    },
    "projectId": 0,
    "required": true,
    "type": "string",
    "updatedAt": "string",
    "updatedBy": 0,
    "updatedByUserId": 0,
    "visibilities": [
      "string"
    ]
  }
}