Create Class - QuickBlox

curl -X POST \
-H "Content-Type: application/json" \
-H "QB-Token: c95dbdc9c72cc8e7f2367d7ef2c6d99c5e013233" \
-d '{
  "name":"UserCustomProfile",
  "fields":{
    "name":"String",
    "last_name":"String",
    "age":"Integer",
    "tags":"String_a"
  },
  "permissions":{
    "create":{
      "access":"open"
    },
    "read":{
      "access":"not_allowed"
    },
    "update":{
      "access":"open_for_users_ids",
      "ids":"1,2"
    }
  }
}' \
https://api.quickblox.com/class.json

{
  "_id": "5ddfb849a0eb4725dfc9b0ad",
  "acl": {
    "read": {
      "access": "not_allowed"
    },
    "update": {
      "access": "open_for_users_ids",
      "users_ids": [
        "1",
        "2"
      ]
    },
    "delete": {
      "access": "owner"
    },
    "create": {
      "access": "open",
      "primary": true
    }
  },
  "application_id": 78387,
  "custom_fields": [
    {
      "name": "name",
      "type": "String"
    },
    {
      "name": "last_name",
      "type": "String"
    },
    {
      "name": "age",
      "type": "Integer"
    },
    {
      "is_array": "1",
      "name": "tags",
      "type": "String"
    }
  ],
  "name": "UserCustomProfile",
  "user_id": 91103344
}

{
  "errors": [
    "You don't have appropriate permissions to do this operation"
  ]
}

{
  "name": [
    "can't be blank",
    "must contain only alphanumeric or underscore characters and begin with a letter.",
    "is too short (minimum is 3 characters)",
    "is too long (maximum is 50 characters)"
  ]
}

POST

class.json

curl -X POST \
-H "Content-Type: application/json" \
-H "QB-Token: c95dbdc9c72cc8e7f2367d7ef2c6d99c5e013233" \
-d '{
  "name":"UserCustomProfile",
  "fields":{
    "name":"String",
    "last_name":"String",
    "age":"Integer",
    "tags":"String_a"
  },
  "permissions":{
    "create":{
      "access":"open"
    },
    "read":{
      "access":"not_allowed"
    },
    "update":{
      "access":"open_for_users_ids",
      "ids":"1,2"
    }
  }
}' \
https://api.quickblox.com/class.json

{
  "_id": "5ddfb849a0eb4725dfc9b0ad",
  "acl": {
    "read": {
      "access": "not_allowed"
    },
    "update": {
      "access": "open_for_users_ids",
      "users_ids": [
        "1",
        "2"
      ]
    },
    "delete": {
      "access": "owner"
    },
    "create": {
      "access": "open",
      "primary": true
    }
  },
  "application_id": 78387,
  "custom_fields": [
    {
      "name": "name",
      "type": "String"
    },
    {
      "name": "last_name",
      "type": "String"
    },
    {
      "name": "age",
      "type": "Integer"
    },
    {
      "is_array": "1",
      "name": "tags",
      "type": "String"
    }
  ],
  "name": "UserCustomProfile",
  "user_id": 91103344
}

{
  "errors": [
    "You don't have appropriate permissions to do this operation"
  ]
}

{
  "name": [
    "can't be blank",
    "must contain only alphanumeric or underscore characters and begin with a letter.",
    "is too short (minimum is 3 characters)",
    "is too long (maximum is 50 characters)"
  ]
}

Recipes

Create class

1. Set a name of the classs

Use a name parameter to set the name of the class.

curl -X POST \
-H "Content-Type: application/json" \
-H "QB-Token: c95dbdc9c72cc8e7f2367d7ef2c6d99c5e013233" \
-d '{
  "name":"UserCustomProfile",
}' \
"https://api.quickblox.com/class.json"

2. Use a `fields` parameter to set custom fields

The fields stores a set of unique keys each having an associated value parameter.

curl -X POST \
-H "Content-Type: application/json" \
-H "QB-Token: c95dbdc9c72cc8e7f2367d7ef2c6d99c5e013233" \
-d '{
  "name":"UserCustomProfile",
  "fields":{},
}' \
"https://api.quickblox.com/class.json"

3. Set fields of the custom class

Set as many fields for a new class as you need.

curl -X POST \
-H "Content-Type: application/json" \
-H "QB-Token: c95dbdc9c72cc8e7f2367d7ef2c6d99c5e013233" \
-d '{
  "name":"UserCustomProfile",
  "fields":{
    "name":"String",
    "last_name":"String",
    "age":"Integer",
    "tags":"String_a"
  },
}' \
"https://api.quickblox.com/class.json"

4. Use a `permissions` parameter to set operations allowed and access levels

curl -X POST \
-H "Content-Type: application/json" \
-H "QB-Token: c95dbdc9c72cc8e7f2367d7ef2c6d99c5e013233" \
-d '{
  "name":"UserCustomProfile",
  "fields":{
    "name":"String",
    "last_name":"String",
    "age":"Integer",
    "tags":"String_a"
  },
  "permissions":{},
}' \
"https://api.quickblox.com/class.json"

5. Set CRUD operations

Set the operations that can be performed on a record.Here, the create, read, and update operations are set.

curl -X POST \
-H "Content-Type: application/json" \
-H "QB-Token: c95dbdc9c72cc8e7f2367d7ef2c6d99c5e013233" \
-d '{
  "name":"UserCustomProfile",
  "fields":{
    "name":"String",
    "last_name":"String",
    "age":"Integer",
    "tags":"String_a"
  },
  "permissions":{
    "create":{},
    "read":{},
    "update":{},
  },
}' \
"https://api.quickblox.com/class.json"

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.

curl -X POST \
-H "Content-Type: application/json" \
-H "QB-Token: c95dbdc9c72cc8e7f2367d7ef2c6d99c5e013233" \
-d '{
  "name":"UserCustomProfile",
  "fields":{
    "name":"String",
    "last_name":"String",
    "age":"Integer",
    "tags":"String_a"
  },
  "permissions":{
    "create":{
      "access":"open"
    },
    "read":{
      "access":"not_allowed"
    },
    "update":{
      "access":"open_for_users_ids"
    },
  },
}' \
"https://api.quickblox.com/class.json"

7. Set IDs of users

Set IDs of users who can make a required operation.

curl -X POST \
-H "Content-Type: application/json" \
-H "QB-Token: c95dbdc9c72cc8e7f2367d7ef2c6d99c5e013233" \
-d '{
  "name":"UserCustomProfile",
  "fields":{
    "name":"String",
    "last_name":"String",
    "age":"Integer",
    "tags":"String_a"
  },
  "permissions":{
    "create":{
      "access":"open"
    },
    "read":{
      "access":"not_allowed"
    },
    "update":{
      "access":"open_for_users_ids",
      "ids":"1,2"
    },
  },
}' \
"https://api.quickblox.com/class.json"

8. As a result, the API returns a newly created class.

{
  "_id": "5ddfb849a0eb4725dfc9b0ad",
  "acl": {
    "read": {
      "access": "not_allowed"
    },
    "update": {
      "access": "open_for_users_ids",
      "users_ids": [
        "1",
        "2"
      ]
    },
    "delete": {
      "access": "owner"
    },
    "create": {
      "access": "open",
      "primary": true
    }
  },
  "application_id": 78387,
  "custom_fields": [
    {
      "name": "name",
      "type": "String"
    },
    {
      "name": "last_name",
      "type": "String"
    },
    {
      "name": "age",
      "type": "Integer"
    },
    {
      "is_array": "1",
      "name": "tags",
      "type": "String"
    }
  ],
  "name": "UserCustomProfile",
  "user_id": 91103344
}

Create class with API key

1. Use 'Authorization' header to pass API key

curl -X POST \
-H "Content-Type: application/json" \
-H "Authorization: ApiKey 28irlNAGasWDSupO9Vw0BBMZfuHrAUYKpmroS9yBORI" \
-d '{
  "name":"UserCustomProfile",
}' \
"https://api.quickblox.com/class.json"

2. Set a name of the classs

Use a name parameter to set the name of the class.

curl -X POST \
-H "Content-Type: application/json" \
-H "Authorization: ApiKey 28irlNAGasWDSupO9Vw0BBMZfuHrAUYKpmroS9yBORI" \
-d '{
  "name":"UserCustomProfile",
}' \
"https://api.quickblox.com/class.json"

3. Use a `fields` parameter to set custom fields

The fields stores a set of unique keys each having an associated value parameter.

curl -X POST \
-H "Content-Type: application/json" \
-H "Authorization: ApiKey 28irlNAGasWDSupO9Vw0BBMZfuHrAUYKpmroS9yBORI" \
-d '{
  "name":"UserCustomProfile",
  "fields":{},
}' \
"https://api.quickblox.com/class.json"

4. Set fields of the custom class

Set as many fields for a new class as you need.

curl -X POST \
-H "Content-Type: application/json" \
-H "Authorization: ApiKey 28irlNAGasWDSupO9Vw0BBMZfuHrAUYKpmroS9yBORI" \
-d '{
  "name":"UserCustomProfile",
  "fields":{
    "name":"String",
    "last_name":"String",
    "age":"Integer",
    "tags":"String_a"
  },
}' \
"https://api.quickblox.com/class.json"

5. Use a `permissions` parameter to set operations allowed and access levels

curl -X POST \
-H "Content-Type: application/json" \
-H "Authorization: ApiKey 28irlNAGasWDSupO9Vw0BBMZfuHrAUYKpmroS9yBORI" \
-d '{
  "name":"UserCustomProfile",
  "fields":{
    "name":"String",
    "last_name":"String",
    "age":"Integer",
    "tags":"String_a"
  },
  "permissions":{},
}' \
"https://api.quickblox.com/class.json"

6. Set CRUD operations

Set the operations that can be performed on a record.Here, the create, read, and update operations are set.

curl -X POST \
-H "Content-Type: application/json" \
-H "Authorization: ApiKey 28irlNAGasWDSupO9Vw0BBMZfuHrAUYKpmroS9yBORI" \
-d '{
  "name":"UserCustomProfile",
  "fields":{
    "name":"String",
    "last_name":"String",
    "age":"Integer",
    "tags":"String_a"
  },
  "permissions":{
    "create":{},
    "read":{},
    "update":{},
  },
}' \
"https://api.quickblox.com/class.json"

7. Set access levels

Set an access level for a record.Here, the open, not_allowed, and open_for_users_ids access levels are set.

curl -X POST \
-H "Content-Type: application/json" \
-H "Authorization: ApiKey 28irlNAGasWDSupO9Vw0BBMZfuHrAUYKpmroS9yBORI" \
-d '{
  "name":"UserCustomProfile",
  "fields":{
    "name":"String",
    "last_name":"String",
    "age":"Integer",
    "tags":"String_a"
  },
  "permissions":{
    "create":{
      "access":"open"
    },
    "read":{
      "access":"not_allowed"
    },
    "update":{
      "access":"open_for_users_ids"
    },
  },
}' \
"https://api.quickblox.com/class.json"

8. Set IDs of users

Set IDs of users who can make a required operation.

curl -X POST \
-H "Content-Type: application/json" \
-H "Authorization: ApiKey 28irlNAGasWDSupO9Vw0BBMZfuHrAUYKpmroS9yBORI" \
-d '{
  "name":"UserCustomProfile",
  "fields":{
    "name":"String",
    "last_name":"String",
    "age":"Integer",
    "tags":"String_a"
  },
  "permissions":{
    "create":{
      "access":"open"
    },
    "read":{
      "access":"not_allowed"
    },
    "update":{
      "access":"open_for_users_ids",
      "ids":"1,2"
    },
  },
}' \
"https://api.quickblox.com/class.json"

9. As a result, the API returns a newly created class.

{
  "_id": "5ddfb849a0eb4725dfc9b0ad",
  "acl": {
    "read": {
      "access": "not_allowed"
    },
    "update": {
      "access": "open_for_users_ids",
      "users_ids": [
        "1",
        "2"
      ]
    },
    "delete": {
      "access": "owner"
    },
    "create": {
      "access": "open",
      "primary": true
    }
  },
  "application_id": 78387,
  "custom_fields": [
    {
      "name": "name",
      "type": "String"
    },
    {
      "name": "last_name",
      "type": "String"
    },
    {
      "name": "age",
      "type": "Integer"
    },
    {
      "is_array": "1",
      "name": "tags",
      "type": "String"
    }
  ],
  "name": "UserCustomProfile",
  "user_id": 91103344
}

Allowed permissions

Permission	Syntax	Example
Open	permissions.<CRUD_operation>.access	permissions.read.access=open
Owner	permissions.<CRUD_operation>.access	permissions.read.access=owner
Not allowed	permissions.<CRUD_operation>.access	permissions.read.access=not_allowed
Open for users IDs	permissions.<CRUD_operation>.access=open_for_users_ids permissions.<CRUD_operation>.ids=id_1,id_2,id_3,…	permissions.update.access=open_for_users_ids permissions.update.ids=3,12
Open for groups	permissions.<CRUD_operation>.access=open_for_groups permissions.<CRUD_operation>.groups=group_name_1,group_name_2	permissions.delete.access=open_for_groups permissions.delete.groups=experience,rate

Body Parameters

string

required

Custom class name.

object

Custom class fields with types. Format: fields.{custom_field}=<field_type>.

Show fields object

string

Name and type of a custom field. Can be many 1..N.Possible plain types: Integer, Float, String, Boolean, File, Date, Location (array of [longitude, latitude]).Possible array types: Integer_a, Float_a, Boolean_a, String_a.

string

Class permissions. Format:
permission.<CRUD_operation>.access=<value>
permission.<CRUD_operation>.<option>=<value>CRUD operations: create, read, update, delete.
CRUD access values: open, owner, not_allowed, open_for_users_ids, open_for_groups.
CRUD options: ids, groups.

Headers

string

required

A user or application session token. See Authentication page to learn more about session tokens. Must be used either QB-Token or Authorization.

string

default:"ApiKey {your_api_key}"

API key from Dashboard. Expected format: ApiKey {your_api_key}. Must be used either QB-Token or Authorization.

string

User ID. The user ID of the user on whose behalf the request is being made.

Responses

201

A successful response

string

object

Show properties

object

Show properties

string

Read access permission

object

Show properties

string

Update access permission

array of strings

Array of user IDs

object

Show properties

string

Delete access permission

object

Show properties

string

Create access permission

boolean

integer

The ID of the associated application

array

Show properties

boolean

string

Name of the custom field

string

Type of the custom field

string

Name of the resource

integer

The ID of the associated user

403

An error response

array of strings

422

An error response

Show Option 1

array of strings

Show Option 2

array of strings

Show Option 3

array of strings

Show Option 4

array of strings

curl -X POST \
-H "Content-Type: application/json" \
-H "QB-Token: c95dbdc9c72cc8e7f2367d7ef2c6d99c5e013233" \
-d '{
  "name":"UserCustomProfile",
  "fields":{
    "name":"String",
    "last_name":"String",
    "age":"Integer",
    "tags":"String_a"
  },
  "permissions":{
    "create":{
      "access":"open"
    },
    "read":{
      "access":"not_allowed"
    },
    "update":{
      "access":"open_for_users_ids",
      "ids":"1,2"
    }
  }
}' \
https://api.quickblox.com/class.json

{
  "_id": "5ddfb849a0eb4725dfc9b0ad",
  "acl": {
    "read": {
      "access": "not_allowed"
    },
    "update": {
      "access": "open_for_users_ids",
      "users_ids": [
        "1",
        "2"
      ]
    },
    "delete": {
      "access": "owner"
    },
    "create": {
      "access": "open",
      "primary": true
    }
  },
  "application_id": 78387,
  "custom_fields": [
    {
      "name": "name",
      "type": "String"
    },
    {
      "name": "last_name",
      "type": "String"
    },
    {
      "name": "age",
      "type": "Integer"
    },
    {
      "is_array": "1",
      "name": "tags",
      "type": "String"
    }
  ],
  "name": "UserCustomProfile",
  "user_id": 91103344
}

{
  "errors": [
    "You don't have appropriate permissions to do this operation"
  ]
}

{
  "name": [
    "can't be blank",
    "must contain only alphanumeric or underscore characters and begin with a letter.",
    "is too short (minimum is 3 characters)",
    "is too long (maximum is 50 characters)"
  ]
}

⌘I

​Recipes

​Body Parameters

​Headers

​Responses

Recipes

Body Parameters

Headers

Responses