API ReferenceForms

Update Form

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 or null
Form identifier
namestring or null
Form name
descriptionstring or null
Form description
templateIdinteger or null
Template ID
updatedAtstring or nullformat: "date-time"
Last update timestamp
statusenum or null
Form status
isCompletedboolean or null
Whether the form is completed
completedAtstring or nullformat: "date-time"
Completion timestamp
createdAtstring or nullformat: "date-time"
Creation timestamp
createdByUserobject or null
Minimal user representation used in responses
assigneeobject or null
Minimal user representation used in responses
dueDatestring or nullformat: "date-time"
Due date
projectIdinteger or null
Associated project ID
phaseIdinteger or null

Phase template ID (if available)

phaseNamestring or null

Phase template name (if available)

formLayoutslist of objects or null
Form layout sections
collaboratorslist of objects or null
Additional users collaborating on the form

Errors