SmartMatchApp

Update Board Field

Update a custom field's label, order or choices. The field's name and kind cannot be changed.

Example Request:
curl "https://<your-agency>.smartmatchapp.com/api3/tasks/boards/1/fields/5/" \
    -u <token>: \
    -X PUT \
    -d "label=Project Budget" \
    -d "order=2"
Request Parameters:

label: (Optional) New human-readable label.

order: (Optional) New sort position (float).

choices: (Optional) Select / Multiselect only. JSON list of [value, label] options, e.g. [[1,"Low"],[2,"High"]]. Replaces the existing option list.

Only the fields present in the request body are updated. A successful update returns 204 No Content.

Base Request:

Method: PUT

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

Rate Limits:

10 requests within 10 seconds

Error Responses:
400 Bad Request

This error occurs if a value is invalid.
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"
404 Not Found

This error occurs if no field with the given id exists on the board.
Possible errors: "not found"
405 Method Not Allowed

This error occurs if an HTTP method other than PUT 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"