v1

latestOpenAPI 3.0.32026-07-246304082.0 MB

form templates

Update form_template by ID

patch/api/v3/projects/{project_id}/form_templates/{id}

Path parameters

project_idstring uuid required

ID of the project this entity belongs to

idstring uuid required

ID of the entity

Headers

Fieldwire-Versionstring date required

Specifies the version of the API to talk to

Request body

last_editor_user_idinteger

ID of the user who most recently edited this entity

namestring

Name of the template

device_updated_atstring date-time

Time when the device last updated the entity

view_edit_permissions'assignee' | 'all_users' | 'null' nullable

View/edit permissions for the template, e.g. assignee, all_users. Consider using form_template_permissions instead.

status_change_recipient_emailsstring[] nullable

Receivers of email notification when form changes its status

should_publishboolean nullable

Indication that the Form Template is published.

Response

Successful response

idstring uuid required

ID of the entity

creator_user_idinteger required

ID of the user who created this entity

last_editor_user_idinteger required

ID of the user who most recently edited this entity

project_idstring uuid required

ID of the project this entity belongs to

is_generatedboolean required

Whether this template is fully generated (in case cloning from another template)

checksumstring nullable

Checksum used for verifying whether all relevant information for a form template is at hand

namestring required

Name of the template

kind'default' | 'time_range' | 'single_day' required

Kind of the template

versioninteger required

Version number of the Form Template. Publishing increases version. Starts at 0.

content_changed_atstring date-time nullable

Time at which this entity was changed across any of its child entities (contents)

created_atstring date-time required

Time when the server created the entity

deleted_atstring date-time nullable

Time the server deleted the entity

device_created_atstring date-time required

Time when the device created the entity

device_updated_atstring date-time required

Time when the device last updated the entity

resolved_conflictboolean nullable required

Specifies if PUT/PATCH request was rejected - do not store this field!

published_atstring date-time nullable

Time when the Form Template is published

updated_atstring date-time required

Time when the server last updated the entity

view_edit_permissions'assignee' | 'all_users' | 'null' nullable

View/edit permissions for the template, e.g. assignee, all_users. Consider using form_template_permissions instead.

form_type'default' | 'fillable_pdf' required

The type of form either custom fieldwire or a fillable_pdf

status_change_recipient_emailsstring[] nullable

Receivers of email notification when form changes its status

process_state'deleting' | 'restoring' | 'null' nullable

State of an async deletion or restoration of this form template