Sign in
Commerce

Record a marketing activity

Creates or updates (by remoteId) an activity in the store's Marketing section, so the merchant sees a post, ad or message you ran for them, with its link and UTM parameters for attribution. Use your own id (for example the Zernio post or ad id) as remoteId.

put/v1/commerce/marketing-activities

Request body

accountIdstring required
remoteIdstring required
titlestring required
urlstring uri required
previewImageUrlstring uri
tactic'ad' | 'post' | 'message' | 'newsletter' | 'link' | 'affiliate' | 'retargeting' | 'loyalty' | 'seo' required
channel'social' | 'search' | 'display' | 'email' | 'referral' required
status'active' | 'inactive' | 'paused' | 'scheduled' required
adSpendstring

Decimal in the store currency.

startedAtstring date-time
endedAtstring date-time

Response

Activity recorded

Changes

Changed in 2 of the 60 revisions of this API.2