API version: unstable
API version: 2021-01 Release candidate
API version: 2020-10 Latest
API version: 2020-07
API version: 2020-04
API version: 2020-01
API version: 2019-10 Unsupported
API version: 2019-07 Unsupported

marketingActivityUpdate mutation

Version unstable

Updates a marketing activity.

Required access

write_marketing_events access scope.

Interactive example

This is an example mutation query. Use the embedded interactive tool below to edit the query.

Hint: use Ctrl + Space for autocompleting fields.


Arguments

input ( MarketingActivityUpdateInput! ) required

The Input of the marketing activity.

MarketingActivityUpdateInput fields

adSpend (MoneyInput)

The cumulative amount spent on this marketing activity. This argument is deprecated: Use MarketingEngagementCreate.MarketingEngagementInput.adSpend GraphQL to send the ad spend.
budget (MarketingActivityBudgetInput)

The budget for this marketing activity.
context (String)

Encoded context provided by Shopify during the update marketing activity callback. This argument is deprecated: This context is no longer needed by Shopify in the callback.
errorOccurredAt (DateTime)

The time at which the most recent error occurred.
errors (JSON)

Error messages generated when app was trying to complete this activity.
eventContext (String)

The event context of the marketing activity.
formData (String)

The form data of the marketing activity.
id (ID!) Required

The id for this marketing activity.
marketedResources ([ID!])

A list of the items that were marketed in this marketing activity. Valid types for these items are:

  • Product
  • Shop (Must be your current shop).
marketingRecommendationId (ID)

The ID of the recommendation this marketing activity was created from, if one exists.
scheduledToEndAt (DateTime)

The time at which the activity is scheduled to end.
scheduledToStartAt (DateTime)

The time at which the activity is scheduled to start.
status (MarketingActivityStatus)

The current state of the marketing activity.
targetStatus (MarketingActivityStatus)

The target state of the marketing activity.
title (String)

The title of this marketing activity.
trackingOpens (Boolean)

Whether or not the marketing activity is tracking opens.
useExternalEditor (Boolean)

Whether or not to point to the external editor.
utm (UTMInput)

Specifies the Urchin Traffic Module (UTM) parameters that are associated with a related marketing campaign. UTMInput is required for all Marketing tactics except Storefront App. This utm param can be only set once and never modified.

Return fields

marketingActivity (MarketingActivity)

The updated marketing activity.
redirectPath (String)

The path to return back to shopify admin from embedded editor.
userErrors ([UserError!]!)

List of errors that occurred executing the mutation.
Version 2021-01 (Release candidate)

Updates a marketing activity.

Required access

write_marketing_events access scope.

Interactive example

This is an example mutation query. Use the embedded interactive tool below to edit the query.

Hint: use Ctrl + Space for autocompleting fields.


Arguments

input ( MarketingActivityUpdateInput! ) required

The Input of the marketing activity.

MarketingActivityUpdateInput fields

adSpend (MoneyInput)

The cumulative amount spent on this marketing activity. This argument is deprecated: Use MarketingEngagementCreate.MarketingEngagementInput.adSpend GraphQL to send the ad spend.
budget (MarketingActivityBudgetInput)

The budget for this marketing activity.
context (String)

Encoded context provided by Shopify during the update marketing activity callback. This argument is deprecated: This context is no longer needed by Shopify in the callback.
errors (JSON)

Error messages generated when app was trying to complete this activity.
formData (String)

The form data of the marketing activity.
id (ID!) Required

The id for this marketing activity.
marketedResources ([ID!])

A list of the items that were marketed in this marketing activity. Valid types for these items are:

  • Product
  • Shop (Must be your current shop).
marketingRecommendationId (ID)

The ID of the recommendation this marketing activity was created from, if one exists.
status (MarketingActivityStatus)

The current state of the marketing activity.
targetStatus (MarketingActivityStatus)

The target state of the marketing activity.
title (String)

The title of this marketing activity.
utm (UTMInput)

Specifies the Urchin Traffic Module (UTM) parameters that are associated with a related marketing campaign. UTMInput is required for all Marketing tactics except Storefront App. This utm param can be only set once and never modified.

Return fields

marketingActivity (MarketingActivity)

The updated marketing activity.
redirectPath (String)

The path to return back to shopify admin from embedded editor.
userErrors ([UserError!]!)

List of errors that occurred executing the mutation.
Version 2020-10 (Latest)

Updates a marketing activity.

Required access

write_marketing_events access scope.

Interactive example

This is an example mutation query. Use the embedded interactive tool below to edit the query.

Hint: use Ctrl + Space for autocompleting fields.


Arguments

input ( MarketingActivityUpdateInput! ) required

The Input of the marketing activity.

MarketingActivityUpdateInput fields

adSpend (MoneyInput)

The cumulative amount spent on this marketing activity. This argument is deprecated: Use MarketingEngagementCreate.MarketingEngagementInput.adSpend GraphQL to send the ad spend.
budget (MarketingActivityBudgetInput)

The budget for this marketing activity.
context (String)

Encoded context provided by Shopify during the update marketing activity callback. This argument is deprecated: This context is no longer needed by Shopify in the callback.
errors (JSON)

Error messages generated when app was trying to complete this activity.
formData (String)

The form data of the marketing activity.
id (ID!) Required

The id for this marketing activity.
marketedResources ([ID!])

A list of the items that were marketed in this marketing activity. Valid types for these items are:

  • Product
  • Shop (Must be your current shop).
marketingRecommendationId (ID)

The ID of the recommendation this marketing activity was created from, if one exists.
status (MarketingActivityStatus)

The current state of the marketing activity.
targetStatus (MarketingActivityStatus)

The target state of the marketing activity.
title (String)

The title of this marketing activity.
utm (UTMInput)

Specifies the Urchin Traffic Module (UTM) parameters that are associated with a related marketing campaign. UTMInput is required for all Marketing tactics except Storefront App. This utm param can be only set once and never modified.

Return fields

marketingActivity (MarketingActivity)

The updated marketing activity.
redirectPath (String)

The path to return back to shopify admin from embedded editor.
userErrors ([UserError!]!)

List of errors that occurred executing the mutation.
Version 2020-07

Updates a marketing activity.

Required access

write_marketing_events access scope.

Interactive example

This is an example mutation query. Use the embedded interactive tool below to edit the query.

Hint: use Ctrl + Space for autocompleting fields.


Arguments

input ( MarketingActivityUpdateInput! ) required

The Input of the marketing activity.

MarketingActivityUpdateInput fields

adSpend (MoneyInput)

The cumulative amount spent on this marketing activity. This argument is deprecated: Use MarketingEngagementCreate.MarketingEngagementInput.adSpend GraphQL to send the ad spend.
budget (MarketingActivityBudgetInput)

The budget for this marketing activity.
context (String)

Encoded context provided by Shopify during the update marketing activity callback. This argument is deprecated: This context is no longer needed by Shopify in the callback.
errors (JSON)

Error messages generated when app was trying to complete this activity.
id (ID!) Required

The id for this marketing activity.
marketedResources ([ID!])

A list of the items that were marketed in this marketing activity. Valid types for these items are:

  • Product
  • Shop (Must be your current shop).
marketingRecommendationId (ID)

The ID of the recommendation this marketing activity was created from, if one exists.
status (MarketingActivityStatus)

The current state of the marketing activity.
title (String)

The title of this marketing activity.
utm (UTMInput)

Specifies the Urchin Traffic Module (UTM) parameters that are associated with a related marketing campaign. UTMInput is required for all Marketing tactics except Storefront App. This utm param can be only set once and never modified.

Return fields

marketingActivity (MarketingActivity)

The updated marketing activity.
userErrors ([UserError!]!)

List of errors that occurred executing the mutation.
Version 2020-04

Updates a marketing activity.

Required access

write_marketing_events access scope.

Interactive example

This is an example mutation query. Use the embedded interactive tool below to edit the query.

Hint: use Ctrl + Space for autocompleting fields.


Arguments

input ( MarketingActivityUpdateInput! ) required

The Input of the marketing activity.

MarketingActivityUpdateInput fields

adSpend (MoneyInput)

The cumulative amount spent on this marketing activity. This argument is deprecated: Use MarketingEngagementCreate.MarketingEngagementInput.adSpend GraphQL to send the ad spend.
budget (MarketingActivityBudgetInput)

The budget for this marketing activity.
context (String)

Encoded context provided by Shopify during the update marketing activity callback. This argument is deprecated: This context is no longer needed by Shopify in the callback.
errors (JSON)

Error messages generated when app was trying to complete this activity.
id (ID!) Required

The id for this marketing activity.
marketedResources ([ID!])

A list of the items that were marketed in this marketing activity. Valid types for these items are:

  • Product
  • Shop (Must be your current shop).
marketingRecommendationId (ID)

The ID of the recommendation this marketing activity was created from, if one exists.
status (MarketingActivityStatus)

The current state of the marketing activity.
title (String)

The title of this marketing activity.
utm (UTMInput)

Specifies the Urchin Traffic Module (UTM) parameters that are associated with a related marketing campaign. UTMInput is required for all Marketing tactics except Storefront App. This utm param can be only set once and never modified.

Return fields

marketingActivity (MarketingActivity)

The updated marketing activity.
userErrors ([UserError!]!)

List of errors that occurred executing the mutation.
Version 2020-01

Updates a marketing activity.

Required access

write_marketing_events access scope.

Interactive example

This is an example mutation query. Use the embedded interactive tool below to edit the query.

Hint: use Ctrl + Space for autocompleting fields.


Arguments

input ( MarketingActivityUpdateInput! ) required

The Input of the marketing activity.

MarketingActivityUpdateInput fields

adSpend (MoneyInput)

The cumulative amount spent on this marketing activity. This argument is deprecated: Use MarketingEngagementCreate.MarketingEngagementInput.adSpend GraphQL to send the ad spend.
budget (MarketingActivityBudgetInput)

The budget for this marketing activity.
context (String)

Encoded context provided by Shopify during the update marketing activity callback. This argument is deprecated: This context is no longer needed by Shopify in the callback.
errors (JSON)

Error messages generated when app was trying to complete this activity.
id (ID!) Required

The id for this marketing activity.
marketedResources ([ID!])

A list of the items that were marketed in this marketing activity. Valid types for these items are:

  • Product
  • Shop (Must be your current shop).
marketingRecommendationId (ID)

The ID of the recommendation this marketing activity was created from, if one exists.
status (MarketingActivityStatus)

The current state of the marketing activity.
title (String)

The title of this marketing activity.
utm (UTMInput)

Specifies the Urchin Traffic Module (UTM) parameters that are associated with a related marketing campaign. UTMInput is required for all Marketing tactics except Storefront App. This utm param can be only set once and never modified.

Return fields

marketingActivity (MarketingActivity)

The updated marketing activity.
userErrors ([UserError!]!)

List of errors that occurred executing the mutation.
Version 2019-10 (Unsupported)

Updates a marketing activity.

Required access

write_marketing_events access scope.

Interactive example

This is an example mutation query. Use the embedded interactive tool below to edit the query.

Hint: use Ctrl + Space for autocompleting fields.


Arguments

input ( MarketingActivityUpdateInput! ) required

The Input of the marketing activity.

MarketingActivityUpdateInput fields

adSpend (MoneyInput)

The cumulative amount spent on this marketing activity. This argument is deprecated: Use MarketingEngagementCreate.MarketingEngagementInput.adSpend GraphQL to send the ad spend.
budget (MarketingActivityBudgetInput)

The budget for this marketing activity.
context (String)

Encoded context provided by Shopify during the update marketing activity callback. This argument is deprecated: This context is no longer needed by Shopify in the callback.
errors (JSON)

Error messages generated when app was trying to complete this activity.
id (ID!) Required

The id for this marketing activity.
marketedResources ([ID!])

A list of the items that were marketed in this marketing activity. Valid types for these items are:

  • Product
  • Shop (Must be your current shop).
marketingRecommendationId (ID)

The ID of the recommendation this marketing activity was created from, if one exists.
status (MarketingActivityStatus)

The current state of the marketing activity.
title (String)

The title of this marketing activity.
utm (UTMInput)

Specifies the Urchin Traffic Module (UTM) parameters that are associated with a related marketing campaign. UTMInput is required for all Marketing tactics except Storefront App. This utm param can be only set once and never modified.

Return fields

marketingActivity (MarketingActivity)

The updated marketing activity.
userErrors ([UserError!]!)

List of errors that occurred executing the mutation.
Version 2019-07 (Unsupported)

Updates a marketing activity.

Required access

write_marketing_events access scope.

Interactive example

This is an example mutation query. Use the embedded interactive tool below to edit the query.

Hint: use Ctrl + Space for autocompleting fields.


Arguments

input ( MarketingActivityUpdateInput! ) required

The Input of the marketing activity.

MarketingActivityUpdateInput fields

adSpend (MoneyInput)

The cumulative amount spent on this marketing activity. This argument is deprecated: Use MarketingEngagementCreate.MarketingEngagementInput.adSpend GraphQL to send the ad spend.
budget (MarketingActivityBudgetInput)

The budget for this marketing activity.
context (String)

Encoded context provided by Shopify during the update marketing activity callback. This argument is deprecated: This context is no longer needed by Shopify in the callback.
errors (JSON)

Error messages generated when app was trying to complete this activity.
id (ID!) Required

The id for this marketing activity.
marketedResources ([ID!])

A list of the items that were marketed in this marketing activity. Valid types for these items are:

  • Product
  • Shop (Must be your current shop).
marketingRecommendationId (ID)

The ID of the recommendation this marketing activity was created from, if one exists.
status (MarketingActivityStatus)

The current state of the marketing activity.
title (String)

The title of this marketing activity.
utm (UTMInput)

Specifies the Urchin Traffic Module (UTM) parameters that are associated with a related marketing campaign. UTMInput is required for all Marketing tactics except Storefront App. This utm param can be only set once and never modified.

Return fields

marketingActivity (MarketingActivity)

The updated marketing activity.
userErrors ([UserError!]!)

List of errors that occurred executing the mutation.
Version 2019-04 (Unsupported)

Updates a marketing activity.

Required access

write_marketing_events access scope.

Interactive example

This is an example mutation query. Use the embedded interactive tool below to edit the query.

Hint: use Ctrl + Space for autocompleting fields.


Arguments

input ( MarketingActivityUpdateInput! ) required

The Input of the marketing activity.

MarketingActivityUpdateInput fields

adSpend (MoneyInput)

The cumulative amount spent on this marketing activity. This argument is deprecated: Use MarketingEngagementCreate.MarketingEngagementInput.adSpend GraphQL to send the ad spend.
budget (MarketingActivityBudgetInput)

The budget for this marketing activity.
context (String)

Encoded context provided by Shopify during the update marketing activity callback. This argument is deprecated: This context is no longer needed by Shopify in the callback.
errors (JSON)

Error messages generated when app was trying to complete this activity.
id (ID!) Required

The id for this marketing activity.
marketedResources ([ID!])

A list of the items that were marketed in this marketing activity. Valid types for these items are:

  • Product
  • Shop (Must be your current shop).
marketingRecommendationId (ID)

The ID of the recommendation this marketing activity was created from, if one exists.
status (MarketingActivityStatus)

The current state of the marketing activity.
title (String)

The title of this marketing activity.
utm (UTMInput)

Specifies the Urchin Traffic Module (UTM) parameters that are associated with a related marketing campaign. UTMInput is required for all Marketing tactics except Storefront App. This utm param can be only set once and never modified.

Return fields

marketingActivity (MarketingActivity)

The updated marketing activity.
userErrors ([UserError!]!)

List of errors that occurred executing the mutation.