forms

Update Form

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

patch/forms/{form_id}

Request

  • Base URL: https://api.coperniq.io/v1
  • URL: https://api.coperniq.io/v1/forms/{form_id}
  • Auth: API key in header x-api-key

Path parameters

form_idstring required

Request body

namestring

Form name

descriptionstring nullable

Form description

assigneeIdinteger

Primary assignee user ID

dueDatestring date-time

Absolute due date (ISO 8601)

status'UNASSIGNED' | 'ASSIGNED' | 'REVIEW' | 'CHANGES_REQUESTED' | 'COMPLETED' | 'CANCELLED'

Form status

labelsinteger[]

Label IDs applied to the form

collaboratorsinteger[]

Collaborator user IDs

Response

Updated form details

idinteger

Form identifier

namestring

Form name

descriptionstring nullable

Form description

templateIdinteger nullable

Template ID

updatedAtstring date-time

Last update timestamp

status'UNASSIGNED' | 'ASSIGNED' | 'REVIEW' | 'CHANGES_REQUESTED' | 'COMPLETED' | 'CANCELLED'

Form status

isCompletedboolean

Whether the form is completed

completedAtstring date-time nullable

Completion timestamp

createdAtstring date-time

Creation timestamp

dueDatestring date-time nullable

Due date

projectIdinteger

Associated project ID

phaseIdinteger nullable

Phase template ID (if available)

phaseNamestring nullable

Phase template name (if available)

Changes

No recorded changes to this operation across all 1 revision of this API.