PATCH /api/field-permissions/{field_id}/
Update permissions for writing field values and form visibility for a specific field. This endpoint is used to restrict the ability to modify field values to the roles defined. It also makes it possible to decide if the field can be exposed in forms or not.
This is a enterprise feature.
Servers
- /
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
field_id |
Integer | Yes |
The ID of the field to update the permissions for. |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
allow_in_forms |
Boolean | No |
Whether to allow this field to be shown in forms. Default is False. This setting is only relevant if the role is not 'EDITOR'. Default value: false |
role |
String | No |
The role required to update the data for this field.
Possible values:
|
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.