SoftSolzSoftSolz
HomeAPI GuideAPI ReferenceWidget Tester
Tasks

Set field values on a piece of work. Keys you send are changed and null clears a value. Only ids of defined work fields are accepted (others are refused with 422 fields_invalid), at most 50 keys and 32 KB per call. Values are checked against the field definitions and refused with 422 fields_invalid, naming each field in details.errors

PATCHhttps://app.softsolz.uk/api/v1/services/tasks/assignments/{id}/fields

Recent Requests

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

Path Params

idstringrequired

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

valuesobjectrequired

Field values keyed by field id. null clears a value.

Response

Response Body

idintegerId of the piece of work.
custom_fieldsobjectAll field values now saved on the work, keyed by field id.

Request

curl --request PATCH \
--url https://app.softsolz.uk/api/v1/services/tasks/assignments/{id}/fields \
--header 'Authorization: Bearer sk_live_your_key' \
--header 'Content-Type: application/json' \
--data '{
"values": {
"site": "North depot"
}
}'

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": {
"id": 1,
"custom_fields": {}
}
}