GraphQL Data Mutations

constant_set

Code example:

constant_set(
  name: String!
  value: String!
): EncryptedConstant!

Arguments

Name of the constant you want to set.

Value of the constant, which will be securely stored.

Type

constant_unset

Code example:

constant_unset(
  name: String!
): EncryptedConstant

Arguments

Name of the constant you want to unset.

Type

record_create

Creates a record.

record_create(
  form_name: String
  record: RecordInputType!
): Record!

Arguments

Name of the form with whitelist attributes that the system can save. If left blank, all attributes will be allowed. The system will trigger all notifications and callbacks associated with the form.

Type

record_delete

Marks a record as deleted. Always pass : the schema marks it optional, but the instance refuses a delete without it, with the error You must specify table to which the record should belong. The record keeps its id and is removed for good after 30 days.

record_delete(
  form_name: String
  id: ID!
  table: String
): Record!

Arguments

Name of the form with whitelist attributes that the system can save. If left blank, all attributes will be allowed. The system will trigger all notifications and callbacks associated with the form.

Type

record_update

Updates a record.

record_update(
  form_name: String
  id: ID!
  record: RecordInputType!
): Record!

Arguments

Name of the form with whitelist attributes that the system can save. If left blank, all attributes will be allowed. The system will trigger all notifications and callbacks associated with the form.

Type

records_delete_all

Marks all matching records as deleted. They are kept for 30 days and then removed for good, and their ids cannot be imported again.

records_delete_all(
  any_table: Boolean
  filter: RecordsFilterInput
  sync: Boolean
  table: String
): ObjectCount!

Arguments

Mark this if you want to remove records across all tables.

Set to if you want it to run synchronously.

Type

records_update_all

Update all records matching the filter conditions; use only for small result sets. For bigger results sets, use the feature.

records_update_all(
  filter: RecordsFilterInput
  record: RecordInputType!
  sync: Boolean
  table: String!
): ObjectCount!

Arguments

Set to if you want it to run synchronously.

Type

user_create

Creates a user.

user_create(
  form_configuration_name: String
  form_name: String
  id: ID
  user: UserInputType!
): User

Arguments

Name of the form with whitelist attributes that the system can save. If left blank, all attributes will be allowed. The system will trigger all notifications and callbacks associated with the form.

Type

user_delete

Deletes a user.

user_delete(
  form_configuration_name: String
  form_name: String
  id: ID!
): User

Arguments

Name of the form with whitelist attributes that the system can save. If left blank, all attributes will be allowed. The system will trigger all notifications and callbacks associated with the form.

Type

user_update

Updates the

user_update(
  form_configuration_name: String
  form_name: String
  id: ID
  user: UserInputType!
): User

Arguments

Name of the form with whitelist attributes that the system can save. If left blank, all attributes will be allowed. The system will trigger all notifications and callbacks associated with the form.

When not provided, try using .

Type

users_delete_all

Remove all users. Beware, there is no coming back!

users_delete_all(
  all_users: Boolean
  filter: UsersFilterInput
  sync: Boolean
): ObjectCount!

Arguments

If filter options are not specified, you must check this.

Set to if you want it to run synchronously.

Type

users_update_all

Update all users matching the filter conditions; use only for a small result set. For a bigger result set, use the feature.

users_update_all(
  all_users: Boolean
  filter: UsersFilterInput
  sync: Boolean
  user: UserInputType!
): ObjectCount!

Arguments

If filter options are not specified, this must be checked.

Set to if you want it to run synchronously.

Type