Historically, the Custom Fields API has been permissioned by a combination of Entities API Permissions and an app-level setting called Custom Fields Behavior.
In order to support more granular permissions, we have added a new dedicated Custom Fields Permission Group.
In order to support more granular permissions, we have added a new dedicated Custom Fields Permission Group.
| Endpoints | Required Permissions | Behavior |
|---|---|---|
| Custom Fields Get/List (Read Operations) |
Entities: Read OR Custom Fields: Read |
App can read all custom fields |
| Custom Fields Create/Update/Delete (Write Operations) |
Entities: Read/Write AND Custom Fields Behavior is ALL OR Custom Fields: Write
|
App can write to any custom field |
The Custom Fields Behavior Setting is no longer settable with the new Developer Console UI, and always defaults to None. As such, any new Apps should use this new Custom Fields Permission Group in order to obtain access to edit custom fields via API.
To do this, when adding API Permissions to an app click + Add Endpoint, then select Custom Fields under Knowledge API. Then click Select Permission and select either Read-Only or Read / Write depending on the level of permissions you’d like to assign to the app.
To learn more about the Developer Console or creating an App, visit our Developer Console training module, or out Create an App guide.