GraphQL Admin Mutations

For example, this mutation turns off an email notification by updating its trigger condition, and reads the new value back:

mutation {
  admin_email_notification_update(
    id: 123
    email_notification: { trigger_condition: "false", delay_by: "0" }
  ) {
    id
    trigger_condition
  }
}

Always send trigger_condition and delay_by when you update an email notification. Fields you leave out are reset to their defaults.

admin_api_call_notification_create

Creates an API call notification.

admin_api_call_notification_create(
  api_call_notification: ApiCallNotificationInputType!
): ApiCallNotification

Arguments

Type

admin_api_call_notification_delete

Deletes an API call notification.

admin_api_call_notification_delete(
  id: ID
  physical_file_path: String
): ApiCallNotification

Arguments

Deprecated; please use physical_file_path.

Type

admin_api_call_notification_update

Updates an API call notification.

admin_api_call_notification_update(
  api_call_notification: UpdateApiCallNotificationInputType!
  id: ID
  physical_file_path: String
): ApiCallNotification

Arguments

Deprecated; please use physical_file_path.

Type

admin_asset_delete

Remove an asset, including the physical file. There is no way to revert this operation. Use with caution.

admin_asset_delete(
  physical_file_path: String!
): Asset

Arguments

Type

admin_asset_delete_all

Removes all assets that match the filter.

admin_asset_delete_all(
  filter: MutationAssetsFilterInput!
  hard_delete: Boolean = false
): String

Arguments

Default false.

Type

admin_asset_update

Updates asset and physically move the file to the new location.

admin_asset_update(
  asset: AssetUpdateInput!
  physical_file_path: String!
): Asset

Arguments

Takes an optional that sets the Cache-Control header on the stored file.

Identifier of a file that you want to update.

Type

admin_asset_update_all

Updates all assets that match the filter.

admin_asset_update_all(
  asset: AssetUpdateAllInput!
  filter: MutationAssetsFilterInput!
): ObjectCount

Arguments

Type

admin_assets_create

Creates an asset.

admin_assets_create(
  assets: [AssetInput!]!
): AssetsCreateMutationPayload

Arguments

Upload each file first with . Each takes an optional , for example . It sets the Cache-Control header on the stored file. is optional: you can leave it out.

Type

admin_assets_listing_create

Asynchronously generates a report of the current s3 state. Returns ID, to be used in query.

admin_assets_listing_create: AssetsListingIdentifier!

Type

admin_assets_presign_urls

Pre-signs assets URLs for a given path.

admin_assets_presign_urls(
  paths: [AssetPresignInput!]!
): AssetsPresignUrlsMutationPayload

Arguments

Type

admin_authorization_policy_create

Creates an authorization policy.

admin_authorization_policy_create(
  authorization_policy: AuthorizationPolicyInputType!
): AuthorizationPolicy

Arguments

Type

admin_authorization_policy_delete

Deletes an authorization policy.

admin_authorization_policy_delete(
  id: ID
  physical_file_path: String
): AuthorizationPolicy

Arguments

Deprecated; please use physical_file_path.

Type

admin_authorization_policy_update

Updates an authorization policy.

admin_authorization_policy_update(
  authorization_policy: UpdateAuthorizationPolicyInputType!
  id: ID
  physical_file_path: String
): AuthorizationPolicy

Arguments

Deprecated; please use physical_file_path.

Type

admin_background_job_delete

Deletes a background job.

admin_background_job_delete(
  id: ID!
): BackgroundJob

Arguments

Type

admin_background_job_retry

Retries a failed background job.

admin_background_job_retry(
  id: ID!
): BackgroundJob

Arguments

Type

admin_background_jobs_delete_all

Deletes all background jobs that match the filter.

admin_background_jobs_delete_all(
  filter: BackgroundJobsFilterInput
): BackgroundJobsResult

Arguments

Type

admin_email_notification_create

Creates an email_notification schema.

admin_email_notification_create(
  email_notification: EmailNotificationInputType!
): EmailNotification

Arguments

Type

admin_email_notification_delete

Deletes an email_notification schema.

admin_email_notification_delete(
  id: ID
  physical_file_path: String
): EmailNotification

Arguments

Deprecated; please use physical_file_path.

Type

admin_email_notification_delete_all

Deletes email notifications that match the filter.

admin_email_notification_delete_all(
  filter: EmailNotificationsFilterInput!
): ObjectCount

Arguments

Filter for matching email notifications to delete.

Type

admin_email_notification_update

Updates email_notification schema.

admin_email_notification_update(
  email_notification: UpdateEmailNotificationInputType!
  id: ID
  physical_file_path: String
): EmailNotification

Arguments

Deprecated; please use physical_file_path.

Type

admin_email_notification_update_all

Updates all email notifications that match the filter.

admin_email_notification_update_all(
  email_notification: UpdateEmailNotificationInputType!
  filter: EmailNotificationsFilterInput!
): ObjectCount

Arguments

Filter for matching email notifications to update.

Type

admin_graphql_create

Creates GraphQL.

admin_graphql_create(
  graphql: GraphqlInputType!
): GraphQL

Arguments

TypeType

admin_graphql_delete

Deletes GraphQL.

admin_graphql_delete(
  physical_file_path: String!
): GraphQL

Arguments

Type

admin_graphql_update

Updates GraphQL.

admin_graphql_update(
  graphql: UpdateGraphqlInputType!
  physical_file_path: String!
): GraphQL

Arguments

Type

admin_liquid_layout_create

Creates liquid layout.

admin_liquid_layout_create(
  liquid_layout: LiquidLayoutInputType!
): LiquidLayout

Arguments

Type

admin_liquid_layout_delete

Deletes liquid layout.

admin_liquid_layout_delete(
  id: ID
  physical_file_path: String
): LiquidLayout

Arguments

Deprecated; please use physical_file_path.

Type

admin_liquid_layout_delete_all

Deletes multiple liquid layouts.

admin_liquid_layout_delete_all(
  filter: LiquidLayoutsFilterInput!
  sync: Boolean = false
): ObjectCount

Arguments

Set to true to run it synchronously. Default false.

Type

admin_liquid_layout_update

Updates liquid layout.

admin_liquid_layout_update(
  id: ID
  liquid_layout: UpdateLiquidLayoutInputType!
  physical_file_path: String
): LiquidLayout

Arguments

Deprecated; please use physical_file_path.

Type

admin_liquid_layout_update_all

Updates multiple liquid layouts.

admin_liquid_layout_update_all(
  filter: LiquidLayoutsFilterInput!
  liquid_layout: UpdateLiquidLayoutInputType!
): ObjectCount

Arguments

Type

admin_liquid_partial_create

Creates liquid partial.

admin_liquid_partial_create(
  liquid_partial: LiquidPartialInputType!
): LiquidPartial

Arguments

Type

admin_liquid_partial_delete

Deletes liquid partial.

admin_liquid_partial_delete(
  id: ID
  physical_file_path: String
): LiquidPartial

Arguments

Deprecated; please use physical_file_path.

Type

admin_liquid_partial_delete_all

Deletes multiple liquid partials.

admin_liquid_partial_delete_all(
  filter: LiquidPartialsFilterInput!
  sync: Boolean = false
): ObjectCount

Arguments

Set to true to run it synchronously. Default false.

Type

admin_liquid_partial_update

Updates liquid partial.

admin_liquid_partial_update(
  id: ID
  liquid_partial: UpdateLiquidPartialInputType!
  physical_file_path: String
): LiquidPartial

Arguments

Deprecated; please use physical_file_path.

Type

admin_liquid_partial_update_all

Updates multiple liquid partials.

admin_liquid_partial_update_all(
  filter: LiquidPartialsFilterInput!
  liquid_partial: UpdateLiquidPartialInputType!
): ObjectCount

Arguments

Type

admin_model_schema_create

Creates model schema.

admin_model_schema_create(
  model_schema: ModelSchemaInputType!
): ModelSchema

Arguments

Type

admin_model_schema_delete

Deletes model schema.

admin_model_schema_delete(
  id: ID
  physical_file_path: String
): ModelSchema

Arguments

Deprecated; please use physical_file_path.

Type

admin_model_schema_update

Updates model schema.

admin_model_schema_update(
  id: ID
  model_schema: UpdateModelSchemaInputType!
  physical_file_path: String
): ModelSchema

Arguments

Deprecated; please use physical_file_path.

Type

admin_page_create

Creates page.

In (and for admin_page_update), takes policy names as written in page front matter, for example . You can use it with . Every name must match an existing policy.

admin_page_create(
  page: PageInputType!
): Page

Arguments

Type

admin_page_delete

Deletes page.

admin_page_delete(
  id: ID
  physical_file_path: String
): Page

Arguments

Deprecated; please use physical_file_path.

Type

admin_page_update

Updates page.

admin_page_update(
  id: ID
  page: UpdatePageInputType!
  physical_file_path: String
): Page

Arguments

Deprecated; please use physical_file_path.

Type

admin_page_update_all

Updates multiple pages.

admin_page_update_all(
  filter: PageFilterInput!
  page: UpdatePageInputType!
): ObjectCount!

Arguments

Type

admin_pages_delete_all

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

admin_pages_delete_all(
  filter: PageFilterInput!
  sync: Boolean = false
): ObjectCount!

Arguments

Set to true if you want it to run synchronously. Default false.

Type

admin_property_create

Creates property.

admin_property_create(
  property: StandalonePropertyInputType!
): Property

Arguments

Type

admin_property_delete

Deletes a property.

admin_property_delete(
  id: ID!
): Property

Arguments

Type

admin_property_update

Updates a property.

admin_property_update(
  id: ID!
  property: UpdateStandalonePropertyInputType!
): Property

Arguments

Type

admin_sms_notification_create

Creates sms_notification schema.

admin_sms_notification_create(
  sms_notification: SmsNotificationInputType!
): SmsNotification

Arguments

Type

admin_sms_notification_delete

Deletes sms_notification schema.

admin_sms_notification_delete(
  id: ID
  physical_file_path: String
): SmsNotification

Arguments

Type

admin_sms_notification_update

Updates sms_notification schema.

admin_sms_notification_update(
  id: ID
  physical_file_path: String
  sms_notification: UpdateSmsNotificationInputType!
): SmsNotification

Arguments

Type

admin_table_create

Creates a table.

admin_table_create(
  table: TableInputType!
): Table

Arguments

Type

admin_table_delete

Deletes a table.

admin_table_delete(
  physical_file_path: String!
): Table

Arguments

Type

admin_table_update

Updates a table.

admin_table_update(
  physical_file_path: String!
  table: UpdateTableInputType!
): Table

Arguments

Type

admin_translation_set

Creates translation if the key/locale pair does not exist or updates existing translation.

admin_translation_set(
  translation: TranslationInputType!
): Translation

Arguments

Type

admin_translation_set_json

Sets the whole JSON branch by merging it with the existing translations or overwriting the whole branch.

admin_translation_set_json(
  strategy: TranslationJsonStrategy!
  translation: TranslationJsonInputType!
): TranslationJson

Arguments

json with translation tree, which should be set

Type

admin_translation_unset

Unsets the translation key for a given locale.

admin_translation_unset(
  key: String!
  locale: String!
): Translation

Arguments

for example en, de etc.

Type