Choose a version:

marketingActivityCreate

mutation

Requires write_marketing_events access scope.

Create new marketing activity. Marketing activity app extensions are deprecated and will be removed in the near future.

Arguments

Anchor to inputinput •MarketingActivityCreateInput! required: The Input of marketing activity create.

Was this section helpful?

Anchor to MarketingActivityCreatePayload returnsMarketingActivityCreatePayload returns

Anchor to userErrorsuserErrors •[UserError!]! non-null: The list of errors that occurred from executing the mutation.

Deprecated marketingactivitycreatepayload returns

Anchor to marketingActivitymarketingActivity •MarketingActivity Deprecated: The created marketing activity.
Anchor to redirectPathredirectPath •String Deprecated: The path to return back to shopify admin from embedded editor.

Was this section helpful?

Create a DRAFT marketing activity for a specific marketing activity extension
marketingActivityCreate reference

Examples

Open in GraphiQL

const { admin } = await authenticate.admin(request);

const response = await admin.graphql(

`#graphql

mutation marketingActivityCreate($marketingActivityTitle: String!, $marketingActivityExtensionId: ID!, $context: String!, $status: MarketingActivityStatus!) {

marketingActivityCreate(input: {marketingActivityTitle: $marketingActivityTitle, marketingActivityExtensionId: $marketingActivityExtensionId, status: $status, context: $context}) {

marketingActivity {

title

status

}

}`,

{

variables: {

"marketingActivityTitle": "Draft Marketing Activity",

"marketingActivityExtensionId": "gid://shopify/MarketingActivityExtension/666dcce8-6389-425f-bcf0-6c9469b6716f",

"context": "eyJtYXJrZXRpbmdfY2FtcGFpZ25faWQiOiI2NDYzMzc3NDMifQ==",

"status": "DRAFT"

);

const data = await response.json();

mutation marketingActivityCreate($marketingActivityTitle: String!, $marketingActivityExtensionId: ID!, $context: String!, $status: MarketingActivityStatus!) {
  marketingActivityCreate(input: {marketingActivityTitle: $marketingActivityTitle, marketingActivityExtensionId: $marketingActivityExtensionId, status: $status, context: $context}) {
    marketingActivity {
      id
      title
      status
    }
  }
}

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2024-10/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "mutation marketingActivityCreate($marketingActivityTitle: String!, $marketingActivityExtensionId: ID!, $context: String!, $status: MarketingActivityStatus!) { marketingActivityCreate(input: {marketingActivityTitle: $marketingActivityTitle, marketingActivityExtensionId: $marketingActivityExtensionId, status: $status, context: $context}) { marketingActivity { id title status } } }",
 "variables": {
    "marketingActivityTitle": "Draft Marketing Activity",
    "marketingActivityExtensionId": "gid://shopify/MarketingActivityExtension/666dcce8-6389-425f-bcf0-6c9469b6716f",
    "context": "eyJtYXJrZXRpbmdfY2FtcGFpZ25faWQiOiI2NDYzMzc3NDMifQ==",
    "status": "DRAFT"
  }
}'

const { admin } = await authenticate.admin(request);

const response = await admin.graphql(
  `#graphql
  mutation marketingActivityCreate($marketingActivityTitle: String!, $marketingActivityExtensionId: ID!, $context: String!, $status: MarketingActivityStatus!) {
    marketingActivityCreate(input: {marketingActivityTitle: $marketingActivityTitle, marketingActivityExtensionId: $marketingActivityExtensionId, status: $status, context: $context}) {
      marketingActivity {
        id
        title
        status
      }
    }
  }`,
  {
    variables: {
      "marketingActivityTitle": "Draft Marketing Activity",
      "marketingActivityExtensionId": "gid://shopify/MarketingActivityExtension/666dcce8-6389-425f-bcf0-6c9469b6716f",
      "context": "eyJtYXJrZXRpbmdfY2FtcGFpZ25faWQiOiI2NDYzMzc3NDMifQ==",
      "status": "DRAFT"
    },
  },
);

const data = await response.json();

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "query": `mutation marketingActivityCreate($marketingActivityTitle: String!, $marketingActivityExtensionId: ID!, $context: String!, $status: MarketingActivityStatus!) {
      marketingActivityCreate(input: {marketingActivityTitle: $marketingActivityTitle, marketingActivityExtensionId: $marketingActivityExtensionId, status: $status, context: $context}) {
        marketingActivity {
          id
          title
          status
        }
      }
    }`,
    "variables": {
      "marketingActivityTitle": "Draft Marketing Activity",
      "marketingActivityExtensionId": "gid://shopify/MarketingActivityExtension/666dcce8-6389-425f-bcf0-6c9469b6716f",
      "context": "eyJtYXJrZXRpbmdfY2FtcGFpZ25faWQiOiI2NDYzMzc3NDMifQ==",
      "status": "DRAFT"
    },
  },
});

session = ShopifyAPI::Auth::Session.new(
  shop: "your-development-store.myshopify.com",
  access_token: access_token
)
client = ShopifyAPI::Clients::Graphql::Admin.new(
  session: session
)

query = <<~QUERY
  mutation marketingActivityCreate($marketingActivityTitle: String!, $marketingActivityExtensionId: ID!, $context: String!, $status: MarketingActivityStatus!) {
    marketingActivityCreate(input: {marketingActivityTitle: $marketingActivityTitle, marketingActivityExtensionId: $marketingActivityExtensionId, status: $status, context: $context}) {
      marketingActivity {
        id
        title
        status
      }
    }
  }
QUERY

variables = {
  "marketingActivityTitle": "Draft Marketing Activity",
  "marketingActivityExtensionId": "gid://shopify/MarketingActivityExtension/666dcce8-6389-425f-bcf0-6c9469b6716f",
  "context": "eyJtYXJrZXRpbmdfY2FtcGFpZ25faWQiOiI2NDYzMzc3NDMifQ==",
  "status": "DRAFT"
}

response = client.query(query: query, variables: variables)

Input variables

JSON

{

"marketingActivityTitle": "Draft Marketing Activity",

"marketingActivityExtensionId": "gid://shopify/MarketingActivityExtension/666dcce8-6389-425f-bcf0-6c9469b6716f",

"context": "eyJtYXJrZXRpbmdfY2FtcGFpZ25faWQiOiI2NDYzMzc3NDMifQ==",

"status": "DRAFT"

}

Response

JSON

{

"marketingActivityCreate": {

"marketingActivity": {

"id": "gid://shopify/MarketingActivity/1063897335",

"title": "Draft Marketing Activity",

"status": "DRAFT"

}