marketingActivityCreate mutation
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
input
(
MarketingActivityCreateInput!
)
required
|
The Input of marketing activity create. |
MarketingActivityCreateInput fields
budget
(MarketingActivityBudgetInput)
|
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. |
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
input
(
MarketingActivityCreateInput!
)
required
|
The Input of marketing activity create. |
MarketingActivityCreateInput fields
budget
(MarketingActivityBudgetInput)
|
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. |
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
input
(
MarketingActivityCreateInput!
)
required
|
The Input of marketing activity create. |
MarketingActivityCreateInput fields
budget
(MarketingActivityBudgetInput)
|
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. |