Update stored values for a form instance

Merges the provided values into the instance (see request body schema). Keys in values must match fields[].valueKey from GET /tasks/{identifier}/form-instances for this instance. For allowed types and select options, either read fields on that GET response or load the template definition with GET /workspace/form-templates/{templateId} using the instance templateId.

PATCH/tasks/{identifier}/form-instances/{formInstanceId}

Authorization

AuthorizationOAuth2 access token · headerrequired

Scopes:api:write

AuthorizationBearer token (JWT) · headerrequired

Path parameters

identifierstringrequired

Task UUID or shortNumber

formInstanceIdstring<uuid>required

Form instance UUID from GET /tasks/{identifier}/form-instances (id on each item).

Query parameters

fieldsToReturnstring

Comma-separated list of top-level response fields to return. Overrides the endpoint compact default unless responseShape=full is used.

responseShapestring

Advanced override. Omit for the endpoint compact default. Use full only when you need the complete endpoint response, including nested fields that are not selectable with fieldsToReturn.

Allowed:compactfull

Header parameters

LT-Response-Shapestring

Advanced override. Set to full only when you need the complete endpoint response, including nested fields that are not selectable with fieldsToReturn.

Allowed:full

Request body

requiredapplication/json

valuesobjectrequired

Map of field keys to submitted values. Each key must match the valueKey of a field on this instance (see GET /tasks/{identifier}/form-instances → fields[].valueKey). valueKey is the template field key when set, otherwise the field UUID. To learn types, required flags, and allowed options before editing, use GET /workspace/form-templates/{templateId} (use templateId from the instance) or read fields from the list response.

Responses

200

401

Unauthorized - Invalid or missing authentication token

403

Forbidden - Insufficient API scopes or permissions

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

OAuth2 access tokenRemember on this deviceInclude my values in samples

Parameters

identifierpath*Task UUID or shortNumberformInstanceIdpath*Form instance UUID from GET `/tasks/{identifier}/form-instances` (`id` on each item).fieldsToReturnqueryComma-separated list of top-level response fields to return. Overrides the endpoint compact default unless responseShape=full is used.responseShapequeryAdvanced override. Omit for the endpoint compact default. Use full only when you need the complete endpoint response, including nested fields that are not selectable with fieldsToReturn.LT-Response-ShapeheaderAdvanced override. Set to full only when you need the complete endpoint response, including nested fields that are not selectable with fieldsToReturn.

Bodyapplication/json

Request body

Request

curl -X PATCH "https://leadtime.app/api/public/tasks/string/form-instances/497f6eca-6276-4993-bfeb-53cbbbba6f08" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "values": {}
}'

const response = await fetch("https://leadtime.app/api/public/tasks/string/form-instances/497f6eca-6276-4993-bfeb-53cbbbba6f08", {
  method: "PATCH",
  headers: {
    "Authorization": "Bearer YOUR_ACCESS_TOKEN",
    "Content-Type": "application/json"
  },
  body: "{\n  \"values\": {}\n}"
});

import requests

response = requests.patch(
    "https://leadtime.app/api/public/tasks/string/form-instances/497f6eca-6276-4993-bfeb-53cbbbba6f08",
    headers={
        "Authorization": "Bearer YOUR_ACCESS_TOKEN",
        "Content-Type": "application/json"
    },
    data="{\n  \"values\": {}\n}",
)

Response

No example response.