Attach a form template to a task

Creates a new form instance from a workspace template. Pass templateId from GET /workspace/form-templates (each item includes id) or the legacy GET /administration/form-templates-available. To review fields, labels, and validation constraints before attaching, call GET /workspace/form-templates/{id} with that template id. After attach, fill values with PATCH /tasks/{identifier}/form-instances/{formInstanceId} (get formInstanceId from GET this resource list).

POST/tasks/{identifier}/form-instances

Authorization

AuthorizationOAuth2 access token · headerrequired

Scopes:api:write

AuthorizationBearer token (JWT) · headerrequired

Path parameters

identifierstringrequired

Task UUID or shortNumber

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

templateIdstring<uuid>required

ID of the form template to attach. List templates (each includes id) via GET /workspace/form-templates or GET /administration/form-templates-available. Optional: inspect field definitions before attach with GET /workspace/form-templates/{id}.

Responses

201

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 shortNumberfieldsToReturnqueryComma-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

templateIdstring*ID of the form template to attach. List templates (each includes `id`) via GET `/workspace/form-templates` or GET `/administration/form-templates-available`. Optional: inspect field definitions before attach with GET `/workspace/form-templates/{id}`.

Request

curl -X POST "https://leadtime.app/api/public/tasks/string/form-instances" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "templateId": "196100ac-4eec-4fb6-a7f7-86c8b584771d"
}'

const response = await fetch("https://leadtime.app/api/public/tasks/string/form-instances", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_ACCESS_TOKEN",
    "Content-Type": "application/json"
  },
  body: "{\n  \"templateId\": \"196100ac-4eec-4fb6-a7f7-86c8b584771d\"\n}"
});

import requests

response = requests.post(
    "https://leadtime.app/api/public/tasks/string/form-instances",
    headers={
        "Authorization": "Bearer YOUR_ACCESS_TOKEN",
        "Content-Type": "application/json"
    },
    data="{\n  \"templateId\": \"196100ac-4eec-4fb6-a7f7-86c8b584771d\"\n}",
)

Response

No example response.