v1

latestOpenAPI 3.0.32026-07-246304082.0 MB

form template form statuses

Update form_template_form_status by ID

patch/api/v3/projects/{project_id}/form_template_form_statuses/{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

owner_user_idinteger nullable

ID of the user who owns this project

is_editableboolean

Flag to show if status is editable (must be true if ordinal is 1)

namestring

Name of the entity

required_role_in'member' | 'follower' | 'admin'

User role required to move a Form into this status

required_role_out'member' | 'follower' | 'admin'

User role required to move a Form out of this status

device_updated_atstring date-time

Time when the device last updated the entity

recipient_emailsstring[] nullable

Receivers of email notification when form changed to this status

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

owner_user_idinteger nullable

ID of the user who owns this project

form_template_idstring uuid required

ID of the template this status belongs to

project_idstring uuid required

ID of the project this entity belongs to

is_editableboolean required

Flag to show if status is editable (must be true if ordinal is 1)

namestring required

Name of the entity

ordinalinteger required

Specifies the ordering among siblings

required_role_in'member' | 'follower' | 'admin' required

User role required to move a Form into this status

required_role_out'member' | 'follower' | 'admin' required

User role required to move a Form out of this status

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 required

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

updated_atstring date-time required

Time when the server last updated the entity

recipient_emailsstring[] nullable

Receivers of email notification when form changed to this status