Recipes
Create class
Create class
1
1. Set a name of the classs
Use a
name
parameter to set the name of the class.2
2. Use a `fields` parameter to set custom fields
The
fields
stores a set of unique keys each having an associated value parameter.3
3. Set fields of the custom class
Set as many fields for a new class as you need.
4
4. Use a `permissions` parameter to set operations allowed and access levels
5
5. Set CRUD operations
Set the operations that can be performed on a record.Here, the
create
, read
, and update
operations are set.6
6. Set access levels
Set an access level for a record.Here, the
open
, not_allowed
, and open_for_users_ids
access levels are set.7
7. Set IDs of users
Set IDs of users who can make a required operation.
8
8. As a result, the API returns a newly created class.
Body Parameters
Custom class name.
Custom class fields with types.
Format:
Format:
fields.{custom_field}=<field_type>
.Headers
A user or application session token. See Authentication page to learn more about session tokens. Must be used either QB-Token or Authorization.
Responses
201
201
403
403
An error response
422
422
An error response