marketingActivityCreate - admin-graphql - MUTATION

Version: 2024-10

Description:

Create new marketing activity.

Access Scopes

`write_marketing_events` access scope.

Arguments

• input: MarketingActivityCreateInput! - The Input of marketing activity create.

Returns

• marketingActivity: MarketingActivity The created marketing activity.
• redirectPath: String The path to return back to shopify admin from embedded editor.
• userErrors: UserError! The list of errors that occurred from executing the mutation.

Examples

• Create a DRAFT marketing activity for a specific marketing activity extension

          Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-10/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"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 } } }\",\n \"variables\": {\n    \"marketingActivityTitle\": \"Draft Marketing Activity\",\n    \"marketingActivityExtensionId\": \"gid://shopify/MarketingActivityExtension/666dcce8-6389-425f-bcf0-6c9469b6716f\",\n    \"context\": \"eyJtYXJrZXRpbmdfY2FtcGFpZ25faWQiOiI2NDYzMzc3NDMifQ==\",\n    \"status\": \"DRAFT\"\n  }\n}'\n"
          Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n  data: {\n    \"query\": `mutation marketingActivityCreate($marketingActivityTitle: String!, $marketingActivityExtensionId: ID!, $context: String!, $status: MarketingActivityStatus!) {\n      marketingActivityCreate(input: {marketingActivityTitle: $marketingActivityTitle, marketingActivityExtensionId: $marketingActivityExtensionId, status: $status, context: $context}) {\n        marketingActivity {\n          id\n          title\n          status\n        }\n      }\n    }`,\n    \"variables\": {\n      \"marketingActivityTitle\": \"Draft Marketing Activity\",\n      \"marketingActivityExtensionId\": \"gid://shopify/MarketingActivityExtension/666dcce8-6389-425f-bcf0-6c9469b6716f\",\n      \"context\": \"eyJtYXJrZXRpbmdfY2FtcGFpZ25faWQiOiI2NDYzMzc3NDMifQ==\",\n      \"status\": \"DRAFT\"\n    },\n  },\n});\n"
          Ruby example: "session = ShopifyAPI::Auth::Session.new(\n  shop: \"your-development-store.myshopify.com\",\n  access_token: access_token\n)\nclient = ShopifyAPI::Clients::Graphql::Admin.new(\n  session: session\n)\n\nquery = <<~QUERY\n  mutation marketingActivityCreate($marketingActivityTitle: String!, $marketingActivityExtensionId: ID!, $context: String!, $status: MarketingActivityStatus!) {\n    marketingActivityCreate(input: {marketingActivityTitle: $marketingActivityTitle, marketingActivityExtensionId: $marketingActivityExtensionId, status: $status, context: $context}) {\n      marketingActivity {\n        id\n        title\n        status\n      }\n    }\n  }\nQUERY\n\nvariables = {\n  \"marketingActivityTitle\": \"Draft Marketing Activity\",\n  \"marketingActivityExtensionId\": \"gid://shopify/MarketingActivityExtension/666dcce8-6389-425f-bcf0-6c9469b6716f\",\n  \"context\": \"eyJtYXJrZXRpbmdfY2FtcGFpZ25faWQiOiI2NDYzMzc3NDMifQ==\",\n  \"status\": \"DRAFT\"\n}\n\nresponse = client.query(query: query, variables: variables)\n"
          PHP example: "use Shopify\\Clients\\Graphql;\n\n$client = new Graphql(\"your-development-store.myshopify.com\", $accessToken);\n$query = <<<QUERY\n  mutation marketingActivityCreate($marketingActivityTitle: String!, $marketingActivityExtensionId: ID!, $context: String!, $status: MarketingActivityStatus!) {\n    marketingActivityCreate(input: {marketingActivityTitle: $marketingActivityTitle, marketingActivityExtensionId: $marketingActivityExtensionId, status: $status, context: $context}) {\n      marketingActivity {\n        id\n        title\n        status\n      }\n    }\n  }\nQUERY;\n\n$variables = [\n  \"marketingActivityTitle\" => \"Draft Marketing Activity\",\n  \"marketingActivityExtensionId\" => \"gid://shopify/MarketingActivityExtension/666dcce8-6389-425f-bcf0-6c9469b6716f\",\n  \"context\" => \"eyJtYXJrZXRpbmdfY2FtcGFpZ25faWQiOiI2NDYzMzc3NDMifQ==\",\n  \"status\" => \"DRAFT\",\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
          Remix example: "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n  `#graphql\n  mutation marketingActivityCreate($marketingActivityTitle: String!, $marketingActivityExtensionId: ID!, $context: String!, $status: MarketingActivityStatus!) {\n    marketingActivityCreate(input: {marketingActivityTitle: $marketingActivityTitle, marketingActivityExtensionId: $marketingActivityExtensionId, status: $status, context: $context}) {\n      marketingActivity {\n        id\n        title\n        status\n      }\n    }\n  }`,\n  {\n    variables: {\n      \"marketingActivityTitle\": \"Draft Marketing Activity\",\n      \"marketingActivityExtensionId\": \"gid://shopify/MarketingActivityExtension/666dcce8-6389-425f-bcf0-6c9469b6716f\",\n      \"context\": \"eyJtYXJrZXRpbmdfY2FtcGFpZ25faWQiOiI2NDYzMzc3NDMifQ==\",\n      \"status\": \"DRAFT\"\n    },\n  },\n);\n\nconst data = await response.json();\n"
          Graphql query: "mutation marketingActivityCreate($marketingActivityTitle: String!, $marketingActivityExtensionId: ID!, $context: String!, $status: MarketingActivityStatus!) {\n  marketingActivityCreate(input: {marketingActivityTitle: $marketingActivityTitle, marketingActivityExtensionId: $marketingActivityExtensionId, status: $status, context: $context}) {\n    marketingActivity {\n      id\n      title\n      status\n    }\n  }\n}"
        

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

  response: {
    "data": {
      "marketingActivityCreate": {
        "marketingActivity": {
          "id": "gid://shopify/MarketingActivity/1063897335",
          "title": "Draft Marketing Activity",
          "status": "DRAFT"
        }
      }
    }
  }