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.

Billing: Request; paid actions are priced in credits (see GET /v1/messaging/prices) · Rate limit: 60/min

put/v1/messaging/commerce/marketing-activities

Request

  • Base URL: https://apihub.co.il
  • URL: https://apihub.co.il/v1/messaging/commerce/marketing-activities
  • Auth: HTTP bearer

Headers

Idempotency-Keystring

Replay-safe: the same execution is returned instead of charging twice

X-Tagstring

Group calls into one job (e.g. one video) — see GET /v1/usage?tag=…

Request body

urlstring uri required
titlestring required
status'active' | 'inactive' | 'paused' | 'scheduled' required
tactic'ad' | 'post' | 'message' | 'newsletter' | 'link' | 'affiliate' | 'retargeting' | 'loyalty' | 'seo' required
adSpendstring

Decimal in the store currency.

channel'social' | 'search' | 'display' | 'email' | 'referral' required
endedAtstring date-time
remoteIdstring required
accountIdstring required
startedAtstring date-time
previewImageUrlstring uri

Response

Completed

idstring

Execution id — stable across internal retries; use it with GET /v1/executions/{id}

status'pending' | 'processing' | 'completed' | 'partial' | 'failed' | 'cancelled' | 'timeout'
operationstring
tagstring nullable

Your X-Tag, if sent

created_atstring date-time
completed_atstring date-time nullable
errorstring nullable

Changes

No recorded changes to this operation across all 2 revisions of this API.