SmartMatchApp

Create Board Field

Create a custom field on a board.

Example Request:
curl "https://<your-agency>.smartmatchapp.com/api3/tasks/boards/1/fields/" \
    -u <token>: \
    -X POST \
    -d "name=budget" \
    -d "label=Budget" \
    -d "kind=1"

A Select field (kind=2) with its options:

curl "https://<your-agency>.smartmatchapp.com/api3/tasks/boards/1/fields/" \
    -u <token>: \
    -X POST \
    -d "name=priority" \
    -d "label=Priority" \
    -d "kind=2" \
    -d 'choices=[[1,"Low"],[2,"Medium"],[3,"High"]]'
Request Parameters:

name: Required. Machine name (slug: letters, numbers, underscores). Must be unique on the board.

label: (Optional) Human-readable label shown in the UI. Defaults to name.

kind: Required. Field-type integer (see the table below).

order: (Optional) Sort position (float). Defaults to the end of the list.

choices: Only for Select / Multiselect fields. A JSON list of [value, label] options, where value is the number you store and send when setting the field, and label is the text shown to the user. Example: [[1,"Low"],[2,"Medium"],[3,"High"]]. Ignored for other field types.

Field Types (kind):

0 = Short Text   7 = Long Text   1 = Integer Number   8 = Fractional Number

6 = Date   9 = Time   12 = Birthday (Age)

11 = Height (ft & in)   15 = Height (cm - ft & in)   16 = Weight (International)

2 = Select   3 = Multiselect   10 = Yes/No

13 = Web Link   21 = Email   17 = Phone Number

Example Success Response:
{
    "id": 5,
    "name": "budget",
    "label": "Budget",
    "kind": 1,
    "order": 0.0
}
Base Request:

Method: POST

Authentication: Basic Authentication. Requires a valid <token> passed.

Rate Limits:

10 requests within 10 seconds

Error Responses:
400 Bad Request

This error occurs if name or kind is missing or invalid, or a field with the same name already exists on the board.
Possible errors: "A field with this name already exists on the board."
401 Unauthorized

This error occurs when the <token> is missing, invalid, or the API access is disabled.

Possible errors: "not authenticated" or "token is disabled" or "Agency API is disabled"
405 Method Not Allowed

This error occurs if an HTTP method other than POST is used.
Possible errors: "wrong method"
429 Too Many Requests

This error occurs when the client has sent too many requests in a given amount of time, leading to rate limiting by the server.

Possible errors: "too many requests"
500 Server Error

Possible errors: "Internal server error"