marketingActivityUpdate mutation

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

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

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

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

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.

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.

Sign up for a Partner account to get started.

Sign up