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

MarketingActivityCreateInput input object

Version unstable

Specifies the input fields required to create a marketing activity.

Input 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.

Version 2021-07 (Release candidate)

Specifies the input fields required to create a marketing activity.

Input 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.

Version 2021-04 (Latest)

Specifies the input fields required to create a marketing activity.

Input 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.

Version 2021-01

Specifies the input fields required to create a marketing activity.

Input 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.

Version 2020-10

Specifies the input fields required to create a marketing activity.

Input 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.