Update Form

PATCH

https://api.coperniq.io/v1/forms/:form_id

PATCH

/v1/forms/:form_id

1 const url = 'https://api.coperniq.io/v1/forms/form_id';
2 const options = {
3   method: 'PATCH',
4   headers: {'x-api-key': '<apiKey>', 'Content-Type': 'application/json'},
5   body: '{}'
6 };
7 
8 try {
9   const response = await fetch(url, options);
10   const data = await response.json();
11   console.log(data);
12 } catch (error) {
13   console.error(error);
14 }

1 {
2   "id": 1,
3   "name": "string",
4   "description": "string",
5   "templateId": 1,
6   "updatedAt": "2024-01-15T09:30:00Z",
7   "status": "UNASSIGNED",
8   "isCompleted": true,
9   "completedAt": "2024-01-15T09:30:00Z",
10   "createdAt": "2024-01-15T09:30:00Z",
11   "createdByUser": {
12     "id": 1,
13     "firstName": "string",
14     "lastName": "string",
15     "email": "string",
16     "avatarUrl": "string"
17   },
18   "assignee": {
19     "id": 1,
20     "firstName": "string",
21     "lastName": "string",
22     "email": "string",
23     "avatarUrl": "string"
24   },
25   "dueDate": "2024-01-15T09:30:00Z",
26   "projectId": 1,
27   "phaseId": 1,
28   "phaseName": "string",
29   "formLayouts": [
30     {
31       "id": 1,
32       "type": "GROUP",
33       "name": "string",
34       "properties": [
35         {
36           "id": 1,
37           "columnId": 1,
38           "name": "string",
39           "type": "string",
40           "value": "string"
41         }
42       ],
43       "fields": [
44         {
45           "id": 1,
46           "columnId": 1,
47           "name": "string",
48           "type": "string",
49           "value": "string"
50         }
51       ]
52     }
53   ],
54   "collaborators": [
55     {
56       "id": 1,
57       "firstName": "string",
58       "lastName": "string",
59       "email": "string",
60       "avatarUrl": "string"
61     }
62   ]
63 }

Update an existing form, including core fields (status, due dates, assignee, collaborators) and individual field responses.

Authentication

x-api-keystring

API Key authentication via header

Path parameters

form_idstringRequired

Request

This endpoint expects an object.

namestringOptional

Form name

descriptionstring or nullOptional

Form description

assigneeIdintegerOptional

Primary assignee user ID

dueDatestringOptionalformat: "date-time"

Absolute due date (ISO 8601)

statusenumOptional

Form status

labelslist of integersOptional

Label IDs applied to the form

collaboratorslist of integersOptional

Collaborator user IDs

propertieslist of objectsOptional

Individual field/column updates.

fieldslist of objectsOptionalDeprecated

Deprecated alias for properties. Accepted for backwards compatibility — new integrations should use properties.

Response

Updated form details

idintegerOptional

Form identifier

namestringOptional

Form name

descriptionstring or nullOptional

Form description

templateIdinteger or nullOptional

Template ID

updatedAtstringOptionalformat: "date-time"

Last update timestamp

statusenumOptional

Form status

isCompletedbooleanOptional

Whether the form is completed

completedAtstring or nullOptionalformat: "date-time"

Completion timestamp

createdAtstringOptionalformat: "date-time"

Creation timestamp

createdByUserobjectOptional

Minimal user representation used in responses

assigneeobjectOptional

Minimal user representation used in responses

dueDatestring or nullOptionalformat: "date-time"

Due date

projectIdintegerOptional

Associated project ID

phaseIdinteger or nullOptional

Phase template ID (if available)

phaseNamestring or nullOptional

Phase template name (if available)

formLayoutslist of objectsOptional

Form layout sections

collaboratorslist of objectsOptional

Additional users collaborating on the form

Errors

400

Bad Request Error

401

Unauthorized Error

404

Not Found Error