Ads · Product Catalogs

Create a product feed

Creates a product feed. Works with Meta Ads.

POSThttps://api.pozy.ai/v1/ads/catalogs/{catalogId}/feeds
Facebook and InstagramcreateAdCatalogFeed

Guide: Product catalogs and catalog ads

Request

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

Path parameters

NameTypeNotes
catalogIdrequiredstring

Request body

application/json, required

  • accountIdstringrequired
  • catalogAccountIdstring
  • namestringrequired

    Up to 100 characters.

  • scheduleobject
    • intervalstringrequired

      One of HOURLY, DAILY, WEEKLY.

    • urlstring (URL)required
    • hourinteger

      0 to 23.

    • dayOfWeekstring

      One of SUNDAY, MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY.

Example

curl -X POST "https://api.pozy.ai/v1/ads/catalogs/6f2f2ffcf4ace3659342c4c2/feeds" \
  -H "Authorization: Bearer $POZY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "accountId": "696e0b682d0a31188e7a2ba9",
  "name": "Acme"
}'

Response

201 on success

  • feedobject
    • idstring
    • namestring
    • productCountinteger
    • scheduleobject

      Can be null.

      4 child fields
      • intervalstring
      • urlstring
      • hourinteger

        Can be null.

      • dayOfWeekstring

        Can be null.

    • createdTimestring

      Can be null.

    • latestUploadobject

      One of:

      Meta Feed Upload (8 fields)
      • idstring
      • urlstring

        Can be null.

      • startTimestring

        Can be null.

      • endTimestring

        Can be null.

      • errorCountinteger
      • warningCountinteger
      • itemsDetectedinteger
      • itemsDeletedinteger
201 response
{
  "feed": {
    "id": "6bfebd43ddc270f6d2c56fc5",
    "name": "Acme",
    "productCount": 42,
    "schedule": {
      "interval": "string",
      "url": "https://pozy.ai/media/example-1.jpg",
      "hour": 1,
      "dayOfWeek": "string"
    },
    "createdTime": "string",
    "latestUpload": {
      "id": "6bfebd43ddc270f6d2c56fc5",
      "url": "https://pozy.ai/media/example-1.jpg",
      "startTime": "string",
      "endTime": "string",
      "errorCount": 42,
      "warningCount": 42,
      "itemsDetected": 1,
      "itemsDeleted": 1
    }
  }
}

Errors

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

400invalid_request_errorA parameter or body field is missing or invalid. param names it.
401authentication_errorThe API key is missing, revoked or expired.
403permission_errorThe key is read-only, scoped to other profiles, or has this resource group disabled.
404not_foundNothing with that id exists in your workspace.
429rate_limit_errorToo many requests this minute. Wait for Retry-After seconds.

Every code is listed in Errors.

More in Product Catalogs