Skip to main content
POST

Recipes

1

1. Use 'Authorization' header to pass API key

2

2. Set record fields.

You can set as many fields as you need for a new child record.
3

3. Set a parent class, parent record ID, and child class name.

Specify the parent class name, parent record ID, and child class name in the URL.Here, the parent class is user, the parent record ID is 617817b94dd9626e64022fdd, and the child class is friends.
4

4. As a result, the API returns a newly created child record.

A child record type is a record that refers to another record that has already been created, a parent. When a record is created, it is assigned a record ID. Thus, you can create a new record, a child, and attach it to the parent record by pointing to its ID.

Path Parameters

string
required
A class name of the parent custom object.
string
required
An ID of the parent custom object.
string
required
A class name of the child custom object.

Body Parameters

string
Set value to the field defined in Custom Object class. Can be many 1..N.
string
Record permissions. Format:
permission.<CRUD_operation>.access=<value>
permission.<CRUD_operation>.<option>=<value>
CRUD operations: create, read, update, delete.
CRUD access values: open, owner, 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

A successful response
string
string
integer
integer
integer
object
An error response