SoftSolzSoftSolz
HomeAPI GuideAPI ReferenceWidget Tester
Tasks

Replace the fields for a scope, workspace-wide (category_id null) or for one category. At most 50 fields. Values already saved on tasks are kept

PUThttps://app.softsolz.uk/api/v1/services/tasks/field-defs

Recent Requests

Kept only in this browser
TimeStatusTook
Send a request with Try it to see it here.

Headers

Authorizationstringrequired

Bearer token: Bearer sk_live_... (or sk_test_... for sandbox). A login token will not work here.

Idempotency-Keystring

Optional idempotency key for safe retries.

Body Params

scopestring

Who fills these fields: the task creator (task) or the person doing it (assignment).

category_idinteger | null

The category these fields belong to, or null for every category.

fieldsarray of objectsrequired

The full list of field definitions, in order.

Response

Response Body

scopestringWho fills these fields: the task creator (task) or the person doing it (assignment).
category_idinteger | nullThe category these fields belong to, or null for every category.
fieldsarray of objectsThe field definitions in order.

Request

curl --request PUT \
--url https://app.softsolz.uk/api/v1/services/tasks/field-defs \
--header 'Authorization: Bearer sk_live_your_key' \
--header 'Content-Type: application/json' \
--data '{
"scope": "task",
"fields": [
{
"id": "site",
"type": "text",
"label": "Site",
"required": true
}
]
}'

Credentials

Sent as a Bearer token and used in the samples above and in Try it. Kept only in this browser tab until you close it. Use an sk_test_ key to stay in your sandbox.

Response · 200

{
"data": {
"scope": "task",
"category_id": 1,
"fields": [
{
"id": "your-id",
"type": "text",
"label": "your-label",
"help": "your-help",
"required": true,
"options": [
{
"value": "your-value",
"label": "your-label"
}
],
"min": 1,
"max": 1,
"currency": "your-currency",
"show_on_card": true,
"expression": "your-expression",
"result_type": "number",
"source": "task",
"source_field": "your-source-field",
"via_field": "your-via-field",
"logic": {}
}
]
}
}