Update Form | Coperniq API

const url = 'https://api.coperniq.io/v1/forms/formId';
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);
}

{
  "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"
    }
  ]
}

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

formIdstringRequired

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

idinteger

Form identifier

namestring

Form name

descriptionstring or null

Form description

templateIdinteger or null

Template ID

updatedAtstringformat: "date-time"

Last update timestamp

statusenum

Form status

isCompletedboolean

Whether the form is completed

completedAtstring or nullformat: "date-time"

Completion timestamp

createdAtstringformat: "date-time"

Creation timestamp

createdByUserobject

Minimal user representation used in responses

assigneeobject

Minimal user representation used in responses

dueDatestring or nullformat: "date-time"

Due date

projectIdinteger

Associated project ID

phaseIdinteger or null

Phase template ID (if available)

phaseNamestring or null

Phase template name (if available)

formLayoutslist of objects

Form layout sections

collaboratorslist of objects

Additional users collaborating on the form

Errors

400

Bad Request Error

401

Unauthorized Error

404

Not Found Error