Insites Docs Developers graphql GraphQL CommonCommon GraphQL Mutations

Common GraphQL Mutations

Last updated on June 18, 2024.

Use this document to guide you in using Common GraphQL Mutations on Insites.

api_call_send

Code example:

Arguments

Variables that will be accessible in liquid.

Template defined in .

Type

The autogenerated return type of .

documents_delete_rc

Delete a document by ID.

Arguments

Index name.

Type

Represents data as a collection of unique keys and their values. Also known as associative arrays, maps or dictionaries. You can create it in liquid by converting JSON object with filter or tag. It can be any level deep.

Beta Feature

Please note this is currently an experimental feature with an appended tag which stands for release candidate. Once this feature has been confirmed as being stable, this tag will be removed.

documents_insert_rc

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

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. You can create it in liquid by converting JSON object with filter or tag. It can be any level deep.

Beta Feature

Please note this is currently an experimental feature with an appended tag which stands for release candidate. Once this feature has been confirmed as being stable, this tag will be removed.

email_send

An email will be queued for sending.

Arguments

Variables that will be accessible in liquid.

Template defined in .

Type

The autogenerated return type of .

image_presign_url

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

Arguments

Type

import_transactables

Code example:

Arguments

Remap IDs; when disabled, all IDs need to be an Integer.

Rebuilds index for full-text search queries.

Type

The autogenerated return type of .

property_upload_presigned_url

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

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.

Deprecated; use .

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.

Arguments

Type

Represents data as a collection of unique keys and their values. Also known as associative arrays, maps or dictionaries. You can create it in liquid by converting JSON object with filter or tag. It can be any level deep.

session_delete_field

Deletes a field from a session.

Arguments

Type

Represents data as a collection of unique keys and their values. Also known as associative arrays, maps or dictionaries. You can create it in liquid by converting JSON object with filter or tag. It can be any level deep.

sms_send

Queues an SMS for sending.

Arguments

Variables that will be accessible in liquid.

Template defined in .

Type

The autogenerated return type of .

user_otp_delete_token

Deletes a user's secret OTP token.

Arguments

OTP name, leave blank for default.

Type

user_otp_secret_refresh

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

Arguments

OTP name, leave blank for default.

Type

Reference

You may visit the following resources for more information:

  • ApiCallSendOptions
  • ApiCallSendPayload
  • Any
  • Boolean
  • HashObject
  • ID
  • ImagePresignedUploadUrl
  • ImagePresignUrlInput
  • ImportTransactablesMutationPayload
  • NotificationSendEmailPayload
  • NotificationTemplateInput
  • PropertyUploadPresignedUrl
  • SmsSendPayload
  • String
  • TransactableImport
  • UserOtpDeleteTokenInformation
  • UserOtpSecretRefreshInformation
Have a suggestion for this page?

Didn't quite find what you are looking for or have feedback on how we can make the content better then we would love to hear from you. Please provide us feedback and we will get back to you shortly.