---
title: "Record a marketing activity"
method: PUT
path: "/v1/messaging/commerce/marketing-activities"
tags: ["Commerce"]
---

# Record a marketing activity

`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

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

## Headers

- `Idempotency-Key` string
- `X-Tag` string

## Request body

- object
  - `url` string, uri, required
  - `utm` object
    - `medium` string, required
    - `source` string, required
    - `campaign` string, required
  - `title` string, required
  - `budget` object
    - `type` 'daily' | 'lifetime', required
    - `amount` string, required: Decimal in the store currency.
  - `status` 'active' | 'inactive' | 'paused' | 'scheduled', required
  - `tactic` 'ad' | 'post' | 'message' | 'newsletter' | 'link' | 'affiliate' | 'retargeting' | 'loyalty' | 'seo', required
  - `adSpend` string: Decimal in the store currency.
  - `channel` 'social' | 'search' | 'display' | 'email' | 'referral', required
  - `endedAt` string, date-time
  - `remoteId` string, required
  - `accountId` string, required
  - `startedAt` string, date-time
  - `previewImageUrl` string, uri

## Response `200`

Completed

- object
  - `id` string: Execution id — stable across internal retries; use it with GET /v1/executions/{id}
  - `status` 'pending' | 'processing' | 'completed' | 'partial' | 'failed' | 'cancelled' | 'timeout'
  - `operation` string
  - `tag` string, nullable: Your X-Tag, if sent
  - `created_at` string, date-time
  - `completed_at` string, date-time, nullable
  - `output` object: Operation result (see each operation). While a Studio render is processing: `stage` (queued · transcribing · downloading · preparing · cleaning_voice · mixing_audio · rendering · finishing), `phase` (the engine's: download · prepare · voice · audio · encode · qa · upload, or null), `progress` (a percent, 0–100) and `progress_fraction` (0–1), `eta_seconds` (seconds left, never below 0) and `estimate_seconds`
    - `marketingActivity` object
      - `id` string
      - `remoteId` string
  - `error` string, nullable
  - `usage` object
    - `credits_charged` number, nullable
    - `credits_reserved` number
    - `estimated_credits` number
    - `cost_source` 'provider_reported' | 'calculated' | 'estimated' | 'null', nullable
    - `provider_usage` object, nullable: Normalised consumption, e.g. { VIDEO_SECOND: 22.4 }
  - `balance` object
    - `available` number
    - `reserved` number

## Other responses

- `400`: Invalid input
- `402`: Insufficient credits / project budget
- `404`: Resource not found (or not yours)
- `429`: Rate limited
- `503`: Service temporarily paused

---

[API](https://skmtc.dev/apihub/apis/apihub-one-api-for-chat-image-video-ai.md) · [All operations](https://skmtc.dev/apihub/apis/apihub-one-api-for-chat-image-video-ai/llms.txt) · [OpenAPI document](https://skmtc.dev/apihub/apis/apihub-one-api-for-chat-image-video-ai/revisions/a8caa42835ce?raw)