Managing a marketing activity extension

Create a form from your Partner Dashboard

You can create a marketing activity extension from your Partners Dashboard. From there, you can configure your app extension by adding, removing, setting, and ordering components. To learn more about the marketing activty components, see the Marketing activity components reference.

Steps:

  1. From your Partner Dashboard, click Apps.
  2. Click the name of the app that you want to change.
  3. Click Extensions.
  4. Click Add marketing activity.
  5. In the Extension information section, enter the required information.
  6. Add the form components:
    1. Click Create field.
    2. On the Add components dialog, select the component that you want to add to your form. Each component has different requirements. To learn more about how to configure a component, see the Marketing activity components reference.
    3. Enter the required information.
  7. Click Save.

Next steps

Add the marketing activity endpoints to your app so that it can receive information about merchants' marketing activities from Shopify. Shopify uses REST calls and structured JSON to communicate with your app.

Update a marketing activity extension

You can update a marketing activity extension from your Partner Dashboard. You can modify your app extension by adding, removing, setting, and ordering components. To learn more about the marketing activity components, see the Marketing activity components reference.

We recommend that you limit modifications to cosmetic changes. Below are some examples of cosmetic changes:

  • updating the extension's description
  • changing the components' ordering
  • updating a field's label or placeholder text
  • adding a new title and body display text component

Steps:

  1. From your Partner Dashboard, click Apps.
  2. Click the name of the app that you want to change.
  3. From the app's page, click Extensions.
  4. In the Marketing activities section, select marketing activity that you want to update.
  5. On the Marketing activity page, enter the new information to the field you want to update.
  6. If you want to add new title and body display text component to the form, then click Create field and choose the component.
  7. If you want to reorder fields in marketing activity form, then click and drag the fields to your desired location.
  8. Click Save.

Deprecate a marketing activity extension

You can deprecate a marketing activity extension from your Partner Dashboard when the extension is no longer supported by your app. The steps below guide you through the recommended gradual deprecation process.

Steps:

  1. Start informing merchants about the incoming deprecation through app banners.
  2. Hide the extension.
  3. Support the activity for the next 6 months (recommended).
  4. After 6 months, start updating the old marketing activities with the DISCONNECTED status and error messages, informing merchants that the marketing activity is no longer supported.

    Merchants see old marketing activities with the DISCONNECTED status and error message on the marketing activity index page.

  5. Disable the extension.

Hide a marketing activity extension

If you've created a marketing activity extension for you app, but you don't want merchants to be able to use it, you can hide the extension from your Partner Dashboard. There are a few different reasons for hiding an extension:

  • The app that supports the extension is unstable, and you want to temporarily prevent merchants from using it to create marketing activities.
  • The extension is being deprecated or replaced with a new version.

Steps:

  1. In your Partner Dashboard, click Apps, and then click the name of the app whose extension you want to hide.
  2. Click Extensions.
  3. In the Marketing activities section, click the name of the marketing activity that you want to hide.
  4. Click Change status.
  5. On the Change activity status dialog, select Hide activity.
  6. Click Save.

Disable a marketing activity extension

If an extension is being deprecated or replaced with a new version, then you can disable the extension from your Partner Dashboard.

Steps:

  1. From your Partner Dashboard, click Apps.
  2. Click the name of the app that you want to change.
  3. Click Extensions.
  4. In the Marketing activities section, select marketing activity that you want to disable.
  5. Click Change status.
  6. On the Change activity status modal, click Disable activity.
  7. Click Save.

Sign up for a Partner account to get started.

Sign up