Creators · Creator Campaigns

Update creator campaign

Updates a creator campaign. Fields you leave out keep their current values.

PATCHhttps://api.pozy.ai/v1/creator-campaigns/{campaignId}

updateCreatorCampaign

Request

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

Path parameters

Name	Type	Notes
`campaignId`required	string

Request body

application/json, required

namestring
1 to 200 characters.
brandNamestring
1 to 200 characters.
platformsarray of string
Each item: one of tiktok, instagram, youtube, threads, pinterest, facebook, twitter.
contentRulesstring
Up to 10000 characters. Can be null.
startsAtstring (date-time)
Can be null.
endsAtstring (date-time)
Can be null.
trackingDaysinteger
1 to 365.
holdDaysinteger
0 to 90.
maxPostAgeMinutesinteger
At least 1. Can be null.
settlementstring
One of none, external, treasury.
economicsobject
One of:
Creator Campaign Economics Cpm (5 fields)
- typestringrequired
  One of cpm.
- ratePer1kCentsintegerrequired
  At least 1.
- minViewsToEarnintegerrequired
  At least 0.
- maxPayoutPerClipCentsinteger
  At least 1.
- budgetCentsintegerrequired
  At least 0.
Creator Campaign Economics Per Post (4 fields)
- typestringrequired
  One of per_post.
- perApprovedPostCentsintegerrequired
  At least 1.
- maxPostsPerParticipantinteger
  At least 1.
- budgetCentsintegerrequired
  At least 0.
Creator Campaign Economics Pool (3 fields)
- typestringrequired
  One of pool.
- budgetCentsintegerrequired
  At least 0.
- minViewsToQualifyintegerrequired
  At least 0.
capsobject
- maxParticipantsinteger
  At least 1.
- maxSubmissionsPerParticipantPerDayinteger
  At least 1.
- maxAccountsPerParticipantinteger
  At least 1.
- maxXReadSpendCentsinteger
  At least 1.
- authenticityThresholdnumberrequired
  0 to 100.
brandingobject
One of:
Creator Campaign Branding (4 fields)
- brandNamestring
- primaryColorstring
- logoUrlstring
- themeobject

Example

curl -X PATCH "https://api.pozy.ai/v1/creator-campaigns/65a3737dd8b11ea61f199e6e" \
  -H "Authorization: Bearer $POZY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Acme",
  "brandName": "Acme",
  "platforms": [
    "tiktok"
  ],
  "contentRules": "Hello from Pozy"
}'

const res = await fetch("https://api.pozy.ai/v1/creator-campaigns/65a3737dd8b11ea61f199e6e", {
  method: "PATCH",
  headers: {
    Authorization: `Bearer ${process.env.POZY_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    name: "Acme",
    brandName: "Acme",
    platforms: [
      "tiktok"
    ],
    contentRules: "Hello from Pozy"
  }),
});
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.patch(
    "https://api.pozy.ai/v1/creator-campaigns/65a3737dd8b11ea61f199e6e",
    headers={"Authorization": f"Bearer {os.environ['POZY_API_KEY']}"},
    json={
        "name": "Acme",
        "brandName": "Acme",
        "platforms": [
            "tiktok",
        ],
        "contentRules": "Hello from Pozy",
    },
    timeout=30,
)
resp.raise_for_status()
print(resp.json())

Response

200 on success

campaignobjectrequired
31 child fields
- idstringrequired
- userIdstringrequired
- profileIdstringrequired
- kindstringrequired
- namestringrequired
- brandNamestringrequired
- statusstringrequired
  One of draft, active, paused, closed.
- typestringrequired
  One of cpm, per_post, pool.
- currencystringrequired
- platformsarray of stringrequired
  Each item: one of tiktok, instagram, youtube, threads, pinterest, facebook, twitter.
- contentRulesstringrequired
  Can be null.
- startsAtstring (date-time)required
  Can be null.
- endsAtstring (date-time)required
  Can be null.
- trackingDaysintegerrequired
- holdDaysintegerrequired
- maxPostAgeMinutesintegerrequired
  Can be null.
- activatedAtstring (date-time)required
  Can be null.
- settlementstringrequired
  One of none, external, treasury.
- economicsobjectrequired
  One of:
  Creator Campaign Economics Cpm (5 fields)
  typestringrequired
  One of cpm.
  ratePer1kCentsintegerrequired
  At least 1.
  minViewsToEarnintegerrequired
  At least 0.
  maxPayoutPerClipCentsinteger
  At least 1.
  budgetCentsintegerrequired
  At least 0.
  Creator Campaign Economics Per Post (4 fields)
  typestringrequired
  One of per_post.
  perApprovedPostCentsintegerrequired
  At least 1.
  maxPostsPerParticipantinteger
  At least 1.
  budgetCentsintegerrequired
  At least 0.
  Creator Campaign Economics Pool (3 fields)
  typestringrequired
  One of pool.
  budgetCentsintegerrequired
  At least 0.
  minViewsToQualifyintegerrequired
  At least 0.
- capsobjectrequired
  5 child fields
  maxParticipantsinteger
  At least 1.
  maxSubmissionsPerParticipantPerDayinteger
  At least 1.
  maxAccountsPerParticipantinteger
  At least 1.
  maxXReadSpendCentsinteger
  At least 1.
  authenticityThresholdnumberrequired
  0 to 100.
- brandingobjectrequired
  One of:
  Creator Campaign Branding (4 fields)
  brandNamestring
  primaryColorstring
  logoUrlstring
  themeobject
- budgetExhaustedAtstring (date-time)required
  Can be null.
- closedAtstring (date-time)required
  Can be null.
- payableScannedAtstring (date-time)required
  Can be null.
- createdAtstring (date-time)required
- updatedAtstring (date-time)required
- hasOpenInvitebooleanrequired
- consumedCentsintegerrequired
- participantCountintegerrequired
- submissionCountsobjectrequired
  7 child fields
  receivedintegerrequired
  trackingintegerrequired
  pending_reviewintegerrequired
  approvedintegerrequired
  rejectedintegerrequired
  expiredintegerrequired
  withdrawnintegerrequired
- payableCentsintegerrequired

200 response

{
  "campaign": {
    "id": "6bfebd43ddc270f6d2c56fc5",
    "userId": "6da95b9455a22c1e061837af",
    "profileId": "6a0b6573846efc28aaa9a3ff",
    "kind": "string",
    "name": "Acme",
    "brandName": "Acme",
    "status": "draft",
    "type": "cpm",
    "currency": "USD",
    "platforms": [
      "tiktok"
    ],
    "contentRules": "Hello from Pozy",
    "startsAt": "2026-10-02T09:00:00.000Z",
    "endsAt": "2026-10-02T09:00:00.000Z",
    "trackingDays": 1,
    "holdDays": 1,
    "maxPostAgeMinutes": 1,
    "activatedAt": "2026-10-02T09:00:00.000Z",
    "settlement": "none",
    "economics": {
      "type": "cpm",
      "ratePer1kCents": 1,
      "minViewsToEarn": 1,
      "maxPayoutPerClipCents": 1,
      "budgetCents": 1
    },
    "caps": {
      "maxParticipants": 1,
      "maxSubmissionsPerParticipantPerDay": 1,
      "maxAccountsPerParticipant": 42,
      "maxXReadSpendCents": 1,
      "authenticityThreshold": 12.5
    },
    "branding": {
      "brandName": "Acme",
      "primaryColor": "string",
      "logoUrl": "https://pozy.ai/media/example-1.jpg",
      "theme": {}
    },
    "budgetExhaustedAt": "2026-10-02T09:00:00.000Z",
    "closedAt": "2026-10-02T09:00:00.000Z",
    "payableScannedAt": "2026-10-02T09:00:00.000Z",
    "createdAt": "2026-10-02T09:00:00.000Z",
    "updatedAt": "2026-10-02T09:00:00.000Z",
    "hasOpenInvite": true,
    "consumedCents": 1,
    "participantCount": 42,
    "submissionCounts": {
      "received": 1,
      "tracking": 1,
      "pending_review": 1,
      "approved": 1,
      "rejected": 1,
      "expired": 1,
      "withdrawn": 1
    },
    "payableCents": 1
  }
}

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.
404	not_found	Nothing with that id exists in your workspace.
429	rate_limit_error	Too many requests this minute. Wait for `Retry-After` seconds.

Every code is listed in Errors.