Field types and validations

date

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

textbox

String

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

Errors

Code Description
401 Unauthorized
500 Internal Server Error
422 Missing parameters

Examples

POST /api/v2/projects/Co2vT3wBW4fR4Me28n3h/custom_fields/30
{
  "custom_fields": {
    "21": "test"
  }
}
200
{
  "custom_fields": {
    "30": {
      "21": "test"
    }
  },
  "errors": []
}
POST /api/v2/projects/C42vT3wBW4fR4Me2-n3Y/custom_fields/31
{
  "custom_fields": [
    {
      "cfg_id": 9,
      "22": "test_value5",
      "23": "test_value6"
    }
  ]
}
200
{
  "custom_fields": {
    "31": [
      {
        "22": "test_value1",
        "23": "test_value2",
        "cfg_id": 8
      },
      {
        "22": "test_value5",
        "23": "test_value6",
        "cfg_id": 9
      }
    ]
  },
  "errors": []
}
POST /api/v2/projects/DI2wT3wBW4fR4Me2GX2t/custom_fields/32
{
  "custom_fields": {
    "not-found": "test"
  }
}
200
{
  "custom_fields": null,
  "errors": [
    {
      "not-found": "Field not found"
    }
  ]
}
POST /api/v2/projects/not-found-id/custom_fields/33
{
  "custom_fields": {
    "25": "test"
  }
}
404
{
  "error": "project not found"
}
POST /api/v2/projects/Do2wT3wBW4fR4Me2IX3h/custom_fields/not-found
{
  "custom_fields": {
    "26": "test"
  }
}
404
{
  "error": "Field group not found"
}

Params

Param name Description
field_group_id
required

Field group ID

Validations:

  • Must be a String

custom_fields
optional

Custom fields

Validations:

  • Must be an array of any type

Headers

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