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

marketingActivityCreate mutation

Version unstable

Create new 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

Argument Description
input ( MarketingActivityCreateInput! ) required

The Input of marketing activity create.

MarketingActivityCreateInput fields

  • The budget for this marketing activity.

  • context (String)

    Encoded context containing marketing campaign id.

  • formData (String)

    The form data in JSON serialized as a string.

  • marketingActivityExtensionId (ID!) Required

    The ID of the marketing activity extension.

  • marketingActivityTitle (String)

    The title of the marketing activity.

  • status (MarketingActivityStatus!) Required

    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.

Return fields

  • marketingActivity (MarketingActivity)

    The created 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-04 (Release candidate)

Create new 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

Argument Description
input ( MarketingActivityCreateInput! ) required

The Input of marketing activity create.

MarketingActivityCreateInput fields

  • The budget for this marketing activity.

  • context (String)

    Encoded context containing marketing campaign id.

  • formData (String)

    The form data in JSON serialized as a string.

  • marketingActivityExtensionId (ID!) Required

    The ID of the marketing activity extension.

  • marketingActivityTitle (String)

    The title of the marketing activity.

  • status (MarketingActivityStatus!) Required

    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.

Return fields

  • marketingActivity (MarketingActivity)

    The created 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 (Latest)

Create new 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

Argument Description
input ( MarketingActivityCreateInput! ) required

The Input of marketing activity create.

MarketingActivityCreateInput fields

  • The budget for this marketing activity.

  • context (String)

    Encoded context containing marketing campaign id.

  • formData (String)

    The form data in JSON serialized as a string.

  • marketingActivityExtensionId (ID!) Required

    The ID of the marketing activity extension.

  • marketingActivityTitle (String)

    The title of the marketing activity.

  • status (MarketingActivityStatus!) Required

    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.

Return fields

  • marketingActivity (MarketingActivity)

    The created 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

Create new 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

Argument Description
input ( MarketingActivityCreateInput! ) required

The Input of marketing activity create.

MarketingActivityCreateInput fields

  • The budget for this marketing activity.

  • context (String)

    Encoded context containing marketing campaign id.

  • formData (String)

    The form data in JSON serialized as a string.

  • marketingActivityExtensionId (ID!) Required

    The ID of the marketing activity extension.

  • marketingActivityTitle (String)

    The title of the marketing activity.

  • status (MarketingActivityStatus!) Required

    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.

Return fields

  • marketingActivity (MarketingActivity)

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