POST /api/v2/projects/:project_id/custom_fields/:field_group_id
Create or update projects custom fields

Field types and validations¶ ↑

date

String in format YYYY-MM-DD. Eg. 2020-01-30

textbox

String

integer

Integer

textarea

String

rich_text

Simple HTML formatting. Allowed tags: p strong em ins ul ol li h1 h2 h3 h4 h5 h6. Everything else is parsed out.

dropdown

String

boolean

Boolean, true/false

datetime

String in format yyyy-mm-ddThh:mm:ss.mmm. Eg. 2021-08-01T00:00:00.000Z

Headers

Header name	Description
Content-Type required	application/json
X-API-KEY required	YOUR_API_KEY

Params

Param name	Description
project_id required	Project ID Validations: Must be a String
field_group_id required	Field group ID Validations: Must be a String
custom_fields required	Custom fields Validations: Must be an array of any type

Examples

// If project is not found
POST /api/v2/projects/not-found-id/custom_fields/23
{
  "custom_fields": {
    "22": "Updated value"
  }
}
404
{
  "error": "project not found"
}

// If custom field group is not found
POST /api/v2/projects/nd5M6d2-Sv6VEShOB5Dj/custom_fields/not-found-id
{
  "custom_fields": {
    "24": "Updated value"
  }
}
404
{
  "error": "Couldn't find FieldGroup with 'id'=not-found-id"
}

// Adding new custom field values for default custom field group
POST /api/v2/projects/F5B-ZjR_4VTjSwRA-Lf2/custom_fields/25
{
  "custom_fields": {
    "25": "New value"
  }
}
200
{
  "custom_fields": {
    "25": {
      "25": "New value"
    }
  },
  "errors": []
}

// Updating existing custom field values for default custom field group
POST /api/v2/projects/pcVcFjq12UbqNd3Yz_yw/custom_fields/26
{
  "custom_fields": {
    "26": "Updated value"
  }
}
200
{
  "custom_fields": {
    "26": {
      "26": "Updated value"
    }
  },
  "errors": []
}

// Adding new custom field values to one complex custom field group
POST /api/v2/projects/xoY0IihXqaxOmoMr_XjR/custom_fields/27
{
  "custom_fields": {
    "27": "New value"
  }
}
200
{
  "custom_fields": {
    "27": [
      {
        "cfg_id": 15,
        "27": "New value"
      }
    ]
  },
  "errors": []
}

// Adding new custom field values to multiple complex custom field groups
POST /api/v2/projects/8JWuRXu2YM0K9zZD_yBF/custom_fields/28
{
  "custom_fields": [
    {
      "28": "New value"
    },
    {
      "29": "New value 2"
    }
  ]
}
200
{
  "custom_fields": {
    "28": [
      {
        "cfg_id": 16,
        "28": "New value"
      }
    ]
  },
  "errors": []
}

// Updating existing custom field values to one complex custom field group
POST /api/v2/projects/0wJApMYic6GMgmfcEBBk/custom_fields/30
{
  "custom_fields": {
    "30": "Updated value",
    "cfg_id": 18
  }
}
200
{
  "custom_fields": {
    "30": [
      {
        "cfg_id": 18,
        "30": "Updated value"
      }
    ]
  },
  "errors": []
}

// Updating existing custom field values to multiple complex custom field groups
POST /api/v2/projects/l-jvYJygTlpCcIMEGS8z/custom_fields/31
{
  "custom_fields": [
    {
      "31": "Updated value",
      "cfg_id": 19
    },
    {
      "31": "Updated value 2",
      "cfg_id": 20
    }
  ]
}
200
{
  "custom_fields": {
    "31": [
      {
        "cfg_id": 19,
        "31": "Updated value"
      },
      {
        "cfg_id": 20,
        "31": "Updated value 2"
      }
    ]
  },
  "errors": []
}

Errors

Code	Description
401	Unauthorized
404	Not found
500	Internal Server Error
422	Missing parameters