Update Form Template | Coperniq

Update an existing form template. All fields are optional — only provided fields are updated. formLayouts is optional — omit it to leave the existing layout untouched.

formLayouts replacement: When provided, the formLayouts array fully replaces all layout groups and their fields on the template. Position is determined by array order.

IDs are not stable across updates. Every update internally deletes all existing layout rows and inserts new ones, so every group and field receives a new auto-generated ID after each PATCH. The IDs returned in a GET response are only valid until the next PATCH. Do not store or rely on layout IDs across updates.

Using id in the request: You can pass { "id": <id from a recent GET> } for a group or field to reference its current data without repeating all attributes — the API will look up the existing name, type, isRequired, etc. and carry them forward. This is a convenience shortcut for the current request only; the ID will be different in the response.

Assignee (mutually exclusive — use at most one):

assigneeId — assign a specific user by ID.
assigneeProperty — assign by project property key: OWNER, SALES_REP, PROJECT_MANAGER, CREATED_BY, or a custom PERSON property keyName.
assigneeTeamId — assign a team: the team lead becomes the assignee and all other team members are added as collaborators.

Collaborators:

collaborators — replaces the list of direct user collaborator IDs.
collaboratorProperties — replaces the list of property-based collaborators. Each value is a standard key (OWNER, SALES_REP, PROJECT_MANAGER, CREATED_BY) or a custom PERSON property keyName.
collaboratorTeamIds — team IDs whose members are resolved to user IDs and merged (deduplicated) into collaborators alongside any direct collaborators and members from assigneeTeamId.

Update an existing form template. All fields are optional — only provided fields are updated. `formLayouts` is optional — omit it to leave the existing layout untouched. **formLayouts replacement:** When provided, the `formLayouts` array **fully replaces** all layout groups and their fields on the template. Position is determined by array order. **IDs are not stable across updates.** Every update internally deletes all existing layout rows and inserts new ones, so every group and field receives a new auto-generated ID after each PATCH. The IDs returned in a GET response are only valid until the next PATCH. Do not store or rely on layout IDs across updates. **Using `id` in the request:** You can pass `{ "id": <id from a recent GET> }` for a group or field to reference its current data without repeating all attributes — the API will look up the existing name, type, isRequired, etc. and carry them forward. This is a convenience shortcut for the current request only; the ID will be different in the response. **Assignee (mutually exclusive — use at most one):** - `assigneeId` — assign a specific user by ID. - `assigneeProperty` — assign by project property key: `OWNER`, `SALES_REP`, `PROJECT_MANAGER`, `CREATED_BY`, or a custom PERSON property `keyName`. - `assigneeTeamId` — assign a team: the team lead becomes the assignee and all other team members are added as collaborators. **Collaborators:** - `collaborators` — replaces the list of direct user collaborator IDs. - `collaboratorProperties` — replaces the list of property-based collaborators. Each value is a standard key (`OWNER`, `SALES_REP`, `PROJECT_MANAGER`, `CREATED_BY`) or a custom PERSON property `keyName`. - `collaboratorTeamIds` — team IDs whose members are resolved to user IDs and merged (deduplicated) into collaborators alongside any direct `collaborators` and members from `assigneeTeamId`.

Authentication

x-api-keystring

API Key authentication via header

Path parameters

formTemplateIdstringRequired

Request

This endpoint expects an object.

namestringOptional

Template name. Optional — omit to leave the existing name untouched.

formLayoutslist of objectsOptional

Optional. When provided, fully replaces all layout groups and their fields. Include existing groups with their id to keep/update them; omit the id for new groups. Groups not included are removed. Array order determines position.

If omitted, the existing layout is left untouched.

assigneeIdinteger or nullOptional

Direct user ID to assign. Mutually exclusive with assigneeProperty and assigneeTeamId.

assigneePropertystring or nullOptional

Property-based assignee. Use a standard key (OWNER, SALES_REP, PROJECT_MANAGER, CREATED_BY) or a custom PERSON property keyName. Mutually exclusive with assigneeId and assigneeTeamId.

assigneeTeamIdinteger or nullOptional

Assign a team: the team lead becomes the assignee and all other team members are added as collaborators. Mutually exclusive with assigneeId and assigneeProperty.

collaboratorslist of integersOptional

Replaces the list of direct user collaborator IDs.

collaboratorPropertieslist of stringsOptional

Property-based collaborators. Each value is a standard key (OWNER, SALES_REP, PROJECT_MANAGER, CREATED_BY) or a custom PERSON property keyName.

collaboratorTeamIdslist of integersOptional

Team IDs whose members are added as collaborators. Resolved to individual user IDs and merged (deduplicated) with any direct collaborators and members from assigneeTeamId.

labelslist of integersOptional

Replaces the list of label IDs applied to the template.

dueDateXDaysAfterinteger or nullOptional

Number of days after creation that the form is due.

Response

Form template updated successfully

idinteger or null

Form template identifier

namestring or null

Template name

createdAtstring or nullformat: "date-time"

updatedAtstring or nullformat: "date-time"

assigneeobject or null

Direct user assignment. Null if assigneeProperty is used instead.

assigneePropertystring or null

Property-based assignee key. Returns a standard key (OWNER, SALES_REP, PROJECT_MANAGER, CREATED_BY) or the keyName of a custom PERSON property. Null if a direct user assignee is set.

collaboratorslist of objects or null

Direct user collaborators.

collaboratorPropertieslist of strings or null

Property-based collaborator keys. Each value is a standard key (OWNER, SALES_REP, PROJECT_MANAGER, CREATED_BY) or the keyName of a custom PERSON property.

labelslist of objects or null

dueDateXDaysAfterinteger or null

Number of days after creation that the form is due

formLayoutslist of objects or null

Top-level layout items (GROUP sections and standalone COLUMN fields). Only root-level items are returned; child items are nested inside each GROUP’s properties array.

Errors

Update an existing form template. All fields are optional — only provided fields are updated. formLayouts is optional — omit it to leave the existing layout untouched.

formLayouts replacement: When provided, the formLayouts array fully replaces all layout groups and their fields on the template. Position is determined by array order.

Assignee (mutually exclusive — use at most one):

assigneeId — assign a specific user by ID.
assigneeProperty — assign by project property key: OWNER, SALES_REP, PROJECT_MANAGER, CREATED_BY, or a custom PERSON property keyName.
assigneeTeamId — assign a team: the team lead becomes the assignee and all other team members are added as collaborators.

Collaborators:

collaborators — replaces the list of direct user collaborator IDs.
collaboratorProperties — replaces the list of property-based collaborators. Each value is a standard key (OWNER, SALES_REP, PROJECT_MANAGER, CREATED_BY) or a custom PERSON property keyName.
collaboratorTeamIds — team IDs whose members are resolved to user IDs and merged (deduplicated) into collaborators alongside any direct collaborators and members from assigneeTeamId.

1	curl -X PATCH https://api.coperniq.io/v1/form-templates/formTemplateId \
2	-H "x-api-key: <apiKey>" \
3	-H "Content-Type: application/json" \
4	-d '{
5	"body": {
6	"name": "Customer Feedback Form"
7	}
8	}'

1	{
2	"id": 42,
3	"name": "Customer Feedback Form",
4	"createdAt": "2024-01-15T09:30:00Z",
5	"updatedAt": "2024-04-20T14:45:00Z",
6	"assignee": {
7	"id": 7,
8	"firstName": "Alice",
9	"lastName": "Johnson",
10	"email": "alice.johnson@example.com"
11	},
12	"assigneeProperty": "PROJECT_MANAGER",
13	"collaborators": [
14	{
15	"id": 12,
16	"firstName": "Bob",
17	"lastName": "Smith",
18	"email": "bob.smith@example.com"
19	}
20	],
21	"collaboratorProperties": [
22	"SALES_REP"
23	],
24	"labels": [
25	{
26	"id": 3,
27	"label": "Urgent",
28	"color": "#FF0000"
29	}
30	],
31	"dueDateXDaysAfter": 7,
32	"formLayouts": [
33	{
34	"id": 101,
35	"name": "Contact Information",
36	"type": "GROUP",
37	"columnId": 0,
38	"column": {
39	"id": 0,
40	"name": "",
41	"type": "",
42	"multiple": false,
43	"isRequired": false,
44	"isReadOnly": false
45	},
46	"properties": [
47	{
48	"id": 201,
49	"name": "Email Address",
50	"type": "COLUMN",
51	"columnId": 11,
52	"column": {
53	"id": 11,
54	"name": "Email Address",
55	"type": "TEXT",
56	"multiple": false,
57	"isRequired": true,
58	"isReadOnly": false
59	}
60	},
61	{
62	"id": 202,
63	"name": "Phone Number",
64	"type": "COLUMN",
65	"columnId": 12,
66	"column": {
67	"id": 12,
68	"name": "Phone Number",
69	"type": "TEXT",
70	"multiple": false,
71	"isRequired": false,
72	"isReadOnly": false
73	}
74	}
75	],
76	"fields": [
77	{
78	"id": 201,
79	"name": "Email Address",
80	"type": "COLUMN",
81	"columnId": 11,
82	"column": {
83	"id": 11,
84	"name": "Email Address",
85	"type": "TEXT",
86	"multiple": false,
87	"isRequired": true,
88	"isReadOnly": false
89	}
90	},
91	{
92	"id": 202,
93	"name": "Phone Number",
94	"type": "COLUMN",
95	"columnId": 12,
96	"column": {
97	"id": 12,
98	"name": "Phone Number",
99	"type": "TEXT",
100	"multiple": false,
101	"isRequired": false,
102	"isReadOnly": false
103	}
104	}
105	]
106	}
107	]
108	}