Common GraphQL Mutations

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

api_call_send

Code example:

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_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. 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.

Beta Feature

This is an experimental feature. The at the end of its name stands for release candidate.

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. 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.

Beta Feature

This is an experimental feature. The at the end of its name stands for release candidate.

email_send

An email will be queued for sending.

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 .

image_presign_url

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

Deprecated. Use instead.

Arguments

Type

import_transactables

Deprecated. Use instead. See GraphQL Importing/Exporting Mutations.

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 .

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.

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.

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.

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.

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
• ApiCallSendRequestInput
• Any
• Boolean
• HashObject
• ID
• ImagePresignedUploadUrl
• ImagePresignUrlInput
• ImportTransactablesMutationPayload
• NotificationEmailInput
• NotificationSendEmailPayload
• NotificationTemplateInput
• PresignUrl
• PropertyUploadPresignedUrl
• SmsSendInput
• SmsSendPayload
• String
• TransactableImport
• UserOtpDeleteTokenInformation
• UserOtpSecretRefreshInformation