Commerce · Commerce

Record a marketing activity

Records a marketing activity. Works with Shopify accounts.

PUThttps://api.pozy.ai/v1/commerce/marketing-activities

ShopifyupsertCommerceMarketingActivity

Guides: Commerce & blogs, Products and catalog

Request

Send your API key as Authorization: Bearer pz_live_.... Read-only keys cannot call it. Keys with the commerce resource group disabled get 403 resource_group_disabled. Authentication

Request body

application/json, required

accountIdstringrequired
remoteIdstringrequired
Up to 255 characters.
titlestringrequired
urlstring (URL)required
previewImageUrlstring (URL)
utmobject
- campaignstringrequired
- sourcestringrequired
- mediumstringrequired
tacticstringrequired
One of ad, post, message, newsletter, link, affiliate, retargeting, loyalty, seo.
channelstringrequired
One of social, search, display, email, referral.
statusstringrequired
One of active, inactive, paused, scheduled.
budgetobject
- typestringrequired
  One of daily, lifetime.
- amountstringrequired
adSpendstring
startedAtstring (date-time)
endedAtstring (date-time)

Example

curl -X PUT "https://api.pozy.ai/v1/commerce/marketing-activities" \
  -H "Authorization: Bearer $POZY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "accountId": "696e0b682d0a31188e7a2ba9",
  "remoteId": "6f548f9d20d8d19954bd9bff",
  "title": "Launch day",
  "url": "https://pozy.ai/media/example-1.jpg",
  "tactic": "ad",
  "channel": "social",
  "status": "active"
}'

const res = await fetch("https://api.pozy.ai/v1/commerce/marketing-activities", {
  method: "PUT",
  headers: {
    Authorization: `Bearer ${process.env.POZY_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    accountId: "696e0b682d0a31188e7a2ba9",
    remoteId: "6f548f9d20d8d19954bd9bff",
    title: "Launch day",
    url: "https://pozy.ai/media/example-1.jpg",
    tactic: "ad",
    channel: "social",
    status: "active"
  }),
});
const data = await res.json();
if (!res.ok) throw new Error(data?.error ?? `Request failed with status ${res.status}`);
console.log(data);

import os
import requests

resp = requests.put(
    "https://api.pozy.ai/v1/commerce/marketing-activities",
    headers={"Authorization": f"Bearer {os.environ['POZY_API_KEY']}"},
    json={
        "accountId": "696e0b682d0a31188e7a2ba9",
        "remoteId": "6f548f9d20d8d19954bd9bff",
        "title": "Launch day",
        "url": "https://pozy.ai/media/example-1.jpg",
        "tactic": "ad",
        "channel": "social",
        "status": "active",
    },
    timeout=30,
)
resp.raise_for_status()
print(resp.json())

Response

200 on success

marketingActivityobject
- idstring
- remoteIdstring

200 response

{
  "marketingActivity": {
    "id": "6bfebd43ddc270f6d2c56fc5",
    "remoteId": "6f548f9d20d8d19954bd9bff"
  }
}

Errors

Errors use one shape: { error, type, code, param?, details? }. The ones you are most likely to see here:

400	invalid_request_error	A parameter or body field is missing or invalid. `param` names it.
401	authentication_error	The API key is missing, revoked or expired.
403	permission_error	The key is read-only, scoped to other profiles, or has this resource group disabled.
429	rate_limit_error	Too many requests this minute. Wait for `Retry-After` seconds.

Every code is listed in Errors.

More in Commerce

GETGet a store GETList orders GETGet an order GETList products POSTCreate a product POSTActivate, deactivate, archive or delete products GETGet a product PATCHUpdate a product POSTUpdate variant prices GETList collections POSTCreate a collection GETGet a collection PATCHUpdate a collection DELDelete a collection POSTAdd or remove products in a collection POSTAdd variants DELDelete variants POSTAdd options DELDelete options POSTAdd images DELRemove images POSTReorder images POSTDuplicate a product GETList product metafields PUTSet product metafields DELDelete product metafields POSTPublish or unpublish a product GETList collection metafields PUTSet collection metafields DELDelete collection metafields POSTPublish or unpublish a collection POSTAdd or remove tags in bulk POSTReorder products in a collection GETList pages POSTCreate a page GETGet a page PATCHUpdate a page DELDelete a page GETList locations GETGet a product's stock POSTSet or adjust stock GETList sales channels GETList discounts POSTCreate a discount GETGet a discount PATCHUpdate a discount DELDelete a discount POSTActivate or deactivate a discount POSTAdd codes to a discount GETList URL redirects POSTCreate a URL redirect PATCHUpdate a URL redirect DELDelete a URL redirect GETList navigation menus POSTCreate a navigation menu GETGet a navigation menu PUTReplace a navigation menu DELDelete a navigation menu GETList metaobject definitions GETList metaobjects of a type POSTCreate a metaobject GETGet a metaobject PATCHUpdate a metaobject DELDelete a metaobject GETList markets GETList price lists PUTSet fixed prices DELRemove fixed prices DELDelete a marketing activity POSTReport daily engagement GETList catalog syncs POSTSync a store into a Meta catalog GETGet a catalog sync DELStop a catalog sync POSTRun a catalog sync now