Setup
To use the MarketingTags API, install the @wix/marketing-tags
package using npm or Yarn:
Copy
1npm install @wix/marketing-tags
or
Copy
1yarn add @wix/marketing-tags
Then import { marketingTags }
from @wix/marketing-tags
:
Copy
1import { marketingTags } from '@wix/marketing-tags'
Was this helpful?
Yes
No
deleteMarketingTag( )
Developer Preview
This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.
Deletes a marketing tag.
Permission Scopes
For app development, you must have one of the following permission scopes:Learn more about permission scopes.
Copy
function deleteMarketingTag(options: DeleteMarketingTagOptions): Promise<void>
Method Parameters
optionsDeleteMarketingTagOptions
Options to use when deleting a marketing tag.
Returns
Return Type:Promise<void>
Was this helpful?
Yes
No
listMarketingTags( )
Developer Preview
This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.
Retrieves marketing tags given the provided filter.
Permission Scopes
For app development, you must have one of the following permission scopes:Learn more about permission scopes.
Copy
function listMarketingTags(options: ListMarketingTagsOptions): Promise<ListMarketingTagsResponse>
Method Parameters
optionsListMarketingTagsOptions
Information about the marketing tags to retrieve.
Returns
Return Type:Promise<ListMarketingTagsResponse>
Was this helpful?
Yes
No
upsertMarketingTag( )
Developer Preview
This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.
Creates or updates a marketing tag.
Permission Scopes
For app development, you must have one of the following permission scopes:Learn more about permission scopes.
Copy
function upsertMarketingTag(tag: MarketingTag): Promise<UpsertMarketingTagResponse>
Method Parameters
tagMarketingTagRequired
Marketing tag to create or update.
Returns
Return Type:Promise<UpsertMarketingTagResponse>
Was this helpful?
Yes
No