> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.coperniq.io/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.coperniq.io/_mcp/server.

# Update Form

PATCH https://api.coperniq.io/v1/forms/{form_id}
Content-Type: application/json

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


Reference: https://docs.coperniq.io/api-reference/forms/update-form

## Authentication

- `x-api-key` header (required) — API Key authentication via header

## Request

### Path parameters

- `form_id` (string, required)

### Body (application/json)

This endpoint expects a FormUpdate.

- `name` (string, optional) — Form name
- `description` (string, optional, nullable) — Form description
- `assigneeId` (integer, optional) — Primary assignee user ID
- `dueDate` (string, optional) — Absolute due date (ISO 8601)
- `status` (enum, optional) — Form status
  - Allowed values: `UNASSIGNED`, `ASSIGNED`, `REVIEW`, `CHANGES_REQUESTED`, `COMPLETED`, `CANCELLED`
- `labels` (list of integer, optional) — Label IDs applied to the form
- `collaborators` (list of integer, optional) — Collaborator user IDs
- `properties` (list of FormUpdateItems, optional) — Individual field/column updates.
- `fields` (list of FormUpdateFieldsItems, optional, deprecated) — Deprecated alias for properties. Accepted for backwards compatibility — new integrations should use properties.

## Response

### 200

Updated form details

- `id` (integer, optional) — Form identifier
- `name` (string, optional) — Form name
- `description` (string, optional, nullable) — Form description
- `templateId` (integer, optional, nullable) — Template ID
- `updatedAt` (string, optional) — Last update timestamp
- `status` (enum, optional) — Form status
  - Allowed values: `UNASSIGNED`, `ASSIGNED`, `REVIEW`, `CHANGES_REQUESTED`, `COMPLETED`, `CANCELLED`
- `isCompleted` (boolean, optional) — Whether the form is completed
- `completedAt` (string, optional, nullable) — Completion timestamp
- `createdAt` (string, optional) — Creation timestamp
- `createdByUser` (UserSummary, optional) — Minimal user representation used in responses
- `assignee` (UserSummary, optional) — Minimal user representation used in responses
- `dueDate` (string, optional, nullable) — Due date
- `projectId` (integer, optional) — Associated project ID
- `phaseId` (integer, optional, nullable) — Phase template ID (if available)
- `phaseName` (string, optional, nullable) — Phase template name (if available)
- `formLayouts` (list of FormLayoutGroup, optional) — Form layout sections
- `collaborators` (list of UserSummary, optional) — Additional users collaborating on the form

## Errors

### 400 Bad Request Error

Invalid request

- `message` (string, optional)
- `code` (enum, optional)
  - Allowed values: `NOT_FOUND`
- `field` (string, optional) — Field that caused the validation error (if applicable)

### 401 Unauthorized Error

Authentication failed

- `message` (string, optional)
- `code` (enum, optional)
  - Allowed values: `NOT_FOUND`

### 404 Not Found Error

Resource not found

- `message` (string, optional)
- `code` (enum, optional)
  - Allowed values: `NOT_FOUND`

## Types

### FormUpdateItems

- `columnId` (integer, required) — Column identifier on the form
- `value` (FormUpdateItemsValue, optional, nullable) — New value for the field
- `description` (string, optional) — Field description when action is update-description

### FormUpdateFieldsItems

- `columnId` (integer, required) — Column identifier on the form
- `value` (FormUpdateFieldsItemsValue, optional, nullable) — New value for the field

### UserSummary

Minimal user representation used in responses

- `id` (integer, optional)
- `firstName` (string, optional, nullable)
- `lastName` (string, optional, nullable)
- `email` (string, optional, nullable)
- `avatarUrl` (string, optional, nullable)

### FormLayoutGroup

- `id` (FormLayoutGroupId, optional) — Group identifier ("default" for ungrouped properties)
- `type` (enum, optional)
  - Allowed values: `GROUP`
- `name` (string, optional) — Group name
- `properties` (list of FormField, optional)
- `fields` (list of FormField, optional) — Alias for properties. Both keys are returned in responses for backwards compatibility.

### FormUpdateItemsValue

New value for the field

- string
- double
- boolean
- Array Value: list of FormUpdateArrayValueItems

### FormUpdateFieldsItemsValue

New value for the field

- string
- double
- boolean
- Array Value: list of FormUpdateArrayValueItems

### FormLayoutGroupId

Group identifier ("default" for ungrouped properties)

- integer
- string

### FormField

- `id` (integer, optional) — Child form layout identifier
- `columnId` (integer, optional) — Column identifier on the form layout
- `name` (string, optional) — Field label
- `type` (string, optional) — Field type
- `value` (FormFieldValue, optional, nullable) — Normalized field value

### FormUpdateArrayValueItems

- string
- double
- boolean

### FormFieldValue

Normalized field value

- string
- double
- User: UserSummary
- Files: list of FormFile
- list of string

### FormFile

- `id` (integer, optional)
- `name` (string, optional)
- `downloadUrl` (string, optional)
- `metaData` (map from string to any, optional)

## Examples

**Request**

```json
{}
```

**Response**

```json
{
  "id": 1,
  "name": "string",
  "description": "string",
  "templateId": 1,
  "updatedAt": "2024-01-15T09:30:00Z",
  "status": "UNASSIGNED",
  "isCompleted": true,
  "completedAt": "2024-01-15T09:30:00Z",
  "createdAt": "2024-01-15T09:30:00Z",
  "createdByUser": {
    "id": 1,
    "firstName": "string",
    "lastName": "string",
    "email": "string",
    "avatarUrl": "string"
  },
  "assignee": {
    "id": 1,
    "firstName": "string",
    "lastName": "string",
    "email": "string",
    "avatarUrl": "string"
  },
  "dueDate": "2024-01-15T09:30:00Z",
  "projectId": 1,
  "phaseId": 1,
  "phaseName": "string",
  "formLayouts": [
    {
      "id": 1,
      "type": "GROUP",
      "name": "string",
      "properties": [
        {
          "id": 1,
          "columnId": 1,
          "name": "string",
          "type": "string",
          "value": "string"
        }
      ],
      "fields": [
        {
          "id": 1,
          "columnId": 1,
          "name": "string",
          "type": "string",
          "value": "string"
        }
      ]
    }
  ],
  "collaborators": [
    {
      "id": 1,
      "firstName": "string",
      "lastName": "string",
      "email": "string",
      "avatarUrl": "string"
    }
  ]
}
```

**SDK Code**

```python
import requests

url = "https://api.coperniq.io/v1/forms/form_id"

payload = {}
headers = {
    "x-api-key": "<apiKey>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.json())
```

```javascript
const url = 'https://api.coperniq.io/v1/forms/form_id';
const options = {
  method: 'PATCH',
  headers: {'x-api-key': '<apiKey>', 'Content-Type': 'application/json'},
  body: '{}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.coperniq.io/v1/forms/form_id"

	payload := strings.NewReader("{}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("x-api-key", "<apiKey>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.coperniq.io/v1/forms/form_id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["x-api-key"] = '<apiKey>'
request["Content-Type"] = 'application/json'
request.body = "{}"

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.patch("https://api.coperniq.io/v1/forms/form_id")
  .header("x-api-key", "<apiKey>")
  .header("Content-Type", "application/json")
  .body("{}")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('PATCH', 'https://api.coperniq.io/v1/forms/form_id', [
  'body' => '{}',
  'headers' => [
    'Content-Type' => 'application/json',
    'x-api-key' => '<apiKey>',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.coperniq.io/v1/forms/form_id");
var request = new RestRequest(Method.PATCH);
request.AddHeader("x-api-key", "<apiKey>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = [
  "x-api-key": "<apiKey>",
  "Content-Type": "application/json"
]
let parameters = [] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://api.coperniq.io/v1/forms/form_id")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "PATCH"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```