Common GraphQL Mutations

api_call_send

Code example:

api_call_send(
  api_call: ApiCallSendRequestInput
  data: HashObject
  options: ApiCallSendOptions
  template: NotificationTemplateInput
): ApiCallSendPayload

Arguments

Sends a request without a template. It takes the url, method, headers and body: .

Variables that will be accessible in liquid.

Set in seconds. For a call made from a web request, the default and the maximum are 5. For a call made from a background job, the default is 8 and the maximum is 180.

Template defined in .

Type

The autogenerated return type of .

documents_delete

Delete a document by ID.

documents_delete(
  id: ID!
  search_index: String!
): HashObject

Arguments

Index name.

Type

Represents data as a collection of unique keys and their values. Also known as associative arrays, maps or dictionaries. It can be any level deep. In Liquid, write a hash directly as a literal, for example . Use only to turn a JSON string you receive at runtime into a hash.

documents_insert

Insert a document into the index. The document will be updated if it already exists.

documents_insert(
  document: HashObject!
  id: ID
  search_index: String!
): HashObject

Arguments

JSON document to be put into the index.

Index name.

Type

Represents data as a collection of unique keys and their values. Also known as associative arrays, maps or dictionaries. It can be any level deep. In Liquid, write a hash directly as a literal, for example . Use only to turn a JSON string you receive at runtime into a hash.

email_send

An email will be queued for sending.

email_send(
  data: HashObject
  email: NotificationEmailInput
  template: NotificationTemplateInput
): NotificationSendEmailPayload

Arguments

Variables that will be accessible in liquid.

Email parameters, such as from, to, subject and content.

Template defined in .

Type

The autogenerated return type of .

property_upload_presigned_url

Generate a pre-signed URL where you can upload an image. Include image processing.

property_upload_presigned_url(
  include_content_type: Boolean = false
  presign_url: PresignUrl
  property_name: String!
  table: String
  user: Boolean = false
): PropertyUploadPresignedUrl!

Arguments

Set to  if you want to include a content type in the request to S3. Useful in some cases where the default provided by S3 will not do, like for example for SVG files.

Presign URL options.

Name of the property of type .

Name of the Table schema to which the property belongs. Must be blank if the property is defined directly in .

Must be set to if a property is defined directly in and not in a Model Schema.

Type

session_create_field

Adds a field to a session.

session_create_field(
  name: String!
  value: Any!
): HashObject

Arguments

Type

Represents data as a collection of unique keys and their values. Also known as associative arrays, maps or dictionaries. It can be any level deep. In Liquid, write a hash directly as a literal, for example . Use only to turn a JSON string you receive at runtime into a hash.

session_delete_field

Deletes a field from a session.

session_delete_field(
  name: String!
): HashObject

Arguments

Type

Represents data as a collection of unique keys and their values. Also known as associative arrays, maps or dictionaries. It can be any level deep. In Liquid, write a hash directly as a literal, for example . Use only to turn a JSON string you receive at runtime into a hash.

sms_send

Queues an SMS for sending.

sms_send(
  data: HashObject
  sms: SmsSendInput
  template: NotificationTemplateInput
): SmsSendPayload

Arguments

Variables that will be accessible in liquid.

SMS parameters: the recipient, the content and an optional delay.

Template defined in .

Type

The autogenerated return type of .

user_otp_delete_token

Deletes a user's secret OTP token.

user_otp_delete_token(
  otp_name: String
  user_id: ID!
): UserOtpDeleteTokenInformation

Arguments

OTP name, leave blank for default.

Type

user_otp_secret_refresh

Refreshes a user's secret OTP token(s).

user_otp_secret_refresh(
  otp_name: String
  user_id: ID!
): UserOtpSecretRefreshInformation

Arguments

OTP name, leave blank for default.

Type