---
title: "Post Form Template Dynamic Fields"
method: POST
path: "/api/v2/retool/admin/forms/template-page-fields"
tags: ["v2", "Platform Files", "Forms App", "Admin"]
---

# Post Form Template Dynamic Fields

`POST /api/v2/retool/admin/forms/template-page-fields`

## Request

- Base URL: `https://api.caresquare.com.au` (the document declares no server; this is the origin it was published from)
- URL: `https://api.caresquare.com.au/api/v2/retool/admin/forms/template-page-fields`
- Auth: none declared

Apply new dynamic fields to a PM's form template

## Query parameters

- `plan_manager_id` string, uuid, required
- `page` string, required

## Request body

- FormTemplateDynamicField[]
  - `name` string, required
  - `type` 'boolean' | 'select' | 'radio' | 'string' | 'textarea' | 'phone' | 'date' | 'email', required
  - `label` string, required
  - `default` union
    - boolean
    - string
  - `required` boolean, nullable
  - `render_kw` FormTemplateDynamicFieldRenderKW
    - `render_as` 'full' | 'half' | 'single', nullable
    - `label_type` 'top', nullable
    - `placeholder` string, nullable
  - `description` string, nullable

## Response `200`

Successful Response

- ApiResponseJSON: Standardised JSON Api Response To conforms to Aus Gov recommended format [api.gov.au](https://api.gov.au/sections/api-response.html#response-payload) Which is a modification of [JSON:API]( https://jsonapi.org/format/#introduction) data meta: meta object that contains non-standard meta-information messages: container for informational and warning messages related to the transaction. Not Implemented (not currently required): Links: [HATEOS Links](https://api.gov.au/sections/api-response.html#response-payload)
  - `data` unknown[]: List of items returned in the response following given criteria
    - unknown
  - `meta` ApiResponseMeta: Standardised Api Response Meta Not always required (except for example; with paginated results) Future: Could provide base that includes org information, copy-write etc
    - `processing_time_ms` integer, nullable
    - `total_records` integer, nullable
    - `page` integer, nullable
    - `limit` integer, nullable
    - `count` integer, nullable
    - `cursor` unknown
    - `cursor_last` unknown
    - `more_data_available` boolean, nullable
  - `messages` ApiResponseMessage[], nullable: Response Messages
    - `message_type` 'debug' | 'info' | 'warning' | 'error', required
    - `message` string, required

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/caresquare/apis/caresquare-api.md) - [All operations](https://skmtc.dev/caresquare/apis/caresquare-api/llms.txt) - [OpenAPI document](https://skmtc.dev/caresquare/apis/caresquare-api/revisions/d428fe38bf62?raw)