{"openapi":"3.1.0","info":{"title":"Pozy API","version":"1.424.0","summary":"One API to publish, message, advertise and measure across every major platform.","termsOfService":"https://pozy.ai/terms","contact":{"name":"Pozy Support","url":"https://pozy.ai/support","email":"support@pozy.ai"}},"servers":[{"url":"https://api.pozy.ai","description":"Production"}],"security":[{"bearerAuth":[]}],"tags":[{"name":"Validate","x-pozy-area":"publishing"},{"name":"Analytics","x-pozy-area":"analytics"},{"name":"Ledger","x-pozy-area":"creators"},{"name":"Treasury","x-pozy-area":"creators"},{"name":"Creator Portal","x-pozy-area":"creators"},{"name":"Inbox Analytics","x-pozy-area":"analytics"},{"name":"Account Groups","x-pozy-area":"accounts"},{"name":"Media","x-pozy-area":"publishing"},{"name":"Reddit Search","x-pozy-area":"inbox"},{"name":"Usage","x-pozy-area":"workspace"},{"name":"Posts","x-pozy-area":"publishing"},{"name":"Users","x-pozy-area":"workspace"},{"name":"Profiles","x-pozy-area":"accounts"},{"name":"Accounts","x-pozy-area":"accounts"},{"name":"WhatsApp","x-pozy-area":"whatsapp"},{"name":"API Keys","x-pozy-area":"workspace"},{"name":"Feedback","x-pozy-area":"workspace"},{"name":"Connected Apps","x-pozy-area":"workspace"},{"name":"Invites","x-pozy-area":"workspace"},{"name":"Connect","x-pozy-area":"accounts"},{"name":"Google Business Reviews","x-pozy-area":"google-business"},{"name":"Google Business Verifications","x-pozy-area":"google-business"},{"name":"Google Business Food Menus","x-pozy-area":"google-business"},{"name":"Google Business Location Details","x-pozy-area":"google-business"},{"name":"Google Business Media","x-pozy-area":"google-business"},{"name":"Google Business Attributes","x-pozy-area":"google-business"},{"name":"Google Business Place Actions","x-pozy-area":"google-business"},{"name":"Google Business Services","x-pozy-area":"google-business"},{"name":"Account Settings","x-pozy-area":"accounts"},{"name":"LinkedIn Mentions","x-pozy-area":"inbox"},{"name":"Instagram","x-pozy-area":"inbox"},{"name":"Discord","x-pozy-area":"messaging"},{"name":"Slack","x-pozy-area":"messaging"},{"name":"Queue","x-pozy-area":"publishing"},{"name":"Webhooks","x-pozy-area":"workspace"},{"name":"Logs","x-pozy-area":"workspace"},{"name":"Email","x-pozy-area":"productivity"},{"name":"Calendar","x-pozy-area":"productivity"},{"name":"Files","x-pozy-area":"productivity"},{"name":"Messages","x-pozy-area":"inbox"},{"name":"Comments","x-pozy-area":"inbox"},{"name":"X Engagement","x-pozy-area":"inbox"},{"name":"Mentions","x-pozy-area":"inbox"},{"name":"Reviews","x-pozy-area":"inbox"},{"name":"WhatsApp Calling","x-pozy-area":"whatsapp"},{"name":"Calls","x-pozy-area":"telephony"},{"name":"Voice","x-pozy-area":"telephony"},{"name":"iMessage","x-pozy-area":"messaging"},{"name":"SMS","x-pozy-area":"messaging"},{"name":"RCS","x-pozy-area":"messaging"},{"name":"Branded Calling","x-pozy-area":"telephony"},{"name":"WhatsApp Templates","x-pozy-area":"whatsapp"},{"name":"WhatsApp Phone Numbers","x-pozy-area":"whatsapp"},{"name":"Phone Numbers","x-pozy-area":"telephony"},{"name":"WhatsApp Sandbox","x-pozy-area":"whatsapp"},{"name":"WhatsApp Flows","x-pozy-area":"whatsapp"},{"name":"Contacts","x-pozy-area":"automations"},{"name":"Custom Fields","x-pozy-area":"automations"},{"name":"Broadcasts","x-pozy-area":"automations"},{"name":"Support Assistant","x-pozy-area":"workspace"},{"name":"Workflows","x-pozy-area":"automations"},{"name":"Sequences","x-pozy-area":"automations"},{"name":"Comment Automations","x-pozy-area":"automations"},{"name":"Ad Campaigns","x-pozy-area":"ads"},{"name":"Ad Insights","x-pozy-area":"ads"},{"name":"Ad Rules","x-pozy-area":"ads"},{"name":"Ad Creatives","x-pozy-area":"ads"},{"name":"Tracking Tags","x-pozy-area":"ads"},{"name":"Ad Accounts","x-pozy-area":"ads"},{"name":"Reach and Frequency","x-pozy-area":"ads"},{"name":"Lead Gen","x-pozy-area":"ads"},{"name":"Ad Targeting","x-pozy-area":"ads"},{"name":"Ad Library","x-pozy-area":"ads"},{"name":"Product Catalogs","x-pozy-area":"ads"},{"name":"Ad Audiences","x-pozy-area":"ads"},{"name":"Conversions","x-pozy-area":"ads"},{"name":"Messaging Ads","x-pozy-area":"ads"},{"name":"Business Agent","x-pozy-area":"whatsapp"},{"name":"Blogs","x-pozy-area":"publishing"},{"name":"Products","x-pozy-area":"commerce"},{"name":"Commerce","x-pozy-area":"commerce"},{"name":"Verify","x-pozy-area":"messaging"},{"name":"Tools","x-pozy-area":"publishing"},{"name":"Changelog","x-pozy-area":"workspace"},{"name":"Creator Campaigns","x-pozy-area":"creators"}],"x-pozy-errors":[{"status":402,"code":"workspace_suspended","type":"payment_required","appliesTo":"Writes, connects and publishing (each operation lists it)","description":"The workspace is paused because a payment failed and the 7-day grace period ended. Reads, billing and paying keep working. Update the card in Billing to resume."},{"status":403,"code":"workspace_suspended","type":"permission_error","appliesTo":"Writes, connects and publishing; on the creator portal, joins, connects, submissions and payout onboarding","description":"The workspace was paused by Pozy (contact support@pozy.ai to resume). On the creator portal: the brand's workspace is paused, so the creator should contact the brand."},{"status":403,"code":"email_not_verified","type":"permission_error","appliesTo":"Email invitations, and connecting accounts in a workspace without a payment method","description":"Confirm your email address, or add a payment method, first. Invite links you share yourself keep working."},{"status":429,"code":"invite_limit_reached","type":"rate_limit_error","appliesTo":"Email invitations (team and creators)","description":"The workspace reached its invitation email limit: 20 a day and 50 pending team invitations without a payment method, 500 a day with one. Share the invite link instead."},{"status":429,"code":"invite_resend_too_soon","type":"rate_limit_error","appliesTo":"Resending an invitation email","description":"An invitation can be emailed again once an hour. The message says how many minutes are left."},{"status":429,"code":"support_ticket_limit","type":"rate_limit_error","appliesTo":"Questions that go to the Pozy team","description":"The workspace sent 5 questions to the Pozy team today. Each one gets an email reply; for anything urgent write to support@pozy.ai."},{"status":502,"code":"email_not_sent","type":"api_error","appliesTo":"Resending a creator invitation","description":"Pozy could not send the email. Copy the creator's invite link and share it instead."},{"status":409,"code":"idempotency_key_in_use","type":"invalid_request_error","appliesTo":"Any write sent with an Idempotency-Key header","description":"A request with the same Idempotency-Key is still running. Retry in a moment; the finished result is then replayed."},{"status":503,"code":"service_unavailable","type":"platform_error","appliesTo":"Any operation","description":"Pozy cannot reach a platform service right now. Nothing is wrong with the request: retry later."},{"status":503,"code":"temporarily_unavailable","type":"platform_error","appliesTo":"Any operation","description":"A platform service is temporarily unavailable on Pozy's side. Retry later."}],"paths":{"/v1/tools/validate/post-length":{"post":{"operationId":"validatePostLength","summary":"Validate character count","tags":["Validate"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"text":{"type":"string"},"platforms":{"type":"object","additionalProperties":{"type":"object","properties":{"count":{"type":"integer"},"limit":{"type":"integer"},"valid":{"type":"boolean"}}}}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["text"],"properties":{"text":{"type":"string"}}}}}},"x-pozy-area":"publishing"}},"/v1/tools/validate/post":{"post":{"operationId":"validatePost","summary":"Validate post content","tags":["Validate"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"valid":{"type":"boolean"},"message":{"type":"string"},"warnings":{"type":"array","items":{"type":"object","properties":{"platform":{"type":"string"},"warning":{"type":"string"}}}}}},{"type":"object","properties":{"valid":{"type":"boolean"},"errors":{"type":"array","items":{"type":"object","properties":{"platform":{"type":"string"},"error":{"type":"string"}}}},"warnings":{"type":"array","items":{"type":"object","properties":{"platform":{"type":"string"},"warning":{"type":"string"}}}}}}]}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["platforms"],"properties":{"content":{"type":"string"},"platforms":{"type":"array","items":{"type":"object","required":["platform"],"properties":{"platform":{"type":"string","enum":["twitter","instagram","tiktok","youtube","facebook","linkedin","bluesky","threads","reddit","pinterest","telegram","snapchat","googlebusiness","discord","slack"]},"accountId":{"type":"string"},"customContent":{"type":"string"},"platformSpecificData":{"type":"object"},"customMedia":{"type":"array","items":{"$ref":"#/components/schemas/MediaItem"}}}}},"mediaItems":{"type":"array","items":{"$ref":"#/components/schemas/MediaItem"}}}}}}},"x-pozy-area":"publishing"}},"/v1/tools/validate/media":{"post":{"operationId":"validateMedia","summary":"Validate media URL","tags":["Validate"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"valid":{"type":"boolean"},"url":{"type":"string","format":"uri"},"error":{"type":"string"},"contentType":{"type":"string"},"size":{"type":["integer","null"]},"sizeFormatted":{"type":"string"},"type":{"type":"string","enum":["image","video","unknown"]},"platformLimits":{"type":"object","additionalProperties":{"type":"object","properties":{"limit":{"type":"integer"},"limitFormatted":{"type":"string"},"withinLimit":{"type":"boolean"}}}}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["url"],"properties":{"url":{"type":"string","format":"uri"}}}}}},"x-pozy-area":"publishing"}},"/v1/tools/validate/subreddit":{"get":{"operationId":"validateSubreddit","summary":"Check subreddit existence","tags":["Validate"],"parameters":[{"name":"name","in":"query","required":true,"schema":{"type":"string"}},{"name":"accountId","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"exists":{"type":"boolean"},"subreddit":{"type":"object","properties":{"name":{"type":"string"},"title":{"type":"string"},"description":{"type":"string"},"subscribers":{"type":"integer"},"isNSFW":{"type":"boolean"},"type":{"type":"string","enum":["public","private","restricted"]},"allowImages":{"type":"boolean"},"allowVideos":{"type":"boolean"}}}}},{"type":"object","properties":{"exists":{"type":"boolean"},"error":{"type":"string"}}}]}}}}},"x-pozy-area":"publishing"}},"/v1/analytics":{"get":{"operationId":"getAnalytics","summary":"Get post analytics","tags":["Analytics"],"parameters":[{"name":"postId","in":"query","required":false,"schema":{"type":"string"}},{"name":"platform","in":"query","required":false,"schema":{"type":"string"}},{"name":"profileId","in":"query","required":false,"schema":{"type":"string"}},{"name":"accountId","in":"query","required":false,"schema":{"type":"string"}},{"name":"source","in":"query","required":false,"schema":{"type":"string","enum":["all","pozy","external"],"default":"all"}},{"name":"fromDate","in":"query","required":false,"schema":{"type":"string","format":"date"}},{"name":"toDate","in":"query","required":false,"schema":{"type":"string","format":"date"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":100,"default":50}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"default":1}},{"name":"sortBy","in":"query","required":false,"schema":{"type":"string","enum":["date","engagement","impressions","reach","likes","comments","shares","saves","clicks","views","follows","ig_reels_avg_watch_time","ig_reels_video_view_total_time","reposts","reels_skip_rate","completion_rate","profile_views","website_clicks"],"default":"date"}},{"name":"order","in":"query","required":false,"schema":{"type":"string","enum":["asc","desc"],"default":"desc"}},{"name":"tags","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/AnalyticsSinglePostResponse"},{"$ref":"#/components/schemas/AnalyticsListResponse"}]}}}}},"x-pozy-area":"analytics"}},"/v1/analytics/delta":{"get":{"operationId":"getAnalyticsDelta","summary":"Analytics changed since a cursor","tags":["Analytics"],"parameters":[{"name":"cursor","in":"query","required":false,"schema":{"type":"string"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":100,"default":50}},{"name":"platform","in":"query","required":false,"schema":{"type":"string"}},{"name":"profileId","in":"query","required":false,"schema":{"type":"string","default":"all"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnalyticsDeltaResponse"}}}}},"x-pozy-area":"analytics"}},"/v1/analytics/youtube/channel-insights":{"get":{"operationId":"getYouTubeChannelInsights","summary":"Get YouTube channel insights","tags":["Analytics"],"parameters":[{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}},{"name":"metrics","in":"query","required":false,"schema":{"type":"string"}},{"name":"fromDate","in":"query","required":false,"schema":{"type":"string","format":"date"}},{"name":"toDate","in":"query","required":false,"schema":{"type":"string","format":"date"}},{"name":"since","in":"query","required":false,"schema":{"type":"string","format":"date"}},{"name":"until","in":"query","required":false,"schema":{"type":"string","format":"date"}},{"name":"metricType","in":"query","required":false,"schema":{"type":"string","enum":["time_series","total_value"],"default":"total_value"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InstagramAccountInsightsResponse"}}}}},"x-pozy-area":"analytics"}},"/v1/analytics/linkedin/org-aggregate-analytics":{"get":{"operationId":"getLinkedInOrgAggregateAnalytics","summary":"Get LinkedIn org analytics","tags":["Analytics"],"parameters":[{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}},{"name":"metrics","in":"query","required":false,"schema":{"type":"string"}},{"name":"fromDate","in":"query","required":false,"schema":{"type":"string","format":"date"}},{"name":"toDate","in":"query","required":false,"schema":{"type":"string","format":"date"}},{"name":"since","in":"query","required":false,"schema":{"type":"string","format":"date"}},{"name":"until","in":"query","required":false,"schema":{"type":"string","format":"date"}},{"name":"metricType","in":"query","required":false,"schema":{"type":"string","enum":["time_series","total_value"],"default":"total_value"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InstagramAccountInsightsResponse"}}}}},"x-pozy-area":"analytics"}},"/v1/analytics/tiktok/account-insights":{"get":{"operationId":"getTikTokAccountInsights","summary":"Get TikTok account-level insights","tags":["Analytics"],"parameters":[{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}},{"name":"metrics","in":"query","required":false,"schema":{"type":"string"}},{"name":"fromDate","in":"query","required":false,"schema":{"type":"string","format":"date"}},{"name":"toDate","in":"query","required":false,"schema":{"type":"string","format":"date"}},{"name":"since","in":"query","required":false,"schema":{"type":"string","format":"date"}},{"name":"until","in":"query","required":false,"schema":{"type":"string","format":"date"}},{"name":"metricType","in":"query","required":false,"schema":{"type":"string","enum":["time_series","total_value"],"default":"total_value"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InstagramAccountInsightsResponse"}}}}},"x-pozy-area":"analytics"}},"/v1/analytics/youtube/daily-views":{"get":{"operationId":"getYouTubeDailyViews","summary":"Get YouTube daily views","tags":["Analytics"],"parameters":[{"name":"videoId","in":"query","required":true,"schema":{"type":"string"}},{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}},{"name":"fromDate","in":"query","required":false,"schema":{"type":"string","format":"date"}},{"name":"toDate","in":"query","required":false,"schema":{"type":"string","format":"date"}},{"name":"startDate","in":"query","required":false,"schema":{"type":"string","format":"date"}},{"name":"endDate","in":"query","required":false,"schema":{"type":"string","format":"date"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/YouTubeDailyViewsResponse"}}}}},"x-pozy-area":"analytics"}},"/v1/analytics/youtube/video-retention":{"get":{"operationId":"getYouTubeVideoRetention","summary":"Get YouTube video retention curve","tags":["Analytics"],"parameters":[{"name":"videoId","in":"query","required":true,"schema":{"type":"string"}},{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}},{"name":"fromDate","in":"query","required":false,"schema":{"type":"string","format":"date"}},{"name":"toDate","in":"query","required":false,"schema":{"type":"string","format":"date"}},{"name":"startDate","in":"query","required":false,"schema":{"type":"string","format":"date"}},{"name":"endDate","in":"query","required":false,"schema":{"type":"string","format":"date"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/YouTubeVideoRetentionResponse"}}}}},"x-pozy-area":"analytics"}},"/v1/analytics/facebook/page-insights":{"get":{"operationId":"getFacebookPageInsights","summary":"Get Facebook Page insights","tags":["Analytics"],"parameters":[{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}},{"name":"metrics","in":"query","required":false,"schema":{"type":"string"}},{"name":"fromDate","in":"query","required":false,"schema":{"type":"string","format":"date"}},{"name":"toDate","in":"query","required":false,"schema":{"type":"string","format":"date"}},{"name":"since","in":"query","required":false,"schema":{"type":"string","format":"date"}},{"name":"until","in":"query","required":false,"schema":{"type":"string","format":"date"}},{"name":"metricType","in":"query","required":false,"schema":{"type":"string","enum":["time_series","total_value"],"default":"total_value"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InstagramAccountInsightsResponse"}}}}},"x-pozy-area":"analytics"}},"/v1/analytics/facebook/post-earnings":{"get":{"operationId":"getFacebookPostEarnings","summary":"Get Facebook post monetization earnings","tags":["Analytics"],"parameters":[{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}},{"name":"postId","in":"query","required":true,"schema":{"type":"string"}},{"name":"metrics","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FacebookPostEarningsResponse"}}}}},"x-pozy-area":"analytics"}},"/v1/analytics/instagram/account-insights":{"get":{"operationId":"getInstagramAccountInsights","summary":"Get Instagram insights","tags":["Analytics"],"parameters":[{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}},{"name":"metrics","in":"query","required":false,"schema":{"type":"string"}},{"name":"fromDate","in":"query","required":false,"schema":{"type":"string","format":"date"}},{"name":"toDate","in":"query","required":false,"schema":{"type":"string","format":"date"}},{"name":"since","in":"query","required":false,"schema":{"type":"string","format":"date"}},{"name":"until","in":"query","required":false,"schema":{"type":"string","format":"date"}},{"name":"metricType","in":"query","required":false,"schema":{"type":"string","enum":["time_series","total_value"],"default":"total_value"}},{"name":"breakdown","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InstagramAccountInsightsResponse"}}}}},"x-pozy-area":"analytics"}},"/v1/analytics/instagram/follower-history":{"get":{"operationId":"getInstagramFollowerHistory","summary":"Get Instagram follower history","tags":["Analytics"],"parameters":[{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}},{"name":"metrics","in":"query","required":false,"schema":{"type":"string"}},{"name":"fromDate","in":"query","required":false,"schema":{"type":"string","format":"date"}},{"name":"toDate","in":"query","required":false,"schema":{"type":"string","format":"date"}},{"name":"since","in":"query","required":false,"schema":{"type":"string","format":"date"}},{"name":"until","in":"query","required":false,"schema":{"type":"string","format":"date"}},{"name":"metricType","in":"query","required":false,"schema":{"type":"string","enum":["time_series","total_value"],"default":"total_value"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InstagramAccountInsightsResponse"}}}}},"x-pozy-area":"analytics"}},"/v1/analytics/facebook/demographics":{"get":{"operationId":"getFacebookDemographics","summary":"Get Facebook Page demographics","tags":["Analytics"],"parameters":[{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}},{"name":"breakdown","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"accountId":{"type":"string"},"platform":{"type":"string","enum":["facebook"]},"metric":{"type":"string","enum":["follower_demographics"]},"snapshotDate":{"type":["string","null"],"format":"date"},"demographics":{"type":"object","properties":{"country":{"type":"array","items":{"type":"object","properties":{"dimension":{"type":"string"},"value":{"type":"integer"}}}},"city":{"type":"array","items":{"type":"object","properties":{"dimension":{"type":"string"},"value":{"type":"integer"}}}}}},"note":{"type":"string"}}}}}}},"x-pozy-area":"analytics"}},"/v1/analytics/linkedin/demographics":{"get":{"operationId":"getLinkedInDemographics","summary":"Get LinkedIn organization follower demographics","tags":["Analytics"],"parameters":[{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}},{"name":"breakdown","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"accountId":{"type":"string"},"platform":{"type":"string","enum":["linkedin"]},"metric":{"type":"string","enum":["follower_demographics"]},"demographics":{"type":"object","additionalProperties":{"type":"array","items":{"type":"object","properties":{"dimension":{"type":"string"},"id":{"type":"string"},"value":{"type":"integer"}}}}},"note":{"type":"string"}}}}}}},"x-pozy-area":"analytics"}},"/v1/analytics/instagram/demographics":{"get":{"operationId":"getInstagramDemographics","summary":"Get Instagram demographics","tags":["Analytics"],"parameters":[{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}},{"name":"metric","in":"query","required":false,"schema":{"type":"string","enum":["follower_demographics","engaged_audience_demographics"],"default":"follower_demographics"}},{"name":"breakdown","in":"query","required":false,"schema":{"type":"string"}},{"name":"timeframe","in":"query","required":false,"schema":{"type":"string","enum":["this_week","this_month"],"default":"this_month"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InstagramDemographicsResponse"}}}}},"x-pozy-area":"analytics"}},"/v1/analytics/instagram/online-followers":{"get":{"operationId":"getInstagramOnlineFollowers","summary":"Get Instagram online followers","tags":["Analytics"],"parameters":[{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"accountId":{"type":"string"},"platform":{"type":"string","enum":["instagram"]},"metric":{"type":"string","enum":["online_followers"]},"days":{"type":"array","items":{"type":"object","properties":{"endTime":{"type":"string"},"hours":{"type":"object","additionalProperties":{"type":"integer"}}}}},"note":{"type":"string"}}}}}}},"x-pozy-area":"analytics"}},"/v1/analytics/youtube/demographics":{"get":{"operationId":"getYouTubeDemographics","summary":"Get YouTube demographics","tags":["Analytics"],"parameters":[{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}},{"name":"videoId","in":"query","required":false,"schema":{"type":"string"}},{"name":"breakdown","in":"query","required":false,"schema":{"type":"string"}},{"name":"fromDate","in":"query","required":false,"schema":{"type":"string","format":"date"}},{"name":"toDate","in":"query","required":false,"schema":{"type":"string","format":"date"}},{"name":"startDate","in":"query","required":false,"schema":{"type":"string","format":"date"}},{"name":"endDate","in":"query","required":false,"schema":{"type":"string","format":"date"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/YouTubeDemographicsResponse"}}}}},"x-pozy-area":"analytics"}},"/v1/analytics/daily-metrics":{"get":{"operationId":"getDailyMetrics","summary":"Get daily aggregated metrics","tags":["Analytics"],"parameters":[{"name":"platform","in":"query","required":false,"schema":{"type":"string"}},{"name":"profileId","in":"query","required":false,"schema":{"type":"string"}},{"name":"accountId","in":"query","required":false,"schema":{"type":"string"}},{"name":"fromDate","in":"query","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"toDate","in":"query","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"source","in":"query","required":false,"schema":{"type":"string","enum":["all","pozy","external"],"default":"all"}},{"name":"attribution","in":"query","required":false,"schema":{"type":"string","enum":["publish","received"],"default":"publish"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"dailyData":{"type":"array","items":{"type":"object","properties":{"date":{"type":"string"},"postCount":{"type":"integer"},"platforms":{"type":"object","additionalProperties":{"type":"integer"}},"metrics":{"type":"object","properties":{"impressions":{"type":"integer"},"reach":{"type":"integer"},"likes":{"type":"integer"},"comments":{"type":"integer"},"shares":{"type":"integer"},"saves":{"type":"integer"},"clicks":{"type":"integer"},"views":{"type":"integer"}}}}}},"platformBreakdown":{"type":"array","items":{"type":"object","properties":{"platform":{"type":"string"},"postCount":{"type":"integer"},"impressions":{"type":"integer"},"reach":{"type":"integer"},"likes":{"type":"integer"},"comments":{"type":"integer"},"shares":{"type":"integer"},"saves":{"type":"integer"},"clicks":{"type":"integer"},"views":{"type":"integer"}}}}}}}}}},"x-pozy-area":"analytics"}},"/v1/analytics/dashboard":{"get":{"operationId":"getAnalyticsDashboard","summary":"Get an analytics dashboard","tags":["Analytics"],"parameters":[{"name":"profileId","in":"query","required":false,"schema":{"type":"string","default":"all"}},{"name":"platform","in":"query","required":false,"schema":{"type":"string","default":"all"}},{"name":"fromDate","in":"query","required":true,"schema":{"type":"string","format":"date"}},{"name":"toDate","in":"query","required":true,"schema":{"type":"string","format":"date"}},{"name":"compare","in":"query","required":false,"schema":{"type":"string","enum":["previous_period"]}},{"name":"topPosts","in":"query","required":false,"schema":{"type":"integer","minimum":0,"maximum":25,"default":5}},{"name":"recentPosts","in":"query","required":false,"schema":{"type":"integer","minimum":0,"maximum":25,"default":10}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","required":["dateRange","totals","followers","daily","topPosts","recentPosts","dataAsOf"],"properties":{"dateRange":{"type":"object","properties":{"fromDate":{"type":"string","format":"date"},"toDate":{"type":"string","format":"date"}}},"totals":{"$ref":"#/components/schemas/AnalyticsDashboardTotals"},"previousTotals":{"$ref":"#/components/schemas/AnalyticsDashboardTotals"},"followers":{"$ref":"#/components/schemas/AnalyticsDashboardFollowers"},"previousFollowers":{"$ref":"#/components/schemas/AnalyticsDashboardFollowers"},"daily":{"type":"array","items":{"type":"object","properties":{"date":{"type":"string","format":"date"},"impressions":{"type":"integer"},"reach":{"type":"integer"},"engagement":{"type":"integer"},"views":{"type":"integer"},"followersGained":{"type":"integer"}}}},"topPosts":{"type":"array","items":{"$ref":"#/components/schemas/AnalyticsDashboardPost"}},"recentPosts":{"type":"array","items":{"$ref":"#/components/schemas/AnalyticsDashboardPost"}},"dataAsOf":{"type":["string","null"],"format":"date-time"}}}}}}},"x-pozy-area":"analytics"}},"/v1/analytics/best-time":{"get":{"operationId":"getBestTimeToPost","summary":"Get best times to post","tags":["Analytics"],"parameters":[{"name":"platform","in":"query","required":false,"schema":{"type":"string"}},{"name":"profileId","in":"query","required":false,"schema":{"type":"string"}},{"name":"accountId","in":"query","required":false,"schema":{"type":"string"}},{"name":"source","in":"query","required":false,"schema":{"type":"string","enum":["all","pozy","external"],"default":"all"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"slots":{"type":"array","items":{"type":"object","properties":{"day_of_week":{"type":"integer","minimum":0,"maximum":6},"hour":{"type":"integer","minimum":0,"maximum":23},"avg_engagement":{"type":"number"},"post_count":{"type":"integer"}}}}}}}}}},"x-pozy-area":"analytics"}},"/v1/analytics/content-decay":{"get":{"operationId":"getContentDecay","summary":"Get content performance decay","tags":["Analytics"],"parameters":[{"name":"platform","in":"query","required":false,"schema":{"type":"string"}},{"name":"profileId","in":"query","required":false,"schema":{"type":"string"}},{"name":"accountId","in":"query","required":false,"schema":{"type":"string"}},{"name":"source","in":"query","required":false,"schema":{"type":"string","enum":["all","pozy","external"],"default":"all"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"buckets":{"type":"array","items":{"type":"object","properties":{"bucket_order":{"type":"integer"},"bucket_label":{"type":"string"},"avg_pct_of_final":{"type":"number"},"post_count":{"type":"integer"}}}}}}}}}},"x-pozy-area":"analytics"}},"/v1/analytics/posting-frequency":{"get":{"operationId":"getPostingFrequency","summary":"Get frequency vs engagement","tags":["Analytics"],"parameters":[{"name":"platform","in":"query","required":false,"schema":{"type":"string"}},{"name":"profileId","in":"query","required":false,"schema":{"type":"string"}},{"name":"accountId","in":"query","required":false,"schema":{"type":"string"}},{"name":"source","in":"query","required":false,"schema":{"type":"string","enum":["all","pozy","external"],"default":"all"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"frequency":{"type":"array","items":{"type":"object","properties":{"platform":{"type":"string"},"posts_per_week":{"type":"integer"},"avg_engagement_rate":{"type":"number"},"avg_engagement":{"type":"number"},"weeks_count":{"type":"integer"}}}}}}}}}},"x-pozy-area":"analytics"}},"/v1/ledger/balances":{"get":{"operationId":"getLedgerBalances","summary":"Get ledger balances","tags":["Ledger"],"parameters":[{"name":"scopeType","in":"query","required":true,"schema":{"type":"string"}},{"name":"scopeId","in":"query","required":true,"schema":{"type":"string"}},{"name":"currency","in":"query","required":false,"schema":{"type":"string","default":"usd"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"scopeType":{"type":"string"},"scopeId":{"type":"string"},"currency":{"type":"string"},"balances":{"type":"object","additionalProperties":{"type":"integer"}}}}}}}},"x-pozy-area":"creators"}},"/v1/ledger/entries":{"get":{"operationId":"listLedgerEntries","summary":"List ledger entries","tags":["Ledger"],"parameters":[{"name":"scopeType","in":"query","required":false,"schema":{"type":"string"}},{"name":"scopeId","in":"query","required":false,"schema":{"type":"string"}},{"name":"kind","in":"query","required":false,"schema":{"type":"string","enum":["accrual","approval","hold_release","adjustment","settling","settlement","reversal","topup","transfer","fee"]}},{"name":"referenceType","in":"query","required":false,"schema":{"type":"string"}},{"name":"referenceId","in":"query","required":false,"schema":{"type":"string"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":200,"default":50}},{"name":"skip","in":"query","required":false,"schema":{"type":"integer","minimum":0,"default":0}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"entries":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"kind":{"type":"string","enum":["accrual","approval","hold_release","adjustment","settling","settlement","reversal","topup","transfer","fee"]},"amountCents":{"type":"integer"},"debit":{"$ref":"#/components/schemas/LedgerAccountSide"},"credit":{"$ref":"#/components/schemas/LedgerAccountSide"},"holdUntil":{"type":["string","null"],"format":"date-time"},"releasedByEntryId":{"type":["string","null"]},"referenceType":{"type":["string","null"]},"referenceId":{"type":["string","null"]},"reversesEntryId":{"type":["string","null"]},"cause":{"type":"string"},"actor":{"type":"string"},"createdAt":{"type":"string","format":"date-time"}}}},"pagination":{"type":"object","properties":{"total":{"type":"integer"},"limit":{"type":"integer"},"skip":{"type":"integer"}}}}}}}}},"x-pozy-area":"creators"}},"/v1/balance":{"get":{"operationId":"getBalance","summary":"Get balance","tags":["Treasury"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"availableCents":{"type":"integer"},"payoutLockedCents":{"type":"integer"},"payoutLocks":{"type":"array","items":{"type":"object","required":["topupId","amountCents","chargedAt","unlocksAt"],"properties":{"topupId":{"type":"string"},"amountCents":{"type":"integer"},"chargedAt":{"type":"string","format":"date-time"},"unlocksAt":{"type":"string","format":"date-time"}}}},"pendingCents":{"type":"integer"},"pendingReleases":{"type":"array","items":{"type":"object","required":["topupId","amountCents","availableAt"],"properties":{"topupId":{"type":"string"},"amountCents":{"type":"integer"},"availableAt":{"type":"string","format":"date-time"}}}},"pendingTopupCents":{"type":"integer"},"currency":{"type":"string","enum":["usd"]},"recentTopups":{"type":"array","items":{"$ref":"#/components/schemas/TreasuryTopup"}}}}}}}},"x-pozy-area":"creators"}},"/v1/balance/top-ups":{"get":{"operationId":"listTopups","summary":"List top-ups","tags":["Treasury"],"parameters":[{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":200,"default":50}},{"name":"skip","in":"query","required":false,"schema":{"type":"integer","minimum":0,"default":0}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"topups":{"type":"array","items":{"$ref":"#/components/schemas/TreasuryTopup"}}}}}}}},"x-pozy-area":"creators"},"post":{"operationId":"createTopup","summary":"Create a top-up","tags":["Treasury"],"parameters":[{"name":"Idempotency-Key","in":"header","required":false,"schema":{"type":"string","maxLength":255}}],"responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"type":"object","required":["topupId","status","clientSecret"],"properties":{"topupId":{"type":"string"},"status":{"type":"string","enum":["succeeded","processing","requires_action"]},"clientSecret":{"type":["string","null"]}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["amountCents","method"],"properties":{"amountCents":{"type":"integer","minimum":1000,"maximum":10000000},"method":{"type":"string","enum":["card","bank_transfer"]},"paymentMethodId":{"type":"string"}}}}}},"x-pozy-area":"creators"}},"/v1/balance/top-ups/{topupId}/receipt":{"get":{"operationId":"getTopupReceipt","summary":"Get a top-up receipt","tags":["Treasury"],"parameters":[{"name":"topupId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","required":["url","format"],"properties":{"url":{"type":"string","format":"uri"},"format":{"type":"string","enum":["pdf","page"]}}}}}}},"x-pozy-area":"creators"}},"/v1/balance/top-ups/{topupId}/confirm":{"post":{"operationId":"confirmTopup","summary":"Confirm a top-up","tags":["Treasury"],"parameters":[{"name":"topupId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TreasuryTopup"}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"x-pozy-area":"creators"}},"/v1/balance/top-ups/{topupId}/cancel":{"post":{"operationId":"cancelTopup","summary":"Cancel a top-up","tags":["Treasury"],"parameters":[{"name":"topupId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TreasuryTopup"}}}}},"x-pozy-area":"creators"}},"/v1/payees":{"get":{"operationId":"listPayees","summary":"List payees","tags":["Treasury"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"payees":{"type":"array","items":{"$ref":"#/components/schemas/TreasuryPayee"}}}}}}}},"x-pozy-area":"creators"}},"/v1/payees/{payeeId}/onboarding-link":{"post":{"operationId":"createPayeeOnboardingLink","summary":"Create a payee onboarding link","tags":["Treasury"],"parameters":[{"name":"payeeId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string","format":"uri"},"expiresAt":{"type":"string","format":"date-time"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"x-pozy-area":"creators"}},"/v1/transfers":{"get":{"operationId":"listTransfers","summary":"List transfers","tags":["Treasury"],"parameters":[{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":200,"default":50}},{"name":"skip","in":"query","required":false,"schema":{"type":"integer","minimum":0,"default":0}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"transfers":{"type":"array","items":{"$ref":"#/components/schemas/TreasuryTransfer"}}}}}}}},"x-pozy-area":"creators"},"post":{"operationId":"createTransfer","summary":"Create a transfer","tags":["Treasury"],"parameters":[{"name":"Idempotency-Key","in":"header","required":false,"schema":{"type":"string","maxLength":255}}],"responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TreasuryTransfer"}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["payeeId","amountCents"],"properties":{"payeeId":{"type":"string","minLength":24,"maxLength":24},"amountCents":{"type":"integer","minimum":1},"reference":{"type":"object","required":["type","id"],"properties":{"type":{"type":"string"},"id":{"type":"string"}}}}}}}},"x-pozy-area":"creators"}},"/v1/transfers/{transferId}":{"get":{"operationId":"getTransfer","summary":"Get a transfer","tags":["Treasury"],"parameters":[{"name":"transferId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TreasuryTransfer"}}}}},"x-pozy-area":"creators"}},"/public/creator-campaigns/recover-link":{"post":{"operationId":"recoverCreatorPortalLinks","summary":"Email a creator their campaign links","tags":["Creator Portal"],"security":[],"responses":{"202":{"description":"Success","content":{"application/json":{"schema":{"type":"object","required":["status","message"],"properties":{"status":{"type":"string","enum":["accepted"]},"message":{"type":"string"}}}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","maxLength":320},"campaignId":{"type":"string"}}}}}},"x-pozy-area":"creators"}},"/public/creator-campaigns/{token}":{"get":{"operationId":"getCreatorPortal","summary":"Read a creator invite or participant page","tags":["Creator Portal"],"parameters":[{"name":"token","in":"path","required":true,"schema":{"type":"string","pattern":"^[A-Za-z0-9_-]{16,128}$"}}],"security":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/CreatorPortalInvite"},{"$ref":"#/components/schemas/CreatorPortalParticipant"}],"discriminator":{"propertyName":"kind","mapping":{"invite":"#/components/schemas/CreatorPortalInvite","participant":"#/components/schemas/CreatorPortalParticipant"}}}}}}},"x-pozy-area":"creators"},"post":{"operationId":"joinCreatorCampaign","summary":"Join a campaign","tags":["Creator Portal"],"parameters":[{"name":"token","in":"path","required":true,"schema":{"type":"string","pattern":"^[A-Za-z0-9_-]{16,128}$"}}],"security":[],"responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"type":"object","required":["participantToken"],"properties":{"participantToken":{"type":"string"}}}}}},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{"displayName":{"type":"string","minLength":1,"maxLength":200},"email":{"type":"string","format":"email"}}}}}},"x-pozy-area":"creators"}},"/public/creator-campaigns/{token}/connect":{"post":{"operationId":"startCreatorConnect","summary":"Start connecting a creator account","tags":["Creator Portal"],"parameters":[{"name":"token","in":"path","required":true,"schema":{"type":"string","pattern":"^[A-Za-z0-9_-]{16,128}$"}}],"security":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","required":["authUrl"],"properties":{"authUrl":{"type":"string","format":"uri"}}}}}},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["platform"],"properties":{"platform":{"type":"string","minLength":1,"maxLength":40}}}}}},"x-pozy-area":"creators"}},"/public/creator-campaigns/{token}/submissions":{"post":{"operationId":"submitCreatorPost","summary":"Submit a post","tags":["Creator Portal"],"parameters":[{"name":"token","in":"path","required":true,"schema":{"type":"string","pattern":"^[A-Za-z0-9_-]{16,128}$"}}],"security":[],"responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"type":"object","required":["submission"],"properties":{"submission":{"$ref":"#/components/schemas/CreatorPortalSubmission"}}}}}},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["url"],"properties":{"url":{"type":"string","minLength":1,"maxLength":2048}}}}}},"x-pozy-area":"creators"}},"/public/creator-campaigns/{token}/payouts":{"get":{"operationId":"getCreatorPayouts","summary":"List a creator's earnings history","tags":["Creator Portal"],"parameters":[{"name":"token","in":"path","required":true,"schema":{"type":"string","pattern":"^[A-Za-z0-9_-]{16,128}$"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":200,"default":50}},{"name":"skip","in":"query","required":false,"schema":{"type":"integer","minimum":0,"default":0}}],"security":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","required":["entries","total","payouts"],"properties":{"entries":{"type":"array","items":{"$ref":"#/components/schemas/CreatorPortalPayoutEntry"}},"total":{"type":"integer"},"payouts":{"$ref":"#/components/schemas/CreatorPortalPayoutSetup"}}}}}}},"x-pozy-area":"creators"},"post":{"operationId":"startCreatorPayouts","summary":"Start payout onboarding","tags":["Creator Portal"],"parameters":[{"name":"token","in":"path","required":true,"schema":{"type":"string","pattern":"^[A-Za-z0-9_-]{16,128}$"}}],"security":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","required":["url"],"properties":{"url":{"type":"string","format":"uri"}}}}}},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["action"],"properties":{"action":{"type":"string","enum":["onboard"]},"country":{"type":"string","pattern":"^[A-Za-z]{2}$"}}}}}},"x-pozy-area":"creators"}},"/public/creator-campaigns/{token}/payout-login":{"post":{"operationId":"createCreatorPayoutLogin","summary":"Open the creator's Stripe dashboard","tags":["Creator Portal"],"parameters":[{"name":"token","in":"path","required":true,"schema":{"type":"string","pattern":"^[A-Za-z0-9_-]{16,128}$"}}],"security":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","required":["url"],"properties":{"url":{"type":"string","format":"uri"}}}}}}},"x-pozy-area":"creators"}},"/public/creator-campaigns/{token}/payouts/{transferId}/statement":{"get":{"operationId":"getCreatorPayoutStatement","summary":"Download a payout statement","tags":["Creator Portal"],"parameters":[{"name":"token","in":"path","required":true,"schema":{"type":"string","pattern":"^[A-Za-z0-9_-]{16,128}$"}},{"name":"transferId","in":"path","required":true,"schema":{"type":"string"}}],"security":[],"responses":{"200":{"description":"Success","content":{"application/pdf":{"schema":{"type":"string","format":"binary"}}}}},"x-pozy-area":"creators"}},"/v1/payout-batches/{batchId}":{"get":{"operationId":"getPayoutBatch","summary":"Get a payout batch","tags":["Treasury"],"parameters":[{"name":"batchId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","required":["batch"],"properties":{"batch":{"$ref":"#/components/schemas/PayoutBatch"}}}}}}},"x-pozy-area":"creators"}},"/v1/payout-batches/{batchId}/confirm":{"post":{"operationId":"confirmPayoutBatch","summary":"Confirm a payout batch payment","tags":["Treasury"],"parameters":[{"name":"batchId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","required":["batch"],"properties":{"batch":{"$ref":"#/components/schemas/PayoutBatch"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"x-pozy-area":"creators"}},"/v1/payout-batches/{batchId}/cancel":{"post":{"operationId":"cancelPayoutBatch","summary":"Cancel an unpaid payout batch","tags":["Treasury"],"parameters":[{"name":"batchId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","required":["batch"],"properties":{"batch":{"$ref":"#/components/schemas/PayoutBatch"}}}}}}},"x-pozy-area":"creators"}},"/v1/analytics/post-timeline":{"get":{"operationId":"getPostTimeline","summary":"Get post analytics timeline","tags":["Analytics"],"parameters":[{"name":"postId","in":"query","required":true,"schema":{"type":"string"}},{"name":"fromDate","in":"query","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"toDate","in":"query","required":false,"schema":{"type":"string","format":"date-time"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"postId":{"type":"string"},"timeline":{"type":"array","items":{"type":"object","properties":{"date":{"type":"string","format":"date"},"platform":{"type":"string"},"platformPostId":{"type":"string"},"impressions":{"type":"integer"},"reach":{"type":"integer"},"likes":{"type":"integer"},"comments":{"type":"integer"},"shares":{"type":"integer"},"saves":{"type":"integer"},"clicks":{"type":"integer"},"views":{"type":"integer"},"follows":{"type":["integer","null"]},"completionRate":{"type":"number"},"profileViews":{"type":"integer"},"websiteClicks":{"type":"integer"},"impressionSources":{"type":"object","additionalProperties":{"type":"number"}},"audienceTypes":{"type":"object","additionalProperties":{"type":"number"}},"audienceCountries":{"type":"object","additionalProperties":{"type":"number"}},"replays":{"type":"integer"},"retentionCurve":{"type":"object","additionalProperties":{"type":"number"}}}}}}}}}}},"x-pozy-area":"analytics"}},"/v1/analytics/googleanalytics/report":{"post":{"operationId":"runGoogleAnalyticsReport","summary":"Run a Google Analytics (GA4) report","tags":["Analytics"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleAnalyticsReport"}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/GoogleAnalyticsReportFields"},{"type":"object","properties":{"dateRanges":{"type":"array","minItems":1,"maxItems":4,"items":{"type":"object","required":["startDate","endDate"],"properties":{"startDate":{"type":"string"},"endDate":{"type":"string"},"name":{"type":"string"}}}},"offset":{"type":"integer","minimum":0},"keepEmptyRows":{"type":"boolean"},"currencyCode":{"type":"string"}}}]}}}},"x-pozy-area":"analytics"}},"/v1/analytics/googleanalytics/realtime":{"post":{"operationId":"runGoogleAnalyticsRealtimeReport","summary":"Run a Google Analytics (GA4) realtime report","tags":["Analytics"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleAnalyticsReport"}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/GoogleAnalyticsReportFields"},{"type":"object","properties":{"minuteRanges":{"type":"array","minItems":1,"maxItems":2,"items":{"type":"object","properties":{"startMinutesAgo":{"type":"integer","minimum":0,"maximum":59},"endMinutesAgo":{"type":"integer","minimum":0,"maximum":59},"name":{"type":"string"}}}}}}]}}}},"x-pozy-area":"analytics"}},"/v1/analytics/googleanalytics/metadata":{"get":{"operationId":"getGoogleAnalyticsMetadata","summary":"List Google Analytics (GA4) dimensions and metrics","tags":["Analytics"],"parameters":[{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"accountId":{"type":"string"},"propertyId":{"type":"string"},"dimensions":{"type":"array","items":{"type":"object","properties":{"apiName":{"type":"string"},"uiName":{"type":"string"},"description":{"type":"string"},"category":{"type":"string"},"customDefinition":{"type":"boolean"}}}},"metrics":{"type":"array","items":{"type":"object","properties":{"apiName":{"type":"string"},"uiName":{"type":"string"},"description":{"type":"string"},"type":{"type":"string"},"category":{"type":"string"},"customDefinition":{"type":"boolean"}}}}}}}}}},"x-pozy-area":"analytics"}},"/v1/analytics/tracking":{"get":{"operationId":"listTrackingWindows","summary":"List tracking windows","tags":["Analytics"],"parameters":[{"name":"accountId","in":"query","required":false,"schema":{"type":"string"}},{"name":"status","in":"query","required":false,"schema":{"type":"string","enum":["open","completing","completed","cancelled"]}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":200,"default":50}},{"name":"skip","in":"query","required":false,"schema":{"type":"integer","minimum":0,"default":0}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","required":["windows"],"properties":{"windows":{"type":"array","items":{"$ref":"#/components/schemas/TrackingWindow"}}}}}}}},"x-pozy-area":"analytics"},"post":{"operationId":"openTrackingWindow","summary":"Open a tracking window","tags":["Analytics"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TrackingWindowResponse"}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"postId":{"type":"string"},"accountId":{"type":"string"},"url":{"type":"string"},"trackingDays":{"type":"integer","minimum":1,"maximum":90,"default":30},"requestedBy":{"type":"string","default":"api"}}}}}},"x-pozy-area":"analytics"}},"/v1/analytics/tracking/{windowId}":{"get":{"operationId":"getTrackingWindow","summary":"Get a tracking window","tags":["Analytics"],"parameters":[{"name":"windowId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TrackingWindowResponse"}}}}},"x-pozy-area":"analytics"},"delete":{"operationId":"cancelTrackingWindow","summary":"Cancel a tracking window","tags":["Analytics"],"parameters":[{"name":"windowId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TrackingWindowResponse"}}}}},"x-pozy-area":"analytics"}},"/v1/analytics/samples":{"get":{"operationId":"getPostSamples","summary":"Get post samples","tags":["Analytics"],"parameters":[{"name":"postId","in":"query","required":true,"schema":{"type":"string"}},{"name":"fromDate","in":"query","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"toDate","in":"query","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":2000,"default":500}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","required":["postId","samples"],"properties":{"postId":{"type":"string"},"samples":{"type":"array","items":{"$ref":"#/components/schemas/PostSample"}}}}}}}},"x-pozy-area":"analytics"}},"/v1/posts/{postId}/authenticity":{"get":{"operationId":"getPostAuthenticity","summary":"Get a post's authenticity score","tags":["Analytics"],"parameters":[{"name":"postId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PostAuthenticity"}}}}},"x-pozy-area":"analytics"}},"/v1/analytics/authenticity":{"get":{"operationId":"listPostAuthenticity","summary":"List authenticity scores","tags":["Analytics"],"parameters":[{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}},{"name":"minScore","in":"query","required":false,"schema":{"type":"integer","minimum":0,"maximum":100}},{"name":"maxScore","in":"query","required":false,"schema":{"type":"integer","minimum":0,"maximum":100}},{"name":"from","in":"query","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"to","in":"query","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":200,"default":50}},{"name":"skip","in":"query","required":false,"schema":{"type":"integer","minimum":0,"default":0}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","required":["scores"],"properties":{"scores":{"type":"array","items":{"$ref":"#/components/schemas/PostAuthenticity"}}}}}}}},"x-pozy-area":"analytics"}},"/v1/analytics/googlebusiness/performance":{"get":{"operationId":"getGoogleBusinessPerformance","summary":"Get Google Business Profile performance metrics","tags":["Analytics"],"parameters":[{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}},{"name":"metrics","in":"query","required":false,"schema":{"type":"string"}},{"name":"fromDate","in":"query","required":false,"schema":{"type":"string","format":"date"}},{"name":"toDate","in":"query","required":false,"schema":{"type":"string","format":"date"}},{"name":"startDate","in":"query","required":false,"schema":{"type":"string","format":"date"}},{"name":"endDate","in":"query","required":false,"schema":{"type":"string","format":"date"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"accountId":{"type":"string"},"platform":{"type":"string"},"dateRange":{"type":"object","properties":{"startDate":{"type":"string","format":"date"},"endDate":{"type":"string","format":"date"}}},"metrics":{"type":"object","additionalProperties":{"type":"object","properties":{"total":{"type":"integer"},"values":{"type":"array","items":{"type":"object","properties":{"date":{"type":"string","format":"date"},"value":{"type":"integer"}}}}}}},"dataDelay":{"type":"string"}}}}}}},"x-pozy-area":"analytics"}},"/v1/analytics/googlebusiness/search-keywords":{"get":{"operationId":"getGoogleBusinessSearchKeywords","summary":"Get Google Business Profile search keywords","tags":["Analytics"],"parameters":[{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}},{"name":"startMonth","in":"query","required":false,"schema":{"type":"string","pattern":"^\\d{4}-\\d{2}$"}},{"name":"endMonth","in":"query","required":false,"schema":{"type":"string","pattern":"^\\d{4}-\\d{2}$"}},{"name":"pageToken","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"accountId":{"type":"string"},"platform":{"type":"string"},"monthRange":{"type":"object","properties":{"startMonth":{"type":"string"},"endMonth":{"type":"string"}}},"keywords":{"type":"array","items":{"type":"object","properties":{"keyword":{"type":"string"},"impressions":{"type":"integer"},"impressionsThreshold":{"type":["integer","null"]}}}},"nextPageToken":{"type":["string","null"]},"note":{"type":"string"}}}}}}},"x-pozy-area":"analytics"}},"/v1/analytics/inbox/volume":{"get":{"operationId":"getInboxVolume","summary":"Get inbox messaging volume","tags":["Inbox Analytics"],"parameters":[{"name":"fromDate","in":"query","required":true,"schema":{"type":"string","format":"date"}},{"name":"toDate","in":"query","required":false,"schema":{"type":"string","format":"date"}},{"name":"profileId","in":"query","required":false,"schema":{"type":"string"}},{"name":"platform","in":"query","required":false,"schema":{"type":"string"}},{"name":"accountId","in":"query","required":false,"schema":{"type":"string"}},{"name":"source","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"from":{"type":"string","format":"date"},"to":{"type":["string","null"],"format":"date"},"summary":{"type":"object","properties":{"received":{"type":"integer"},"sent":{"type":"integer"},"read":{"type":"integer"},"failed":{"type":"integer"},"uniqueConversations":{"type":"integer"}}},"timeseries":{"type":"array","items":{"type":"object","properties":{"date":{"type":"string","format":"date"},"sent":{"type":"integer"},"received":{"type":"integer"},"read":{"type":"integer"},"failed":{"type":"integer"}}}},"byPlatform":{"type":"array","items":{"type":"object","properties":{"platform":{"type":"string"},"sent":{"type":"integer"},"received":{"type":"integer"},"read":{"type":"integer"},"failed":{"type":"integer"}}}}}}}}}},"x-pozy-area":"analytics"}},"/v1/analytics/inbox/heatmap":{"get":{"operationId":"getInboxHeatmap","summary":"Get day × hour heatmap","tags":["Inbox Analytics"],"parameters":[{"name":"fromDate","in":"query","required":true,"schema":{"type":"string","format":"date"}},{"name":"toDate","in":"query","required":false,"schema":{"type":"string","format":"date"}},{"name":"profileId","in":"query","required":false,"schema":{"type":"string"}},{"name":"platform","in":"query","required":false,"schema":{"type":"string"}},{"name":"accountId","in":"query","required":false,"schema":{"type":"string"}},{"name":"source","in":"query","required":false,"schema":{"type":"string"}},{"name":"action","in":"query","required":false,"schema":{"type":"string","enum":["message.received","message.sent","message.read","all"]}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"from":{"type":"string","format":"date"},"to":{"type":["string","null"],"format":"date"},"buckets":{"type":"array","items":{"type":"object","properties":{"dow":{"type":"integer","minimum":1,"maximum":7},"hour":{"type":"integer","minimum":0,"maximum":23},"received":{"type":"integer"},"sent":{"type":"integer"},"read":{"type":"integer"}}}}}}}}}},"x-pozy-area":"analytics"}},"/v1/analytics/inbox/source-breakdown":{"get":{"operationId":"getInboxSourceBreakdown","summary":"Get inbox source breakdown","tags":["Inbox Analytics"],"parameters":[{"name":"fromDate","in":"query","required":true,"schema":{"type":"string","format":"date"}},{"name":"toDate","in":"query","required":false,"schema":{"type":"string","format":"date"}},{"name":"profileId","in":"query","required":false,"schema":{"type":"string"}},{"name":"platform","in":"query","required":false,"schema":{"type":"string"}},{"name":"accountId","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"from":{"type":"string","format":"date"},"to":{"type":["string","null"],"format":"date"},"sources":{"type":"array","items":{"type":"object","properties":{"source":{"type":"string"},"received":{"type":"integer"},"sent":{"type":"integer"},"read":{"type":"integer"},"byPlatform":{"type":"array","items":{"type":"object","properties":{"platform":{"type":"string"},"received":{"type":"integer"},"sent":{"type":"integer"},"read":{"type":"integer"}}}}}}}}}}}}},"x-pozy-area":"analytics"}},"/v1/analytics/inbox/response-time":{"get":{"operationId":"getInboxResponseTime","summary":"Get inbox response-time stats","tags":["Inbox Analytics"],"parameters":[{"name":"fromDate","in":"query","required":true,"schema":{"type":"string","format":"date"}},{"name":"toDate","in":"query","required":false,"schema":{"type":"string","format":"date"}},{"name":"profileId","in":"query","required":false,"schema":{"type":"string"}},{"name":"platform","in":"query","required":false,"schema":{"type":"string"}},{"name":"accountId","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"from":{"type":"string","format":"date"},"to":{"type":["string","null"],"format":"date"},"summary":{"type":"object","properties":{"sampleSize":{"type":"integer"},"medianSeconds":{"type":"integer"},"p90Seconds":{"type":"integer"},"p99Seconds":{"type":"integer"},"meanSeconds":{"type":"integer"},"fastestSeconds":{"type":"integer"},"slowestSeconds":{"type":"integer"}}},"histogram":{"type":"array","items":{"type":"object","properties":{"bucket":{"type":"string"},"lowerSeconds":{"type":"integer"},"upperSeconds":{"type":["integer","null"]},"count":{"type":"integer"}}}}}}}}}},"x-pozy-area":"analytics"}},"/v1/analytics/inbox/top-accounts":{"get":{"operationId":"getInboxTopAccounts","summary":"Get top accounts by inbox volume","tags":["Inbox Analytics"],"parameters":[{"name":"fromDate","in":"query","required":true,"schema":{"type":"string","format":"date"}},{"name":"toDate","in":"query","required":false,"schema":{"type":"string","format":"date"}},{"name":"profileId","in":"query","required":false,"schema":{"type":"string"}},{"name":"platform","in":"query","required":false,"schema":{"type":"string"}},{"name":"source","in":"query","required":false,"schema":{"type":"string"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":50,"default":10}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"from":{"type":"string","format":"date"},"to":{"type":["string","null"],"format":"date"},"accounts":{"type":"array","items":{"type":"object","properties":{"accountId":{"type":"string"},"platform":{"type":"string"},"displayName":{"type":"string"},"username":{"type":"string"},"received":{"type":"integer"},"sent":{"type":"integer"},"total":{"type":"integer"},"conversations":{"type":"integer"},"medianResponseSeconds":{"type":"integer"},"repliedCount":{"type":"integer"}}}}}}}}}},"x-pozy-area":"analytics"}},"/v1/analytics/inbox/conversations":{"get":{"operationId":"listInboxConversationAnalytics","summary":"List conversation analytics","tags":["Inbox Analytics"],"parameters":[{"name":"fromDate","in":"query","required":true,"schema":{"type":"string","format":"date"}},{"name":"toDate","in":"query","required":false,"schema":{"type":"string","format":"date"}},{"name":"profileId","in":"query","required":false,"schema":{"type":"string"}},{"name":"platform","in":"query","required":false,"schema":{"type":"string"}},{"name":"accountId","in":"query","required":false,"schema":{"type":"string"}},{"name":"source","in":"query","required":false,"schema":{"type":"string"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":100,"default":50}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"default":1}},{"name":"sortBy","in":"query","required":false,"schema":{"type":"string","enum":["lastMessageAt","firstMessageAt","totalMessages","received","sent","read","failed"],"default":"lastMessageAt"}},{"name":"order","in":"query","required":false,"schema":{"type":"string","enum":["asc","desc"],"default":"desc"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"from":{"type":"string","format":"date"},"to":{"type":["string","null"],"format":"date"},"items":{"type":"array","items":{"type":"object","properties":{"conversationId":{"type":"string"},"mongoId":{"type":["string","null"]},"accountId":{"type":"string"},"platform":{"type":"string"},"participantName":{"type":["string","null"]},"participantUsername":{"type":["string","null"]},"participantPicture":{"type":["string","null"]},"lastMessage":{"type":["string","null"]},"totalMessages":{"type":"integer"},"received":{"type":"integer"},"sent":{"type":"integer"},"read":{"type":"integer"},"failed":{"type":"integer"},"firstMessageAt":{"type":"string","format":"date-time"},"lastMessageAt":{"type":"string","format":"date-time"}}}},"pagination":{"type":"object","properties":{"page":{"type":"integer"},"limit":{"type":"integer"},"total":{"type":"integer"},"totalPages":{"type":"integer"},"hasMore":{"type":"boolean"}}}}}}}}},"x-pozy-area":"analytics"}},"/v1/analytics/inbox/conversations/{conversationId}":{"get":{"operationId":"getInboxConversationAnalytics","summary":"Get conversation analytics","tags":["Inbox Analytics"],"parameters":[{"name":"conversationId","in":"path","required":true,"schema":{"type":"string"}},{"name":"fromDate","in":"query","required":true,"schema":{"type":"string","format":"date"}},{"name":"toDate","in":"query","required":false,"schema":{"type":"string","format":"date"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"conversationId":{"type":"string"},"mongoId":{"type":"string"},"platform":{"type":["string","null"]},"from":{"type":"string","format":"date"},"to":{"type":["string","null"],"format":"date"},"summary":{"type":"object","properties":{"received":{"type":"integer"},"sent":{"type":"integer"},"read":{"type":"integer"},"failed":{"type":"integer"},"totalMessages":{"type":"integer"},"firstMessageAt":{"type":["string","null"],"format":"date-time"},"lastMessageAt":{"type":["string","null"],"format":"date-time"}}},"timeseries":{"type":"array","items":{"type":"object","properties":{"date":{"type":"string","format":"date"},"sent":{"type":"integer"},"received":{"type":"integer"},"read":{"type":"integer"},"failed":{"type":"integer"}}}},"bySource":{"type":"array","items":{"type":"object","properties":{"source":{"type":"string"},"count":{"type":"integer"}}}}}}}}}},"x-pozy-area":"analytics"}},"/v1/account-groups":{"get":{"operationId":"listAccountGroups","summary":"List groups","tags":["Account Groups"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"groups":{"type":"array","items":{"type":"object","properties":{"_id":{"type":"string"},"name":{"type":"string"},"accountIds":{"type":"array","items":{"type":"string"}},"createdBy":{"type":"string"},"profileId":{"type":"string"}}}}}}}}}},"x-pozy-area":"accounts"},"post":{"operationId":"createAccountGroup","summary":"Create group","tags":["Account Groups"],"responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"group":{"type":"object","properties":{"_id":{"type":"string"},"name":{"type":"string"},"accountIds":{"type":"array","items":{"type":"string"}}}}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["name","accountIds"],"properties":{"name":{"type":"string"},"accountIds":{"type":"array","items":{"type":"string"}},"profileId":{"type":"string","deprecated":true}}}}}},"x-pozy-area":"accounts"}},"/v1/account-groups/{groupId}":{"put":{"operationId":"updateAccountGroup","summary":"Update group","tags":["Account Groups"],"parameters":[{"name":"groupId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"group":{"type":"object"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"accountIds":{"type":"array","items":{"type":"string"}}}}}}},"x-pozy-area":"accounts"},"delete":{"operationId":"deleteAccountGroup","summary":"Delete group","tags":["Account Groups"],"parameters":[{"name":"groupId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}}}}}}},"x-pozy-area":"accounts"}},"/v1/media/presign":{"post":{"operationId":"getMediaPresignedUrl","summary":"Get upload URL","tags":["Media"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"uploadUrl":{"type":"string","format":"uri"},"publicUrl":{"type":"string","format":"uri"},"key":{"type":"string"},"expiresIn":{"type":"integer"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["filename","contentType"],"properties":{"filename":{"type":"string"},"contentType":{"$ref":"#/components/schemas/MediaContentType"},"size":{"type":"integer"}}}}}},"x-pozy-area":"publishing"}},"/v1/reddit/search":{"get":{"operationId":"searchReddit","summary":"Search posts","tags":["Reddit Search"],"parameters":[{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}},{"name":"subreddit","in":"query","required":false,"schema":{"type":"string"}},{"name":"q","in":"query","required":true,"schema":{"type":"string"}},{"name":"restrict_sr","in":"query","required":false,"schema":{"type":"string","enum":["0","1"]}},{"name":"sort","in":"query","required":false,"schema":{"type":"string","enum":["relevance","hot","top","new","comments"],"default":"new"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","default":25,"maximum":100}},{"name":"after","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/RedditPost"}},"after":{"type":["string","null"]},"before":{"type":["string","null"]}}}}}}},"x-pozy-area":"inbox"}},"/v1/reddit/feed":{"get":{"operationId":"getRedditFeed","summary":"Get subreddit feed","tags":["Reddit Search"],"parameters":[{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}},{"name":"subreddit","in":"query","required":false,"schema":{"type":"string"}},{"name":"sort","in":"query","required":false,"schema":{"type":"string","enum":["hot","new","top","rising"],"default":"hot"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","default":25,"maximum":100}},{"name":"after","in":"query","required":false,"schema":{"type":"string"}},{"name":"t","in":"query","required":false,"schema":{"type":"string","enum":["hour","day","week","month","year","all"]}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/RedditPost"}},"after":{"type":["string","null"]},"before":{"type":["string","null"]}}}}}}},"x-pozy-area":"inbox"}},"/v1/reddit/comments/{postId}":{"get":{"operationId":"getRedditPostComments","summary":"Get the comments of a Reddit post","tags":["Reddit Search"],"parameters":[{"name":"postId","in":"path","required":true,"schema":{"type":"string"}},{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}},{"name":"sort","in":"query","required":false,"schema":{"type":"string","enum":["new","top","best","controversial","old","qa"],"default":"new"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","default":25,"maximum":100}},{"name":"commentId","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"post":{"oneOf":[{"$ref":"#/components/schemas/RedditPost"},{"type":"null"}]},"items":{"type":"array","items":{"$ref":"#/components/schemas/RedditComment"}},"more":{"type":"array","items":{"type":"string"}}}}}}}},"x-pozy-area":"inbox"}},"/v1/billing":{"get":{"operationId":"getBilling","summary":"Account billing snapshot (plan, cycle, balance, caps, status)","tags":["Usage"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BillingSnapshot"}}}}},"x-pozy-area":"workspace"}},"/v1/billing/x-pricing":{"get":{"operationId":"getXApiPricing","summary":"Get X API pricing table","tags":["Usage"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/XApiPricing"}}}}},"x-pozy-area":"workspace"}},"/v1/usage":{"get":{"operationId":"getUsage","summary":"Usage snapshot (default) or billed-spend metering (with params)","tags":["Usage"],"parameters":[{"name":"reconcile","in":"query","required":false,"schema":{"type":"boolean"}},{"name":"range","in":"query","required":false,"schema":{"type":"string","enum":["cycle","prev-cycle","7d","14d","30d","3mo","12mo","custom"],"default":"cycle"}},{"name":"from","in":"query","required":false,"schema":{"type":"string","format":"date"}},{"name":"to","in":"query","required":false,"schema":{"type":"string","format":"date"}},{"name":"granularity","in":"query","required":false,"schema":{"type":"string","enum":["day","month","total"],"default":"day"}},{"name":"groupBy","in":"query","required":false,"schema":{"type":"string","enum":["profile","account"]}},{"name":"profileId","in":"query","required":false,"schema":{"type":"string"}},{"name":"accountId","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/UsageStats"},{"$ref":"#/components/schemas/UsageMetering"}]}}}}},"x-pozy-area":"workspace"}},"/v1/usage-stats":{"get":{"operationId":"getUsageStats","summary":"Get plan and usage snapshot (plan, limits, payment status)","tags":["Usage"],"deprecated":true,"parameters":[{"name":"reconcile","in":"query","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UsageStats"}}}}},"x-pozy-area":"workspace"}},"/v1/usage/calls":{"get":{"operationId":"getCallsUsage","summary":"Calling usage and cost","tags":["Usage"],"parameters":[{"name":"since","in":"query","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"until","in":"query","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"channel","in":"query","required":false,"schema":{"type":"string","enum":["whatsapp","pstn"]}},{"name":"number","in":"query","required":false,"schema":{"type":"string"}},{"name":"groupBy","in":"query","required":false,"schema":{"type":"string","enum":["day","number","channel"]}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"since":{"type":"string","format":"date-time"},"until":{"type":"string","format":"date-time"},"groupBy":{"type":["string","null"],"enum":["day","number","channel",null]},"totals":{"type":"object","properties":{"calls":{"type":"integer"},"answered":{"type":"integer"},"minutes":{"type":"number"},"billableUSD":{"type":"number"},"metaUSD":{"type":"number"},"brandedCalls":{"type":"integer"},"brandedCallUSD":{"type":"number"}}},"groups":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"calls":{"type":"integer"},"answered":{"type":"integer"},"minutes":{"type":"number"},"billableUSD":{"type":"number"},"metaUSD":{"type":"number"},"brandedCalls":{"type":"integer"},"brandedCallUSD":{"type":"number"}}}}}}}}}},"x-pozy-area":"workspace"}},"/v1/usage/sms":{"get":{"operationId":"getSmsUsage","summary":"SMS usage (volumes)","tags":["Usage"],"parameters":[{"name":"since","in":"query","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"until","in":"query","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"number","in":"query","required":false,"schema":{"type":"string"}},{"name":"groupBy","in":"query","required":false,"schema":{"type":"string","enum":["day","number"]}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"since":{"type":"string","format":"date-time"},"until":{"type":"string","format":"date-time"},"groupBy":{"type":["string","null"],"enum":["day","number",null]},"totals":{"type":"object","properties":{"sent":{"type":"integer"},"received":{"type":"integer"},"total":{"type":"integer"}}},"groups":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"sent":{"type":"integer"},"received":{"type":"integer"},"total":{"type":"integer"}}}}}}}}}},"x-pozy-area":"workspace"}},"/v1/posts":{"get":{"operationId":"listPosts","summary":"List posts","tags":["Posts"],"parameters":[{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"default":1}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":500,"default":10}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0}},{"name":"cursor","in":"query","required":false,"schema":{"type":"string"}},{"name":"fields","in":"query","required":false,"schema":{"type":"string"}},{"name":"updatedSince","in":"query","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"source","in":"query","required":false,"schema":{"type":"string","enum":["pozy","external"],"default":"pozy"}},{"name":"status","in":"query","required":false,"schema":{"type":"string","enum":["draft","pending_approval","scheduled","publishing","published","partial","failed","cancelled"]}},{"name":"platform","in":"query","required":false,"schema":{"type":"string"}},{"name":"profileId","in":"query","required":false,"schema":{"type":"string"}},{"name":"createdBy","in":"query","required":false,"schema":{"type":"string"}},{"name":"fromDate","in":"query","required":false,"schema":{"type":"string","format":"date"}},{"name":"toDate","in":"query","required":false,"schema":{"type":"string","format":"date"}},{"name":"dateFrom","in":"query","required":false,"schema":{"type":"string","format":"date"}},{"name":"dateTo","in":"query","required":false,"schema":{"type":"string","format":"date"}},{"name":"includeHidden","in":"query","required":false,"schema":{"type":"boolean","default":false}},{"name":"search","in":"query","required":false,"schema":{"type":"string"}},{"name":"tags","in":"query","required":false,"schema":{"type":"string"}},{"name":"sortBy","in":"query","required":false,"schema":{"type":"string","enum":["scheduled-desc","scheduled-asc","created-desc","created-asc","status","platform"],"default":"scheduled-desc"}},{"name":"accountId","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PostsListResponse"}}}}},"x-pozy-area":"publishing"},"post":{"operationId":"createPost","summary":"Create post","tags":["Posts"],"parameters":[{"name":"Idempotency-Key","in":"header","required":false,"schema":{"type":"string","maxLength":255}},{"name":"x-request-id","in":"header","required":false,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/TikTokDryRunVerdict"},{"$ref":"#/components/schemas/PostCreateResponse"}]}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"title":{"type":"string"},"content":{"type":"string"},"mediaItems":{"type":"array","items":{"$ref":"#/components/schemas/MediaItem"}},"platforms":{"type":"array","items":{"type":"object","required":["platform","accountId"],"properties":{"platform":{"type":"string"},"accountId":{"type":"string"},"customContent":{"type":"string"},"customMedia":{"type":"array","items":{"$ref":"#/components/schemas/MediaItem"}},"scheduledFor":{"type":"string","format":"date-time"},"platformSpecificData":{"oneOf":[{"$ref":"#/components/schemas/TwitterPlatformData"},{"$ref":"#/components/schemas/ThreadsPlatformData"},{"$ref":"#/components/schemas/FacebookPlatformData"},{"$ref":"#/components/schemas/InstagramPlatformData"},{"$ref":"#/components/schemas/LinkedInPlatformData"},{"$ref":"#/components/schemas/PinterestPlatformData"},{"$ref":"#/components/schemas/YouTubePlatformData"},{"$ref":"#/components/schemas/GoogleBusinessPlatformData"},{"$ref":"#/components/schemas/TikTokPlatformData"},{"$ref":"#/components/schemas/TelegramPlatformData"},{"$ref":"#/components/schemas/SnapchatPlatformData"},{"$ref":"#/components/schemas/RedditPlatformData"},{"$ref":"#/components/schemas/BlueskyPlatformData"},{"$ref":"#/components/schemas/DiscordPlatformData"},{"$ref":"#/components/schemas/SlackPlatformData"}]}}}},"scheduledFor":{"type":"string","format":"date-time"},"publishNow":{"type":"boolean","default":false},"isDraft":{"type":"boolean","default":false},"requiresApproval":{"type":"boolean","default":false},"dryRun":{"type":"boolean","default":false},"timezone":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}},"hashtags":{"type":"array","items":{"type":"string"}},"mentions":{"type":"array","items":{"type":"string"}},"crosspostingEnabled":{"type":"boolean","default":true},"metadata":{"type":"object","additionalProperties":true},"tiktokSettings":{"$ref":"#/components/schemas/TikTokPlatformData"},"facebookSettings":{"$ref":"#/components/schemas/FacebookSettings"},"recycling":{"$ref":"#/components/schemas/RecyclingConfig"},"queuedFromProfile":{"type":"string"},"queueId":{"type":"string"}}}}}},"x-pozy-area":"publishing"}},"/v1/posts/sync-external":{"post":{"operationId":"syncExternalPosts","summary":"Sync an external post","tags":["Analytics"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"synced":{"type":"object","properties":{"postsFound":{"type":"integer"},"postsSynced":{"type":"integer"},"skipped":{"type":"boolean"}}},"found":{"type":"boolean"},"post":{"oneOf":[{"$ref":"#/components/schemas/ExternalPostSummary"},{"type":"null"}]},"posts":{"type":"array","items":{"$ref":"#/components/schemas/ExternalPostSummary"}}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId"],"properties":{"accountId":{"type":"string"},"url":{"type":"string"},"postId":{"type":"string"}}}}}},"x-pozy-area":"analytics"}},"/v1/posts/{postId}":{"get":{"operationId":"getPost","summary":"Get post","tags":["Posts"],"parameters":[{"name":"postId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PostGetResponse"}}}}},"x-pozy-area":"publishing"},"put":{"operationId":"updatePost","summary":"Update post","tags":["Posts"],"parameters":[{"name":"postId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PostUpdateResponse"}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"title":{"type":"string"},"content":{"type":"string"},"mediaItems":{"type":"array","items":{"$ref":"#/components/schemas/MediaItem"}},"platforms":{"type":"array","items":{"type":"object","required":["platform","accountId"],"properties":{"platform":{"type":"string"},"accountId":{"type":"string"},"customContent":{"type":"string"},"customMedia":{"type":"array","items":{"$ref":"#/components/schemas/MediaItem"}},"scheduledFor":{"type":"string","format":"date-time"},"platformSpecificData":{"type":"object","additionalProperties":true}}}},"scheduledFor":{"type":"string","format":"date-time"},"publishNow":{"type":"boolean","default":false},"isDraft":{"type":"boolean"},"requiresApproval":{"type":"boolean"},"timezone":{"type":"string"},"visibility":{"type":"string","enum":["public","private","unlisted"]},"tags":{"type":"array","items":{"type":"string"}},"hashtags":{"type":"array","items":{"type":"string"}},"mentions":{"type":"array","items":{"type":"string"}},"crosspostingEnabled":{"type":"boolean"},"metadata":{"type":"object","additionalProperties":true},"queuedFromProfile":{"type":"string"},"queueId":{"type":"string"},"tiktokSettings":{"$ref":"#/components/schemas/TikTokPlatformData"},"facebookSettings":{"$ref":"#/components/schemas/FacebookSettings"},"recycling":{"$ref":"#/components/schemas/RecyclingConfig"}},"additionalProperties":true}}}},"x-pozy-area":"publishing"},"delete":{"operationId":"deletePost","summary":"Delete post","tags":["Posts"],"parameters":[{"name":"postId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PostDeleteResponse"}}}}},"x-pozy-area":"publishing"}},"/v1/posts/bulk-upload":{"post":{"operationId":"bulkUploadPosts","summary":"Bulk upload from CSV","tags":["Posts"],"parameters":[{"name":"dryRun","in":"query","required":false,"schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkUploadResult"}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"file":{"type":"string","format":"binary"}}}}}},"x-pozy-area":"publishing"}},"/v1/posts/{postId}/retry":{"post":{"operationId":"retryPost","summary":"Retry failed post","tags":["Posts"],"parameters":[{"name":"postId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PostRetryResponse"}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"x-pozy-area":"publishing"}},"/v1/posts/{postId}/review":{"post":{"operationId":"reviewPost","summary":"Approve or reject a post","tags":["Posts"],"parameters":[{"name":"postId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PostGetResponse"}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["decision"],"properties":{"decision":{"type":"string","enum":["approve","reject"]},"reason":{"type":"string","maxLength":1000}}}}}},"x-pozy-area":"publishing"}},"/v1/posts/{postId}/unpublish":{"post":{"operationId":"unpublishPost","summary":"Unpublish post","tags":["Posts"],"parameters":[{"name":"postId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["platform"],"properties":{"platform":{"type":"string","enum":["threads","facebook","twitter","linkedin","youtube","pinterest","reddit","bluesky","googlebusiness","telegram"]},"accountId":{"type":"string"}}}}}},"x-pozy-area":"publishing"}},"/v1/posts/{postId}/pin":{"post":{"operationId":"pinPost","summary":"Pin post","tags":["Posts"],"parameters":[{"name":"postId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PinPostResponse"}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PinPostRequest"}}}},"x-pozy-area":"publishing"}},"/v1/posts/{postId}/unpin":{"post":{"operationId":"unpinPost","summary":"Unpin post","tags":["Posts"],"parameters":[{"name":"postId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PinPostResponse"}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PinPostRequest"}}}},"x-pozy-area":"publishing"}},"/v1/posts/{postId}/edit":{"post":{"operationId":"editPost","summary":"Edit published post","tags":["Posts"],"parameters":[{"name":"postId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"id":{"type":"string"},"url":{"type":"string","format":"uri"},"message":{"type":"string"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["platform","content"],"properties":{"platform":{"type":"string","enum":["twitter","discord","facebook","reddit","linkedin","telegram","pinterest","googlebusiness","youtube","slack"]},"content":{"type":"string"},"accountId":{"type":"string"}}}}}},"x-pozy-area":"publishing"}},"/v1/posts/{postId}/update-metadata":{"post":{"operationId":"updatePostMetadata","summary":"Update post metadata","tags":["Posts"],"parameters":[{"name":"postId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"},"videoId":{"type":"string"},"updatedFields":{"type":"array","items":{"type":"string"}}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["platform"],"properties":{"platform":{"type":"string","enum":["youtube"]},"videoId":{"type":"string"},"accountId":{"type":"string"},"title":{"type":"string","maxLength":100},"description":{"type":"string"},"tags":{"type":"array","items":{"type":"string","maxLength":100}},"categoryId":{"type":"string"},"privacyStatus":{"type":"string","enum":["public","private","unlisted"]},"thumbnailUrl":{"type":"string","format":"uri"},"madeForKids":{"type":"boolean"},"containsSyntheticMedia":{"type":"boolean"},"playlistId":{"type":"string"}}}}}},"x-pozy-area":"publishing"}},"/v1/users":{"get":{"operationId":"listUsers","summary":"List users","tags":["Users"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"currentUserId":{"type":"string"},"users":{"type":"array","items":{"type":"object","properties":{"_id":{"type":"string"},"name":{"type":"string"},"email":{"type":"string"},"role":{"type":"string"},"isRoot":{"type":"boolean"},"profileAccess":{"type":"array","items":{"type":"string"}},"createdAt":{"type":"string","format":"date-time"},"lastLoginAt":{"type":"string","format":"date-time"}}}}}}}}}},"x-pozy-area":"workspace"}},"/v1/users/{userId}":{"get":{"operationId":"getUser","summary":"Get user","tags":["Users"],"parameters":[{"name":"userId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"user":{"type":"object","properties":{"_id":{"type":"string"},"name":{"type":"string"},"email":{"type":"string"},"role":{"type":"string"},"isRoot":{"type":"boolean"},"profileAccess":{"type":"array","items":{"type":"string"}}}}}}}}}},"x-pozy-area":"workspace"}},"/v1/profiles":{"get":{"operationId":"listProfiles","summary":"List profiles","tags":["Profiles"],"parameters":[{"name":"includeOverLimit","in":"query","required":false,"schema":{"type":"boolean","default":false}},{"name":"name","in":"query","required":false,"schema":{"type":"string"}},{"name":"externalId","in":"query","required":false,"schema":{"type":"string"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":1000}},{"name":"skip","in":"query","required":false,"schema":{"type":"integer","minimum":0}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProfilesListResponse"}}}}},"x-pozy-area":"accounts"},"post":{"operationId":"createProfile","summary":"Create profile","tags":["Profiles"],"parameters":[{"name":"Idempotency-Key","in":"header","required":false,"schema":{"type":"string","maxLength":255}}],"responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProfileCreateResponse"}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["name"],"properties":{"name":{"type":"string"},"description":{"type":"string"},"color":{"type":"string"},"timezone":{"type":"string"},"externalId":{"type":"string","minLength":1,"maxLength":255}}}}}},"x-pozy-area":"accounts"}},"/v1/profiles/{profileId}":{"get":{"operationId":"getProfile","summary":"Get profile","tags":["Profiles"],"parameters":[{"name":"profileId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProfileGetResponse"}}}}},"x-pozy-area":"accounts"},"put":{"operationId":"updateProfile","summary":"Update profile","tags":["Profiles"],"parameters":[{"name":"profileId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProfileUpdateResponse"}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","minProperties":1,"properties":{"name":{"type":"string","minLength":1},"description":{"type":["string","null"]},"color":{"type":"string"},"timezone":{"type":["string","null"]},"externalId":{"type":["string","null"],"minLength":1,"maxLength":255},"isDefault":{"type":"boolean"}}}}}},"x-pozy-area":"accounts"},"delete":{"operationId":"deleteProfile","summary":"Delete profile","tags":["Profiles"],"parameters":[{"name":"profileId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProfileDeleteResponse"}}}}},"x-pozy-area":"accounts"}},"/v1/accounts":{"get":{"operationId":"listAccounts","summary":"List accounts","tags":["Accounts"],"parameters":[{"name":"profileId","in":"query","required":false,"schema":{"type":"string"}},{"name":"platform","in":"query","required":false,"schema":{"type":"string"}},{"name":"status","in":"query","required":false,"schema":{"type":"string","enum":["connected","disconnected"]}},{"name":"search","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":100}},{"name":"category","in":"query","required":false,"schema":{"type":"string","enum":["social","ads","communication","blogs","crm","analytics"]}},{"name":"sort","in":"query","required":false,"schema":{"type":"string","enum":["account","platform","profile","status","connected"]}},{"name":"order","in":"query","required":false,"schema":{"type":"string","enum":["asc","desc"],"default":"asc"}},{"name":"includeOverLimit","in":"query","required":false,"schema":{"type":"boolean","default":false}},{"name":"excludeHidden","in":"query","required":false,"schema":{"type":"boolean","default":false}},{"name":"adAccountRows","in":"query","required":false,"schema":{"type":"boolean","default":false}},{"name":"includeCreatorAccounts","in":"query","required":false,"schema":{"type":"boolean","default":false}},{"name":"includeSandbox","in":"query","required":false,"schema":{"type":"boolean","default":false}},{"name":"includeStatusCounts","in":"query","required":false,"schema":{"type":"boolean","default":false}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":500}},{"name":"cursor","in":"query","required":false,"schema":{"type":"string"}},{"name":"profileIds","in":"query","required":false,"schema":{"type":"string"}},{"name":"perProfile","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":24}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountsListResponse"}}}}},"x-pozy-area":"accounts"}},"/v1/accounts/follower-stats":{"get":{"operationId":"getFollowerStats","summary":"Get follower stats","tags":["Accounts"],"parameters":[{"name":"accountIds","in":"query","required":false,"schema":{"type":"string"}},{"name":"profileId","in":"query","required":false,"schema":{"type":"string"}},{"name":"fromDate","in":"query","required":false,"schema":{"type":"string","format":"date"}},{"name":"toDate","in":"query","required":false,"schema":{"type":"string","format":"date"}},{"name":"granularity","in":"query","required":false,"schema":{"type":"string","enum":["daily","weekly","monthly"],"default":"daily"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":25}},{"name":"cursor","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FollowerStatsResponse"}}}}},"x-pozy-area":"accounts"}},"/v1/accounts/{accountId}":{"put":{"operationId":"updateAccount","summary":"Update account","tags":["Accounts"],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"username":{"type":"string"},"displayName":{"type":"string"},"xCapabilities":{"type":"object","properties":{"analytics":{"type":"boolean"},"inbox":{"type":"boolean"}}}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"username":{"type":"string"},"displayName":{"type":"string"},"xCapabilities":{"type":"object","properties":{"analytics":{"type":"boolean"},"inbox":{"type":"boolean"}}}}}}}},"x-pozy-area":"accounts"},"patch":{"operationId":"moveAccountToProfile","summary":"Move account to another profile","tags":["Accounts"],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"profileId":{"type":"string"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["profileId"],"properties":{"profileId":{"type":"string"}}}}}},"x-pozy-area":"accounts"},"delete":{"operationId":"deleteAccount","summary":"Disconnect account","tags":["Accounts"],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}}}}}}},"x-pozy-area":"accounts"}},"/v1/accounts/health":{"get":{"operationId":"getAllAccountsHealth","summary":"Check accounts health","tags":["Accounts"],"parameters":[{"name":"profileId","in":"query","required":false,"schema":{"type":"string"}},{"name":"platform","in":"query","required":false,"schema":{"type":"string","enum":["facebook","instagram","linkedin","twitter","tiktok","youtube","threads","pinterest","reddit","bluesky","googlebusiness","telegram","snapchat","discord","slack","whatsapp","shopify","wordpress","wix","linkedinads","metaads","pinterestads","tiktokads","xads","googleads","openaiads","redditads","whopads","hubspot","webflow","googleanalytics"]}},{"name":"status","in":"query","required":false,"schema":{"type":"string","enum":["healthy","warning","error"]}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"summary":{"type":"object","properties":{"total":{"type":"integer"},"healthy":{"type":"integer"},"warning":{"type":"integer"},"error":{"type":"integer"},"needsReconnect":{"type":"integer"}}},"accounts":{"type":"array","items":{"type":"object","properties":{"accountId":{"type":"string"},"platform":{"type":"string"},"username":{"type":"string"},"displayName":{"type":"string"},"profileId":{"type":"string"},"status":{"type":"string","enum":["healthy","warning","error"]},"canPost":{"type":"boolean"},"canFetchAnalytics":{"type":"boolean"},"tokenValid":{"type":"boolean"},"tokenExpiresAt":{"type":"string","format":"date-time"},"needsReconnect":{"type":"boolean"},"issues":{"type":"array","items":{"type":"string"}},"ownerUserId":{"type":"string"},"disconnectReason":{"type":["string","null"]},"disconnectionType":{"type":["string","null"],"enum":["intentional","unintentional",null]},"unhealthySince":{"type":["string","null"],"format":"date-time"},"analyticsSync":{"type":"object","properties":{"status":{"type":"string","enum":["ok","failing","stalled","never_synced"]},"lastSyncedAt":{"type":["string","null"],"format":"date-time"}}},"messagingRestriction":{"type":["object","null"],"properties":{"code":{"type":["integer","null"]},"subcode":{"type":["integer","null"]},"message":{"type":["string","null"]},"firstSeenAt":{"type":"string","format":"date-time"},"lastSeenAt":{"type":"string","format":"date-time"},"pausedUntil":{"type":["string","null"],"format":"date-time"}}}}}}}}}}}},"x-pozy-area":"accounts"}},"/v1/accounts/{accountId}/whatsapp/register":{"post":{"operationId":"registerWhatsAppNumber","summary":"Register a connected WhatsApp number on the Cloud API","tags":["WhatsApp"],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"registered":{"type":"boolean"},"accountId":{"type":"string"},"phoneNumberId":{"type":"string"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{"pin":{"type":"string","pattern":"^\\d{6}$"}}}}}},"x-pozy-area":"whatsapp"}},"/v1/accounts/{accountId}/whatsapp/request-code":{"post":{"operationId":"requestWhatsAppVerificationCode","summary":"Request a Meta re-verification code for a BYO WhatsApp number","tags":["WhatsApp"],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"requested":{"type":"boolean"},"alreadyActive":{"type":"boolean"},"method":{"type":"string"},"accountId":{"type":"string"},"phoneNumberId":{"type":"string"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{"method":{"type":"string","enum":["SMS","VOICE"],"default":"SMS"},"language":{"type":"string","default":"en_US"}}}}}},"x-pozy-area":"whatsapp"}},"/v1/accounts/{accountId}/whatsapp/verify-code":{"post":{"operationId":"verifyWhatsAppNumber","summary":"Verify the Meta re-verification code for a BYO WhatsApp number","tags":["WhatsApp"],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"verified":{"type":"boolean"},"accountId":{"type":"string"},"phoneNumberId":{"type":"string"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["code"],"properties":{"code":{"type":"string"}}}}}},"x-pozy-area":"whatsapp"}},"/v1/accounts/{accountId}/health":{"get":{"operationId":"getAccountHealth","summary":"Check account health","tags":["Accounts"],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"accountId":{"type":"string"},"platform":{"type":"string"},"integrationLane":{"type":"string","enum":["business","developer"]},"sendCap":{"type":"object","properties":{"limit":{"type":"integer"},"used":{"type":"integer"},"resetsAt":{"type":"string","format":"date-time"}}},"push":{"type":"string","enum":["active","pending","failed","not_applicable"]},"username":{"type":"string"},"displayName":{"type":"string"},"status":{"type":"string","enum":["healthy","warning","error"]},"tokenStatus":{"type":"object","properties":{"valid":{"type":"boolean"},"expiresAt":{"type":"string","format":"date-time"},"expiresIn":{"type":"string"},"needsRefresh":{"type":"boolean"}}},"permissions":{"type":"object","properties":{"posting":{"type":"array","items":{"type":"object","properties":{"scope":{"type":"string"},"granted":{"type":"boolean"},"required":{"type":"boolean"}}}},"analytics":{"type":"array","items":{"type":"object","properties":{"scope":{"type":"string"},"granted":{"type":"boolean"},"required":{"type":"boolean"}}}},"optional":{"type":"array","items":{"type":"object","properties":{"scope":{"type":"string"},"granted":{"type":"boolean"},"required":{"type":"boolean"}}}},"canPost":{"type":"boolean"},"canFetchAnalytics":{"type":"boolean"},"missingRequired":{"type":"array","items":{"type":"string"}}}},"issues":{"type":"array","items":{"type":"string"}},"recommendations":{"type":"array","items":{"type":"string"}},"ownerUserId":{"type":"string"},"disconnectReason":{"type":["string","null"]},"disconnectionType":{"type":["string","null"],"enum":["intentional","unintentional",null]},"unhealthySince":{"type":["string","null"],"format":"date-time"},"analyticsSync":{"type":"object","properties":{"status":{"type":"string","enum":["ok","failing","stalled","never_synced"]},"lastSyncedAt":{"type":["string","null"],"format":"date-time"}}},"messagingRestriction":{"type":["object","null"],"properties":{"code":{"type":["integer","null"]},"subcode":{"type":["integer","null"]},"message":{"type":["string","null"]},"firstSeenAt":{"type":"string","format":"date-time"},"lastSeenAt":{"type":"string","format":"date-time"},"pausedUntil":{"type":["string","null"],"format":"date-time"}}},"platformConnection":{"type":"object","properties":{"status":{"type":"string","enum":["connected","disconnected","unknown"]},"checkedAt":{"type":"string","format":"date-time"},"phoneStatus":{"type":["string","null"]},"metaError":{"type":["object","null"],"properties":{"code":{"type":"integer"},"subcode":{"type":"integer"},"message":{"type":"string"}}},"inboundWebhookSubscribed":{"type":["boolean","null"]}}}}}}}}},"x-pozy-area":"accounts"}},"/v1/accounts/{accountId}/posts":{"get":{"operationId":"getAccountPosts","summary":"List posts published on the platform","tags":["Accounts"],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["success"]},"posts":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"platform":{"type":"string"},"message":{"type":"string"},"createdTime":{"type":"string","format":"date-time"},"permalink":{"type":"string"},"picture":{"type":"string"},"mediaType":{"type":"string"},"commentCount":{"type":"integer"},"likeCount":{"type":"integer"},"reactionCount":{"type":"integer"},"shareCount":{"type":"integer"},"cid":{"type":"string"},"subreddit":{"type":"string"},"title":{"type":"string"},"description":{"type":"string"},"link":{"type":"string"},"boardId":{"type":"string"},"boardOwnerUsername":{"type":"string"}}}},"lastUpdated":{"type":"string","format":"date-time"}}}}}}},"x-pozy-area":"accounts"}},"/v1/accounts/{accountId}/follow-status/{userId}":{"get":{"operationId":"getInstagramFollowStatus","summary":"Check whether an Instagram user follows the account","tags":["Accounts"],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}},{"name":"userId","in":"path","required":true,"schema":{"type":"string"}},{"name":"refresh","in":"query","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","required":["userId","accountId","isFollower"],"properties":{"userId":{"type":"string"},"accountId":{"type":"string"},"isFollower":{"type":["boolean","null"]},"isFollowedByAccount":{"type":["boolean","null"]},"followerCount":{"type":["integer","null"]},"isVerified":{"type":["boolean","null"]},"username":{"type":["string","null"]},"name":{"type":["string","null"]},"unavailableReason":{"type":["string","null"],"enum":["consent_required","dm_access_disabled","not_messageable","error",null]}}}}}}},"x-pozy-area":"accounts"}},"/v1/accounts/{accountId}/tiktok/commercial-music":{"get":{"operationId":"listTikTokCommercialMusic","summary":"List trending commercial music","tags":["Accounts"],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}},{"name":"countryCode","in":"query","required":false,"schema":{"type":"string","minLength":2,"maxLength":2}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"tracks":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"commercialMusicId":{"type":"string"},"name":{"type":"string"},"artist":{"type":"string"},"durationSec":{"type":"integer"},"genres":{"type":"array","items":{"type":"string"}},"previewUrl":{"type":"string"},"thumbnailUrl":{"type":"string"},"rank":{"type":"integer"},"clip":{"type":"object","properties":{"id":{"type":"string"},"durationSec":{"type":"integer"},"previewUrl":{"type":"string"}}}}}}}}}}}},"x-pozy-area":"accounts"}},"/v1/accounts/{accountId}/tiktok/locations":{"get":{"operationId":"searchTikTokLocations","summary":"Search TikTok location tags","tags":["Accounts"],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}},{"name":"query","in":"query","required":true,"schema":{"type":"string","minLength":1,"maxLength":100}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"locations":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"address":{"type":"string"}}}}}}}}}},"x-pozy-area":"accounts"}},"/v1/accounts/{accountId}/tiktok/creator-info":{"get":{"operationId":"getTikTokCreatorInfo","summary":"Get TikTok creator info","tags":["Accounts"],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}},{"name":"mediaType","in":"query","required":false,"schema":{"type":"string","enum":["video","photo"],"default":"video"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"creator":{"type":"object","properties":{"nickname":{"type":"string"},"avatarUrl":{"type":"string"},"isVerified":{"type":"boolean"},"canPostMore":{"type":"boolean"}}},"privacyLevels":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"label":{"type":"string"}}}},"postingLimits":{"type":"object","properties":{"maxVideoDurationSec":{"type":"integer"},"interactionSettings":{"type":"object","properties":{"allow_comment":{"type":"object","properties":{"enabled":{"type":"boolean"},"required":{"type":"boolean"},"default":{"type":"boolean"},"label":{"type":"string"}}},"allow_duet":{"type":["object","null"],"properties":{"enabled":{"type":"boolean"},"required":{"type":"boolean"},"default":{"type":"boolean"},"label":{"type":"string"}}},"allow_stitch":{"type":["object","null"],"properties":{"enabled":{"type":"boolean"},"required":{"type":"boolean"},"default":{"type":"boolean"},"label":{"type":"string"}}}}}}},"commercialContentTypes":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"label":{"type":"string"},"requires":{"type":"array","items":{"type":"string"}}}}}}}}}}},"x-pozy-area":"accounts"}},"/v1/auth/verify":{"get":{"operationId":"verifyCredential","summary":"Verify credential","tags":["API Keys"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"valid":{"type":"boolean"},"userId":{"type":"string"},"name":{"type":["string","null"]},"email":{"type":["string","null"]},"authType":{"type":"string","enum":["api_key","oauth","session"]},"scope":{"type":["string","null"]}}}}}}},"x-pozy-area":"workspace"}},"/v1/feedback":{"post":{"operationId":"submitFeedback","summary":"Submit feedback","tags":["Feedback"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FeedbackReceipt"}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["type","summary"],"properties":{"type":{"type":"string","enum":["bug","missing_feature","docs","other"]},"summary":{"type":"string","minLength":1,"maxLength":200},"details":{"type":"string","maxLength":5000},"endpoint":{"type":"string","maxLength":300},"requestId":{"type":"string","maxLength":200},"expected":{"type":"string","maxLength":2000},"actual":{"type":"string","maxLength":2000},"agent":{"type":"object","properties":{"name":{"type":"string","maxLength":100},"model":{"type":"string","maxLength":100}}}}}}}},"x-pozy-area":"workspace"}},"/v1/api-keys":{"get":{"operationId":"listApiKeys","summary":"List keys","tags":["API Keys"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"apiKeys":{"type":"array","items":{"$ref":"#/components/schemas/ApiKey"}}}}}}}},"x-pozy-area":"workspace"},"post":{"operationId":"createApiKey","summary":"Create key","tags":["API Keys"],"responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"apiKey":{"$ref":"#/components/schemas/ApiKey"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["name"],"properties":{"name":{"type":"string"},"expiresIn":{"type":"integer"},"scope":{"type":"string","enum":["full","profiles"],"default":"full"},"profileIds":{"type":"array","items":{"type":"string"}},"permission":{"type":"string","enum":["read-write","read"],"default":"read-write"},"disabledResourceGroups":{"type":"array","items":{"type":"string","enum":["publishing","engagement","messages","contacts","analytics","ads","telephony","accounts","billing","webhooks","commerce","creator_campaigns","money","calendar","files"]}}}}}}},"x-pozy-area":"workspace"}},"/v1/api-keys/{keyId}":{"delete":{"operationId":"deleteApiKey","summary":"Delete key","tags":["API Keys"],"parameters":[{"name":"keyId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}}}}}}},"x-pozy-area":"workspace"}},"/v1/me/connected-apps":{"get":{"operationId":"listConnectedApps","summary":"List connected apps","tags":["Connected Apps"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"connectedApps":{"type":"array","items":{"$ref":"#/components/schemas/ConnectedApp"}}}}}}}},"x-pozy-area":"workspace"}},"/v1/me/connected-apps/{clientId}":{"delete":{"operationId":"revokeConnectedApp","summary":"Revoke connected app","tags":["Connected Apps"],"parameters":[{"name":"clientId","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":200}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"revoked":{"type":"boolean"},"clientId":{"type":"string"},"revokedTokens":{"type":"integer"},"invalidatedCodes":{"type":"integer"}}}}}}},"x-pozy-area":"workspace"}},"/v1/invite/tokens":{"post":{"operationId":"createInviteToken","summary":"Create invite token","tags":["Invites"],"responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"token":{"type":"string"},"scope":{"type":"string"},"invitedProfileIds":{"type":"array","items":{"type":"string"}},"disabledResourceGroups":{"type":"array","items":{"type":"string"}},"expiresAt":{"type":"string","format":"date-time"},"inviteUrl":{"type":"string","format":"uri"},"role":{"type":"string","enum":["admin","member","billing_admin","viewer"]},"email":{"type":["string","null"],"format":"email"},"emailSent":{"type":"boolean","description":"True when Pozy emailed the invitation. False when no email address was given or the email could not be sent: share inviteUrl yourself."}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"description":"email_not_verified: Confirm your email address, or add a payment method, first. Invite links you share yourself keep working. workspace_suspended: The workspace was paused by Pozy (contact support@pozy.ai to resume). On the creator portal: the brand's workspace is paused, so the creator should contact the brand.","x-pozy-error-codes":["email_not_verified","workspace_suspended"],"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"invite_limit_reached: The workspace reached its invitation email limit: 20 a day and 50 pending team invitations without a payment method, 500 a day with one. Share the invite link instead.","x-pozy-error-codes":["invite_limit_reached"],"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["scope"],"properties":{"scope":{"type":"string","enum":["all","profiles"]},"profileIds":{"type":"array","items":{"type":"string"}},"role":{"type":"string","enum":["admin","member","billing_admin","viewer"],"default":"member"},"disabledResourceGroups":{"type":"array","items":{"type":"string","enum":["publishing","engagement","messages","contacts","analytics","ads","telephony","accounts","billing","webhooks","commerce"]}},"readOnly":{"type":"boolean","deprecated":true},"email":{"type":"string","format":"email","description":"Optional. Pozy emails the invitation to this address."}}}}}},"x-pozy-area":"workspace"}},"/v1/connect/{platform}":{"get":{"operationId":"getConnectUrl","summary":"Get OAuth connect URL","tags":["Connect"],"parameters":[{"name":"platform","in":"path","required":true,"schema":{"type":"string","enum":["facebook","instagram","linkedin","twitter","tiktok","youtube","threads","reddit","pinterest","bluesky","googlebusiness","telegram","snapchat","discord","slack","whatsapp","google","microsoft"]}},{"name":"profileId","in":"query","required":true,"schema":{"type":"string"}},{"name":"reconnectAccountId","in":"query","required":false,"schema":{"type":"string"}},{"name":"oauthAppId","in":"query","required":false,"schema":{"type":"string"}},{"name":"expectedPlatformUserId","in":"query","required":false,"schema":{"type":"string","maxLength":100}},{"name":"expectedUsername","in":"query","required":false,"schema":{"type":"string","maxLength":100}},{"name":"forceReauth","in":"query","required":false,"schema":{"type":"boolean","default":false}},{"name":"redirect_url","in":"query","required":false,"schema":{"type":"string","format":"uri"}},{"name":"scopes","in":"query","required":false,"schema":{"type":"string"}},{"name":"loginHint","in":"query","required":false,"schema":{"type":"string","format":"email"}},{"name":"headless","in":"query","required":false,"schema":{"type":"boolean","default":false}},{"name":"loginMethod","in":"query","required":false,"schema":{"type":"string","enum":["instagram_login","facebook_login"],"default":"instagram_login"}},{"name":"onboarding","in":"query","required":false,"schema":{"type":"string","enum":["api","business_app"]}},{"name":"signup","in":"query","required":false,"schema":{"type":"string","enum":["hosted"]}},{"name":"brandName","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":60}},{"name":"primaryColor","in":"query","required":false,"schema":{"type":"string","pattern":"^#[0-9a-fA-F]{6}$"}},{"name":"welcome","in":"query","required":false,"schema":{"type":"boolean"}},{"name":"welcomeTheme","in":"query","required":false,"schema":{"type":"string","maxLength":4000}},{"name":"logoUrl","in":"query","required":false,"schema":{"type":"string","format":"uri","maxLength":2048}},{"name":"language","in":"query","required":false,"schema":{"type":"string","enum":["en","es","pt-BR"]}},{"name":"handoff","in":"query","required":false,"schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"authUrl":{"type":"string","format":"uri"},"state":{"type":"string"},"handoff":{"$ref":"#/components/schemas/ConnectHandoffLink"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"x-pozy-area":"accounts"},"post":{"operationId":"handleOAuthCallback","summary":"Complete OAuth callback","tags":["Connect"],"parameters":[{"name":"platform","in":"path","required":true,"schema":{"type":"string","enum":["instagram","twitter","threads","linkedin","youtube","tiktok","reddit","pinterest","google","microsoft"]}}],"responses":{"200":{"description":"Success"},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["code","state","profileId"],"properties":{"code":{"type":"string"},"state":{"type":"string"},"profileId":{"type":"string"}}}}}},"x-pozy-area":"accounts"}},"/v1/connect/{platform}/ads":{"get":{"operationId":"connectAds","summary":"Connect ads for a platform","tags":["Connect"],"parameters":[{"name":"loginMode","in":"query","required":false,"schema":{"type":"string","enum":["classic","business"],"default":"classic"}},{"name":"permissionLevel","in":"query","required":false,"schema":{"type":"string","enum":["full","advertise"],"default":"full"}},{"name":"pageId","in":"query","required":false,"schema":{"type":"string","pattern":"^\\d+$"}},{"name":"platform","in":"path","required":true,"schema":{"type":"string","enum":["facebook","instagram","linkedin","tiktok","twitter","pinterest","googleads","redditads"]}},{"name":"profileId","in":"query","required":true,"schema":{"type":"string"}},{"name":"accountId","in":"query","required":false,"schema":{"type":"string"}},{"name":"redirect_url","in":"query","required":false,"schema":{"type":"string","format":"uri"}},{"name":"headless","in":"query","required":false,"schema":{"type":"boolean","default":false}},{"name":"force","in":"query","required":false,"schema":{"type":"boolean","default":false}},{"name":"adAccountId","in":"query","required":false,"schema":{"type":"string"}},{"name":"adAccountIds","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"welcome","in":"query","required":false,"schema":{"type":"boolean"}},{"name":"brandName","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":60}},{"name":"logoUrl","in":"query","required":false,"schema":{"type":"string","format":"uri","maxLength":2048}},{"name":"primaryColor","in":"query","required":false,"schema":{"type":"string","pattern":"^#[0-9a-fA-F]{6}$"}},{"name":"welcomeTheme","in":"query","required":false,"schema":{"type":"string","maxLength":4000}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"alreadyConnected":{"type":"boolean"},"accountId":{"type":"string"},"platform":{"type":"string"},"username":{"type":"string"},"displayName":{"type":"string"},"tokenType":{"type":"string","enum":["system-user"]},"scopedAdAccountIds":{"type":"array","items":{"type":"string"}}}},{"type":"object","properties":{"authUrl":{"type":"string","format":"uri"},"state":{"type":"string"}}}]}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"x-pozy-area":"accounts"}},"/v1/connect/shopify":{"get":{"operationId":"getShopifyConnectUrl","summary":"Get Shopify OAuth connect URL","tags":["Connect"],"parameters":[{"name":"profileId","in":"query","required":true,"schema":{"type":"string"}},{"name":"shop","in":"query","required":true,"schema":{"type":"string"}},{"name":"redirect_url","in":"query","required":false,"schema":{"type":"string","format":"uri"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"authUrl":{"type":"string","format":"uri"},"state":{"type":"string"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"x-pozy-area":"accounts"}},"/v1/connect/shopify/token":{"post":{"operationId":"connectShopifyWithToken","summary":"Connect a Shopify store with a custom-app Admin token","tags":["Connect"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"account":{"type":"object","properties":{"_id":{"type":"string"},"platform":{"type":"string","enum":["shopify"]},"username":{"type":"string"},"displayName":{"type":"string"},"profileId":{"type":"string"}}}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["profileId","shop","accessToken"],"properties":{"profileId":{"type":"string"},"shop":{"type":"string"},"accessToken":{"type":"string"}}}}}},"x-pozy-area":"accounts"}},"/v1/connect/googleanalytics":{"get":{"operationId":"getGoogleAnalyticsConnectUrl","summary":"Get Google Analytics OAuth connect URL","tags":["Connect"],"parameters":[{"name":"profileId","in":"query","required":true,"schema":{"type":"string"}},{"name":"redirect_url","in":"query","required":false,"schema":{"type":"string"}},{"name":"reconnectAccountId","in":"query","required":false,"schema":{"type":"string"}}],"security":[{"bearerAuth":[]},{"connectToken":[]}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","required":["authUrl","state"],"properties":{"authUrl":{"type":"string","format":"uri"},"state":{"type":"string"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"x-pozy-area":"accounts"}},"/v1/connect/googleanalytics/properties":{"get":{"operationId":"listGoogleAnalyticsProperties","summary":"List Google Analytics properties for a pending connect","tags":["Connect"],"parameters":[{"name":"pendingDataToken","in":"query","required":true,"schema":{"type":"string"}}],"security":[{"bearerAuth":[]},{"connectToken":[]}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"properties":{"type":"array","items":{"type":"object","properties":{"propertyId":{"type":"string"},"displayName":{"type":"string"},"accountId":{"type":"string"},"accountName":{"type":"string"}}}}}}}}}},"x-pozy-area":"accounts"}},"/v1/connect/googleanalytics/select-property":{"post":{"operationId":"selectGoogleAnalyticsProperty","summary":"Connect the chosen Google Analytics property","tags":["Connect"],"security":[{"bearerAuth":[]},{"connectToken":[]}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"redirect_url":{"type":"string"},"account":{"type":["object","null"],"properties":{"accountId":{"type":"string"},"platform":{"type":"string"},"username":{"type":"string"},"displayName":{"type":"string"}}}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["pendingDataToken","propertyId"],"properties":{"pendingDataToken":{"type":"string"},"propertyId":{"type":"string"}}}}}},"x-pozy-area":"accounts"}},"/v1/connect/hubspot":{"get":{"operationId":"getHubSpotConnectUrl","summary":"Get HubSpot OAuth connect URL","tags":["Connect"],"parameters":[{"name":"profileId","in":"query","required":true,"schema":{"type":"string"}},{"name":"redirect_url","in":"query","required":false,"schema":{"type":"string"}}],"security":[{"bearerAuth":[]},{"connectToken":[]}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","required":["authUrl","state"],"properties":{"authUrl":{"type":"string","format":"uri"},"state":{"type":"string"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"x-pozy-area":"accounts"}},"/v1/connect/wordpress":{"get":{"operationId":"getWordPressAuthUrl","summary":"Get WordPress.com OAuth connect URL","tags":["Connect"],"parameters":[{"name":"profileId","in":"query","required":true,"schema":{"type":"string"}},{"name":"redirect_url","in":"query","required":false,"schema":{"type":"string"}}],"security":[{"bearerAuth":[]},{"connectToken":[]}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","required":["authUrl","state"],"properties":{"authUrl":{"type":"string","format":"uri"},"state":{"type":"string"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"x-pozy-area":"accounts"}},"/v1/connect/wix":{"get":{"operationId":"getWixConnectUrl","summary":"Get Wix site install URL","tags":["Connect"],"parameters":[{"name":"profileId","in":"query","required":true,"schema":{"type":"string"}},{"name":"redirect_url","in":"query","required":false,"schema":{"type":"string"}}],"security":[{"bearerAuth":[]},{"connectToken":[]}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","required":["authUrl","state"],"properties":{"authUrl":{"type":"string","format":"uri"},"state":{"type":"string"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"x-pozy-area":"accounts"}},"/v1/connect/webflow":{"get":{"operationId":"getWebflowConnectUrl","summary":"Get Webflow OAuth URL","tags":["Connect"],"parameters":[{"name":"profileId","in":"query","required":true,"schema":{"type":"string"}},{"name":"redirect_url","in":"query","required":false,"schema":{"type":"string"}}],"security":[{"bearerAuth":[]},{"connectToken":[]}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","required":["authUrl","state"],"properties":{"authUrl":{"type":"string","format":"uri"},"state":{"type":"string"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"x-pozy-area":"accounts"}},"/v1/connect/webflow/token":{"post":{"operationId":"connectWebflowWithSiteToken","summary":"Connect Webflow with a site API token","tags":["Connect"],"security":[{"bearerAuth":[]},{"connectToken":[]}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","required":["account"],"properties":{"account":{"type":"object","required":["_id","platform","username","displayName","profileId"],"properties":{"_id":{"type":"string"},"platform":{"type":"string","enum":["webflow"]},"username":{"type":"string"},"displayName":{"type":"string"},"profileId":{"type":"string"}}}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["profileId","siteToken"],"properties":{"profileId":{"type":"string"},"siteToken":{"type":"string","minLength":1,"maxLength":512,"writeOnly":true}}}}}},"x-pozy-area":"accounts"}},"/v1/connect/wordpress/token":{"post":{"operationId":"connectWordPressWithApplicationPassword","summary":"Connect self-hosted WordPress with an application password","tags":["Connect"],"security":[{"bearerAuth":[]},{"connectToken":[]}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","required":["account"],"properties":{"account":{"type":"object","required":["_id","platform","username","displayName","profileId"],"properties":{"_id":{"type":"string"},"platform":{"type":"string","enum":["wordpress"]},"username":{"type":"string"},"displayName":{"type":"string"},"profileId":{"type":"string"}}}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["profileId","siteUrl","username","applicationPassword"],"properties":{"profileId":{"type":"string"},"siteUrl":{"type":"string","format":"uri","pattern":"^https://"},"username":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[^:\\r\\n]+$"},"applicationPassword":{"type":"string","minLength":1,"maxLength":1024,"writeOnly":true}}}}}},"x-pozy-area":"accounts"}},"/v1/connect/tiktok-ads":{"patch":{"operationId":"configureTikTokAdsBrandIdentity","summary":"Set TikTok brand identity","tags":["Connect"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"identityId":{"type":"string"},"displayName":{"type":"string"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","displayName","imageUrl"],"properties":{"accountId":{"type":"string"},"displayName":{"type":"string","minLength":1,"maxLength":40},"imageUrl":{"type":"string","format":"uri"}}}}}},"x-pozy-area":"accounts"}},"/v1/connect/facebook/select-page":{"get":{"operationId":"listFacebookPages","summary":"List Facebook pages","tags":["Connect"],"parameters":[{"name":"profileId","in":"query","required":false,"schema":{"type":"string"}},{"name":"tempToken","in":"query","required":false,"schema":{"type":"string"}},{"name":"X-Temp-Token","in":"header","required":false,"schema":{"type":"string"}},{"name":"connectFlow","in":"query","required":false,"schema":{"type":"string","pattern":"^[a-f0-9]{32}$"}},{"name":"selectionToken","in":"query","required":false,"schema":{"type":"string"}}],"security":[{"bearerAuth":[]},{"connectToken":[]}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"pages":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"username":{"type":"string"},"access_token":{"type":"string"},"category":{"type":"string"},"tasks":{"type":"array","items":{"type":"string"}}}}},"truncated":{"type":"boolean"}}}}}}},"x-pozy-area":"accounts"},"post":{"operationId":"selectFacebookPage","summary":"Select Facebook page","tags":["Connect"],"security":[{"bearerAuth":[]},{"connectToken":[]}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"redirect_url":{"type":"string"},"adsAccountId":{"type":"string"},"account":{"type":"object","properties":{"accountId":{"type":"string"},"platform":{"type":"string","enum":["facebook"]},"username":{"type":"string"},"displayName":{"type":"string"},"profilePicture":{"type":"string"},"isActive":{"type":"boolean"},"selectedPageName":{"type":"string"}}},"accounts":{"type":"array","items":{"type":"object"}},"failed":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"code":{"type":"string"},"message":{"type":"string"}}}}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"type":"object","required":["profileId","userProfile"],"not":{"required":["selectionToken"],"properties":{"selectionToken":{}}},"properties":{"profileId":{"type":"string"},"pageId":{"type":"string"},"pageIds":{"type":"array","minItems":1,"maxItems":25,"items":{"type":"string"}},"tempToken":{"type":"string"},"connectFlow":{"type":"string","pattern":"^[a-f0-9]{32}$"},"userProfile":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"profilePicture":{"type":"string"}}},"redirect_url":{"type":"string","format":"uri"}}},{"type":"object","additionalProperties":false,"required":["selectionToken","pageId"],"properties":{"selectionToken":{"type":"string"},"pageId":{"type":"string","pattern":"^\\d+$"}}}]}}}},"x-pozy-area":"accounts"}},"/v1/connect/instagram/select-account":{"get":{"operationId":"listInstagramPages","summary":"List Pages with a linked Instagram account","tags":["Connect"],"parameters":[{"name":"profileId","in":"query","required":true,"schema":{"type":"string"}},{"name":"tempToken","in":"query","required":false,"schema":{"type":"string"}},{"name":"X-Temp-Token","in":"header","required":false,"schema":{"type":"string"}},{"name":"connectFlow","in":"query","required":false,"schema":{"type":"string","pattern":"^[a-f0-9]{32}$"}}],"security":[{"bearerAuth":[]},{"connectToken":[]}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"pages":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"access_token":{"type":"string"},"instagram_business_account":{"type":"object","properties":{"id":{"type":"string"},"username":{"type":"string"},"profile_picture_url":{"type":"string"},"followers_count":{"type":"integer"}}}}}}}}}}}},"x-pozy-area":"accounts"},"post":{"operationId":"selectInstagramAccount","summary":"Select the Page whose Instagram account to connect","tags":["Connect"],"security":[{"bearerAuth":[]},{"connectToken":[]}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"redirect_url":{"type":"string"},"adsAccountId":{"type":"string"},"account":{"type":"object","properties":{"accountId":{"type":"string"},"platform":{"type":"string","enum":["instagram"]},"username":{"type":"string"},"displayName":{"type":"string"},"profilePicture":{"type":"string"},"isActive":{"type":"boolean"},"loginMethod":{"type":"string","enum":["facebook_login"]}}},"accounts":{"type":"array","items":{"type":"object"}},"failed":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"code":{"type":"string"},"message":{"type":"string"}}}}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["profileId"],"properties":{"profileId":{"type":"string"},"pageId":{"type":"string"},"pageIds":{"type":"array","minItems":1,"maxItems":25,"items":{"type":"string"}},"tempToken":{"type":"string"},"connectFlow":{"type":"string","pattern":"^[a-f0-9]{32}$"},"redirect_url":{"type":"string","format":"uri"}}}}}},"x-pozy-area":"accounts"}},"/v1/connect/googlebusiness/locations":{"get":{"operationId":"listGoogleBusinessLocations","summary":"List Google Business Profile locations","tags":["Connect"],"parameters":[{"name":"profileId","in":"query","required":false,"schema":{"type":"string"}},{"name":"pendingDataToken","in":"query","required":false,"schema":{"type":"string"}},{"name":"tempToken","in":"query","required":false,"schema":{"type":"string"}},{"name":"search","in":"query","required":false,"schema":{"type":"string"}},{"name":"filter","in":"query","required":false,"schema":{"type":"string"}}],"security":[{"bearerAuth":[]},{"connectToken":[]}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"locations":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"accountId":{"type":"string"},"accountName":{"type":"string"},"address":{"type":"string"},"category":{"type":"string"},"storeCode":{"type":"string"}}}},"hasMore":{"type":"boolean"}}}}}}},"x-pozy-area":"accounts"}},"/v1/connect/googlebusiness/select-location":{"post":{"operationId":"selectGoogleBusinessLocation","summary":"Select Google Business Profile location","tags":["Connect"],"security":[{"bearerAuth":[]},{"connectToken":[]}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"redirect_url":{"type":"string"},"account":{"type":"object","properties":{"accountId":{"type":"string"},"platform":{"type":"string","enum":["googlebusiness"]},"username":{"type":"string"},"displayName":{"type":"string"},"isActive":{"type":"boolean"},"selectedLocationName":{"type":"string"},"selectedLocationId":{"type":"string"}}},"accounts":{"type":"array","items":{"type":"object"}},"failed":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"code":{"type":"string"},"message":{"type":"string"}}}}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["profileId","pendingDataToken"],"properties":{"profileId":{"type":"string"},"locationId":{"type":"string"},"locations":{"type":"array","minItems":1,"maxItems":25,"items":{"type":"object","required":["locationId"],"properties":{"locationId":{"type":"string"},"accountId":{"type":"string"}}}},"accountId":{"type":"string"},"pendingDataToken":{"type":"string"},"redirect_url":{"type":"string","format":"uri"}}}}}},"x-pozy-area":"accounts"}},"/v1/accounts/{accountId}/gmb-reviews":{"get":{"operationId":"getGoogleBusinessReviews","summary":"Get reviews","tags":["Google Business Reviews"],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}},{"name":"locationId","in":"query","required":false,"schema":{"type":"string"}},{"name":"pageSize","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":50,"default":50}},{"name":"pageToken","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"accountId":{"type":"string"},"locationId":{"type":"string"},"reviews":{"type":"array","items":{"$ref":"#/components/schemas/GoogleBusinessReview"}},"averageRating":{"type":"number"},"totalReviewCount":{"type":"integer"},"nextPageToken":{"type":["string","null"]}}}}}}},"x-pozy-area":"google-business"}},"/v1/accounts/{accountId}/gmb-verifications":{"get":{"operationId":"getGoogleBusinessVerifications","summary":"Get verification state","tags":["Google Business Verifications"],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}},{"name":"locationId","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"accountId":{"type":"string"},"locationId":{"type":"string"},"voiceOfMerchantState":{"type":"object","properties":{"hasVoiceOfMerchant":{"type":"boolean"},"hasBusinessAuthority":{"type":"boolean"},"verify":{"type":"object","properties":{"hasPendingVerification":{"type":"boolean"}}}}},"verifications":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"method":{"type":"string","enum":["ADDRESS","EMAIL","PHONE_CALL","SMS","AUTO","VETTED_PARTNER"]},"state":{"type":"string","enum":["PENDING","COMPLETED","FAILED"]},"createTime":{"type":"string","format":"date-time"}}}}}}}}}},"x-pozy-area":"google-business"},"post":{"operationId":"startGoogleBusinessVerification","summary":"Start a verification","tags":["Google Business Verifications"],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}},{"name":"locationId","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"accountId":{"type":"string"},"locationId":{"type":"string"},"verification":{"type":"object","properties":{"name":{"type":"string"},"method":{"type":"string","enum":["ADDRESS","EMAIL","PHONE_CALL","SMS","AUTO","VETTED_PARTNER"]},"state":{"type":"string","enum":["PENDING","COMPLETED","FAILED"]},"createTime":{"type":"string","format":"date-time"}}}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["method"],"properties":{"method":{"type":"string","enum":["ADDRESS","EMAIL","PHONE_CALL","SMS","AUTO","VETTED_PARTNER"]},"languageCode":{"type":"string"},"phoneNumber":{"type":"string"},"emailAddress":{"type":"string"},"mailerContact":{"type":"object"},"context":{"type":"object"}}}}}},"x-pozy-area":"google-business"}},"/v1/accounts/{accountId}/gmb-verifications/options":{"post":{"operationId":"fetchGoogleBusinessVerificationOptions","summary":"Fetch verification options","tags":["Google Business Verifications"],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}},{"name":"locationId","in":"query","required":false,"schema":{"type":"string","minLength":1}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"accountId":{"type":"string"},"locationId":{"type":"string"},"options":{"type":"array","items":{"type":"object","properties":{"verificationMethod":{"type":"string","enum":["ADDRESS","EMAIL","PHONE_CALL","SMS","AUTO","VETTED_PARTNER"]},"phoneNumber":{"type":"string"}}}}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["languageCode"],"properties":{"languageCode":{"type":"string"},"context":{"type":"object"}}}}}},"x-pozy-area":"google-business"}},"/v1/accounts/{accountId}/gmb-verifications/{verificationId}/complete":{"post":{"operationId":"completeGoogleBusinessVerification","summary":"Complete a verification","tags":["Google Business Verifications"],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}},{"name":"verificationId","in":"path","required":true,"schema":{"type":"string"}},{"name":"locationId","in":"query","required":false,"schema":{"type":"string","minLength":1}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"accountId":{"type":"string"},"locationId":{"type":"string"},"verification":{"type":"object","properties":{"name":{"type":"string"},"method":{"type":"string","enum":["ADDRESS","EMAIL","PHONE_CALL","SMS","AUTO","VETTED_PARTNER"]},"state":{"type":"string","enum":["PENDING","COMPLETED","FAILED"]},"createTime":{"type":"string","format":"date-time"}}}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["pin"],"properties":{"pin":{"type":"string"}}}}}},"x-pozy-area":"google-business"}},"/v1/accounts/{accountId}/gmb-food-menus":{"get":{"operationId":"getGoogleBusinessFoodMenus","summary":"Get food menus","tags":["Google Business Food Menus"],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}},{"name":"locationId","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"accountId":{"type":"string"},"locationId":{"type":"string"},"name":{"type":"string"},"menus":{"type":"array","items":{"$ref":"#/components/schemas/FoodMenu"}}}}}}}},"x-pozy-area":"google-business"},"put":{"operationId":"updateGoogleBusinessFoodMenus","summary":"Update food menus","tags":["Google Business Food Menus"],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}},{"name":"locationId","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"accountId":{"type":"string"},"locationId":{"type":"string"},"name":{"type":"string"},"menus":{"type":"array","items":{"$ref":"#/components/schemas/FoodMenu"}}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["menus"],"properties":{"menus":{"type":"array","items":{"$ref":"#/components/schemas/FoodMenu"}},"updateMask":{"type":"string"}}}}}},"x-pozy-area":"google-business"}},"/v1/accounts/{accountId}/gmb-location-details":{"get":{"operationId":"getGoogleBusinessLocationDetails","summary":"Get location details","tags":["Google Business Location Details"],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}},{"name":"locationId","in":"query","required":false,"schema":{"type":"string"}},{"name":"readMask","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"accountId":{"type":"string"},"locationId":{"type":"string"},"location":{"type":["object","null"],"properties":{"name":{"type":["string","null"]},"placeId":{"type":["string","null"]},"reviewUrl":{"type":["string","null"]},"mapsUri":{"type":["string","null"]},"isVerified":{"type":"boolean"}}},"title":{"type":"string"},"regularHours":{"type":"object","properties":{"periods":{"type":"array","items":{"type":"object","properties":{"openDay":{"type":"string","enum":["MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY","SUNDAY"]},"openTime":{"type":"string"},"closeDay":{"type":"string"},"closeTime":{"type":"string"}}}}}},"specialHours":{"type":"object","properties":{"specialHourPeriods":{"type":"array","items":{"type":"object","properties":{"startDate":{"type":"object","properties":{"year":{"type":"integer"},"month":{"type":"integer"},"day":{"type":"integer"}}},"endDate":{"type":"object","properties":{"year":{"type":"integer"},"month":{"type":"integer"},"day":{"type":"integer"}}},"openTime":{"type":"string"},"closeTime":{"type":"string"},"closed":{"type":"boolean"}}}}}},"profile":{"type":"object","properties":{"description":{"type":"string"}}},"websiteUri":{"type":"string"},"phoneNumbers":{"type":"object","properties":{"primaryPhone":{"type":"string"},"additionalPhones":{"type":"array","items":{"type":"string"}}}},"categories":{"type":"object","properties":{"primaryCategory":{"type":"object","properties":{"name":{"type":"string"},"displayName":{"type":"string"}}},"additionalCategories":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"displayName":{"type":"string"}}}}}},"serviceItems":{"type":"array","items":{"type":"object","properties":{"structuredServiceItem":{"type":"object","properties":{"serviceTypeId":{"type":"string"},"description":{"type":"string"}}},"freeFormServiceItem":{"type":"object","properties":{"category":{"type":"string"},"label":{"type":"object","properties":{"displayName":{"type":"string"},"languageCode":{"type":"string"}}}}},"price":{"type":"object","properties":{"currencyCode":{"type":"string"},"units":{"type":"string"},"nanos":{"type":"integer"}}}}}}}}}}}},"x-pozy-area":"google-business"},"put":{"operationId":"updateGoogleBusinessLocationDetails","summary":"Update location details","tags":["Google Business Location Details"],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}},{"name":"locationId","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"accountId":{"type":"string"},"locationId":{"type":"string"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["updateMask"],"additionalProperties":true,"properties":{"updateMask":{"type":"string"},"regularHours":{"type":"object","properties":{"periods":{"type":"array","items":{"type":"object","properties":{"openDay":{"type":"string"},"openTime":{"type":"string"},"closeDay":{"type":"string"},"closeTime":{"type":"string"}}}}}},"specialHours":{"type":"object","properties":{"specialHourPeriods":{"type":"array","items":{"type":"object","properties":{"startDate":{"type":"object","properties":{"year":{"type":"integer"},"month":{"type":"integer"},"day":{"type":"integer"}}},"endDate":{"type":"object","properties":{"year":{"type":"integer"},"month":{"type":"integer"},"day":{"type":"integer"}}},"openTime":{"type":"string"},"closeTime":{"type":"string"},"closed":{"type":"boolean"}}}}}},"profile":{"type":"object","properties":{"description":{"type":"string"}}},"websiteUri":{"type":"string"},"phoneNumbers":{"type":"object","properties":{"primaryPhone":{"type":"string"},"additionalPhones":{"type":"array","items":{"type":"string"}}}},"categories":{"type":"object","properties":{"primaryCategory":{"type":"object","properties":{"name":{"type":"string"}}},"additionalCategories":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"}}}}}},"serviceItems":{"type":"array","items":{"type":"object","properties":{"structuredServiceItem":{"type":"object","properties":{"serviceTypeId":{"type":"string"},"description":{"type":"string"}}},"freeFormServiceItem":{"type":"object","properties":{"category":{"type":"string"},"label":{"type":"object","properties":{"displayName":{"type":"string"},"languageCode":{"type":"string"}}}}},"price":{"type":"object","properties":{"currencyCode":{"type":"string"},"units":{"type":"string"},"nanos":{"type":"integer"}}}}}},"title":{"type":"string"},"storeCode":{"type":"string"},"labels":{"type":"array","items":{"type":"string"}},"storefrontAddress":{"type":"object","properties":{"regionCode":{"type":"string"},"languageCode":{"type":"string"},"postalCode":{"type":"string"},"administrativeArea":{"type":"string"},"locality":{"type":"string"},"addressLines":{"type":"array","items":{"type":"string"}}}},"serviceArea":{"type":"object","properties":{"businessType":{"type":"string","enum":["CUSTOMER_LOCATION_ONLY","CUSTOMER_AND_BUSINESS_LOCATION"]},"places":{"type":"object","properties":{"placeInfos":{"type":"array","items":{"type":"object","properties":{"placeName":{"type":"string"},"placeId":{"type":"string"}}}}}},"regionCode":{"type":"string"}}},"openInfo":{"type":"object","properties":{"status":{"type":"string","enum":["OPEN","CLOSED_PERMANENTLY","CLOSED_TEMPORARILY"]},"openingDate":{"type":"object","properties":{"year":{"type":"integer"},"month":{"type":"integer"},"day":{"type":"integer"}}}}},"moreHours":{"type":"array","items":{"type":"object","properties":{"hoursTypeId":{"type":"string"},"periods":{"type":"array","items":{"type":"object","properties":{"openDay":{"type":"string"},"openTime":{"type":"string"},"closeDay":{"type":"string"},"closeTime":{"type":"string"}}}}}}},"latlng":{"type":"object","properties":{"latitude":{"type":"number"},"longitude":{"type":"number"}}},"adWordsLocationExtensions":{"type":"object","properties":{"adPhone":{"type":"string"}}}}}}}},"x-pozy-area":"google-business"}},"/v1/accounts/{accountId}/gmb-media":{"get":{"operationId":"listGoogleBusinessMedia","summary":"List media","tags":["Google Business Media"],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}},{"name":"locationId","in":"query","required":false,"schema":{"type":"string"}},{"name":"pageSize","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":100,"default":100}},{"name":"pageToken","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"accountId":{"type":"string"},"locationId":{"type":"string"},"mediaItems":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"mediaFormat":{"type":"string","enum":["PHOTO","VIDEO"]},"sourceUrl":{"type":"string"},"googleUrl":{"type":"string"},"thumbnailUrl":{"type":"string"},"description":{"type":"string"},"createTime":{"type":"string","format":"date-time"},"locationAssociation":{"type":"object","properties":{"category":{"type":"string"}}}}}},"nextPageToken":{"type":"string"},"totalMediaItemsCount":{"type":"integer"}}}}}}},"x-pozy-area":"google-business"},"post":{"operationId":"createGoogleBusinessMedia","summary":"Upload photo","tags":["Google Business Media"],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}},{"name":"locationId","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"name":{"type":"string"},"mediaFormat":{"type":"string"},"googleUrl":{"type":"string"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["sourceUrl"],"properties":{"sourceUrl":{"type":"string","format":"uri"},"mediaFormat":{"type":"string","enum":["PHOTO","VIDEO"],"default":"PHOTO"},"description":{"type":"string","minLength":1},"category":{"type":"string","enum":["CATEGORY_UNSPECIFIED","COVER","PROFILE","LOGO","EXTERIOR","INTERIOR","PRODUCT","FOOD_AND_DRINK","MENU","COMMON_AREA","ROOMS","TEAMS","AT_WORK","ADDITIONAL"]}}}}}},"x-pozy-area":"google-business"},"delete":{"operationId":"deleteGoogleBusinessMedia","summary":"Delete photo","tags":["Google Business Media"],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}},{"name":"locationId","in":"query","required":false,"schema":{"type":"string"}},{"name":"mediaId","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"deleted":{"type":"boolean"},"mediaId":{"type":"string"}}}}}}},"x-pozy-area":"google-business"}},"/v1/accounts/{accountId}/gmb-attribute-metadata":{"get":{"operationId":"getGmbAttributeMetadata","summary":"Get attribute metadata","tags":["Google Business Attributes"],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}},{"name":"locationId","in":"query","required":false,"schema":{"type":"string"}},{"name":"categoryName","in":"query","required":false,"schema":{"type":"string"}},{"name":"regionCode","in":"query","required":false,"schema":{"type":"string"}},{"name":"languageCode","in":"query","required":false,"schema":{"type":"string"}},{"name":"pageSize","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":200}},{"name":"pageToken","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"accountId":{"type":"string"},"locationId":{"type":"string"},"attributeMetadata":{"type":"array","items":{"type":"object","properties":{"parent":{"type":"string"},"valueType":{"type":"string"},"displayName":{"type":"string"},"groupDisplayName":{"type":"string"},"repeatable":{"type":"boolean"},"deprecated":{"type":"boolean"},"valueMetadata":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"displayName":{"type":"string"}}}}}}},"nextPageToken":{"type":"string"}}}}}}},"x-pozy-area":"google-business"}},"/v1/accounts/{accountId}/gmb-attributes":{"get":{"operationId":"getGoogleBusinessAttributes","summary":"Get attributes","tags":["Google Business Attributes"],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}},{"name":"locationId","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"accountId":{"type":"string"},"locationId":{"type":"string"},"attributes":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"valueType":{"type":"string"},"values":{"type":"array","items":{}},"repeatedEnumValue":{"type":"object","properties":{"setValues":{"type":"array","items":{"type":"string"}},"unsetValues":{"type":"array","items":{"type":"string"}}}}}}}}}}}}},"x-pozy-area":"google-business"},"put":{"operationId":"updateGoogleBusinessAttributes","summary":"Update attributes","tags":["Google Business Attributes"],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}},{"name":"locationId","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"accountId":{"type":"string"},"locationId":{"type":"string"},"attributes":{"type":"array","items":{"type":"object"}}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["attributes","attributeMask"],"properties":{"attributes":{"type":"array","items":{"type":"object","required":["name"],"properties":{"name":{"type":"string","minLength":1},"valueType":{"type":"string","enum":["ATTRIBUTE_VALUE_TYPE_UNSPECIFIED","BOOL","ENUM","URL","REPEATED_ENUM"]},"values":{"type":"array","items":{}},"repeatedEnumValue":{"type":"object","properties":{"setValues":{"type":"array","items":{"type":"string"}},"unsetValues":{"type":"array","items":{"type":"string"}}}},"uriValues":{"type":"array","items":{"type":"object","required":["uri"],"properties":{"uri":{"type":"string","format":"uri"}}}}}}},"attributeMask":{"type":"string","minLength":1}}}}}},"x-pozy-area":"google-business"}},"/v1/accounts/{accountId}/gmb-place-actions":{"get":{"operationId":"listGoogleBusinessPlaceActions","summary":"List action links","tags":["Google Business Place Actions"],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}},{"name":"locationId","in":"query","required":false,"schema":{"type":"string"}},{"name":"pageSize","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":100,"default":100}},{"name":"pageToken","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"accountId":{"type":"string"},"locationId":{"type":"string"},"placeActionLinks":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"uri":{"type":"string"},"placeActionType":{"type":"string"},"createTime":{"type":"string","format":"date-time"},"updateTime":{"type":"string","format":"date-time"}}}},"nextPageToken":{"type":"string"}}}}}}},"x-pozy-area":"google-business"},"post":{"operationId":"createGoogleBusinessPlaceAction","summary":"Create action link","tags":["Google Business Place Actions"],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}},{"name":"locationId","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"name":{"type":"string"},"uri":{"type":"string"},"placeActionType":{"type":"string"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["uri","placeActionType"],"properties":{"uri":{"type":"string","format":"uri"},"placeActionType":{"type":"string","enum":["APPOINTMENT","ONLINE_APPOINTMENT","DINING_RESERVATION","FOOD_ORDERING","FOOD_DELIVERY","FOOD_TAKEOUT","SHOP_ONLINE"]}}}}}},"x-pozy-area":"google-business"},"patch":{"operationId":"updateGoogleBusinessPlaceAction","summary":"Update action link","tags":["Google Business Place Actions"],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}},{"name":"locationId","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"name":{"type":"string"},"uri":{"type":"string"},"placeActionType":{"type":"string"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["name"],"properties":{"name":{"type":"string"},"uri":{"type":"string","format":"uri"},"placeActionType":{"type":"string","enum":["APPOINTMENT","ONLINE_APPOINTMENT","DINING_RESERVATION","FOOD_ORDERING","FOOD_DELIVERY","FOOD_TAKEOUT","SHOP_ONLINE"]}}}}}},"x-pozy-area":"google-business"},"delete":{"operationId":"deleteGoogleBusinessPlaceAction","summary":"Delete action link","tags":["Google Business Place Actions"],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}},{"name":"locationId","in":"query","required":false,"schema":{"type":"string"}},{"name":"name","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"deleted":{"type":"boolean"},"name":{"type":"string"}}}}}}},"x-pozy-area":"google-business"}},"/v1/accounts/{accountId}/gmb-services":{"get":{"operationId":"getGoogleBusinessServices","summary":"Get services","tags":["Google Business Services"],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}},{"name":"locationId","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"accountId":{"type":"string"},"locationId":{"type":"string"},"services":{"type":"array","items":{"type":"object","properties":{"structuredServiceItem":{"type":"object","properties":{"serviceTypeId":{"type":"string"},"description":{"type":"string"}}},"freeFormServiceItem":{"type":"object","properties":{"category":{"type":"string"},"label":{"type":"object","properties":{"displayName":{"type":"string"},"description":{"type":"string"}}}}},"price":{"type":"object","properties":{"currencyCode":{"type":"string"},"units":{"type":"string"},"nanos":{"type":"integer"}}}}}}}}}}}},"x-pozy-area":"google-business"},"put":{"operationId":"updateGoogleBusinessServices","summary":"Replace services","tags":["Google Business Services"],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}},{"name":"locationId","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"services":{"type":"array","items":{"type":"object"}}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["serviceItems"],"properties":{"serviceItems":{"type":"array","items":{"type":"object","properties":{"structuredServiceItem":{"type":"object","required":["serviceTypeId"],"properties":{"serviceTypeId":{"type":"string","minLength":1},"description":{"type":"string"}}},"freeFormServiceItem":{"type":"object","required":["category","label"],"properties":{"category":{"type":"string","minLength":1},"label":{"type":"object","required":["displayName"],"properties":{"displayName":{"type":"string","minLength":1},"description":{"type":"string"},"languageCode":{"type":"string"}}}}},"price":{"type":"object","properties":{"currencyCode":{"type":"string","minLength":1},"units":{"type":"string","minLength":1},"nanos":{"type":"integer"}}}}}}}}}}},"x-pozy-area":"google-business"}},"/v1/accounts/{accountId}/gmb-reviews/batch":{"post":{"operationId":"batchGetGoogleBusinessReviews","summary":"Batch get reviews","tags":["Google Business Reviews"],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"accountId":{"type":"string"},"locationReviews":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"review":{"type":"object"}}}},"nextPageToken":{"type":"string"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["locationNames"],"properties":{"locationNames":{"type":"array","minItems":1,"maxItems":50,"items":{"type":"string","pattern":"^accounts/[^/]+/locations/[^/]+$"}},"pageSize":{"type":"integer","minimum":1,"maximum":50,"default":50},"pageToken":{"type":"string","minLength":1},"orderBy":{"type":"string","enum":["updateTime desc","rating","rating desc"],"default":"updateTime desc"}}}}}},"x-pozy-area":"google-business"}},"/v1/accounts/{accountId}/gmb-reviews/{reviewId}":{"get":{"operationId":"getGoogleBusinessReview","summary":"Get a review","tags":["Google Business Reviews"],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}},{"name":"reviewId","in":"path","required":true,"schema":{"type":"string"}},{"name":"locationId","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"accountId":{"type":"string"},"locationId":{"type":"string"},"review":{"$ref":"#/components/schemas/GoogleBusinessReview"}}}}}}},"x-pozy-area":"google-business"}},"/v1/accounts/{accountId}/gmb-reviews/{reviewId}/reply":{"post":{"operationId":"replyToGoogleBusinessReview","summary":"Reply to a review","tags":["Google Business Reviews"],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}},{"name":"reviewId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"reviewId":{"type":"string"},"platform":{"type":"string"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["comment"],"properties":{"comment":{"type":"string","minLength":1}}}}}},"x-pozy-area":"google-business"},"delete":{"operationId":"deleteGoogleBusinessReviewReply","summary":"Delete a review reply","tags":["Google Business Reviews"],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}},{"name":"reviewId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"},"platform":{"type":"string"}}}}}}},"x-pozy-area":"google-business"}},"/v1/connect/handoffs/{handoffId}":{"get":{"operationId":"getConnectHandoff","summary":"Get a phone handoff","tags":["Connect"],"parameters":[{"name":"handoffId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConnectHandoff"}}}}},"x-pozy-area":"accounts"}},"/v1/connect/welcome-screen":{"get":{"operationId":"getConnectWelcomeScreen","summary":"Get the saved welcome screen","tags":["Connect"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConnectWelcomeScreen"}}}}},"x-pozy-area":"accounts"},"put":{"operationId":"updateConnectWelcomeScreen","summary":"Save the welcome screen","tags":["Connect"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConnectWelcomeScreen"}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["showByDefault"],"properties":{"showByDefault":{"type":"boolean"},"brandName":{"type":"string","minLength":1,"maxLength":60},"logoUrl":{"type":"string","format":"uri","maxLength":2048},"theme":{"type":"object"}}}}}},"x-pozy-area":"accounts"}},"/v1/connect/oauth-apps":{"get":{"operationId":"listOAuthApps","summary":"List your OAuth apps","tags":["Connect"],"parameters":[{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":100,"default":50}},{"name":"cursor","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","required":["apps","pagination","platforms"],"properties":{"apps":{"type":"array","items":{"$ref":"#/components/schemas/OAuthApp"}},"pagination":{"type":"object","required":["nextCursor"],"properties":{"nextCursor":{"type":["string","null"]}}},"platforms":{"type":"array","items":{"$ref":"#/components/schemas/OAuthAppSetup"}}}}}}}},"x-pozy-area":"accounts"},"post":{"operationId":"createOAuthApp","summary":"Add an OAuth app","tags":["Connect"],"responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"type":"object","required":["app"],"properties":{"app":{"$ref":"#/components/schemas/OAuthApp"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["platform","label","clientId","clientSecret"],"properties":{"platform":{"type":"string"},"label":{"type":"string","minLength":1,"maxLength":80},"clientId":{"type":"string","minLength":1,"maxLength":500},"clientSecret":{"type":"string","minLength":1,"maxLength":1000},"metaAppId":{"type":"string","pattern":"^\\d{1,32}$"},"metaAppSecret":{"type":"string","minLength":1,"maxLength":1000},"slackSigningSecret":{"type":"string","minLength":1,"maxLength":1000},"scopeAreas":{"type":"array","items":{"type":"string","enum":["posting","analytics","comments","messaging"]}}}}}}},"x-pozy-area":"accounts"}},"/v1/connect/oauth-apps/{appId}":{"get":{"operationId":"getOAuthApp","summary":"Get an OAuth app","tags":["Connect"],"parameters":[{"name":"appId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","required":["app"],"properties":{"app":{"$ref":"#/components/schemas/OAuthApp"}}}}}}},"x-pozy-area":"accounts"},"patch":{"operationId":"updateOAuthApp","summary":"Update an OAuth app","tags":["Connect"],"parameters":[{"name":"appId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","required":["app"],"properties":{"app":{"$ref":"#/components/schemas/OAuthApp"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"properties":{"label":{"type":"string","minLength":1,"maxLength":80},"clientSecret":{"type":"string","minLength":1,"maxLength":1000},"metaAppId":{"type":"string","pattern":"^\\d{1,32}$"},"metaAppSecret":{"type":"string","minLength":1,"maxLength":1000},"slackSigningSecret":{"type":"string","minLength":1,"maxLength":1000},"scopeAreas":{"type":"array","items":{"type":"string","enum":["posting","analytics","comments","messaging"]}}}}}}},"x-pozy-area":"accounts"},"delete":{"operationId":"deleteOAuthApp","summary":"Remove an OAuth app","tags":["Connect"],"parameters":[{"name":"appId","in":"path","required":true,"schema":{"type":"string"}},{"name":"confirm","in":"query","required":false,"schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","required":["disconnectedAccounts"],"properties":{"disconnectedAccounts":{"type":"integer"}}}}}}},"x-pozy-area":"accounts"}},"/v1/connect/oauth-apps/{appId}/test":{"post":{"operationId":"testOAuthApp","summary":"Check an OAuth app's keys","tags":["Connect"],"parameters":[{"name":"appId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","required":["app"],"properties":{"app":{"$ref":"#/components/schemas/OAuthApp"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"x-pozy-area":"accounts"}},"/v1/connect/pending-data":{"get":{"operationId":"getPendingOAuthData","summary":"Get pending OAuth data","tags":["Connect"],"parameters":[{"name":"token","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"platform":{"type":"string"},"profileId":{"type":"string"},"tempToken":{"type":"string"},"refreshToken":{"type":"string"},"expiresIn":{"type":"number"},"userProfile":{"type":"object"},"selectionType":{"type":"string","enum":["organizations","pages","boards","locations","profiles"]},"organizations":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"urn":{"type":"string"},"name":{"type":"string"},"vanityName":{"type":"string"}}}}}}}}}},"x-pozy-area":"accounts"}},"/v1/connect/linkedin/organizations":{"get":{"operationId":"listLinkedInOrganizations","summary":"List LinkedIn orgs","tags":["Connect"],"parameters":[{"name":"tempToken","in":"query","required":true,"schema":{"type":"string"}},{"name":"orgIds","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"organizations":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"logoUrl":{"type":"string","format":"uri"},"vanityName":{"type":"string"},"website":{"type":"string","format":"uri"},"industry":{"type":"string"},"description":{"type":"string"}}}}}}}}}},"x-pozy-area":"accounts"}},"/v1/connect/linkedin/select-organization":{"post":{"operationId":"selectLinkedInOrganization","summary":"Select LinkedIn org","tags":["Connect"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"redirect_url":{"type":"string"},"account":{"type":"object","properties":{"accountId":{"type":"string"},"platform":{"type":"string","enum":["linkedin"]},"username":{"type":"string"},"displayName":{"type":"string"},"profilePicture":{"type":"string"},"isActive":{"type":"boolean"},"accountType":{"type":"string","enum":["personal","organization"]}}},"accounts":{"type":"array","items":{"type":"object"}},"failed":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"code":{"type":"string"},"message":{"type":"string"}}}},"bulkRefresh":{"type":"object","properties":{"updatedCount":{"type":"integer"},"errors":{"type":"integer"}}}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["profileId","tempToken","userProfile"],"properties":{"profileId":{"type":"string"},"tempToken":{"type":"string"},"userProfile":{"type":"object"},"accountType":{"type":"string","enum":["personal","organization"]},"selections":{"type":"array","minItems":1,"maxItems":25,"items":{"type":"object","required":["accountType"],"properties":{"accountType":{"type":"string","enum":["personal","organization"]},"selectedOrganization":{"type":"object"}}}},"selectedOrganization":{"type":"object","required":["id","urn","name"],"properties":{"id":{"type":"string","minLength":1},"urn":{"type":"string","pattern":"^urn:li:organization:"},"name":{"type":"string","minLength":1},"logoUrl":{"type":"string","format":"uri"},"vanityName":{"type":"string"}}},"redirect_url":{"type":"string","format":"uri"}}}}}},"x-pozy-area":"accounts"}},"/v1/connect/pinterest/select-board":{"get":{"operationId":"listPinterestBoardsForSelection","summary":"List Pinterest boards","tags":["Connect"],"parameters":[{"name":"X-Connect-Token","in":"header","required":true,"schema":{"type":"string"}},{"name":"profileId","in":"query","required":true,"schema":{"type":"string"}},{"name":"tempToken","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"boards":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"privacy":{"type":"string"}}}}}}}}}},"x-pozy-area":"accounts"},"post":{"operationId":"selectPinterestBoard","summary":"Select Pinterest board","tags":["Connect"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"redirect_url":{"type":"string"},"account":{"type":"object","properties":{"accountId":{"type":"string"},"platform":{"type":"string","enum":["pinterest"]},"username":{"type":"string"},"displayName":{"type":"string"},"profilePicture":{"type":"string"},"isActive":{"type":"boolean"},"defaultBoardName":{"type":"string"}}}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["profileId","boardId","tempToken"],"properties":{"profileId":{"type":"string"},"boardId":{"type":"string"},"boardName":{"type":"string"},"tempToken":{"type":"string"},"userProfile":{"type":"object"},"refreshToken":{"type":"string"},"expiresIn":{"type":"integer"},"redirect_url":{"type":"string","format":"uri"},"oauthAppId":{"type":"string"}}}}}},"x-pozy-area":"accounts"}},"/v1/connect/snapchat/select-profile":{"get":{"operationId":"listSnapchatProfiles","summary":"List Snapchat profiles","tags":["Connect"],"parameters":[{"name":"X-Connect-Token","in":"header","required":true,"schema":{"type":"string"}},{"name":"profileId","in":"query","required":true,"schema":{"type":"string"}},{"name":"tempToken","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"publicProfiles":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"display_name":{"type":"string"},"username":{"type":"string"},"profile_image_url":{"type":"string"},"subscriber_count":{"type":"integer"}}}}}}}}}},"x-pozy-area":"accounts"},"post":{"operationId":"selectSnapchatProfile","summary":"Select Snapchat profile","tags":["Connect"],"parameters":[{"name":"X-Connect-Token","in":"header","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"redirect_url":{"type":"string"},"account":{"type":"object","properties":{"accountId":{"type":"string"},"platform":{"type":"string","enum":["snapchat"]},"username":{"type":"string"},"displayName":{"type":"string"},"profilePicture":{"type":"string"},"isActive":{"type":"boolean"},"publicProfileName":{"type":"string"}}}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["profileId","selectedPublicProfile","tempToken","userProfile"],"properties":{"profileId":{"type":"string"},"selectedPublicProfile":{"type":"object","required":["id","display_name"],"properties":{"id":{"type":"string"},"display_name":{"type":"string"},"username":{"type":"string"},"profile_image_url":{"type":"string"},"subscriber_count":{"type":"integer"}}},"tempToken":{"type":"string"},"userProfile":{"type":"object"},"refreshToken":{"type":"string"},"expiresIn":{"type":"integer"},"redirect_url":{"type":"string","format":"uri"},"oauthAppId":{"type":"string"}}}}}},"x-pozy-area":"accounts"}},"/v1/connect/bluesky/credentials":{"post":{"operationId":"connectBlueskyCredentials","summary":"Connect Bluesky account","tags":["Connect"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"account":{"$ref":"#/components/schemas/SocialAccount"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["identifier","appPassword","state"],"properties":{"identifier":{"type":"string"},"appPassword":{"type":"string"},"state":{"type":"string"},"redirect_url":{"type":"string","format":"uri"},"redirectUri":{"type":"string","format":"uri","deprecated":true}}}}}},"x-pozy-area":"accounts"}},"/v1/connect/openai-ads/credentials":{"post":{"operationId":"connectOpenAIAdsCredentials","summary":"Connect an OpenAI Ads account","tags":["Connect"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"accountId":{"type":"string"},"adAccountName":{"type":"string"},"redirectUrl":{"type":"string"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["apiKey","profileId"],"properties":{"apiKey":{"type":"string"},"profileId":{"type":"string"},"state":{"type":"string"},"redirect_url":{"type":"string","format":"uri"},"redirectUri":{"type":"string","format":"uri","deprecated":true}}}}}},"x-pozy-area":"accounts"}},"/v1/connect/whop-ads/credentials":{"post":{"operationId":"connectWhopAdsCredentials","summary":"Connect a Whop account","tags":["Connect"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"accountId":{"type":"string"},"whopAccountId":{"type":"string"},"accountName":{"type":"string"},"redirectUrl":{"type":"string"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["apiKey","profileId"],"properties":{"apiKey":{"type":"string"},"profileId":{"type":"string"},"state":{"type":"string"},"redirect_url":{"type":"string","format":"uri"}}}}}},"x-pozy-area":"accounts"}},"/v1/connect/whatsapp/credentials":{"post":{"operationId":"connectWhatsAppCredentials","summary":"Connect WhatsApp via credentials","tags":["Connect"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"registrationWarning":{"type":"string"},"webhookNotice":{"type":"string"},"account":{"type":"object","properties":{"accountId":{"type":"string"},"platform":{"type":"string","enum":["whatsapp"]},"username":{"type":"string"},"displayName":{"type":"string"},"isActive":{"type":"boolean"},"phoneNumber":{"type":"string"},"verifiedName":{"type":"string"},"qualityRating":{"type":"string"}}}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["profileId","accessToken","wabaId","phoneNumberId"],"properties":{"profileId":{"type":"string"},"accessToken":{"type":"string"},"wabaId":{"type":"string"},"phoneNumberId":{"type":"string"},"pin":{"type":"string","pattern":"^\\d{6}$"},"oauthAppId":{"type":"string"}}}}}},"x-pozy-area":"accounts"}},"/v1/connect/whatsapp/select-phone-number":{"get":{"operationId":"listWhatsAppPhoneNumbers","summary":"List numbers for selection","tags":["Connect"],"parameters":[{"name":"profileId","in":"query","required":true,"schema":{"type":"string"}},{"name":"tempToken","in":"query","required":true,"schema":{"type":"string"}},{"name":"X-Connect-Token","in":"header","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"phoneNumbers":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"display_phone_number":{"type":"string"},"verified_name":{"type":"string"},"quality_rating":{"type":"string"},"name_status":{"type":"string"},"messaging_limit_tier":{"type":"string"},"wabaId":{"type":"string"},"wabaName":{"type":"string"}}}}}}}}}},"x-pozy-area":"accounts"},"post":{"operationId":"completeWhatsAppPhoneSelection","summary":"Complete number selection","tags":["Connect"],"parameters":[{"name":"X-Connect-Token","in":"header","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"redirect_url":{"type":"string"},"account":{"type":"object","properties":{"accountId":{"type":"string"},"platform":{"type":"string","enum":["whatsapp"]},"username":{"type":"string"},"displayName":{"type":"string"},"isActive":{"type":"boolean"},"selectedPhoneNumber":{"type":"string"}}}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["profileId","phoneNumberId","wabaId","tempToken"],"properties":{"profileId":{"type":"string"},"phoneNumberId":{"type":"string"},"wabaId":{"type":"string"},"tempToken":{"type":"string"},"userProfile":{"type":"object"},"redirect_url":{"type":"string"}}}}}},"x-pozy-area":"accounts"}},"/v1/connect/whatsapp/embedded-signup":{"post":{"operationId":"connectWhatsAppEmbeddedSignup","summary":"Connect WhatsApp from Embedded Signup","tags":["Connect"],"parameters":[{"name":"X-Connect-Token","in":"header","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"account":{"type":"object","properties":{"accountId":{"type":"string"},"platform":{"type":"string","enum":["whatsapp"]},"username":{"type":"string"},"displayName":{"type":"string"},"isActive":{"type":"boolean"},"selectedPhoneNumber":{"type":"string"}}},"redirectUrl":{"type":"string"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["code","profileId"],"properties":{"code":{"type":"string"},"profileId":{"type":"string"},"wabaId":{"type":"string"},"phoneNumberId":{"type":"string"},"isCoexistence":{"type":"boolean"},"expectedPhoneNumber":{"type":"string"},"redirect_url":{"type":"string"},"echoConnectToken":{"type":"boolean"}}}}}},"x-pozy-area":"accounts"}},"/v1/connect/whatsapp/sdk-config":{"get":{"operationId":"getWhatsAppSdkConfig","summary":"Get Embedded Signup SDK config","tags":["Connect"],"parameters":[{"name":"X-Connect-Token","in":"header","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","required":["appId","configId","branding"],"properties":{"appId":{"type":"string"},"configId":{"type":"string"},"branding":{"type":["object","null"],"properties":{"brandName":{"type":["string","null"]},"primaryColor":{"type":["string","null"]},"language":{"type":["string","null"],"enum":["en","es","pt-BR",null]}}}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"x-pozy-area":"accounts"}},"/v1/connect/discord":{"post":{"operationId":"connectDiscordChannel","summary":"Connect a Discord channel","tags":["Connect"],"responses":{"200":{"description":"Success"},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["guildId","profileId"],"properties":{"guildId":{"type":"string"},"channelId":{"type":"string"},"channelIds":{"type":"array","minItems":1,"maxItems":25,"items":{"type":"string"}},"profileId":{"type":"string"},"redirect_url":{"type":"string"}}}}}},"x-pozy-area":"accounts"}},"/v1/connect/slack":{"get":{"operationId":"listSlackChannels","summary":"List Slack channels for the channel picker","tags":["Connect"],"parameters":[{"name":"profileId","in":"query","required":true,"schema":{"type":"string"}},{"name":"pendingDataToken","in":"query","required":false,"schema":{"type":"string","minLength":16}},{"name":"accountId","in":"query","required":false,"schema":{"type":"string"}},{"name":"redirect_url","in":"query","required":false,"schema":{"type":"string","format":"uri"}},{"name":"scopes","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"oneOf":[{"type":"object","title":"Channel picker","required":["team","channels"],"properties":{"team":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":["string","null"]},"icon":{"type":["string","null"],"format":"uri"}}},"channels":{"type":"array","items":{"type":"object","required":["id","name","isPrivate","isMember"],"properties":{"id":{"type":"string"},"name":{"type":"string"},"isPrivate":{"type":"boolean"},"isMember":{"type":"boolean"}}}}}},{"type":"object","title":"Start OAuth","required":["authUrl","state"],"properties":{"authUrl":{"type":"string","format":"uri"},"state":{"type":"string"}}}]}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"x-pozy-area":"accounts"},"post":{"operationId":"connectSlackChannel","summary":"Connect a Slack channel","tags":["Connect"],"responses":{"200":{"description":"Success"},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["profileId"],"properties":{"profileId":{"type":"string"},"channelId":{"type":"string"},"channelIds":{"type":"array","minItems":1,"maxItems":25,"items":{"type":"string"}},"redirect_url":{"type":"string"},"pendingDataToken":{"type":"string"},"accountId":{"type":"string"}}}}}},"x-pozy-area":"accounts"}},"/v1/connect/telegram":{"get":{"operationId":"getTelegramConnectStatus","summary":"Generate Telegram code","tags":["Connect"],"parameters":[{"name":"profileId","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string"},"expiresAt":{"type":"string","format":"date-time"},"expiresIn":{"type":"integer"},"botUsername":{"type":"string"},"instructions":{"type":"array","items":{"type":"string"}}}}}}}},"x-pozy-area":"accounts"},"post":{"operationId":"initiateTelegramConnect","summary":"Connect Telegram directly","tags":["Connect"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"account":{"type":"object","properties":{"_id":{"type":"string"},"platform":{"type":"string","enum":["telegram"]},"username":{"type":"string"},"displayName":{"type":"string"},"isActive":{"type":"boolean"},"chatType":{"type":"string","enum":["channel","group","supergroup","private"]}}}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["chatId","profileId"],"properties":{"chatId":{"type":"string"},"profileId":{"type":"string"}}}}}},"x-pozy-area":"accounts"},"patch":{"operationId":"completeTelegramConnect","summary":"Check Telegram status","tags":["Connect"],"parameters":[{"name":"code","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"oneOf":[{"type":"object","title":"Pending","properties":{"status":{"type":"string","enum":["pending"]},"expiresAt":{"type":"string","format":"date-time"},"expiresIn":{"type":"integer"}}},{"type":"object","title":"Connected","properties":{"status":{"type":"string","enum":["connected"]},"chatId":{"type":"string"},"chatTitle":{"type":"string"},"chatType":{"type":"string","enum":["channel","group","supergroup"]},"account":{"type":"object","properties":{"_id":{"type":"string"},"platform":{"type":"string"},"username":{"type":"string"},"displayName":{"type":"string"}}}}},{"type":"object","title":"Expired","properties":{"status":{"type":"string","enum":["expired"]},"message":{"type":"string"}}}]}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"x-pozy-area":"accounts"}},"/v1/accounts/{accountId}/webhook-subscription":{"get":{"operationId":"getPageWebhookSubscription","summary":"Read a Facebook Page's webhook subscription","tags":["Connect"],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"pageId":{"type":"string"},"appSubscribed":{"type":"boolean"},"leadgen":{"type":"boolean"},"subscribedFields":{"type":"array","items":{"type":"string"}},"warning":{"type":["string","null"]}}}}}}},"x-pozy-area":"accounts"},"post":{"operationId":"resyncPageWebhookSubscription","summary":"Re-subscribe a Facebook Page to Pozy's webhooks","tags":["Connect"],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"resubscribed":{"type":"boolean"},"pageId":{"type":"string"},"appSubscribed":{"type":"boolean"},"leadgen":{"type":"boolean"},"subscribedFields":{"type":"array","items":{"type":"string"}},"warning":{"type":["string","null"]}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"x-pozy-area":"accounts"}},"/v1/accounts/{accountId}/business-partners":{"get":{"operationId":"listBusinessPartners","summary":"List partner businesses of the Page","tags":["Accounts"],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"page":{"$ref":"#/components/schemas/MetaPageOwnership"},"partners":{"type":"array","items":{"$ref":"#/components/schemas/MetaPagePartner"}}}}}}}},"x-pozy-area":"accounts"},"post":{"operationId":"grantBusinessPartner","summary":"Share the Page with a partner business","tags":["Accounts"],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"page":{"$ref":"#/components/schemas/MetaPageOwnership"},"partner":{"type":"object","properties":{"businessId":{"type":"string"},"permittedTasks":{"type":"array","items":{"type":"string"}}}},"alreadyShared":{"type":"boolean"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["businessId"],"properties":{"businessId":{"type":"string"},"permittedTasks":{"type":"array","items":{"type":"string","enum":["MANAGE","CREATE_CONTENT","MODERATE","MESSAGING","ADVERTISE","ANALYZE","MODERATE_COMMUNITY","MANAGE_JOBS","PAGES_MESSAGING","PAGES_MESSAGING_SUBSCRIPTIONS","READ_PAGE_MAILBOXES","VIEW_MONETIZATION_INSIGHTS","MANAGE_LEADS","CASHIER_ROLE","GLOBAL_STRUCTURE_MANAGEMENT","PROFILE_PLUS_FULL_CONTROL","PROFILE_PLUS_MANAGE","PROFILE_PLUS_FACEBOOK_ACCESS","PROFILE_PLUS_CREATE_CONTENT","PROFILE_PLUS_MODERATE","PROFILE_PLUS_MODERATE_DELEGATE_COMMUNITY","PROFILE_PLUS_MESSAGING","PROFILE_PLUS_ADVERTISE","PROFILE_PLUS_ANALYZE","PROFILE_PLUS_REVENUE","PROFILE_PLUS_MANAGE_LEADS","PROFILE_PLUS_CREATIVE_MANAGEMENT","PROFILE_PLUS_CREATOR_MANAGEMENT","PROFILE_PLUS_GLOBAL_STRUCTURE_MANAGEMENT"]}}}}}}},"x-pozy-area":"accounts"},"delete":{"operationId":"revokeBusinessPartner","summary":"Revoke a partner business from the Page","tags":["Accounts"],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}},{"name":"businessId","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"pageId":{"type":"string"},"businessId":{"type":"string"},"revoked":{"type":"boolean"}}}}}}},"x-pozy-area":"accounts"}},"/v1/accounts/{accountId}/facebook-page":{"get":{"operationId":"getFacebookPages","summary":"List Facebook pages","tags":["Connect"],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}},{"name":"refresh","in":"query","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"pages":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"username":{"type":"string"},"category":{"type":"string"},"fan_count":{"type":"integer"},"instagramAccount":{"type":["object","null"],"properties":{"id":{"type":"string"},"username":{"type":["string","null"]}}}}}},"selectedPageId":{"type":["string","null"]},"cached":{"type":"boolean"}}}}}}},"x-pozy-area":"accounts"},"put":{"operationId":"updateFacebookPage","summary":"Update Facebook page","tags":["Connect"],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"selectedPage":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}}}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["selectedPageId"],"properties":{"selectedPageId":{"type":"string"}}}}}},"x-pozy-area":"accounts"}},"/v1/accounts/{accountId}/facebook-page-info":{"get":{"operationId":"getFacebookPageInfo","summary":"Get a Facebook Page's public info","tags":["Account Settings"],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FacebookPageInfo"}}}}},"x-pozy-area":"accounts"},"patch":{"operationId":"updateFacebookPageInfo","summary":"Update a Facebook Page's public info","tags":["Account Settings"],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FacebookPageInfo"}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"minProperties":1,"properties":{"about":{"type":"string","maxLength":100},"description":{"type":"string"},"website":{"type":"string"},"phone":{"type":"string"},"emails":{"type":"array","items":{"type":"string","format":"email"}},"hours":{"type":"object","additionalProperties":{"type":"string","pattern":"^([01]\\d|2[0-3]):[0-5]\\d$"}}}}}}},"x-pozy-area":"accounts"}},"/v1/accounts/{accountId}/linkedin-organizations":{"get":{"operationId":"getLinkedInOrganizations","summary":"List LinkedIn orgs","tags":["Connect"],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"organizations":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"vanityName":{"type":"string"},"localizedName":{"type":"string"}}}}}}}}}},"x-pozy-area":"accounts"}},"/v1/accounts/{accountId}/linkedin-aggregate-analytics":{"get":{"operationId":"getLinkedInAggregateAnalytics","summary":"Get LinkedIn aggregate stats","tags":["Analytics"],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}},{"name":"aggregation","in":"query","required":false,"schema":{"type":"string","enum":["TOTAL","DAILY"],"default":"TOTAL"}},{"name":"fromDate","in":"query","required":false,"schema":{"type":"string","format":"date"}},{"name":"toDate","in":"query","required":false,"schema":{"type":"string","format":"date"}},{"name":"startDate","in":"query","required":false,"schema":{"type":"string","format":"date"}},{"name":"endDate","in":"query","required":false,"schema":{"type":"string","format":"date"}},{"name":"metrics","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/LinkedInAggregateAnalyticsTotalResponse"},{"$ref":"#/components/schemas/LinkedInAggregateAnalyticsDailyResponse"}]}}}}},"x-pozy-area":"analytics"}},"/v1/accounts/{accountId}/linkedin-post-analytics":{"get":{"operationId":"getLinkedInPostAnalytics","summary":"Get LinkedIn post stats","tags":["Analytics"],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}},{"name":"urn","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"accountId":{"type":"string"},"platform":{"type":"string"},"accountType":{"type":"string","enum":["personal","organization"]},"username":{"type":"string"},"postUrn":{"type":"string"},"analytics":{"type":"object","properties":{"impressions":{"type":"integer"},"reach":{"type":"integer"},"likes":{"type":"integer"},"comments":{"type":"integer"},"shares":{"type":"integer"},"saves":{"type":"integer"},"sends":{"type":"integer"},"clicks":{"type":"integer"},"views":{"type":"integer"},"engagementRate":{"type":"number"}}},"lastUpdated":{"type":"string","format":"date-time"}}}}}}},"x-pozy-area":"analytics"}},"/v1/accounts/{accountId}/linkedin-post-reactions":{"get":{"operationId":"getLinkedInPostReactions","summary":"Get LinkedIn post reactions","tags":["Analytics"],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}},{"name":"urn","in":"query","required":true,"schema":{"type":"string","pattern":"^urn:li:(share|ugcPost|activity):[0-9]+$"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":100,"default":25}},{"name":"cursor","in":"query","required":false,"schema":{"type":"integer","minimum":0,"default":0}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"accountId":{"type":"string"},"platform":{"type":"string"},"accountType":{"type":"string"},"username":{"type":"string"},"postUrn":{"type":"string"},"reactions":{"type":"array","items":{"type":"object","properties":{"reactionType":{"type":"string"},"reactionLabel":{"type":"string"},"reactedAt":{"type":"string","format":"date-time"},"from":{"type":"object","properties":{"urn":{"type":"string"},"name":{"type":"string"},"headline":{"type":"string"},"username":{"type":"string"},"profilePicture":{"type":"string"},"profileUrl":{"type":"string"}}}}}},"pagination":{"type":"object","properties":{"hasMore":{"type":"boolean"},"cursor":{"type":"string"},"total":{"type":"integer"}}},"lastUpdated":{"type":"string","format":"date-time"}}}}}}},"x-pozy-area":"analytics"}},"/v1/accounts/{accountId}/linkedin-organization":{"put":{"operationId":"updateLinkedInOrganization","summary":"Switch LinkedIn account type","tags":["Connect"],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"accountType":{"type":"string","enum":["personal","organization"]},"accountName":{"type":"string"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountType"],"properties":{"accountType":{"type":"string","enum":["personal","organization"]},"selectedOrganization":{"type":"object"}}}}}},"x-pozy-area":"accounts"}},"/v1/accounts/{accountId}/linkedin-mentions":{"get":{"operationId":"getLinkedInMentions","summary":"Resolve LinkedIn mention","tags":["LinkedIn Mentions"],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}},{"name":"url","in":"query","required":true,"schema":{"type":"string"}},{"name":"displayName","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"urn":{"type":"string"},"type":{"type":"string","enum":["person","organization"]},"displayName":{"type":"string"},"mentionFormat":{"type":"string"},"vanityName":{"type":"string"},"warning":{"type":"string"}}}}}}},"x-pozy-area":"inbox"}},"/v1/accounts/{accountId}/instagram/stories":{"get":{"operationId":"listInstagramStories","summary":"List active Instagram stories","tags":["Instagram"],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"array","items":{"type":"object","required":["id"],"properties":{"id":{"type":"string"},"mediaType":{"type":["string","null"]},"mediaProductType":{"type":["string","null"]},"mediaUrl":{"type":["string","null"]},"permalink":{"type":["string","null"]},"thumbnailUrl":{"type":["string","null"]},"timestamp":{"type":["string","null"],"format":"date-time"}}}}}}}}}},"x-pozy-area":"inbox"}},"/v1/accounts/{accountId}/instagram/publishing-limit":{"get":{"operationId":"getInstagramPublishingLimit","summary":"Get Instagram publishing limit","tags":["Instagram"],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"quotaUsage":{"type":"integer"},"quotaTotal":{"type":"integer"},"quotaDurationSeconds":{"type":"integer"}}}}}}},"x-pozy-area":"inbox"}},"/v1/accounts/{accountId}/instagram/audio":{"get":{"operationId":"searchInstagramAudio","summary":"Search Instagram audio","tags":["Instagram"],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}},{"name":"audioType","in":"query","required":true,"schema":{"type":"string","enum":["music","original_sound"]}},{"name":"q","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":200}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"audio":{"type":"array","items":{"$ref":"#/components/schemas/InstagramAudioAsset"}}}}}}}},"x-pozy-area":"inbox"}},"/v1/accounts/{accountId}/instagram/audio/{audioId}":{"get":{"operationId":"getInstagramAudio","summary":"Get Instagram audio metadata","tags":["Instagram"],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}},{"name":"audioId","in":"path","required":true,"schema":{"type":"string","pattern":"^\\d{1,30}$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"audio":{"$ref":"#/components/schemas/InstagramAudioAsset"}}}}}}},"x-pozy-area":"inbox"}},"/v1/accounts/{accountId}/instagram/business-discovery":{"get":{"operationId":"getInstagramBusinessDiscovery","summary":"Look up a public Instagram Business account","tags":["Instagram"],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}},{"name":"username","in":"query","required":true,"schema":{"type":"string","maxLength":31}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":25,"default":12}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InstagramBusinessDiscovery"}}}}},"x-pozy-area":"inbox"}},"/v1/accounts/{accountId}/instagram/media/{mediaId}/collaborators":{"get":{"operationId":"listInstagramMediaCollaborators","summary":"List the collaborators of an Instagram post","tags":["Instagram"],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}},{"name":"mediaId","in":"path","required":true,"schema":{"type":"string","pattern":"^[0-9]+$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"array","maxItems":5,"items":{"$ref":"#/components/schemas/InstagramMediaCollaborator"}}}}}}}},"x-pozy-area":"inbox"}},"/v1/accounts/{accountId}/instagram/live-media":{"get":{"operationId":"listInstagramLiveMedia","summary":"List the live broadcasts of an Instagram account","tags":["Instagram"],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/InstagramLiveMedia"}}}}}}}},"x-pozy-area":"inbox"}},"/v1/accounts/{accountId}/instagram/tags":{"get":{"operationId":"listInstagramTaggedMedia","summary":"List the posts an Instagram account is tagged in","tags":["Instagram"],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":50,"default":25}},{"name":"cursor","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":1000}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","required":["data","nextCursor"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/InstagramTaggedMedia"}},"nextCursor":{"type":["string","null"]}}}}}}},"x-pozy-area":"inbox"}},"/v1/accounts/{accountId}/instagram/mentions/media/{mediaId}":{"get":{"operationId":"getInstagramMentionedMedia","summary":"Get a post that mentions an Instagram account in its caption","tags":["Instagram"],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}},{"name":"mediaId","in":"path","required":true,"schema":{"type":"string","pattern":"^[0-9]+$","maxLength":32}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InstagramMentionedMedia"}}}}},"x-pozy-area":"inbox"}},"/v1/accounts/{accountId}/instagram/mentions/comments/{commentId}":{"get":{"operationId":"getInstagramMentionedComment","summary":"Get a comment that mentions an Instagram account","tags":["Instagram"],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}},{"name":"commentId","in":"path","required":true,"schema":{"type":"string","pattern":"^[0-9]+$","maxLength":32}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InstagramMentionedComment"}}}}},"x-pozy-area":"inbox"}},"/v1/accounts/{accountId}/instagram/stories/{storyId}/insights":{"get":{"operationId":"getInstagramStoryInsights","summary":"Get Instagram story insights","tags":["Instagram"],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}},{"name":"storyId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["source","metrics"],"properties":{"source":{"type":"string","enum":["live","cached","unavailable"]},"metrics":{"type":"object","required":["views","reach","replies","shares","navigation","tapsForward","tapsBack","exits","swipesForward","profileVisits","follows","reposts","totalInteractions"],"properties":{"views":{"type":"integer"},"reach":{"type":"integer"},"replies":{"type":"integer"},"shares":{"type":"integer"},"navigation":{"type":"integer"},"tapsForward":{"type":"integer"},"tapsBack":{"type":"integer"},"exits":{"type":"integer"},"swipesForward":{"type":"integer"},"profileVisits":{"type":"integer"},"follows":{"type":"integer"},"reposts":{"type":"integer"},"totalInteractions":{"type":"integer"}}}}}}}}}}},"x-pozy-area":"inbox"}},"/v1/accounts/{accountId}/pinterest-boards":{"get":{"operationId":"getPinterestBoards","summary":"List Pinterest boards","tags":["Connect"],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"boards":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"privacy":{"type":"string"}}}}}}}}}},"x-pozy-area":"accounts"},"post":{"operationId":"createPinterestBoard","summary":"Create Pinterest board","tags":["Connect"],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"board":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"privacy":{"type":"string"},"url":{"type":"string"}}}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["name"],"properties":{"name":{"type":"string"},"description":{"type":"string"},"privacy":{"type":"string","enum":["PUBLIC","PROTECTED","SECRET"],"default":"PUBLIC"}}}}}},"x-pozy-area":"accounts"},"put":{"operationId":"updatePinterestBoards","summary":"Set default Pinterest board","tags":["Connect"],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"account":{"$ref":"#/components/schemas/SocialAccount"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["defaultBoardId"],"properties":{"defaultBoardId":{"type":"string"},"defaultBoardName":{"type":"string"}}}}}},"x-pozy-area":"accounts"}},"/v1/accounts/{accountId}/youtube-captions":{"get":{"operationId":"getYoutubeCaptions","summary":"Get a YouTube video transcript","tags":["Connect"],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}},{"name":"videoId","in":"query","required":true,"schema":{"type":"string"}},{"name":"language","in":"query","required":false,"schema":{"type":"string"}},{"name":"format","in":"query","required":false,"schema":{"type":"string","enum":["json","srt"],"default":"json"}},{"name":"refresh","in":"query","required":false,"schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"accountId":{"type":"string"},"videoId":{"type":"string"},"language":{"type":"string"},"trackId":{"type":"string"},"trackKind":{"type":"string","enum":["asr","standard"]},"source":{"type":"string","enum":["cache","youtube"]},"fetchedAt":{"type":"string","format":"date-time"},"text":{"type":"string"},"cues":{"type":"array","items":{"type":"object","properties":{"start":{"type":"number"},"end":{"type":"number"},"text":{"type":"string"}}}},"srt":{"type":"string"},"availableTracks":{"type":"array","items":{"type":"object","properties":{"trackId":{"type":"string"},"language":{"type":"string"},"trackKind":{"type":"string","enum":["asr","standard"]},"name":{"type":"string"}}}}}}}}}},"x-pozy-area":"accounts"}},"/v1/accounts/{accountId}/youtube-playlists":{"get":{"operationId":"getYoutubePlaylists","summary":"List YouTube playlists","tags":["Connect"],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"playlists":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"title":{"type":"string"},"description":{"type":"string"},"privacy":{"type":"string","enum":["public","private","unlisted"]},"itemCount":{"type":"integer"},"thumbnailUrl":{"type":"string"}}}},"defaultPlaylistId":{"type":["string","null"]}}}}}}},"x-pozy-area":"accounts"},"post":{"operationId":"createYoutubePlaylist","summary":"Create YouTube playlist","tags":["Connect"],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"type":"object","required":["playlist"],"properties":{"playlist":{"type":"object","required":["id","title","description","privacy","itemCount","thumbnailUrl"],"properties":{"id":{"type":"string"},"title":{"type":"string"},"description":{"type":"string"},"privacy":{"type":"string","enum":["private","public","unlisted"]},"itemCount":{"type":"integer"},"thumbnailUrl":{"type":"string"}}}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["title"],"properties":{"title":{"type":"string","minLength":1},"description":{"type":"string"},"privacy":{"type":"string","enum":["private","public","unlisted"],"default":"private"}}}}}},"x-pozy-area":"accounts"},"put":{"operationId":"updateYoutubeDefaultPlaylist","summary":"Set default YouTube playlist","tags":["Connect"],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["defaultPlaylistId"],"properties":{"defaultPlaylistId":{"type":"string","minLength":1},"defaultPlaylistName":{"type":"string"}}}}}},"x-pozy-area":"accounts"}},"/v1/accounts/{accountId}/gmb-locations":{"get":{"operationId":"getGmbLocations","summary":"List Google Business Profile locations","tags":["Connect"],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}},{"name":"search","in":"query","required":false,"schema":{"type":"string"}},{"name":"filter","in":"query","required":false,"schema":{"type":"string"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":500,"default":100}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"locations":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"accountId":{"type":"string"},"accountName":{"type":"string"},"address":{"type":"string"},"category":{"type":"string"},"websiteUrl":{"type":"string"},"storeCode":{"type":"string"}}}},"hasMore":{"type":"boolean"},"selectedLocationId":{"type":"string"},"cached":{"type":"boolean"}}}}}}},"x-pozy-area":"accounts"},"put":{"operationId":"updateGmbLocation","summary":"Update Google Business Profile location","tags":["Connect"],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"selectedLocation":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}}}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["selectedLocationId"],"properties":{"selectedLocationId":{"type":"string","minLength":1},"googleAccountId":{"type":"string","minLength":1}}}}}},"x-pozy-area":"accounts"}},"/v1/accounts/{accountId}/gmb-locations/assign":{"post":{"operationId":"assignGoogleBusinessLocation","summary":"Assign Google Business Profile location to another profile","tags":["Connect"],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"account":{"type":"object","properties":{"accountId":{"type":"string"},"platform":{"type":"string"},"username":{"type":"string"},"displayName":{"type":"string"},"isActive":{"type":"boolean"},"selectedLocationName":{"type":"string"},"selectedLocationId":{"type":"string"}}}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["profileId","selectedLocationId"],"properties":{"profileId":{"type":"string"},"selectedLocationId":{"type":"string"},"googleAccountId":{"type":"string"}}}}}},"x-pozy-area":"accounts"}},"/v1/accounts/{accountId}/facebook-post-reactions":{"get":{"operationId":"getFacebookPostReactions","summary":"Get Facebook post reactions","tags":["Analytics"],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}},{"name":"postId","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"accountId":{"type":"string"},"platform":{"type":"string"},"username":{"type":"string"},"postId":{"type":"string"},"total":{"type":"integer"},"breakdown":{"type":"object","properties":{"like":{"type":"integer"},"love":{"type":"integer"},"haha":{"type":"integer"},"wow":{"type":"integer"},"sad":{"type":"integer"},"angry":{"type":"integer"},"care":{"type":"integer"}}},"lastUpdated":{"type":"string","format":"date-time"}}}}}}},"x-pozy-area":"analytics"}},"/v1/accounts/{accountId}/facebook-visitor-posts":{"get":{"operationId":"listFacebookVisitorPosts","summary":"List visitor posts on a Facebook Page","tags":["Analytics"],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":100,"default":25}},{"name":"cursor","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":4096}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","required":["data","nextCursor"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/FacebookVisitorPost"}},"nextCursor":{"type":["string","null"]}}}}}}},"x-pozy-area":"analytics"}},"/v1/accounts/{accountId}/facebook-tagged-posts":{"get":{"operationId":"listFacebookTaggedPosts","summary":"List the posts a Facebook Page is tagged in","tags":["Analytics"],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":50,"default":25}},{"name":"cursor","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":1000}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","required":["data","nextCursor"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/FacebookTaggedPost"}},"nextCursor":{"type":["string","null"]}}}}}}},"x-pozy-area":"analytics"}},"/v1/accounts/{accountId}/reddit-subreddits":{"get":{"operationId":"getRedditSubreddits","summary":"List Reddit subreddits","tags":["Connect"],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"subreddits":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"title":{"type":"string"},"url":{"type":"string"},"over18":{"type":"boolean"}}}},"defaultSubreddit":{"type":"string"}}}}}}},"x-pozy-area":"accounts"},"put":{"operationId":"updateRedditSubreddits","summary":"Set default subreddit","tags":["Connect"],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["defaultSubreddit"],"properties":{"defaultSubreddit":{"type":"string","minLength":1}}}}}},"x-pozy-area":"accounts"}},"/v1/accounts/{accountId}/reddit-subreddits/{subreddit}/rules":{"get":{"operationId":"getSubredditRules","summary":"Get subreddit rules","tags":["Connect"],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}},{"name":"subreddit","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"rules":{"type":"array","items":{"type":"object","properties":{"kind":{"type":"string"},"shortName":{"type":"string"},"description":{"type":"string"},"violationReason":{"type":"string"},"createdUtc":{"type":"number"},"priority":{"type":"integer"}}}},"siteRules":{"type":"array","items":{"type":"string"}}}}}}}},"x-pozy-area":"accounts"}},"/v1/accounts/{accountId}/reddit-vote":{"post":{"operationId":"voteRedditThing","summary":"Vote on a Reddit post or comment","tags":["Connect"],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["thingId","direction"],"properties":{"thingId":{"type":"string"},"direction":{"type":"integer","enum":[1,0,-1]}}}}}},"x-pozy-area":"accounts"}},"/v1/accounts/{accountId}/reddit-flairs":{"get":{"operationId":"getRedditFlairs","summary":"List subreddit flairs","tags":["Connect"],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}},{"name":"subreddit","in":"query","required":true,"schema":{"type":"string","minLength":1}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"flairs":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"text":{"type":"string"},"textColor":{"type":"string"},"backgroundColor":{"type":"string"}}}}}}}}}},"x-pozy-area":"accounts"},"post":{"operationId":"setRedditPostFlair","summary":"Set Reddit post flair","tags":["Connect"],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["subreddit","postId","flairTemplateId"],"properties":{"subreddit":{"type":"string","minLength":1},"postId":{"type":"string","minLength":1},"flairTemplateId":{"type":"string","minLength":1},"text":{"type":"string"}}}}}},"x-pozy-area":"accounts"}},"/v1/accounts/{accountId}/hubspot-settings":{"get":{"operationId":"getHubSpotSettings","summary":"Get HubSpot account settings","tags":["Accounts"],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"account":{"$ref":"#/components/schemas/HubSpotSettings"}}}}}}},"x-pozy-area":"accounts"},"patch":{"operationId":"updateHubSpotSettings","summary":"Update HubSpot account settings","tags":["Accounts"],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"account":{"$ref":"#/components/schemas/HubSpotSettings"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"syncContacts":{"type":"boolean"},"logMessages":{"type":"boolean"},"reportDeals":{"type":"boolean"}}}}}},"x-pozy-area":"accounts"}},"/v1/accounts/{accountId}/slack-settings":{"get":{"operationId":"getSlackSettings","summary":"Get Slack account settings","tags":["Accounts"],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"account":{"type":"object","properties":{"_id":{"type":"string"},"platform":{"type":"string"},"displayName":{"type":["string","null"]},"channelId":{"type":["string","null"]},"channelName":{"type":["string","null"]},"channelType":{"type":["string","null"]},"teamId":{"type":["string","null"]},"teamName":{"type":["string","null"]},"defaultUsername":{"type":["string","null"]},"defaultIconUrl":{"type":["string","null"]}}}}}}}}},"x-pozy-area":"accounts"},"patch":{"operationId":"updateSlackSettings","summary":"Update Slack account settings","tags":["Accounts"],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"defaultUsername":{"type":"string","maxLength":80},"defaultIconUrl":{"type":"string"},"applyToWorkspace":{"type":"boolean","default":false}}}}}},"x-pozy-area":"accounts"}},"/v1/accounts/{accountId}/bluesky-settings":{"get":{"operationId":"getBlueskySettings","summary":"Get Bluesky account settings","tags":["Accounts"],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"defaultLangs":{"type":["array","null"],"items":{"type":"string"}}}}}}}},"x-pozy-area":"accounts"},"patch":{"operationId":"updateBlueskySettings","summary":"Update Bluesky account settings","tags":["Accounts"],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["defaultLangs"],"properties":{"defaultLangs":{"type":["array","null"],"minItems":1,"maxItems":3,"items":{"type":"string"}}}}}}},"x-pozy-area":"accounts"}},"/v1/accounts/{accountId}/discord-settings":{"get":{"operationId":"getDiscordSettings","summary":"Get Discord account settings","tags":["Discord"],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"account":{"type":"object","properties":{"_id":{"type":"string"},"platform":{"type":"string"},"username":{"type":"string"},"displayName":{"type":"string"},"profilePicture":{"type":"string"},"channelId":{"type":"string"},"channelName":{"type":"string"},"channelType":{"type":"string"},"guildId":{"type":"string"},"webhookUsername":{"type":["string","null"]},"webhookAvatarUrl":{"type":["string","null"]}}}}}}}}},"x-pozy-area":"messaging"},"patch":{"operationId":"updateDiscordSettings","summary":"Update Discord settings","tags":["Discord"],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"account":{"type":"object","properties":{"_id":{"type":"string"},"platform":{"type":"string"},"username":{"type":"string"},"displayName":{"type":"string"},"profilePicture":{"type":"string"},"channelId":{"type":"string"},"channelName":{"type":"string"},"channelType":{"type":"string"},"guildId":{"type":"string"},"webhookUsername":{"type":["string","null"]},"webhookAvatarUrl":{"type":["string","null"]}}}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"webhookUsername":{"type":"string"},"webhookAvatarUrl":{"type":"string"},"channelId":{"type":"string"}}}}}},"x-pozy-area":"messaging"}},"/v1/accounts/{accountId}/discord-channels":{"get":{"operationId":"getDiscordChannels","summary":"List Discord guild channels","tags":["Discord"],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"channels":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"type":{"type":"integer"}}}}}}}}}},"x-pozy-area":"messaging"}},"/v1/accounts/{accountId}/slack-members":{"get":{"operationId":"listSlackMembers","summary":"List Slack workspace members","tags":["Slack"],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}},{"name":"query","in":"query","required":false,"schema":{"type":"string","maxLength":100}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":2000,"default":50}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"members":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"username":{"type":["string","null"]},"picture":{"type":["string","null"]}}}}}}}}}},"x-pozy-area":"messaging"}},"/v1/discord/dms":{"post":{"operationId":"sendDiscordDirectMessage","summary":"Send a Discord Direct Message","tags":["Discord"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"messageId":{"type":"string"},"channelId":{"type":"string"},"url":{"type":"string"},"timestamp":{"type":"string","format":"date-time"},"recipient":{"type":"object","properties":{"userId":{"type":"string"},"platform":{"type":"string"}}},"account":{"type":"object","properties":{"id":{"type":"string"},"username":{"type":"string"},"displayName":{"type":"string"}}}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","userId"],"properties":{"accountId":{"type":"string"},"userId":{"type":"string"},"content":{"type":"string","maxLength":2000},"embeds":{"type":"array","maxItems":10,"items":{"type":"object"}},"attachments":{"type":"array","maxItems":10,"items":{"type":"object","required":["type","url"],"properties":{"type":{"type":"string","enum":["image","video","gif","document"]},"url":{"type":"string","format":"uri"},"filename":{"type":"string"},"mimeType":{"type":"string"},"size":{"type":"integer"}}}},"tts":{"type":"boolean"}}}}}},"x-pozy-area":"messaging"}},"/v1/discord/guilds/{guildId}/roles":{"get":{"operationId":"listDiscordGuildRoles","summary":"List Discord guild roles","tags":["Discord"],"parameters":[{"name":"guildId","in":"path","required":true,"schema":{"type":"string"}},{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"color":{"type":"integer"},"position":{"type":"integer"},"permissions":{"type":"string"},"managed":{"type":"boolean"},"mentionable":{"type":"boolean"},"hoist":{"type":"boolean"}}}}}}}}}},"x-pozy-area":"messaging"},"post":{"operationId":"createDiscordGuildRole","summary":"Create a Discord guild role","tags":["Discord"],"parameters":[{"name":"guildId","in":"path","required":true,"schema":{"type":"string"}},{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/DiscordRole"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["name"],"properties":{"name":{"type":"string","minLength":1,"maxLength":100},"color":{"type":"integer","minimum":0,"maximum":16777215},"hoist":{"type":"boolean"},"mentionable":{"type":"boolean"},"permissions":{"type":"string"}}}}}},"x-pozy-area":"messaging"}},"/v1/discord/guilds/{guildId}/roles/{roleId}":{"patch":{"operationId":"editDiscordGuildRole","summary":"Edit a Discord guild role","tags":["Discord"],"parameters":[{"name":"guildId","in":"path","required":true,"schema":{"type":"string"}},{"name":"roleId","in":"path","required":true,"schema":{"type":"string"}},{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/DiscordRole"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","minProperties":1,"properties":{"name":{"type":"string","minLength":1,"maxLength":100},"color":{"type":"integer","minimum":0,"maximum":16777215},"hoist":{"type":"boolean"},"mentionable":{"type":"boolean"},"permissions":{"type":"string"}}}}}},"x-pozy-area":"messaging"},"delete":{"operationId":"deleteDiscordGuildRole","summary":"Delete a Discord guild role","tags":["Discord"],"parameters":[{"name":"guildId","in":"path","required":true,"schema":{"type":"string"}},{"name":"roleId","in":"path","required":true,"schema":{"type":"string"}},{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"}}}}}}},"x-pozy-area":"messaging"}},"/v1/discord/guilds/{guildId}/members":{"get":{"operationId":"listDiscordGuildMembers","summary":"List Discord guild members","tags":["Discord"],"parameters":[{"name":"guildId","in":"path","required":true,"schema":{"type":"string"}},{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":1000,"default":100}},{"name":"after","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/DiscordGuildMember"}},"pagination":{"type":"object","properties":{"nextCursor":{"type":["string","null"]},"hasMore":{"type":"boolean"}}}}}}}}},"x-pozy-area":"messaging"}},"/v1/discord/guilds/{guildId}/members/search":{"get":{"operationId":"searchDiscordGuildMembers","summary":"Search Discord guild members","tags":["Discord"],"parameters":[{"name":"guildId","in":"path","required":true,"schema":{"type":"string"}},{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}},{"name":"query","in":"query","required":true,"schema":{"type":"string","minLength":1,"maxLength":100}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":1000,"default":25}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/DiscordGuildMember"}}}}}}}},"x-pozy-area":"messaging"}},"/v1/discord/guilds/{guildId}/members/{userId}":{"get":{"operationId":"getDiscordGuildMember","summary":"Get a Discord guild member","tags":["Discord"],"parameters":[{"name":"guildId","in":"path","required":true,"schema":{"type":"string"}},{"name":"userId","in":"path","required":true,"schema":{"type":"string"}},{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/DiscordGuildMember"}}}}}}},"x-pozy-area":"messaging"}},"/v1/discord/guilds/{guildId}/members/{userId}/roles/{roleId}":{"put":{"operationId":"addDiscordMemberRole","summary":"Assign a role to a guild member","tags":["Discord"],"parameters":[{"name":"guildId","in":"path","required":true,"schema":{"type":"string"}},{"name":"userId","in":"path","required":true,"schema":{"type":"string"}},{"name":"roleId","in":"path","required":true,"schema":{"type":"string"}},{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"operation":{"type":"string","enum":["role_assigned"]},"guildId":{"type":"string"},"userId":{"type":"string"},"roleId":{"type":"string"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"x-pozy-area":"messaging"},"delete":{"operationId":"removeDiscordMemberRole","summary":"Remove a role from a guild member","tags":["Discord"],"parameters":[{"name":"guildId","in":"path","required":true,"schema":{"type":"string"}},{"name":"userId","in":"path","required":true,"schema":{"type":"string"}},{"name":"roleId","in":"path","required":true,"schema":{"type":"string"}},{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"operation":{"type":"string","enum":["role_removed"]},"guildId":{"type":"string"},"userId":{"type":"string"},"roleId":{"type":"string"}}}}}}},"x-pozy-area":"messaging"}},"/v1/discord/channels/{channelId}/messages/{messageId}":{"delete":{"operationId":"deleteDiscordMessage","summary":"Delete a Discord channel message","tags":["Discord"],"parameters":[{"name":"channelId","in":"path","required":true,"schema":{"type":"string"}},{"name":"messageId","in":"path","required":true,"schema":{"type":"string"}},{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"}}}}}}},"x-pozy-area":"messaging"}},"/v1/discord/channels/{channelId}/messages/{messageId}/crosspost":{"post":{"operationId":"crosspostDiscordMessage","summary":"Crosspost Discord message","tags":["Discord"],"parameters":[{"name":"channelId","in":"path","required":true,"schema":{"type":"string"}},{"name":"messageId","in":"path","required":true,"schema":{"type":"string"}},{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"x-pozy-area":"messaging"}},"/v1/discord/channels/{channelId}/threads":{"post":{"operationId":"createDiscordThread","summary":"Create a Discord public thread","tags":["Discord"],"parameters":[{"name":"channelId","in":"path","required":true,"schema":{"type":"string"}},{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}}}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["name"],"properties":{"name":{"type":"string","minLength":1,"maxLength":100},"messageId":{"type":"string"},"autoArchiveDuration":{"type":"integer","enum":[60,1440,4320,10080]}}}}}},"x-pozy-area":"messaging"}},"/v1/discord/channels/{channelId}/pins":{"get":{"operationId":"listDiscordPinnedMessages","summary":"List pinned messages","tags":["Discord"],"parameters":[{"name":"channelId","in":"path","required":true,"schema":{"type":"string"}},{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"channel_id":{"type":"string"},"content":{"type":"string"},"timestamp":{"type":"string","format":"date-time"},"author":{"type":"object"},"attachments":{"type":"array","items":{"type":"object"}},"embeds":{"type":"array","items":{"type":"object"}}}}}}}}}}},"x-pozy-area":"messaging"}},"/v1/discord/channels/{channelId}/pins/{messageId}":{"put":{"operationId":"pinDiscordMessage","summary":"Pin a Discord message","tags":["Discord"],"parameters":[{"name":"channelId","in":"path","required":true,"schema":{"type":"string"}},{"name":"messageId","in":"path","required":true,"schema":{"type":"string"}},{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"operation":{"type":"string","enum":["message_pinned"]},"channelId":{"type":"string"},"messageId":{"type":"string"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"x-pozy-area":"messaging"},"delete":{"operationId":"unpinDiscordMessage","summary":"Unpin a Discord message","tags":["Discord"],"parameters":[{"name":"channelId","in":"path","required":true,"schema":{"type":"string"}},{"name":"messageId","in":"path","required":true,"schema":{"type":"string"}},{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"operation":{"type":"string","enum":["message_unpinned"]},"channelId":{"type":"string"},"messageId":{"type":"string"}}}}}}},"x-pozy-area":"messaging"}},"/v1/discord/guilds/{guildId}/events":{"get":{"operationId":"listDiscordScheduledEvents","summary":"List Discord scheduled events","tags":["Discord"],"parameters":[{"name":"guildId","in":"path","required":true,"schema":{"type":"string"}},{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}},{"name":"withUserCount","in":"query","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/DiscordScheduledEvent"}}}}}}}},"x-pozy-area":"messaging"},"post":{"operationId":"createDiscordScheduledEvent","summary":"Create a Discord scheduled event","tags":["Discord"],"parameters":[{"name":"guildId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/DiscordScheduledEvent"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","name","startsAt","entity"],"properties":{"accountId":{"type":"string"},"name":{"type":"string","minLength":1,"maxLength":100},"description":{"type":"string","maxLength":1000},"startsAt":{"type":"string","format":"date-time"},"entity":{"oneOf":[{"type":"object","required":["type","location","endsAt"],"properties":{"type":{"type":"string","enum":["external"]},"location":{"type":"string","minLength":1,"maxLength":100},"endsAt":{"type":"string","format":"date-time"}}},{"type":"object","required":["type","channelId"],"properties":{"type":{"type":"string","enum":["voice"]},"channelId":{"type":"string"},"endsAt":{"type":"string","format":"date-time"}}},{"type":"object","required":["type","channelId"],"properties":{"type":{"type":"string","enum":["stage"]},"channelId":{"type":"string"},"endsAt":{"type":"string","format":"date-time"}}}]},"imageDataUri":{"type":"string","pattern":"^data:image/(png|jpeg|gif);base64,"}}}}}},"x-pozy-area":"messaging"}},"/v1/discord/guilds/{guildId}/events/{eventId}":{"get":{"operationId":"getDiscordScheduledEvent","summary":"Get a Discord scheduled event","tags":["Discord"],"parameters":[{"name":"guildId","in":"path","required":true,"schema":{"type":"string"}},{"name":"eventId","in":"path","required":true,"schema":{"type":"string"}},{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/DiscordScheduledEvent"}}}}}}},"x-pozy-area":"messaging"},"patch":{"operationId":"updateDiscordScheduledEvent","summary":"Update a Discord scheduled event","tags":["Discord"],"parameters":[{"name":"guildId","in":"path","required":true,"schema":{"type":"string"}},{"name":"eventId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/DiscordScheduledEvent"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId"],"properties":{"accountId":{"type":"string"},"name":{"type":"string","minLength":1,"maxLength":100},"description":{"type":"string","maxLength":1000},"startsAt":{"type":"string","format":"date-time"},"endsAt":{"type":"string","format":"date-time"},"location":{"type":"string","minLength":1,"maxLength":100},"status":{"type":"string","enum":["scheduled","active","completed","cancelled"]},"imageDataUri":{"type":"string","pattern":"^data:image/(png|jpeg|gif);base64,"}}}}}},"x-pozy-area":"messaging"},"delete":{"operationId":"deleteDiscordScheduledEvent","summary":"Delete a Discord scheduled event","tags":["Discord"],"parameters":[{"name":"guildId","in":"path","required":true,"schema":{"type":"string"}},{"name":"eventId","in":"path","required":true,"schema":{"type":"string"}},{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"deleted":{"type":"string"}}}}}}},"x-pozy-area":"messaging"}},"/v1/queue/slots":{"get":{"operationId":"listQueueSlots","summary":"List schedules","tags":["Queue"],"parameters":[{"name":"profileId","in":"query","required":true,"schema":{"type":"string"}},{"name":"queueId","in":"query","required":false,"schema":{"type":"string"}},{"name":"all","in":"query","required":false,"schema":{"type":"string","enum":["true","false"]}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/QueueSlotsResponse"},{"type":"object","properties":{"queues":{"type":"array","items":{"$ref":"#/components/schemas/QueueSchedule"}},"count":{"type":"integer"}}}]}}}}},"x-pozy-area":"publishing"},"post":{"operationId":"createQueueSlot","summary":"Create schedule","tags":["Queue"],"responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"schedule":{"$ref":"#/components/schemas/QueueSchedule"},"nextSlots":{"type":"array","items":{"type":"string","format":"date-time"}}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["profileId","name","timezone","slots"],"properties":{"profileId":{"type":"string"},"name":{"type":"string"},"timezone":{"type":"string"},"slots":{"type":"array","items":{"$ref":"#/components/schemas/QueueSlot"}},"active":{"type":"boolean","default":true}}}}}},"x-pozy-area":"publishing"},"put":{"operationId":"updateQueueSlot","summary":"Update schedule","tags":["Queue"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueueUpdateResponse"}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["profileId","timezone","slots"],"properties":{"profileId":{"type":"string"},"queueId":{"type":"string"},"name":{"type":"string"},"timezone":{"type":"string"},"slots":{"type":"array","items":{"$ref":"#/components/schemas/QueueSlot"}},"active":{"type":"boolean","default":true},"setAsDefault":{"type":"boolean"},"reshuffleExisting":{"type":"boolean","default":false}}}}}},"x-pozy-area":"publishing"},"delete":{"operationId":"deleteQueueSlot","summary":"Delete schedule","tags":["Queue"],"parameters":[{"name":"profileId","in":"query","required":true,"schema":{"type":"string"}},{"name":"queueId","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueueDeleteResponse"}}}}},"x-pozy-area":"publishing"}},"/v1/queue/preview":{"get":{"operationId":"previewQueue","summary":"Preview upcoming slots","tags":["Queue"],"parameters":[{"name":"profileId","in":"query","required":true,"schema":{"type":"string"}},{"name":"queueId","in":"query","required":false,"schema":{"type":"string"}},{"name":"count","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":100,"default":20}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueuePreviewResponse"}}}}},"x-pozy-area":"publishing"}},"/v1/queue/next-slot":{"get":{"operationId":"getNextQueueSlot","summary":"Get next available slot","tags":["Queue"],"parameters":[{"name":"profileId","in":"query","required":true,"schema":{"type":"string"}},{"name":"queueId","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueueNextSlotResponse"}}}}},"x-pozy-area":"publishing"}},"/v1/webhooks/settings":{"get":{"operationId":"getWebhookSettings","summary":"List webhooks","tags":["Webhooks"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"webhooks":{"type":"array","items":{"$ref":"#/components/schemas/Webhook"}}}}}}}},"x-pozy-area":"workspace"},"post":{"operationId":"createWebhookSettings","summary":"Create webhook","tags":["Webhooks"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"webhook":{"$ref":"#/components/schemas/Webhook"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["name","url","events"],"properties":{"name":{"type":"string","minLength":1,"maxLength":50},"url":{"type":"string","format":"uri"},"secret":{"type":"string"},"events":{"type":"array","minItems":1,"items":{"type":"string","enum":["post.scheduled","post.published","post.failed","post.partial","post.cancelled","post.recycled","post.platform.published","post.platform.failed","post.platform.deleted","post.tiktok.url_resolved","post.external.created","post.external.updated","post.external.deleted","account.connected","account.disconnected","account.permissions_changed","account.ads.initial_sync_completed","account.ads.sync_failed","account.ads.sync_recovered","analytics.synced","post.tracking_completed","post.authenticity_changed","message.received","conversation.started","conversation.control_changed","call.received","call.ended","call.failed","call.permission_request","message.sent","message.edited","message.deleted","message.delivered","message.read","message.played","message.failed","reaction.received","referral.received","comment.received","review.new","review.updated","review.deleted","review.restored","lead.received","ad.status_changed","ad.review.approved","ad.review.rejected","ad.delivery_issue","campaign.budget.depleted","ad_account.status_changed","ad.video.processed","ad_rule.triggered","whatsapp.template.status_updated","whatsapp.template.category_updated","whatsapp.account.name_status_updated","whatsapp.account.quality_updated","whatsapp.account.status_updated","whatsapp.account.alert_received","whatsapp.contact.identity_changed","whatsapp.automatic_event","whatsapp.number.activated","whatsapp.number.declined","whatsapp.number.action_required","whatsapp.number.verification_required","whatsapp.number.suspended","whatsapp.number.reactivated","whatsapp.number.released","whatsapp.number.kyc_submitted","phone_number.stock_available","verification.approved","verification.failed","api.changelog.published","sms.registration.action_required","sms.registration.status_updated","branded_calling.identity.status_updated","branded_calling.identity.action_required","branded_calling.number.status_updated","rcs.agent.status_updated","commerce.product.created","commerce.product.updated","commerce.product.deleted","commerce.order.created","commerce.order.updated","commerce.order.refunded","contact.tag_added","contact.tag_removed","contact.field_changed","sequence.enrolled","sequence.exited","workflow.run.started","workflow.run.completed","workflow.run.failed","support.run.completed","support.run.failed","campaign_submission.received","campaign_submission.flagged","campaign_submission.pending_review","campaign_submission.approved","campaign_submission.rejected","creator_campaign.budget_exhausted","creator_campaign.closed","campaign_payout.payable","campaign_payout.settled","campaign_payout.failed","campaign_participant.joined","campaign_participant.suspended","campaign_participant.removed"]}},"isActive":{"type":"boolean","default":true},"customHeaders":{"type":"object","additionalProperties":{"type":"string"}},"disabledResourceGroups":{"type":"array","items":{"type":"string","enum":["publishing","engagement","messages","contacts","analytics","ads","telephony","accounts","billing","webhooks","commerce","creator_campaigns","money","calendar","files"]}},"profileIds":{"type":"array","maxItems":50,"items":{"type":"string"}},"accountIds":{"type":"array","maxItems":50,"items":{"type":"string"}}}}}}},"x-pozy-area":"workspace"},"put":{"operationId":"updateWebhookSettings","summary":"Update webhook","tags":["Webhooks"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"webhook":{"$ref":"#/components/schemas/Webhook"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"webhookId":{"type":"string"},"_id":{"type":"string","deprecated":true},"name":{"type":"string","minLength":1,"maxLength":50},"url":{"type":"string","format":"uri"},"secret":{"type":"string"},"events":{"type":"array","minItems":1,"items":{"type":"string","enum":["post.scheduled","post.published","post.failed","post.partial","post.cancelled","post.recycled","post.platform.published","post.platform.failed","post.platform.deleted","post.tiktok.url_resolved","post.external.created","post.external.updated","post.external.deleted","account.connected","account.disconnected","account.permissions_changed","account.ads.initial_sync_completed","account.ads.sync_failed","account.ads.sync_recovered","analytics.synced","post.tracking_completed","post.authenticity_changed","message.received","conversation.started","conversation.control_changed","call.received","call.ended","call.failed","call.permission_request","message.sent","message.edited","message.deleted","message.delivered","message.read","message.played","message.failed","reaction.received","referral.received","comment.received","review.new","review.updated","review.deleted","review.restored","lead.received","ad.status_changed","ad.review.approved","ad.review.rejected","ad.delivery_issue","campaign.budget.depleted","ad_account.status_changed","ad.video.processed","ad_rule.triggered","whatsapp.template.status_updated","whatsapp.template.category_updated","whatsapp.account.name_status_updated","whatsapp.account.quality_updated","whatsapp.account.status_updated","whatsapp.account.alert_received","whatsapp.contact.identity_changed","whatsapp.automatic_event","whatsapp.number.activated","whatsapp.number.declined","whatsapp.number.action_required","whatsapp.number.verification_required","whatsapp.number.suspended","whatsapp.number.reactivated","whatsapp.number.released","whatsapp.number.kyc_submitted","phone_number.stock_available","verification.approved","verification.failed","api.changelog.published","sms.registration.action_required","sms.registration.status_updated","branded_calling.identity.status_updated","branded_calling.identity.action_required","branded_calling.number.status_updated","rcs.agent.status_updated","commerce.product.created","commerce.product.updated","commerce.product.deleted","commerce.order.created","commerce.order.updated","commerce.order.refunded","contact.tag_added","contact.tag_removed","contact.field_changed","sequence.enrolled","sequence.exited","workflow.run.started","workflow.run.completed","workflow.run.failed","support.run.completed","support.run.failed","campaign_submission.received","campaign_submission.flagged","campaign_submission.pending_review","campaign_submission.approved","campaign_submission.rejected","creator_campaign.budget_exhausted","creator_campaign.closed","campaign_payout.payable","campaign_payout.settled","campaign_payout.failed","campaign_participant.joined","campaign_participant.suspended","campaign_participant.removed"]}},"isActive":{"type":"boolean"},"customHeaders":{"type":"object","additionalProperties":{"type":"string"}},"disabledResourceGroups":{"type":"array","items":{"type":"string","enum":["publishing","engagement","messages","contacts","analytics","ads","telephony","accounts","billing","webhooks","commerce","creator_campaigns","money","calendar","files"]}},"profileIds":{"type":"array","maxItems":50,"items":{"type":"string"}},"accountIds":{"type":"array","maxItems":50,"items":{"type":"string"}}}}}}},"x-pozy-area":"workspace"},"delete":{"operationId":"deleteWebhookSettings","summary":"Delete webhook","tags":["Webhooks"],"parameters":[{"name":"webhookId","in":"query","required":false,"schema":{"type":"string","pattern":"^[a-fA-F0-9]{24}$"}},{"name":"id","in":"query","required":false,"schema":{"type":"string","pattern":"^[a-fA-F0-9]{24}$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"}}}}}}},"x-pozy-area":"workspace"}},"/v1/webhooks/logs":{"get":{"operationId":"getWebhookLogs","summary":"List webhook delivery logs","tags":["Webhooks"],"parameters":[{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":100,"default":50}},{"name":"skip","in":"query","required":false,"schema":{"type":"integer","minimum":0,"maximum":10000,"default":0}},{"name":"status","in":"query","required":false,"schema":{"type":"string","enum":["success","failed"]}},{"name":"event","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":100}},{"name":"webhookId","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":100}},{"name":"eventId","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":200}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"logs":{"type":"array","items":{"$ref":"#/components/schemas/WebhookLog"}},"pagination":{"type":"object","properties":{"total":{"type":"integer"},"limit":{"type":"integer"},"skip":{"type":"integer"},"pages":{"type":"integer"},"hasMore":{"type":"boolean"}}}}}}}}},"x-pozy-area":"workspace"}},"/v1/webhooks/logs/redeliver":{"post":{"operationId":"redeliverWebhookEvent","summary":"Redeliver a webhook event","tags":["Webhooks"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["webhookId","eventId"],"properties":{"webhookId":{"type":"string","minLength":1},"eventId":{"type":"string","minLength":1}}}}}},"x-pozy-area":"workspace"}},"/v1/webhooks/test":{"post":{"operationId":"testWebhook","summary":"Send test webhook","tags":["Webhooks"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["webhookId"],"properties":{"webhookId":{"type":"string"},"event":{"type":"string","enum":["post.scheduled","post.published","post.failed","post.partial","post.cancelled","post.recycled","post.platform.published","post.platform.failed","post.platform.deleted","post.tiktok.url_resolved","post.external.created","post.external.updated","post.external.deleted","account.connected","account.disconnected","account.permissions_changed","account.ads.initial_sync_completed","account.ads.sync_failed","account.ads.sync_recovered","account.rate_limited","calendar.event.created","calendar.event.updated","calendar.event.deleted","file.created","file.updated","file.deleted","file.picked","contact.updated","contact.deleted","analytics.synced","post.tracking_completed","post.authenticity_changed","message.received","message.sent","message.edited","message.deleted","message.delivered","message.read","message.played","message.failed","reaction.received","referral.received","conversation.started","conversation.control_changed","contact.tag_added","contact.tag_removed","contact.field_changed","sequence.enrolled","sequence.exited","workflow.run.started","workflow.run.completed","workflow.run.failed","support.run.completed","support.run.failed","campaign_submission.received","campaign_submission.flagged","campaign_submission.pending_review","campaign_submission.approved","campaign_submission.rejected","creator_campaign.budget_exhausted","creator_campaign.closed","campaign_payout.payable","campaign_payout.settled","campaign_payout.failed","campaign_participant.joined","campaign_participant.suspended","campaign_participant.removed","call.received","call.ended","call.failed","call.permission_request","comment.received","review.new","review.updated","review.deleted","review.restored","ad.status_changed","ad.review.approved","ad.review.rejected","ad.delivery_issue","campaign.budget.depleted","ad_account.status_changed","ad.video.processed","ad_rule.triggered","lead.received","whatsapp.template.status_updated","whatsapp.template.category_updated","whatsapp.account.name_status_updated","whatsapp.account.quality_updated","whatsapp.account.status_updated","whatsapp.account.alert_received","whatsapp.contact.identity_changed","whatsapp.number.activated","whatsapp.number.declined","whatsapp.number.action_required","whatsapp.automatic_event","whatsapp.number.verification_required","whatsapp.number.suspended","whatsapp.number.reactivated","whatsapp.number.released","whatsapp.number.kyc_submitted","phone_number.stock_available","sms.registration.action_required","sms.registration.status_updated","branded_calling.identity.status_updated","branded_calling.identity.action_required","branded_calling.number.status_updated","rcs.agent.status_updated","verification.approved","verification.failed","commerce.product.created","commerce.product.updated","commerce.product.deleted","commerce.order.created","commerce.order.updated","commerce.order.refunded","api.changelog.published"]}}}}}},"x-pozy-area":"workspace"}},"/v1/logs":{"get":{"operationId":"listLogs","summary":"List activity logs","tags":["Logs"],"parameters":[{"name":"type","in":"query","required":false,"schema":{"type":"string","enum":["all","publishing","connections","webhooks","messaging","workflow_event","api_request","activity"],"default":"publishing"}},{"name":"status","in":"query","required":false,"schema":{"type":"string","enum":["success","failed","pending","skipped","all"]}},{"name":"platform","in":"query","required":false,"schema":{"type":"string","enum":["tiktok","instagram","whatsapp","facebook","youtube","linkedin","twitter","threads","pinterest","reddit","bluesky","googlebusiness","telegram","snapchat","all"]}},{"name":"action","in":"query","required":false,"schema":{"type":"string"}},{"name":"search","in":"query","required":false,"schema":{"type":"string"}},{"name":"days","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":90,"default":90}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":100,"default":50}},{"name":"skip","in":"query","required":false,"schema":{"type":"integer","minimum":0,"default":0}},{"name":"accountId","in":"query","required":false,"schema":{"type":"string"}},{"name":"event","in":"query","required":false,"schema":{"type":"string"}},{"name":"requestId","in":"query","required":false,"schema":{"type":"string"}},{"name":"from","in":"query","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"to","in":"query","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"statusCode","in":"query","required":false,"schema":{"type":"integer"}},{"name":"apiKeyId","in":"query","required":false,"schema":{"type":"string"}},{"name":"profileId","in":"query","required":false,"schema":{"type":"string"}},{"name":"includeReadReceipts","in":"query","required":false,"schema":{"type":"boolean","default":false}},{"name":"statusClass","in":"query","required":false,"schema":{"type":"string","enum":["1xx","2xx","3xx","4xx","5xx"]}},{"name":"method","in":"query","required":false,"schema":{"type":"string","enum":["GET","POST","PUT","PATCH","DELETE"]}},{"name":"source","in":"query","required":false,"schema":{"type":"string","enum":["api","dashboard","mcp","cli"]}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"logs":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"action":{"type":"string"},"user_id":{"type":"string"},"platform":{"type":"string"},"account_id":{"type":"string"},"profile_id":{"type":"string"},"operation_id":{"type":"string"},"status":{"type":"string","enum":["success","failed","pending","skipped"]},"status_code":{"type":"integer"},"error_message":{"type":"string"},"error_code":{"type":"string"},"duration_ms":{"type":"integer"},"endpoint":{"type":"string"},"request_body":{"type":"string"},"response_body":{"type":"string"},"created_at":{"type":"string","format":"date-time"},"metadata":{"type":"string"},"request_id":{"type":"string"},"api_key_id":{"type":"string"},"method":{"type":"string"},"path":{"type":"string"},"ip_address":{"type":"string"},"user_agent":{"type":"string"}}}},"pagination":{"type":"object","properties":{"total":{"type":"integer"},"limit":{"type":"integer"},"skip":{"type":"integer"},"pages":{"type":"integer"},"hasMore":{"type":"boolean"}}}}}}}}},"x-pozy-area":"workspace"}},"/v1/email/threads":{"get":{"operationId":"listEmailThreads","summary":"List email threads","tags":["Email"],"parameters":[{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}},{"name":"folder","in":"query","required":false,"schema":{"type":"string"}},{"name":"unread","in":"query","required":false,"schema":{"type":"boolean"}},{"name":"starred","in":"query","required":false,"schema":{"type":"boolean"}},{"name":"hasAttachment","in":"query","required":false,"schema":{"type":"boolean"}},{"name":"subject","in":"query","required":false,"schema":{"type":"string"}},{"name":"from","in":"query","required":false,"schema":{"type":"string"}},{"name":"to","in":"query","required":false,"schema":{"type":"string"}},{"name":"cc","in":"query","required":false,"schema":{"type":"string"}},{"name":"bcc","in":"query","required":false,"schema":{"type":"string"}},{"name":"anyEmail","in":"query","required":false,"schema":{"type":"string"}},{"name":"after","in":"query","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"before","in":"query","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"searchQueryNative","in":"query","required":false,"schema":{"type":"string","maxLength":500}},{"name":"sortOrder","in":"query","required":false,"schema":{"type":"string","enum":["asc","desc"],"default":"desc"}},{"name":"cursor","in":"query","required":false,"schema":{"type":"string"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":200,"default":50}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/EmailThread"}},"pagination":{"$ref":"#/components/schemas/CursorPagination"},"meta":{"$ref":"#/components/schemas/EmailListMeta"}}}}}}},"x-pozy-area":"productivity"}},"/v1/email/threads/{threadId}":{"get":{"operationId":"getEmailThread","summary":"Get an email thread with its messages","tags":["Email"],"parameters":[{"name":"threadId","in":"path","required":true,"schema":{"type":"string"}},{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"allOf":[{"$ref":"#/components/schemas/EmailThread"},{"type":"object","properties":{"messages":{"type":"array","items":{"$ref":"#/components/schemas/EmailMessage"}}}}]}}}}}}},"x-pozy-area":"productivity"},"patch":{"operationId":"updateEmailThread","summary":"Update every message in a thread","tags":["Email"],"parameters":[{"name":"threadId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/EmailThread"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmailMessagePatch"}}}},"x-pozy-area":"productivity"}},"/v1/email/messages":{"get":{"operationId":"listEmailMessages","summary":"List email messages","tags":["Email"],"parameters":[{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}},{"name":"folder","in":"query","required":false,"schema":{"type":"string"}},{"name":"unread","in":"query","required":false,"schema":{"type":"boolean"}},{"name":"starred","in":"query","required":false,"schema":{"type":"boolean"}},{"name":"hasAttachment","in":"query","required":false,"schema":{"type":"boolean"}},{"name":"subject","in":"query","required":false,"schema":{"type":"string"}},{"name":"from","in":"query","required":false,"schema":{"type":"string"}},{"name":"to","in":"query","required":false,"schema":{"type":"string"}},{"name":"cc","in":"query","required":false,"schema":{"type":"string"}},{"name":"bcc","in":"query","required":false,"schema":{"type":"string"}},{"name":"anyEmail","in":"query","required":false,"schema":{"type":"string"}},{"name":"after","in":"query","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"before","in":"query","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"searchQueryNative","in":"query","required":false,"schema":{"type":"string","maxLength":500}},{"name":"sortOrder","in":"query","required":false,"schema":{"type":"string","enum":["asc","desc"],"default":"desc"}},{"name":"cursor","in":"query","required":false,"schema":{"type":"string"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":200,"default":50}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/EmailMessage"}},"pagination":{"$ref":"#/components/schemas/CursorPagination"},"meta":{"$ref":"#/components/schemas/EmailListMeta"}}}}}}},"x-pozy-area":"productivity"},"post":{"operationId":"sendEmailMessage","summary":"Send an email","tags":["Email"],"responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/EmailMessage"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendEmailRequest"}}}},"x-pozy-area":"productivity"}},"/v1/email/messages/{messageId}":{"get":{"operationId":"getEmailMessage","summary":"Get an email message","tags":["Email"],"parameters":[{"name":"messageId","in":"path","required":true,"schema":{"type":"string"}},{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}},{"name":"includeHeaders","in":"query","required":false,"schema":{"type":"boolean","default":false}},{"name":"raw","in":"query","required":false,"schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/EmailMessage"}}}}}}},"x-pozy-area":"productivity"},"patch":{"operationId":"updateEmailMessage","summary":"Mark read or starred, or move a message","tags":["Email"],"parameters":[{"name":"messageId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/EmailMessage"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmailMessagePatch"}}}},"x-pozy-area":"productivity"},"delete":{"operationId":"trashEmailMessage","summary":"Move a message to trash","tags":["Email"],"parameters":[{"name":"messageId","in":"path","required":true,"schema":{"type":"string"}},{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string"},"trashed":{"type":"boolean"}}}}}}}}},"x-pozy-area":"productivity"}},"/v1/email/messages/{messageId}/reply":{"post":{"operationId":"replyEmailMessage","summary":"Reply to a message","tags":["Email"],"parameters":[{"name":"messageId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/EmailMessage"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/SendEmailRequest"},{"type":"object","properties":{"mode":{"type":"string","enum":["reply","replyAll"],"default":"reply"},"subject":{"type":"string","maxLength":998}}}]}}}},"x-pozy-area":"productivity"}},"/v1/email/folders":{"get":{"operationId":"listEmailFolders","summary":"List mailbox folders","tags":["Email"],"parameters":[{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/EmailFolder"}}}}}}}},"x-pozy-area":"productivity"}},"/v1/email/attachments/{attachmentId}":{"get":{"operationId":"downloadEmailAttachment","summary":"Download an attachment","tags":["Email"],"parameters":[{"name":"attachmentId","in":"path","required":true,"schema":{"type":"string"}},{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}},{"name":"messageId","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/octet-stream":{"schema":{"type":"string","format":"binary"}}}}},"x-pozy-area":"productivity"}},"/v1/calendar/calendars":{"get":{"operationId":"listCalendars","summary":"List calendars","tags":["Calendar"],"parameters":[{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Calendar"}}}}}}}},"x-pozy-area":"productivity"}},"/v1/calendar/events":{"get":{"operationId":"listCalendarEvents","summary":"List events in a window","tags":["Calendar"],"parameters":[{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}},{"name":"calendarId","in":"query","required":false,"schema":{"type":"string"}},{"name":"from","in":"query","required":true,"schema":{"type":"string","format":"date-time"}},{"name":"to","in":"query","required":true,"schema":{"type":"string","format":"date-time"}},{"name":"title","in":"query","required":false,"schema":{"type":"string"}},{"name":"location","in":"query","required":false,"schema":{"type":"string"}},{"name":"showCancelled","in":"query","required":false,"schema":{"type":"boolean","default":false}},{"name":"expandRecurring","in":"query","required":false,"schema":{"type":"boolean","default":true}},{"name":"icalUid","in":"query","required":false,"schema":{"type":"string"}},{"name":"sortOrder","in":"query","required":false,"schema":{"type":"string","enum":["asc","desc"],"default":"asc"}},{"name":"cursor","in":"query","required":false,"schema":{"type":"string"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":200,"default":50}},{"name":"timezone","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/CalendarEvent"}},"pagination":{"$ref":"#/components/schemas/CursorPagination"}}}}}}},"x-pozy-area":"productivity"},"post":{"operationId":"createCalendarEvent","summary":"Create an event","tags":["Calendar"],"responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/CalendarEvent"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCalendarEventRequest"}}}},"x-pozy-area":"productivity"}},"/v1/calendar/events/{eventId}":{"get":{"operationId":"getCalendarEvent","summary":"Get an event","tags":["Calendar"],"parameters":[{"name":"eventId","in":"path","required":true,"schema":{"type":"string"}},{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}},{"name":"calendarId","in":"query","required":false,"schema":{"type":"string"}},{"name":"timezone","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/CalendarEvent"}}}}}}},"x-pozy-area":"productivity"},"patch":{"operationId":"updateCalendarEvent","summary":"Update an event","tags":["Calendar"],"parameters":[{"name":"eventId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/CalendarEvent"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["accountId"],"properties":{"accountId":{"type":"string"},"calendarId":{"type":"string"}}},{"$ref":"#/components/schemas/CalendarEventFields"}]}}}},"x-pozy-area":"productivity"},"delete":{"operationId":"deleteCalendarEvent","summary":"Delete an event","tags":["Calendar"],"parameters":[{"name":"eventId","in":"path","required":true,"schema":{"type":"string"}},{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}},{"name":"calendarId","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string"},"deleted":{"type":"boolean"}}}}}}}}},"x-pozy-area":"productivity"}},"/v1/calendar/events/{eventId}/rsvp":{"post":{"operationId":"rsvpCalendarEvent","summary":"Respond to an invitation","tags":["Calendar"],"parameters":[{"name":"eventId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/CalendarEvent"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","status"],"properties":{"accountId":{"type":"string"},"calendarId":{"type":"string"},"status":{"type":"string","enum":["accepted","declined","tentative"]},"comment":{"type":"string","maxLength":1000}}}}}},"x-pozy-area":"productivity"}},"/v1/calendar/free-busy":{"post":{"operationId":"calendarFreeBusy","summary":"Busy blocks for one or more accounts","tags":["Calendar"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"accountId":{"type":"string"},"from":{"type":"string","format":"date-time"},"to":{"type":"string","format":"date-time"},"busy":{"type":"array","items":{"$ref":"#/components/schemas/BusyBlock"}}}}}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountIds","from","to"],"properties":{"accountIds":{"type":"array","minItems":1,"maxItems":10,"items":{"type":"string"}},"from":{"type":"string","format":"date-time"},"to":{"type":"string","format":"date-time"}}}}}},"x-pozy-area":"productivity"}},"/v1/calendar/availability":{"post":{"operationId":"calendarAvailability","summary":"Find meeting slots across accounts","tags":["Calendar"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"timeSlots":{"type":"array","items":{"type":"object","properties":{"from":{"type":"string","format":"date-time"},"to":{"type":"string","format":"date-time"},"accountIds":{"type":"array","items":{"type":"string"}}}}}}}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["participants","from","to","durationMinutes"],"properties":{"participants":{"type":"array","minItems":1,"maxItems":10,"items":{"type":"object","required":["accountId"],"properties":{"accountId":{"type":"string"},"openHours":{"$ref":"#/components/schemas/OpenHours"}}}},"from":{"type":"string","format":"date-time"},"to":{"type":"string","format":"date-time"},"durationMinutes":{"type":"integer","minimum":5,"maximum":480},"intervalMinutes":{"type":"integer","minimum":5,"maximum":240,"default":30},"roundTo":{"type":"integer","minimum":5,"maximum":60},"buffer":{"type":"object","properties":{"before":{"type":"integer","minimum":0,"maximum":240,"default":0},"after":{"type":"integer","minimum":0,"maximum":240,"default":0}}},"defaultOpenHours":{"$ref":"#/components/schemas/OpenHours"},"method":{"type":"string","enum":["collective","max_availability"],"default":"collective"}}}}}},"x-pozy-area":"productivity"}},"/v1/files":{"get":{"operationId":"listFiles","summary":"List files in a folder or search the drive","tags":["Files"],"parameters":[{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}},{"name":"folderId","in":"query","required":false,"schema":{"type":"string"}},{"name":"q","in":"query","required":false,"schema":{"type":"string","maxLength":200}},{"name":"cursor","in":"query","required":false,"schema":{"type":"string"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":100,"default":50}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/FileItem"}},"pagination":{"type":"object","properties":{"hasMore":{"type":"boolean"},"nextCursor":{"type":["string","null"]}}}}}}}}},"x-pozy-area":"productivity"},"post":{"operationId":"uploadFile","summary":"Upload a file","tags":["Files"],"responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/FileItem"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","name","contentType","url"],"properties":{"accountId":{"type":"string"},"name":{"type":"string","maxLength":255},"contentType":{"type":"string"},"parentId":{"type":"string"},"url":{"type":"string","format":"uri"},"convertTo":{"type":"string","enum":["application/vnd.google-apps.document","application/vnd.google-apps.spreadsheet","application/vnd.google-apps.presentation"]}}}}}},"x-pozy-area":"productivity"}},"/v1/files/folders":{"post":{"operationId":"createFolder","summary":"Create a folder","tags":["Files"],"responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/FileItem"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","name"],"properties":{"accountId":{"type":"string"},"name":{"type":"string","maxLength":255},"parentId":{"type":"string"}}}}}},"x-pozy-area":"productivity"}},"/v1/files/picker-sessions":{"post":{"operationId":"createFilePickerSession","summary":"Create a hosted Google Picker session","tags":["Files"],"responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/FilePickerSession"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId"],"properties":{"accountId":{"type":"string"},"redirectUrl":{"type":"string","format":"uri","maxLength":2048},"fileIds":{"type":"array","maxItems":50,"items":{"type":"string"}},"mimeTypes":{"type":"array","maxItems":30,"items":{"type":"string"}},"multiselect":{"type":"boolean","default":true}}}}}},"x-pozy-area":"productivity"}},"/v1/files/{fileId}":{"get":{"operationId":"getFile","summary":"Get a file or folder","tags":["Files"],"parameters":[{"name":"fileId","in":"path","required":true,"schema":{"type":"string"}},{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/FileItem"}}}}}}},"x-pozy-area":"productivity"},"patch":{"operationId":"updateFile","summary":"Rename or move a file","tags":["Files"],"parameters":[{"name":"fileId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/FileItem"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId"],"properties":{"accountId":{"type":"string"},"name":{"type":"string","maxLength":255},"parentId":{"type":"string"}}}}}},"x-pozy-area":"productivity"},"delete":{"operationId":"trashFile","summary":"Move a file to the trash","tags":["Files"],"parameters":[{"name":"fileId","in":"path","required":true,"schema":{"type":"string"}},{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string"},"trashed":{"type":"boolean"}}}}}}}}},"x-pozy-area":"productivity"}},"/v1/files/{fileId}/download":{"get":{"operationId":"downloadFile","summary":"Download a file","tags":["Files"],"parameters":[{"name":"fileId","in":"path","required":true,"schema":{"type":"string"}},{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/octet-stream":{"schema":{"type":"string","format":"binary"}}}}},"x-pozy-area":"productivity"}},"/v1/files/{fileId}/share-link":{"get":{"operationId":"getFileShareLink","summary":"Get an anyone-with-the-link share link","tags":["Files"],"parameters":[{"name":"fileId","in":"path","required":true,"schema":{"type":"string"}},{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/FileShareLink"}}}}}}},"x-pozy-area":"productivity"}},"/v1/connect/microsoft/admin-consent":{"get":{"operationId":"startMicrosoftAdminConsent","summary":"Admin-consent link for a Microsoft tenant","tags":["Connect"],"parameters":[{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}},{"name":"redirectUrl","in":"query","required":false,"schema":{"type":"string","format":"uri"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"adminConsentUrl":{"type":"string","format":"uri"}}}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"x-pozy-area":"accounts"}},"/v1/inbox/conversations":{"get":{"operationId":"listInboxConversations","summary":"List conversations","tags":["Messages"],"parameters":[{"name":"profileId","in":"query","required":false,"schema":{"type":"string"}},{"name":"platform","in":"query","required":false,"schema":{"type":"string","enum":["facebook","instagram","twitter","bluesky","reddit","telegram","whatsapp","imessage","sms"]}},{"name":"status","in":"query","required":false,"schema":{"type":"string","enum":["active","archived"]}},{"name":"folder","in":"query","required":false,"schema":{"type":"string","enum":["inbox","requests"],"default":"inbox"}},{"name":"sortOrder","in":"query","required":false,"schema":{"type":"string","enum":["asc","desc"],"default":"desc"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":100,"default":50}},{"name":"cursor","in":"query","required":false,"schema":{"type":"string"}},{"name":"accountId","in":"query","required":false,"schema":{"type":"string"}},{"name":"tags","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"platform":{"type":"string"},"accountId":{"type":"string"},"accountUsername":{"type":"string"},"pageId":{"type":["string","null"]},"participantId":{"type":"string"},"participantName":{"type":"string"},"participantPicture":{"type":["string","null"]},"participantVerifiedType":{"type":["string","null"],"enum":["blue","government","business","none"]},"businessScopedUserId":{"type":"string"},"whatsappUsername":{"type":"string"},"lastMessage":{"type":"string"},"updatedTime":{"type":"string","format":"date-time"},"status":{"type":"string","enum":["active","archived"]},"unreadCount":{"type":["integer","null"],"maximum":1000},"threadControl":{"type":"string","enum":["app","ai_agent","other"]},"folder":{"type":"string","enum":["requests"]},"isGroup":{"type":"boolean"},"url":{"type":["string","null"]},"instagramProfile":{"type":["object","null"],"properties":{"isFollower":{"type":["boolean","null"]},"isFollowing":{"type":["boolean","null"]},"followerCount":{"type":["integer","null"]},"isVerified":{"type":["boolean","null"]},"fetchedAt":{"type":["string","null"],"format":"date-time"}}},"metadata":{"$ref":"#/components/schemas/InboxConversationAdMetadata"},"adAttribution":{"$ref":"#/components/schemas/ConversationAdAttribution"}}}},"pagination":{"type":"object","properties":{"hasMore":{"type":"boolean"},"nextCursor":{"type":["string","null"]}}},"meta":{"type":"object","properties":{"accountsQueried":{"type":"integer"},"accountsFailed":{"type":"integer"},"failedAccounts":{"type":"array","items":{"type":"object","properties":{"accountId":{"type":"string"},"accountUsername":{"type":["string","null"]},"platform":{"type":"string"},"error":{"type":"string"},"code":{"type":["string","null"]},"retryAfter":{"type":["integer","null"]}}}},"lastUpdated":{"type":"string","format":"date-time"},"accountsSkipped":{"type":"array","items":{"type":"object","properties":{"accountId":{"type":"string"},"platform":{"type":"string"}}}}}}}}}}}},"x-pozy-area":"inbox"},"post":{"operationId":"createInboxConversation","summary":"Create conversation","tags":["Messages"],"responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"data":{"type":"object","properties":{"messageId":{"type":"string"},"conversationId":{"type":"string"},"participantId":{"type":"string"},"participantName":{"type":["string","null"]},"participantUsername":{"type":["string","null"]}}}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId"],"properties":{"accountId":{"type":"string"},"participantId":{"type":"string"},"participantUsername":{"type":"string"},"message":{"type":"string"},"subject":{"type":"string","maxLength":998},"cc":{"type":"array","maxItems":50,"items":{"type":"string","format":"email"}},"skipDmCheck":{"type":"boolean","default":false},"templateName":{"type":"string"},"category":{"type":"string","enum":["utility"]},"linkPreview":{"type":"boolean","default":true},"templateLanguage":{"type":"string"},"templateParams":{"type":"array","items":{"type":"string"}},"templateButtonParams":{"type":"array","maxItems":10,"items":{"type":"object","required":["index","subType","value"],"properties":{"index":{"type":"integer","minimum":0,"maximum":9},"subType":{"type":"string","enum":["url","copy_code","flow"]},"value":{"type":"string","minLength":1}}}},"templateCards":{"type":"array","maxItems":10,"items":{"type":"object","required":["cardIndex"],"properties":{"cardIndex":{"type":"integer","minimum":0,"maximum":9},"params":{"type":"array","items":{"type":"string"}},"headerMedia":{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["image","video","document"]},"link":{"type":"string"},"id":{"type":"string"}}},"buttons":{"type":"array","maxItems":2,"items":{"type":"object","required":["index","subType","value"],"properties":{"index":{"type":"integer","minimum":0,"maximum":1},"subType":{"type":"string","enum":["quick_reply","url"]},"value":{"type":"string","minLength":1}}}}}}},"headerMedia":{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["image","video","document"]},"link":{"type":"string"},"id":{"type":"string"},"filename":{"type":"string"}}},"headerLocation":{"type":"object","required":["latitude","longitude"],"properties":{"latitude":{"type":"number"},"longitude":{"type":"number"},"name":{"type":"string"},"address":{"type":"string"}}}}}}}},"x-pozy-area":"inbox"}},"/v1/inbox/conversations/search":{"get":{"operationId":"searchInboxConversations","summary":"Search conversations","tags":["Messages"],"parameters":[{"name":"query","in":"query","required":true,"schema":{"type":"string","minLength":2,"maxLength":200}},{"name":"direction","in":"query","required":false,"schema":{"type":"string","enum":["incoming","outgoing"]}},{"name":"profileId","in":"query","required":false,"schema":{"type":"string"}},{"name":"platform","in":"query","required":false,"schema":{"type":"string","enum":["facebook","instagram","telegram","whatsapp","sms","rcs","slack","imessage"]}},{"name":"accountId","in":"query","required":false,"schema":{"type":"string"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":50,"default":20}},{"name":"cursor","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"conversation":{"type":"object","properties":{"id":{"type":"string"},"platform":{"type":"string"},"accountId":{"type":"string"},"participantName":{"type":["string","null"]},"participantUsername":{"type":["string","null"]},"participantPicture":{"type":["string","null"]},"businessScopedUserId":{"type":"string"},"whatsappUsername":{"type":"string"},"status":{"type":"string","enum":["active","archived"]},"lastMessage":{"type":["string","null"]},"lastMessageAt":{"type":["string","null"],"format":"date-time"}}},"matchCount":{"type":"integer"},"matches":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"text":{"type":["string","null"]},"direction":{"type":"string","enum":["incoming","outgoing"]},"timestamp":{"type":"string","format":"date-time"}}}}}}},"pagination":{"type":"object","properties":{"hasMore":{"type":"boolean"},"nextCursor":{"type":["string","null"]}}},"meta":{"type":"object","properties":{"accountsQueried":{"type":"integer"},"accountsFailed":{"type":"integer"},"failedAccounts":{"type":"array","items":{"type":"object","properties":{"accountId":{"type":"string"},"accountUsername":{"type":["string","null"]},"platform":{"type":"string"},"error":{"type":"string"}}}},"lastUpdated":{"type":"string","format":"date-time"},"accountsSkipped":{"type":"array","items":{"type":"object","properties":{"accountId":{"type":"string"},"platform":{"type":"string"}}}}}}}}}}}},"x-pozy-area":"inbox"}},"/v1/inbox/conversations/{conversationId}":{"get":{"operationId":"getInboxConversation","summary":"Get conversation","tags":["Messages"],"parameters":[{"name":"conversationId","in":"path","required":true,"schema":{"type":"string"}},{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string"},"accountId":{"type":"string"},"accountUsername":{"type":"string"},"pageId":{"type":["string","null"]},"platform":{"type":"string"},"status":{"type":"string","enum":["active","archived"]},"participantName":{"type":"string"},"participantId":{"type":"string"},"participantVerifiedType":{"type":["string","null"],"enum":["blue","government","business","none"]},"businessScopedUserId":{"type":"string"},"whatsappUsername":{"type":"string"},"lastMessage":{"type":"string"},"lastMessageAt":{"type":"string","format":"date-time"},"updatedTime":{"type":"string","format":"date-time"},"participants":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}}}},"instagramProfile":{"type":["object","null"],"properties":{"isFollower":{"type":["boolean","null"]},"isFollowing":{"type":["boolean","null"]},"followerCount":{"type":["integer","null"]},"isVerified":{"type":["boolean","null"]},"fetchedAt":{"type":["string","null"],"format":"date-time"}}},"metadata":{"$ref":"#/components/schemas/InboxConversationAdMetadata"},"adAttribution":{"$ref":"#/components/schemas/ConversationAdAttribution"}}}}}}}}},"x-pozy-area":"inbox"},"put":{"operationId":"updateInboxConversation","summary":"Update conversation status","tags":["Messages"],"parameters":[{"name":"conversationId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"data":{"type":"object","properties":{"id":{"type":"string"},"accountId":{"type":"string"},"status":{"type":"string","enum":["active","archived"]},"platform":{"type":"string"},"updatedAt":{"type":"string","format":"date-time"}}}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","status"],"properties":{"accountId":{"type":"string"},"status":{"type":"string","enum":["active","archived"]}}}}}},"x-pozy-area":"inbox"},"delete":{"operationId":"deleteInboxConversation","summary":"Delete conversation","tags":["Messages"],"parameters":[{"name":"conversationId","in":"path","required":true,"schema":{"type":"string"}},{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"data":{"type":"object","properties":{"id":{"type":"string"},"accountId":{"type":"string"},"platform":{"type":"string"},"deletedMessages":{"type":"integer"}}}}}}}}},"x-pozy-area":"inbox"}},"/v1/inbox/conversations/{conversationId}/messages":{"get":{"operationId":"getInboxConversationMessages","summary":"List messages","tags":["Messages"],"parameters":[{"name":"conversationId","in":"path","required":true,"schema":{"type":"string"}},{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":100,"default":100}},{"name":"cursor","in":"query","required":false,"schema":{"type":"string"}},{"name":"sortOrder","in":"query","required":false,"schema":{"type":"string","enum":["asc","desc"],"default":"asc"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string"},"pagination":{"type":"object","properties":{"hasMore":{"type":"boolean"},"nextCursor":{"type":["string","null"]}}},"sortOrderApplied":{"type":"string","enum":["asc","desc"]},"messages":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"conversationId":{"type":"string"},"accountId":{"type":"string"},"platform":{"type":"string"},"message":{"type":"string"},"senderId":{"type":"string"},"senderName":{"type":["string","null"]},"senderVerifiedType":{"type":["string","null"],"enum":["blue","government","business","none"]},"direction":{"type":"string","enum":["incoming","outgoing"]},"createdAt":{"type":"string","format":"date-time"},"attachments":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["image","video","audio","file","sticker","share","template","unsupported_type"]},"originalType":{"type":"string"},"mimeType":{"type":"string"},"url":{"type":"string"},"refreshUrl":{"type":["string","null"]},"filename":{"type":["string","null"]},"previewUrl":{"type":["string","null"]},"payload":{"type":"object","additionalProperties":true}}}},"subject":{"type":["string","null"]},"storyReply":{"type":"object","properties":{"storyId":{"type":"string"},"storyUrl":{"type":"string"}}},"isStoryMention":{"type":"boolean"},"noRenderableContent":{"type":"boolean"},"isEdited":{"type":"boolean"},"editedAt":{"type":["string","null"],"format":"date-time"},"editCount":{"type":"integer"},"editHistory":{"type":"array","items":{"$ref":"#/components/schemas/InboxMessageEditHistoryEntry"}},"isDeleted":{"type":"boolean"},"deletedAt":{"type":["string","null"],"format":"date-time"},"deliveryStatus":{"type":["string","null"],"enum":["sent","delivered","read","played","failed","deleted"]},"deliveredAt":{"type":["string","null"],"format":"date-time"},"readAt":{"type":["string","null"],"format":"date-time"},"sentAt":{"type":["string","null"],"format":"date-time"},"deliveryError":{"type":["object","null"],"properties":{"code":{"type":"integer"},"title":{"type":"string"},"message":{"type":"string"},"details":{"type":"string"},"href":{"type":"string","format":"uri"}}},"reactions":{"type":"array","items":{"type":"object","properties":{"emoji":{"type":"string"},"fromMe":{"type":"boolean"},"reactedAt":{"type":"string","format":"date-time"}}}},"metadata":{"type":"object","additionalProperties":true},"sentVia":{"type":["string","null"],"enum":["human","api","broadcast","sequence","workflow","comment_automation","bulk-api",null]}}}},"lastUpdated":{"type":"string","format":"date-time"}}}}}}},"x-pozy-area":"inbox"},"post":{"operationId":"sendInboxMessage","summary":"Send message","tags":["Messages"],"parameters":[{"name":"conversationId","in":"path","required":true,"schema":{"type":"string"}},{"name":"Idempotency-Key","in":"header","required":false,"schema":{"type":"string","maxLength":255}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"warnings":{"type":"array","items":{"type":"object","required":["code","param","message"],"properties":{"code":{"type":"string","enum":["ignored_field"]},"param":{"type":"string","enum":["replyTo"]},"message":{"type":"string"}}}},"data":{"type":"object","properties":{"messageId":{"type":"string"},"conversationId":{"type":"string"},"attachments":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"url":{"type":"string"}}}},"messageIds":{"type":"array","items":{"type":"string"}},"partialFailure":{"type":"object","properties":{"part":{"type":"string","enum":["text"]},"error":{"type":"string"},"platformError":{"type":"object","properties":{"code":{"type":"integer"},"subcode":{"type":"integer"},"fbtraceId":{"type":"string"},"type":{"type":"string"}}}}}}}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId"],"properties":{"accountId":{"type":"string"},"message":{"type":"string"},"attachmentUrl":{"type":"string"},"category":{"type":"string","enum":["utility"]},"linkPreview":{"type":"boolean","default":true},"attachmentType":{"type":"string","enum":["image","video","audio","file"]},"attachmentName":{"type":"string"},"voiceNote":{"type":"boolean"},"subject":{"type":"string","maxLength":1000},"cc":{"type":"array","maxItems":50,"items":{"type":"string","format":"email"}},"effect":{"type":"string","enum":["slam","loud","gentle","invisibleInk","echo","spotlight","balloons","confetti","love","lasers","fireworks","shootingStar","celebration"]},"contactCard":{"type":"boolean"},"channel":{"type":"string","enum":["imessage","sms","rcs","whatsapp"]},"sharedMediaId":{"type":"string","pattern":"^\\d+$"},"sticker":{"type":"string","enum":["like_heart"]},"quickReplies":{"type":"array","maxItems":13,"items":{"type":"object","required":["title","payload"],"properties":{"title":{"type":"string","maxLength":20},"payload":{"type":"string"},"imageUrl":{"type":"string"}}}},"buttons":{"type":"array","maxItems":3,"items":{"type":"object","required":["type","title"],"properties":{"type":{"type":"string","enum":["url","postback","phone"]},"title":{"type":"string","maxLength":20},"url":{"type":"string"},"payload":{"type":"string"},"phone":{"type":"string"}}}},"template":{"type":"object","properties":{"type":{"type":"string","enum":["generic"]},"imageAspectRatio":{"type":"string","enum":["horizontal","square"]},"elements":{"type":"array","maxItems":10,"items":{"type":"object","properties":{"title":{"type":"string","maxLength":80},"subtitle":{"type":"string"},"imageUrl":{"type":"string"},"buttons":{"type":"array","maxItems":3,"items":{"type":"object","properties":{"type":{"type":"string","enum":["url","postback"]},"title":{"type":"string","maxLength":20},"url":{"type":"string"},"payload":{"type":"string"}}}},"name":{"type":"string"},"language":{"type":"string"},"components":{"type":"array","items":{"type":"object","additionalProperties":true}}}}}}},"interactive":{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["list","cta_url","flow","location_request_message","request_contact_info","voice_call","product","product_list","catalog_message","carousel","address_message"]},"header":{"type":"object","properties":{"type":{"type":"string","enum":["text","image","video","document"]},"text":{"type":"string"},"image":{"type":"object","properties":{"link":{"type":"string"}}},"video":{"type":"object","properties":{"link":{"type":"string"}}},"document":{"type":"object","properties":{"link":{"type":"string"}}}}},"body":{"type":"object","required":["text"],"properties":{"text":{"type":"string"}}},"footer":{"type":"object","properties":{"text":{"type":"string"}}},"action":{"oneOf":[{"type":"object","required":["button","sections"],"properties":{"button":{"type":"string"},"sections":{"type":"array","minItems":1,"maxItems":10,"items":{"type":"object","required":["rows"],"properties":{"title":{"type":"string"},"rows":{"type":"array","minItems":1,"maxItems":10,"items":{"type":"object","required":["id","title"],"properties":{"id":{"type":"string"},"title":{"type":"string"},"description":{"type":"string"}}}}}}}}},{"type":"object","required":["name","parameters"],"properties":{"name":{"type":"string","enum":["cta_url"]},"parameters":{"type":"object","required":["display_text","url"],"properties":{"display_text":{"type":"string"},"url":{"type":"string","format":"uri"}}}}},{"type":"object","required":["name"],"properties":{"name":{"type":"string","enum":["voice_call"]},"parameters":{"type":"object","properties":{"display_text":{"type":"string","maxLength":20},"ttl_minutes":{"type":"integer","minimum":1,"maximum":43200},"payload":{"type":"string","maxLength":512}}}}},{"type":"object","required":["name","parameters"],"properties":{"name":{"type":"string","enum":["flow"]},"parameters":{"type":"object","required":["flow_token","flow_id","flow_cta","flow_action"],"properties":{"flow_message_version":{"type":"string","enum":["3"]},"flow_token":{"type":"string"},"flow_id":{"type":"string"},"flow_cta":{"type":"string"},"flow_action":{"type":"string","enum":["navigate","data_exchange"]},"flow_action_payload":{"type":"object","properties":{"screen":{"type":"string"},"data":{"type":"object","additionalProperties":true}}},"mode":{"type":"string","enum":["draft"]}}}}},{"type":"object","required":["name"],"properties":{"name":{"type":"string","enum":["send_location"]}}},{"type":"object","required":["name"],"properties":{"name":{"type":"string","enum":["request_contact_info"]}}},{"type":"object","required":["catalog_id","product_retailer_id"],"properties":{"catalog_id":{"type":"string"},"product_retailer_id":{"type":"string"}}},{"type":"object","required":["catalog_id","sections"],"properties":{"catalog_id":{"type":"string"},"sections":{"type":"array","minItems":1,"maxItems":10,"items":{"type":"object","required":["product_items"],"properties":{"title":{"type":"string"},"product_items":{"type":"array","minItems":1,"items":{"type":"object","required":["product_retailer_id"],"properties":{"product_retailer_id":{"type":"string"}}}}}}}}},{"type":"object","required":["name"],"properties":{"name":{"type":"string","enum":["catalog_message"]},"parameters":{"type":"object","properties":{"thumbnail_product_retailer_id":{"type":"string"}}}}},{"type":"object","required":["cards"],"properties":{"cards":{"type":"array","minItems":2,"maxItems":10,"items":{"type":"object","additionalProperties":true,"properties":{"card_index":{"type":"integer","minimum":0,"maximum":9},"type":{"type":"string"},"header":{"type":"object"},"body":{"type":"object"},"action":{"type":"object"}}}}}},{"type":"object","required":["name","parameters"],"properties":{"name":{"type":"string","enum":["address_message"]},"parameters":{"type":"object","required":["country"],"properties":{"country":{"type":"string"},"values":{"type":"object","additionalProperties":true},"saved_addresses":{"type":"array","items":{"type":"object","additionalProperties":true}},"validation_errors":{"type":"object","additionalProperties":{"type":"string"}}}}}}]}}},"replyMarkup":{"type":"object","properties":{"type":{"type":"string","enum":["inline_keyboard","reply_keyboard"]},"keyboard":{"type":"array","items":{"type":"array","items":{"type":"object","properties":{"text":{"type":"string"},"callbackData":{"type":"string","maxLength":64},"url":{"type":"string"}}}}},"oneTime":{"type":"boolean","default":true}}},"messagingType":{"type":"string","enum":["RESPONSE","UPDATE","MESSAGE_TAG"]},"messageTag":{"type":"string","enum":["CONFIRMED_EVENT_UPDATE","POST_PURCHASE_UPDATE","ACCOUNT_UPDATE","HUMAN_AGENT"]},"replyTo":{"type":"string"},"location":{"type":"object","required":["latitude","longitude"],"properties":{"latitude":{"type":"number"},"longitude":{"type":"number"},"name":{"type":"string"},"address":{"type":"string"}}},"contacts":{"type":"array","items":{"type":"object","required":["name"],"properties":{"name":{"type":"object","required":["formatted_name"],"properties":{"formatted_name":{"type":"string"},"first_name":{"type":"string"},"last_name":{"type":"string"}}},"phones":{"type":"array","items":{"type":"object","properties":{"phone":{"type":"string"},"type":{"type":"string"}}}},"emails":{"type":"array","items":{"type":"object","properties":{"email":{"type":"string"},"type":{"type":"string"}}}}}}}}}}}},"x-pozy-area":"inbox"}},"/v1/whatsapp/media/{mediaId}":{"get":{"operationId":"getWhatsAppMedia","summary":"Download WhatsApp media","tags":["WhatsApp"],"parameters":[{"name":"mediaId","in":"path","required":true,"schema":{"type":"string"}},{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/octet-stream":{"schema":{"type":"string","format":"binary"}}}}},"x-pozy-area":"whatsapp"}},"/v1/inbox/conversations/{conversationId}/messages/{messageId}":{"patch":{"operationId":"editInboxMessage","summary":"Edit message","tags":["Messages"],"parameters":[{"name":"conversationId","in":"path","required":true,"schema":{"type":"string"}},{"name":"messageId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"data":{"type":"object","properties":{"messageId":{"type":"integer"}}}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId"],"properties":{"accountId":{"type":"string"},"text":{"type":"string"},"replyMarkup":{"type":"object","properties":{"type":{"type":"string","enum":["inline_keyboard"]},"keyboard":{"type":"array","items":{"type":"array","items":{"type":"object","properties":{"text":{"type":"string"},"callbackData":{"type":"string"},"url":{"type":"string"}}}}}}}}}}}},"x-pozy-area":"inbox"},"delete":{"operationId":"deleteInboxMessage","summary":"Delete message","tags":["Messages"],"parameters":[{"name":"conversationId","in":"path","required":true,"schema":{"type":"string"}},{"name":"messageId","in":"path","required":true,"schema":{"type":"string"}},{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"}}}}}}},"x-pozy-area":"inbox"}},"/v1/inbox/conversations/{conversationId}/typing":{"post":{"operationId":"sendTypingIndicator","summary":"Send typing indicator","tags":["Messages"],"parameters":[{"name":"conversationId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId"],"properties":{"accountId":{"type":"string"}}}}}},"x-pozy-area":"inbox"}},"/v1/inbox/conversations/{conversationId}/thread-control":{"post":{"operationId":"setConversationThreadControl","summary":"Change who answers a conversation (handover)","tags":["Messages"],"parameters":[{"name":"conversationId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"control":{"type":"object","properties":{"owner":{"type":"string","enum":["app","ai_agent","other"]},"ownerAppId":{"type":"string"}}}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","action"],"properties":{"accountId":{"type":"string"},"action":{"type":"string","enum":["release","take","pass","request"]},"target":{"type":"string","enum":["ai_agent"]},"targetAppId":{"type":"string","pattern":"^[0-9]+$"},"metadata":{"type":"string","maxLength":2000}}}}}},"x-pozy-area":"inbox"}},"/v1/inbox/conversations/{conversationId}/accept":{"post":{"operationId":"acceptConversationRequest","summary":"Accept a message request","tags":["Messages"],"parameters":[{"name":"conversationId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"data":{"type":"object","properties":{"messageId":{"type":"string"}}}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","message"],"properties":{"accountId":{"type":"string"},"message":{"type":"string","minLength":1}}}}}},"x-pozy-area":"inbox"}},"/v1/inbox/labels":{"get":{"operationId":"listInboxLabels","summary":"List the Page's conversation labels","tags":["Messages"],"parameters":[{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"labels":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}}}}}}}}}},"x-pozy-area":"inbox"},"post":{"operationId":"createInboxLabel","summary":"Create a conversation label","tags":["Messages"],"responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"label":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}}}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","name"],"properties":{"accountId":{"type":"string"},"name":{"type":"string","minLength":1}}}}}},"x-pozy-area":"inbox"}},"/v1/inbox/labels/{labelId}":{"delete":{"operationId":"deleteInboxLabel","summary":"Delete a conversation label","tags":["Messages"],"parameters":[{"name":"labelId","in":"path","required":true,"schema":{"type":"string","pattern":"^[0-9]+$"}},{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"}}}}}}},"x-pozy-area":"inbox"}},"/v1/inbox/conversations/{conversationId}/labels":{"get":{"operationId":"listConversationLabels","summary":"List the labels on a conversation","tags":["Messages"],"parameters":[{"name":"conversationId","in":"path","required":true,"schema":{"type":"string"}},{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"labels":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}}}}}}}}}},"x-pozy-area":"inbox"},"post":{"operationId":"addConversationLabel","summary":"Add a label to a conversation","tags":["Messages"],"parameters":[{"name":"conversationId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","labelId"],"properties":{"accountId":{"type":"string"},"labelId":{"type":"string","pattern":"^[0-9]+$"}}}}}},"x-pozy-area":"inbox"}},"/v1/inbox/conversations/{conversationId}/labels/{labelId}":{"delete":{"operationId":"removeConversationLabel","summary":"Remove a label from a conversation","tags":["Messages"],"parameters":[{"name":"conversationId","in":"path","required":true,"schema":{"type":"string"}},{"name":"labelId","in":"path","required":true,"schema":{"type":"string","pattern":"^[0-9]+$"}},{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"}}}}}}},"x-pozy-area":"inbox"}},"/v1/inbox/conversations/{conversationId}/read":{"post":{"operationId":"markConversationRead","summary":"Mark a conversation as read","tags":["Messages"],"parameters":[{"name":"conversationId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"markedCount":{"type":"integer"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId"],"properties":{"accountId":{"type":"string"}}}}}},"x-pozy-area":"inbox"}},"/v1/inbox/conversations/{conversationId}/messages/{messageId}/reactions":{"post":{"operationId":"addMessageReaction","summary":"Add reaction","tags":["Messages"],"parameters":[{"name":"conversationId","in":"path","required":true,"schema":{"type":"string"}},{"name":"messageId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"messageId":{"type":"string"},"platformMessageId":{"type":"string"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","emoji"],"properties":{"accountId":{"type":"string"},"emoji":{"type":"string"}}}}}},"x-pozy-area":"inbox"},"delete":{"operationId":"removeMessageReaction","summary":"Remove reaction","tags":["Messages"],"parameters":[{"name":"conversationId","in":"path","required":true,"schema":{"type":"string"}},{"name":"messageId","in":"path","required":true,"schema":{"type":"string"}},{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"messageId":{"type":"string"},"platformMessageId":{"type":"string"}}}}}}},"x-pozy-area":"inbox"}},"/v1/media/upload-direct":{"post":{"operationId":"uploadMediaDirect","summary":"Upload media file","tags":["Messages"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string"},"filename":{"type":"string"},"contentType":{"type":"string"},"size":{"type":"integer"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"type":"object","required":["file"],"properties":{"file":{"type":"string","format":"binary"},"contentType":{"type":"string"}}}}}},"x-pozy-area":"inbox"}},"/v1/accounts/{accountId}/messenger-menu":{"get":{"operationId":"getMessengerMenu","summary":"Get persistent menu","tags":["Account Settings"],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object"}}}}}}}},"x-pozy-area":"accounts"},"put":{"operationId":"setMessengerMenu","summary":"Set persistent menu","tags":["Account Settings"],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["persistent_menu"],"properties":{"persistent_menu":{"type":"array","items":{"type":"object"}}}}}}},"x-pozy-area":"accounts"},"delete":{"operationId":"deleteMessengerMenu","summary":"Delete persistent menu","tags":["Account Settings"],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"}},"x-pozy-area":"accounts"}},"/v1/accounts/{accountId}/messenger-get-started":{"get":{"operationId":"getMessengerGetStarted","summary":"Get FB Get Started button","tags":["Account Settings"],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":["object","null"],"properties":{"payload":{"type":"string"}}}}}}}}},"x-pozy-area":"accounts"},"put":{"operationId":"setMessengerGetStarted","summary":"Set FB Get Started button","tags":["Account Settings"],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["payload"],"properties":{"payload":{"type":"string","minLength":1,"maxLength":1000}}}}}},"x-pozy-area":"accounts"},"delete":{"operationId":"deleteMessengerGetStarted","summary":"Delete FB Get Started button","tags":["Account Settings"],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"}}}}}}},"x-pozy-area":"accounts"}},"/v1/accounts/{accountId}/messenger-greeting":{"get":{"operationId":"getMessengerGreeting","summary":"Get FB greeting text","tags":["Account Settings"],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/MessengerGreeting"}}}}}}}},"x-pozy-area":"accounts"},"put":{"operationId":"setMessengerGreeting","summary":"Set FB greeting text","tags":["Account Settings"],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["greeting"],"properties":{"greeting":{"type":"array","minItems":1,"items":{"$ref":"#/components/schemas/MessengerGreeting"}}}}}}},"x-pozy-area":"accounts"},"delete":{"operationId":"deleteMessengerGreeting","summary":"Delete FB greeting text","tags":["Account Settings"],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"}}}}}}},"x-pozy-area":"accounts"}},"/v1/accounts/{accountId}/messenger-ice-breakers":{"get":{"operationId":"getMessengerIceBreakers","summary":"Get FB ice breakers","tags":["Account Settings"],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/MessengerIceBreakerLocale"}}}}}}}},"x-pozy-area":"accounts"},"put":{"operationId":"setMessengerIceBreakers","summary":"Set FB ice breakers","tags":["Account Settings"],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ice_breakers"],"properties":{"ice_breakers":{"type":"array","minItems":1,"items":{"$ref":"#/components/schemas/MessengerIceBreakerLocale"}}}}}}},"x-pozy-area":"accounts"},"delete":{"operationId":"deleteMessengerIceBreakers","summary":"Delete FB ice breakers","tags":["Account Settings"],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"}}}}}}},"x-pozy-area":"accounts"}},"/v1/accounts/{accountId}/instagram-ice-breakers":{"get":{"operationId":"getInstagramIceBreakers","summary":"Get IG ice breakers","tags":["Account Settings"],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object"}}}}}}}},"x-pozy-area":"accounts"},"put":{"operationId":"setInstagramIceBreakers","summary":"Set IG ice breakers","tags":["Account Settings"],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ice_breakers"],"properties":{"ice_breakers":{"type":"array","minItems":1,"maxItems":4,"items":{"type":"object","required":["question","payload"],"properties":{"question":{"type":"string","minLength":1,"maxLength":80},"payload":{"type":"string","minLength":1}}}}}}}}},"x-pozy-area":"accounts"},"delete":{"operationId":"deleteInstagramIceBreakers","summary":"Delete IG ice breakers","tags":["Account Settings"],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"}},"x-pozy-area":"accounts"}},"/v1/accounts/{accountId}/telegram-commands":{"get":{"operationId":"getTelegramCommands","summary":"Get TG bot commands","tags":["Account Settings"],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"command":{"type":"string","minLength":1,"maxLength":32,"pattern":"^[a-z0-9_]+$"},"description":{"type":"string","minLength":1,"maxLength":256}}}}}}}}}},"x-pozy-area":"accounts"},"put":{"operationId":"setTelegramCommands","summary":"Set TG bot commands","tags":["Account Settings"],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["commands"],"properties":{"commands":{"type":"array","maxItems":100,"items":{"type":"object","required":["command","description"],"properties":{"command":{"type":"string","minLength":1,"maxLength":32,"pattern":"^[a-z0-9_]+$"},"description":{"type":"string","minLength":1,"maxLength":256}}}}}}}}},"x-pozy-area":"accounts"},"delete":{"operationId":"deleteTelegramCommands","summary":"Delete TG bot commands","tags":["Account Settings"],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"}},"x-pozy-area":"accounts"}},"/v1/inbox/conversations/{conversationId}/messages/{messageId}/attachments/{index}":{"get":{"operationId":"getMessageAttachment","summary":"Resolve message attachment","tags":["Messages"],"parameters":[{"name":"conversationId","in":"path","required":true,"schema":{"type":"string"}},{"name":"messageId","in":"path","required":true,"schema":{"type":"string"}},{"name":"index","in":"path","required":true,"schema":{"type":"integer","minimum":0}},{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}},{"name":"format","in":"query","required":false,"schema":{"type":"string","enum":["redirect","json"],"default":"redirect"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string"},"url":{"type":"string"},"refreshed":{"type":"boolean"}}}}}}},"x-pozy-area":"inbox"}},"/v1/inbox/comments":{"get":{"operationId":"listInboxComments","summary":"List commented posts","tags":["Comments"],"parameters":[{"name":"profileId","in":"query","required":false,"schema":{"type":"string"}},{"name":"platform","in":"query","required":false,"schema":{"type":"string","enum":["facebook","instagram","twitter","bluesky","threads","youtube","linkedin","reddit","tiktok","metaads"]}},{"name":"minComments","in":"query","required":false,"schema":{"type":"integer","minimum":0}},{"name":"since","in":"query","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"sortBy","in":"query","required":false,"schema":{"type":"string","enum":["date","comments"],"default":"date"}},{"name":"sortOrder","in":"query","required":false,"schema":{"type":"string","enum":["asc","desc"],"default":"desc"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":100,"default":50}},{"name":"cursor","in":"query","required":false,"schema":{"type":"string"}},{"name":"accountId","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"platform":{"type":"string"},"accountId":{"type":"string"},"accountUsername":{"type":"string"},"content":{"type":"string"},"picture":{"type":["string","null"]},"permalink":{"type":["string","null"]},"createdTime":{"type":"string","format":"date-time"},"commentCount":{"type":"integer"},"likeCount":{"type":"integer"},"cid":{"type":["string","null"]},"subreddit":{"type":["string","null"]},"isAd":{"type":"boolean"},"adId":{"type":"string"},"placement":{"type":"string","enum":["facebook","instagram"]}}}},"pagination":{"type":"object","properties":{"hasMore":{"type":"boolean"},"nextCursor":{"type":["string","null"]}}},"meta":{"type":"object","properties":{"accountsQueried":{"type":"integer"},"accountsFailed":{"type":"integer"},"failedAccounts":{"type":"array","items":{"type":"object","properties":{"accountId":{"type":"string"},"accountUsername":{"type":["string","null"]},"platform":{"type":"string"},"error":{"type":"string"},"code":{"type":["string","null"]},"retryAfter":{"type":["integer","null"]}}}},"lastUpdated":{"type":"string","format":"date-time"},"accountsSkipped":{"type":"array","items":{"type":"object","properties":{"accountId":{"type":"string"},"platform":{"type":"string"}}}}}}}}}}}},"x-pozy-area":"inbox"}},"/v1/inbox/comments/{postId}":{"get":{"operationId":"getInboxPostComments","summary":"Get post comments","tags":["Comments"],"parameters":[{"name":"postId","in":"path","required":true,"schema":{"type":"string"}},{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}},{"name":"subreddit","in":"query","required":false,"schema":{"type":"string"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":100,"default":25}},{"name":"cursor","in":"query","required":false,"schema":{"type":"string"}},{"name":"commentId","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string"},"comments":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"message":{"type":"string"},"createdTime":{"type":"string","format":"date-time"},"from":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"username":{"type":"string"},"picture":{"type":["string","null"]},"isOwner":{"type":"boolean"},"verifiedType":{"type":["string","null"],"enum":["blue","government","business","none"]}}},"likeCount":{"type":"integer"},"replyCount":{"type":"integer"},"platform":{"type":"string"},"url":{"type":["string","null"]},"replies":{"type":"array","items":{"type":"object"}},"repliesHasMore":{"type":"boolean"},"canReply":{"type":"boolean"},"canDelete":{"type":"boolean"},"canHide":{"type":"boolean"},"canLike":{"type":"boolean"},"isHidden":{"type":"boolean"},"isLiked":{"type":"boolean"},"likeUri":{"type":["string","null"]},"cid":{"type":["string","null"]},"parentId":{"type":["string","null"]},"rootUri":{"type":["string","null"]},"rootCid":{"type":["string","null"]}}}},"post":{"anyOf":[{"title":"Reddit post","type":"object","properties":{"id":{"type":"string"},"fullname":{"type":"string"},"title":{"type":"string"},"selftext":{"type":"string"},"author":{"type":"string"},"subreddit":{"type":"string"},"permalink":{"type":"string"},"url":{"type":"string"},"score":{"type":"integer"},"numComments":{"type":"integer"},"createdUtc":{"type":"integer"},"over18":{"type":"boolean"},"stickied":{"type":"boolean"},"flairText":{"type":["string","null"]},"isGallery":{"type":"boolean"}}},{"title":"Facebook or Instagram post","type":"object","required":["id","permalink","text","thumbnailUrl","mediaUrl","mediaType","productType","createdAt"],"properties":{"id":{"type":"string"},"permalink":{"type":["string","null"],"format":"uri"},"text":{"type":["string","null"]},"thumbnailUrl":{"type":["string","null"],"format":"uri"},"mediaUrl":{"type":["string","null"],"format":"uri"},"mediaType":{"type":["string","null"]},"productType":{"type":["string","null"]},"createdAt":{"type":["string","null"]}}},{"type":"null"}]},"comment":{"type":"object"},"pagination":{"type":"object","properties":{"hasMore":{"type":"boolean"},"cursor":{"type":["string","null"]}}},"meta":{"type":"object","properties":{"platform":{"type":"string"},"postId":{"type":"string"},"accountId":{"type":"string"},"subreddit":{"type":["string","null"]},"postUrn":{"type":"string"},"lastUpdated":{"type":"string","format":"date-time"},"adComments":{"type":["object","null"],"properties":{"adId":{"type":"string"},"adCommentsUrl":{"type":"string"}}}}}}}}}}},"x-pozy-area":"inbox"},"post":{"operationId":"replyToInboxPost","summary":"Reply to comment","tags":["Comments"],"parameters":[{"name":"postId","in":"path","required":true,"schema":{"type":"string"}},{"name":"Idempotency-Key","in":"header","required":false,"schema":{"type":"string","maxLength":255}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"data":{"type":"object","properties":{"commentId":{"type":"string"},"isReply":{"type":"boolean"},"cid":{"type":["string","null"]}}}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","message"],"properties":{"accountId":{"type":"string"},"message":{"type":"string"},"attachmentUrl":{"type":"string","format":"uri"},"commentId":{"type":"string"},"parentCid":{"type":"string"},"rootUri":{"type":"string"},"rootCid":{"type":"string"}}}}}},"x-pozy-area":"inbox"},"delete":{"operationId":"deleteInboxComment","summary":"Delete comment","tags":["Comments"],"parameters":[{"name":"postId","in":"path","required":true,"schema":{"type":"string"}},{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}},{"name":"commentId","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"data":{"type":"object","properties":{"message":{"type":"string"}}}}}}}}},"x-pozy-area":"inbox"}},"/v1/inbox/comments/{postId}/{commentId}":{"patch":{"operationId":"editInboxComment","summary":"Edit comment","tags":["Comments"],"parameters":[{"name":"postId","in":"path","required":true,"schema":{"type":"string"}},{"name":"commentId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string"},"commentId":{"type":"string"},"platform":{"type":"string"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","platform","content"],"properties":{"accountId":{"type":"string"},"platform":{"type":"string","enum":["reddit"]},"content":{"type":"string","minLength":1}}}}}},"x-pozy-area":"inbox"}},"/v1/inbox/comments/{postId}/{commentId}/moderation":{"post":{"operationId":"setCommentModeration","summary":"Set comment moderation status","tags":["Comments"],"parameters":[{"name":"postId","in":"path","required":true,"schema":{"type":"string"}},{"name":"commentId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","platform","moderationStatus"],"properties":{"accountId":{"type":"string"},"platform":{"type":"string","enum":["youtube"]},"moderationStatus":{"type":"string","enum":["published","rejected","heldForReview"]},"banAuthor":{"type":"boolean"}}}}}},"x-pozy-area":"inbox"}},"/v1/inbox/comments/{postId}/{commentId}/hide":{"post":{"operationId":"hideInboxComment","summary":"Hide comment","tags":["Comments"],"parameters":[{"name":"postId","in":"path","required":true,"schema":{"type":"string"}},{"name":"commentId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string"},"commentId":{"type":"string"},"hidden":{"type":"boolean"},"platform":{"type":"string"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId"],"properties":{"accountId":{"type":"string"}}}}}},"x-pozy-area":"inbox"},"delete":{"operationId":"unhideInboxComment","summary":"Unhide comment","tags":["Comments"],"parameters":[{"name":"postId","in":"path","required":true,"schema":{"type":"string"}},{"name":"commentId","in":"path","required":true,"schema":{"type":"string"}},{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string"},"commentId":{"type":"string"},"hidden":{"type":"boolean"},"platform":{"type":"string"}}}}}}},"x-pozy-area":"inbox"}},"/v1/inbox/comments/{postId}/{commentId}/pin":{"post":{"operationId":"pinInboxComment","summary":"Pin comment","tags":["Comments"],"parameters":[{"name":"postId","in":"path","required":true,"schema":{"type":"string"}},{"name":"commentId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string"},"commentId":{"type":"string"},"pinned":{"type":"boolean"},"platform":{"type":"string"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId"],"properties":{"accountId":{"type":"string"}}}}}},"x-pozy-area":"inbox"},"delete":{"operationId":"unpinInboxComment","summary":"Unpin comment","tags":["Comments"],"parameters":[{"name":"postId","in":"path","required":true,"schema":{"type":"string"}},{"name":"commentId","in":"path","required":true,"schema":{"type":"string"}},{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string"},"commentId":{"type":"string"},"pinned":{"type":"boolean"},"platform":{"type":"string"}}}}}}},"x-pozy-area":"inbox"}},"/v1/inbox/comments/{postId}/{commentId}/like":{"post":{"operationId":"likeInboxComment","summary":"Like comment","tags":["Comments"],"parameters":[{"name":"postId","in":"path","required":true,"schema":{"type":"string"}},{"name":"commentId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string"},"commentId":{"type":"string"},"liked":{"type":"boolean"},"likeUri":{"type":"string"},"alreadyReacted":{"type":"boolean"},"reactionType":{"type":"string"},"platform":{"type":"string"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId"],"properties":{"accountId":{"type":"string"},"reactionType":{"type":"string","enum":["LIKE","PRAISE","EMPATHY","INTEREST","APPRECIATION","ENTERTAINMENT"]},"cid":{"type":"string"}}}}}},"x-pozy-area":"inbox"},"delete":{"operationId":"unlikeInboxComment","summary":"Unlike comment","tags":["Comments"],"parameters":[{"name":"postId","in":"path","required":true,"schema":{"type":"string"}},{"name":"commentId","in":"path","required":true,"schema":{"type":"string"}},{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}},{"name":"likeUri","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string"},"commentId":{"type":"string"},"liked":{"type":"boolean"},"platform":{"type":"string"}}}}}}},"x-pozy-area":"inbox"}},"/v1/inbox/posts/{postId}/like":{"post":{"operationId":"likePost","summary":"Like post","tags":["Comments"],"parameters":[{"name":"postId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string"},"postId":{"type":"string"},"platform":{"type":"string"},"liked":{"type":"boolean"},"likeUri":{"type":"string"},"alreadyReacted":{"type":"boolean"},"reactionType":{"type":"string"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId"],"properties":{"accountId":{"type":"string"},"reactionType":{"type":"string","enum":["LIKE","PRAISE","EMPATHY","INTEREST","APPRECIATION","ENTERTAINMENT"]},"cid":{"type":"string"}}}}}},"x-pozy-area":"inbox"},"delete":{"operationId":"unlikePost","summary":"Unlike post","tags":["Comments"],"parameters":[{"name":"postId","in":"path","required":true,"schema":{"type":"string"}},{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}},{"name":"likeUri","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string"},"postId":{"type":"string"},"platform":{"type":"string"},"liked":{"type":"boolean"}}}}}}},"x-pozy-area":"inbox"}},"/v1/inbox/comments/{postId}/{commentId}/private-reply":{"post":{"operationId":"sendPrivateReplyToComment","summary":"Send private reply","tags":["Comments"],"parameters":[{"name":"postId","in":"path","required":true,"schema":{"type":"string"}},{"name":"commentId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string"},"messageId":{"type":"string"},"commentId":{"type":"string"},"platform":{"type":"string","enum":["instagram","facebook"]}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","message"],"properties":{"accountId":{"type":"string"},"message":{"type":"string"},"quickReplies":{"type":"array","maxItems":13,"items":{"type":"object","required":["title","payload"],"properties":{"title":{"type":"string","maxLength":20},"payload":{"type":"string"},"imageUrl":{"type":"string","format":"uri"}}}},"buttons":{"type":"array","minItems":1,"maxItems":3,"items":{"oneOf":[{"type":"object","required":["type","title","url"],"properties":{"type":{"type":"string","enum":["url"]},"title":{"type":"string","maxLength":20},"url":{"type":"string","format":"uri"}}},{"type":"object","required":["type","title","payload"],"properties":{"type":{"type":"string","enum":["postback"]},"title":{"type":"string","maxLength":20},"payload":{"type":"string"}}},{"type":"object","required":["type","title","phone"],"properties":{"type":{"type":"string","enum":["phone"]},"title":{"type":"string","maxLength":20},"phone":{"type":"string"}}}]}}}}}}},"x-pozy-area":"inbox"}},"/v1/twitter/retweet":{"post":{"operationId":"retweetPost","summary":"Retweet a post","tags":["X Engagement"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string"},"tweetId":{"type":"string"},"retweeted":{"type":"boolean"},"platform":{"type":"string"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","tweetId"],"properties":{"accountId":{"type":"string"},"tweetId":{"type":"string"}}}}}},"x-pozy-area":"inbox"},"delete":{"operationId":"undoRetweet","summary":"Undo retweet","tags":["X Engagement"],"parameters":[{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}},{"name":"tweetId","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string"},"tweetId":{"type":"string"},"retweeted":{"type":"boolean"},"platform":{"type":"string"}}}}}}},"x-pozy-area":"inbox"}},"/v1/twitter/bookmark":{"post":{"operationId":"bookmarkPost","summary":"Bookmark a tweet","tags":["X Engagement"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string"},"tweetId":{"type":"string"},"bookmarked":{"type":"boolean"},"platform":{"type":"string"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","tweetId"],"properties":{"accountId":{"type":"string"},"tweetId":{"type":"string"}}}}}},"x-pozy-area":"inbox"},"delete":{"operationId":"removeBookmark","summary":"Remove bookmark","tags":["X Engagement"],"parameters":[{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}},{"name":"tweetId","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string"},"tweetId":{"type":"string"},"bookmarked":{"type":"boolean"},"platform":{"type":"string"}}}}}}},"x-pozy-area":"inbox"}},"/v1/twitter/follow":{"post":{"operationId":"followUser","summary":"Follow a user","tags":["X Engagement"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string"},"targetUserId":{"type":"string"},"following":{"type":"boolean"},"pending_follow":{"type":"boolean"},"platform":{"type":"string"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","targetUserId"],"properties":{"accountId":{"type":"string"},"targetUserId":{"type":"string"}}}}}},"x-pozy-area":"inbox"},"delete":{"operationId":"unfollowUser","summary":"Unfollow a user","tags":["X Engagement"],"parameters":[{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}},{"name":"targetUserId","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string"},"targetUserId":{"type":"string"},"following":{"type":"boolean"},"platform":{"type":"string"}}}}}}},"x-pozy-area":"inbox"}},"/v1/twitter/search":{"get":{"operationId":"searchTweets","summary":"Search recent tweets","tags":["X Engagement"],"parameters":[{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}},{"name":"query","in":"query","required":true,"schema":{"type":"string","minLength":1,"maxLength":512}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":10,"maximum":100,"default":10}},{"name":"sinceId","in":"query","required":false,"schema":{"type":"string","pattern":"^[0-9]{1,19}$"}},{"name":"untilId","in":"query","required":false,"schema":{"type":"string","pattern":"^[0-9]{1,19}$"}},{"name":"startTime","in":"query","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"endTime","in":"query","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"cursor","in":"query","required":false,"schema":{"type":"string"}},{"name":"sortOrder","in":"query","required":false,"schema":{"type":"string","enum":["recency","relevancy"],"default":"recency"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string"},"tweets":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"text":{"type":"string"},"created":{"type":"string","format":"date-time"},"conversationId":{"type":"string"},"inReplyToTweetId":{"type":["string","null"]},"lang":{"type":"string"},"author":{"type":"object","properties":{"id":{"type":"string"},"username":{"type":"string"},"displayName":{"type":"string"},"avatar":{"type":"string"},"verifiedType":{"type":"string"}}},"likeCount":{"type":"integer"},"replyCount":{"type":"integer"},"retweetCount":{"type":"integer"},"quoteCount":{"type":"integer"},"platform":{"type":"string"}}}},"pagination":{"type":"object","properties":{"hasMore":{"type":"boolean"},"cursor":{"type":["string","null"]}}},"meta":{"type":"object","properties":{"resultCount":{"type":"integer"},"newestId":{"type":["string","null"]},"oldestId":{"type":["string","null"]},"platform":{"type":"string"}}}}}}}}},"x-pozy-area":"inbox"}},"/v1/twitter/tweet":{"get":{"operationId":"getTweet","summary":"Look up a tweet","tags":["X Engagement"],"parameters":[{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}},{"name":"tweetId","in":"query","required":true,"schema":{"type":"string"}},{"name":"id","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string"},"tweet":{"type":"object","properties":{"id":{"type":"string"},"text":{"type":"string"},"created":{"type":"string","format":"date-time"},"conversationId":{"type":"string"},"inReplyToTweetId":{"type":["string","null"]},"lang":{"type":"string"},"author":{"type":"object","properties":{"id":{"type":"string"},"username":{"type":"string"},"displayName":{"type":"string"},"avatar":{"type":"string"},"verifiedType":{"type":"string"}}},"likeCount":{"type":"integer"},"replyCount":{"type":"integer"},"retweetCount":{"type":"integer"},"quoteCount":{"type":"integer"},"platform":{"type":"string"}}}}}}}}},"x-pozy-area":"inbox"}},"/v1/inbox/mentions":{"get":{"operationId":"listInboxMentions","summary":"List mentions","tags":["Mentions"],"parameters":[{"name":"accountId","in":"query","required":false,"schema":{"type":"string"}},{"name":"profileId","in":"query","required":false,"schema":{"type":"string"}},{"name":"sortOrder","in":"query","required":false,"schema":{"type":"string","enum":["asc","desc"],"default":"desc"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":100,"default":25}},{"name":"cursor","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"platform":{"type":"string","enum":["linkedin","instagram","facebook"]},"type":{"type":["string","null"],"enum":["caption","post","comment",null]},"mediaId":{"type":["string","null"]},"postId":{"type":["string","null"]},"commentId":{"type":["string","null"]},"accountId":{"type":"string"},"accountUsername":{"type":"string"},"content":{"type":"string"},"permalink":{"type":["string","null"]},"authorUrn":{"type":["string","null"]},"authorName":{"type":["string","null"]},"authorUsername":{"type":["string","null"]},"authorPicture":{"type":["string","null"]},"organizationalEntity":{"type":"string"},"publishedAt":{"type":"string","format":"date-time"},"createdAt":{"type":"string","format":"date-time"}}}},"pagination":{"type":"object","properties":{"hasMore":{"type":"boolean"},"cursor":{"type":["string","null"]}}},"meta":{"type":"object","properties":{"total":{"type":"integer"},"sortOrder":{"type":"string","enum":["asc","desc"]}}}}}}}}},"x-pozy-area":"inbox"}},"/v1/inbox/mentions/reply":{"post":{"operationId":"replyToMention","summary":"Reply to a mention","tags":["Mentions"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"id":{"type":"string"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","mediaId","message"],"properties":{"accountId":{"type":"string"},"mediaId":{"type":"string"},"commentId":{"type":"string"},"message":{"type":"string"}}}}}},"x-pozy-area":"inbox"}},"/v1/inbox/reviews":{"get":{"operationId":"listInboxReviews","summary":"List reviews","tags":["Reviews"],"parameters":[{"name":"profileId","in":"query","required":false,"schema":{"type":"string"}},{"name":"platform","in":"query","required":false,"schema":{"type":"string","enum":["facebook","googlebusiness"]}},{"name":"minRating","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":5}},{"name":"maxRating","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":5}},{"name":"hasReply","in":"query","required":false,"schema":{"type":"boolean"}},{"name":"sortBy","in":"query","required":false,"schema":{"type":"string","enum":["date","rating"],"default":"date"}},{"name":"sortOrder","in":"query","required":false,"schema":{"type":"string","enum":["asc","desc"],"default":"desc"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":50,"default":25}},{"name":"cursor","in":"query","required":false,"schema":{"type":"string"}},{"name":"accountId","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string"},"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"platform":{"type":"string"},"accountId":{"type":"string"},"accountUsername":{"type":"string"},"locationId":{"type":"string"},"locationName":{"type":["string","null"]},"reviewer":{"type":"object","properties":{"id":{"type":["string","null"]},"name":{"type":"string"},"profileImage":{"type":["string","null"]}}},"rating":{"type":"integer"},"recommendationType":{"type":["string","null"],"enum":["positive","negative",null]},"text":{"type":"string"},"created":{"type":"string","format":"date-time"},"hasReply":{"type":"boolean"},"hasPhotos":{"type":"boolean"},"photoCount":{"type":"integer"},"photos":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string","format":"uri"}}}},"reply":{"type":["object","null"],"properties":{"id":{"type":"string"},"text":{"type":"string"},"created":{"type":"string","format":"date-time"}}},"reviewUrl":{"type":["string","null"]}}}},"pagination":{"type":"object","properties":{"hasMore":{"type":"boolean"},"nextCursor":{"type":["string","null"]}}},"meta":{"type":"object","properties":{"accountsQueried":{"type":"integer"},"accountsFailed":{"type":"integer"},"failedAccounts":{"type":"array","items":{"type":"object","properties":{"accountId":{"type":"string"},"accountUsername":{"type":["string","null"]},"platform":{"type":"string"},"error":{"type":"string"},"code":{"type":["string","null"]},"retryAfter":{"type":["integer","null"]}}}},"lastUpdated":{"type":"string","format":"date-time"},"accountsSkipped":{"type":"array","items":{"type":"object","properties":{"accountId":{"type":"string"},"platform":{"type":"string"}}}}}},"summary":{"type":"object","properties":{"totalReviews":{"type":"integer"},"averageRating":{"type":["number","null"]}}}}}}}}},"x-pozy-area":"inbox"}},"/v1/inbox/reviews/{reviewId}/reply":{"post":{"operationId":"replyToInboxReview","summary":"Reply to review","tags":["Reviews"],"parameters":[{"name":"reviewId","in":"path","required":true,"schema":{"type":"string"}},{"name":"Idempotency-Key","in":"header","required":false,"schema":{"type":"string","maxLength":255}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string"},"reply":{"type":"object","properties":{"id":{"type":"string"},"text":{"type":"string"},"created":{"type":"string","format":"date-time"}}},"platform":{"type":"string"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","message"],"properties":{"accountId":{"type":"string"},"message":{"type":"string"}}}}}},"x-pozy-area":"inbox"},"delete":{"operationId":"deleteInboxReviewReply","summary":"Delete review reply","tags":["Reviews"],"parameters":[{"name":"reviewId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string"},"message":{"type":"string"},"platform":{"type":"string"}}}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId"],"properties":{"accountId":{"type":"string"}}}}}},"x-pozy-area":"inbox"}},"/v1/whatsapp/templates":{"get":{"operationId":"getWhatsAppTemplates","summary":"List templates","tags":["WhatsApp"],"parameters":[{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}},{"name":"name","in":"query","required":false,"schema":{"type":"string"}},{"name":"language","in":"query","required":false,"schema":{"type":"string"}},{"name":"status","in":"query","required":false,"schema":{"type":"string","enum":["APPROVED","REJECTED","PENDING","PAUSED","DISABLED","IN_APPEAL","PENDING_DELETION"]}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"templates":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"status":{"type":"string","enum":["APPROVED","PENDING","REJECTED"]},"category":{"type":"string","enum":["AUTHENTICATION","MARKETING","UTILITY"]},"language":{"type":"string"},"message_send_ttl_seconds":{"type":"integer"},"components":{"type":"array","items":{"type":"object"}}}}}}}}}}},"x-pozy-area":"whatsapp"},"post":{"operationId":"createWhatsAppTemplate","summary":"Create template","tags":["WhatsApp"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"template":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"status":{"type":"string"},"category":{"type":"string"},"language":{"type":"string"},"message_send_ttl_seconds":{"type":"integer"}}}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","name","category","language"],"properties":{"accountId":{"type":"string"},"name":{"type":"string","pattern":"^[a-z][a-z0-9_]*$"},"category":{"type":"string","enum":["AUTHENTICATION","MARKETING","UTILITY"]},"language":{"type":"string"},"parameter_format":{"type":"string","enum":["POSITIONAL","NAMED","positional","named"]},"components":{"type":"array","minItems":1,"items":{"$ref":"#/components/schemas/WhatsAppTemplateComponent"}},"library_template_name":{"type":"string"},"library_template_body_inputs":{"type":"object"},"library_template_button_inputs":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["quick_reply","url","phone_number"]},"url":{"type":"object","properties":{"base_url":{"type":"string"}}},"phone_number":{"type":"string"}}}},"message_send_ttl_seconds":{"type":"integer"}}}}}},"x-pozy-area":"whatsapp"}},"/v1/whatsapp/templates/{templateName}":{"get":{"operationId":"getWhatsAppTemplate","summary":"Get template","tags":["WhatsApp"],"parameters":[{"name":"templateName","in":"path","required":true,"schema":{"type":"string"}},{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}},{"name":"language","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"template":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"status":{"type":"string"},"category":{"type":"string"},"language":{"type":"string"},"components":{"type":"array","items":{"type":"object"}},"message_send_ttl_seconds":{"type":"integer"},"rejected_reason":{"type":"string"},"quality_score":{"type":"object"}}}}}}}}},"x-pozy-area":"whatsapp"},"patch":{"operationId":"updateWhatsAppTemplate","summary":"Update template","tags":["WhatsApp"],"parameters":[{"name":"templateName","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"template":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"language":{"type":"string"},"status":{"type":"string"}}}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId"],"properties":{"accountId":{"type":"string"},"language":{"type":"string"},"components":{"type":"array","minItems":1,"items":{"$ref":"#/components/schemas/WhatsAppTemplateComponent"}},"message_send_ttl_seconds":{"type":"integer"}}}}}},"x-pozy-area":"whatsapp"},"delete":{"operationId":"deleteWhatsAppTemplate","summary":"Delete template","tags":["WhatsApp"],"parameters":[{"name":"templateName","in":"path","required":true,"schema":{"type":"string"}},{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}},{"name":"language","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"scope":{"type":"string","enum":["all_languages","language"]},"language":{"type":"string"},"message":{"type":"string"}}}}}}},"x-pozy-area":"whatsapp"}},"/v1/whatsapp/templates/id/{templateId}":{"get":{"operationId":"getWhatsAppTemplateById","summary":"Get template by id","tags":["WhatsApp"],"parameters":[{"name":"templateId","in":"path","required":true,"schema":{"type":"string"}},{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"template":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"status":{"type":"string"},"category":{"type":"string"},"language":{"type":"string"},"components":{"type":"array","items":{"type":"object"}},"message_send_ttl_seconds":{"type":"integer"},"rejected_reason":{"type":"string"},"quality_score":{"type":"object"}}}}}}}}},"x-pozy-area":"whatsapp"},"patch":{"operationId":"updateWhatsAppTemplateById","summary":"Update template by id","tags":["WhatsApp"],"parameters":[{"name":"templateId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"template":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"language":{"type":"string"},"status":{"type":"string"}}}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId"],"properties":{"accountId":{"type":"string"},"components":{"type":"array","minItems":1,"items":{"$ref":"#/components/schemas/WhatsAppTemplateComponent"}},"message_send_ttl_seconds":{"type":"integer"}}}}}},"x-pozy-area":"whatsapp"},"delete":{"operationId":"deleteWhatsAppTemplateById","summary":"Delete template by id","tags":["WhatsApp"],"parameters":[{"name":"templateId","in":"path","required":true,"schema":{"type":"string"}},{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"scope":{"type":"string","enum":["language"]},"language":{"type":"string"},"message":{"type":"string"}}}}}}},"x-pozy-area":"whatsapp"}},"/v1/whatsapp/calling":{"get":{"operationId":"getWhatsAppCallingConfig","summary":"Get calling config for an account","tags":["WhatsApp Calling"],"parameters":[{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"phoneNumberDocId":{"type":"string"},"phoneNumber":{"type":"string"},"callingEnabled":{"type":"boolean"},"callDeepLink":{"type":["string","null"]},"forwardTo":{"type":["string","null"]},"recordingEnabled":{"type":"boolean"},"sipAuthUsername":{"type":["string","null"]},"sipAuthPasswordConfigured":{"type":"boolean"},"callIconCountries":{"type":["array","null"],"items":{"type":"string","minLength":2,"maxLength":2}},"callerIdMode":{"type":"string","enum":["business","platform"]},"callerIdVerified":{"type":"boolean"},"maxCallDurationSeconds":{"type":["integer","null"]},"forwardCallerId":{"type":"string","enum":["business","caller"]}}}}}}},"x-pozy-area":"whatsapp"}},"/v1/whatsapp/phone-numbers/{id}/calling":{"post":{"operationId":"enableWhatsAppCallingLegacy","summary":"Enable calling on a number","tags":["WhatsApp Calling"],"deprecated":true,"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"callingEnabled":{"type":"boolean"},"sipHostname":{"type":"string"},"forwardTo":{"type":"string"},"callerIdMode":{"type":"string","enum":["business","platform"]}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","forwardTo"],"properties":{"accountId":{"type":"string"},"forwardTo":{"type":"string"},"sipAuthUsername":{"type":"string"},"sipAuthPassword":{"type":"string"},"recordingEnabled":{"type":"boolean","default":false},"callIconCountries":{"type":"array","items":{"type":"string","minLength":2,"maxLength":2}},"maxCallDurationSeconds":{"type":"integer","minimum":30,"maximum":14400},"forwardCallerId":{"type":"string","enum":["business","caller"],"default":"business"}}}}}},"x-pozy-area":"whatsapp"},"patch":{"operationId":"updateWhatsAppCallingLegacy","summary":"Update calling config","tags":["WhatsApp Calling"],"deprecated":true,"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId"],"properties":{"accountId":{"type":"string"},"forwardTo":{"type":"string"},"sipAuthUsername":{"type":["string","null"]},"sipAuthPassword":{"type":["string","null"]},"recordingEnabled":{"type":"boolean"},"callIconCountries":{"type":["array","null"],"items":{"type":"string","minLength":2,"maxLength":2}},"maxCallDurationSeconds":{"type":["integer","null"],"minimum":30,"maximum":14400},"forwardCallerId":{"type":"string","enum":["business","caller"]}}}}}},"x-pozy-area":"whatsapp"},"delete":{"operationId":"disableWhatsAppCallingLegacy","summary":"Disable calling on a number","tags":["WhatsApp Calling"],"deprecated":true,"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"}},"x-pozy-area":"whatsapp"}},"/v1/whatsapp/call-permissions":{"get":{"operationId":"getWhatsAppCallPermissions","summary":"Check call permission","tags":["WhatsApp Calling"],"parameters":[{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}},{"name":"to","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"permission":{"type":"object","properties":{"status":{"type":"string","enum":["temporary","no_permission","permanent"]},"expiration_time":{"type":"integer"}}},"actions":{"type":"array","items":{"type":"object","properties":{"action_name":{"type":"string","enum":["send_call_permission_request","start_call"]},"can_perform_action":{"type":"boolean"}}}}}}}}}},"x-pozy-area":"whatsapp"}},"/v1/whatsapp/calls":{"get":{"operationId":"listWhatsAppCalls","summary":"List call history for an account","tags":["WhatsApp Calling"],"parameters":[{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}},{"name":"status","in":"query","required":false,"schema":{"type":"string","enum":["ringing","answered","ended","failed"]}},{"name":"direction","in":"query","required":false,"schema":{"type":"string","enum":["inbound","outbound"]}},{"name":"since","in":"query","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"until","in":"query","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"before","in":"query","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":200}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"calls":{"type":"array","items":{"type":"object","properties":{"_id":{"type":"string"},"direction":{"type":"string","enum":["inbound","outbound"]},"from":{"type":"string"},"to":{"type":"string"},"status":{"type":"string","enum":["ringing","answered","ended","failed"]},"startedAt":{"type":"string","format":"date-time"},"endedAt":{"type":"string","format":"date-time"},"durationSeconds":{"type":"integer"},"endReason":{"type":"string","enum":["hangup","no_answer","rejected","error"]},"recordingUrl":{"type":"string"},"billing":{"type":"object","properties":{"metaCostUSD":{"type":"number"},"carrierCostUSD":{"type":"number"},"recordingCostUSD":{"type":"number"},"billableCostUSD":{"type":"number"},"totalCostUSD":{"type":"number"},"currency":{"type":"string"}}}}}},"nextCursor":{"type":["string","null"],"format":"date-time"}}}}}}},"x-pozy-area":"whatsapp"},"post":{"operationId":"initiateWhatsAppCall","summary":"Initiate outbound call","tags":["WhatsApp Calling"],"parameters":[{"name":"Idempotency-Key","in":"header","required":false,"schema":{"type":"string","maxLength":255}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"callId":{"type":"string"},"carrierCallControlId":{"type":"string"},"status":{"type":"string","enum":["dialing"]},"direction":{"type":"string","enum":["outbound"]},"to":{"type":"string"},"forwardTo":{"type":["string","null"]},"recordingEnabled":{"type":"boolean"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","to"],"properties":{"accountId":{"type":"string"},"to":{"type":"string"},"action":{"type":"string","enum":["send_call_permission_request"]},"bodyText":{"type":"string","maxLength":1024},"forwardTo":{"type":"string"},"recordOverride":{"type":"boolean"},"biz_opaque_callback_data":{"type":"string","maxLength":512}}}}}},"x-pozy-area":"whatsapp"}},"/v1/whatsapp/calls/{id}":{"get":{"operationId":"getWhatsAppCall","summary":"Get a single call","tags":["WhatsApp Calling"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"call":{"type":"object"}}}}}}},"x-pozy-area":"whatsapp"}},"/v1/whatsapp/calls/{id}/recording":{"get":{"operationId":"getWhatsAppCallRecording","summary":"Get a call recording","tags":["WhatsApp Calling"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}},{"name":"as","in":"query","required":false,"schema":{"type":"string","enum":["json"]}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string"}}}}}}},"x-pozy-area":"whatsapp"}},"/v1/whatsapp/calls/estimate":{"get":{"operationId":"getWhatsAppCallEstimate","summary":"Estimate per-minute cost","tags":["WhatsApp Calling"],"parameters":[{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}},{"name":"to","in":"query","required":true,"schema":{"type":"string"}},{"name":"minutes","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":120}},{"name":"recording","in":"query","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"destinationCountry":{"type":["string","null"]},"perMinuteUsd":{"type":"number"},"breakdown":{"type":"object","properties":{"metaMinutes":{"type":"integer"},"metaCostUSD":{"type":"number"},"carrierCostUSD":{"type":"number"},"recordingCostUSD":{"type":"number"},"billableCostUSD":{"type":"number"},"totalCostUSD":{"type":"number"}}}}}}}}},"x-pozy-area":"whatsapp"}},"/v1/calls":{"get":{"operationId":"listCalls","summary":"List all calls (unified history)","tags":["Calls"],"parameters":[{"name":"channel","in":"query","required":false,"schema":{"type":"string","enum":["whatsapp","pstn"]}},{"name":"status","in":"query","required":false,"schema":{"type":"string","enum":["ringing","answered","ended","failed"]}},{"name":"direction","in":"query","required":false,"schema":{"type":"string","enum":["inbound","outbound"]}},{"name":"number","in":"query","required":false,"schema":{"type":"string"}},{"name":"search","in":"query","required":false,"schema":{"type":"string"}},{"name":"before","in":"query","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":200,"default":50}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"calls":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/CallRecord"},{"type":"object","properties":{"contactName":{"type":"string"}}}]}},"nextCursor":{"type":["string","null"],"format":"date-time"}}}}}}},"x-pozy-area":"telephony"}},"/v1/calls/{id}":{"get":{"operationId":"getCall","summary":"Get a call (any channel)","tags":["Calls"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"call":{"allOf":[{"$ref":"#/components/schemas/CallRecord"},{"type":"object","properties":{"contactName":{"type":"string"}}}]}}}}}}},"x-pozy-area":"telephony"}},"/v1/calls/{id}/recording":{"get":{"operationId":"getCallRecording","summary":"Get a call recording","tags":["Calls"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"name":"as","in":"query","required":false,"schema":{"type":"string","enum":["json"]}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string"}}}}}}},"x-pozy-area":"telephony"}},"/v1/voice/calls":{"get":{"operationId":"listVoiceCalls","summary":"List phone calls","tags":["Voice"],"parameters":[{"name":"status","in":"query","required":false,"schema":{"type":"string","enum":["ringing","answered","ended","failed"]}},{"name":"direction","in":"query","required":false,"schema":{"type":"string","enum":["inbound","outbound"]}},{"name":"number","in":"query","required":false,"schema":{"type":"string"}},{"name":"before","in":"query","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":200,"default":50}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"calls":{"type":"array","items":{"$ref":"#/components/schemas/CallRecord"}},"nextCursor":{"type":["string","null"],"format":"date-time"}}}}}}},"x-pozy-area":"telephony"},"post":{"operationId":"createVoiceCall","summary":"Place an outbound phone call","tags":["Voice"],"parameters":[{"name":"Idempotency-Key","in":"header","required":false,"schema":{"type":"string","maxLength":255}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"callId":{"type":"string"},"carrierCallControlId":{"type":"string"},"status":{"type":"string","enum":["dialing"]},"direction":{"type":"string","enum":["outbound"]},"from":{"type":"string"},"to":{"type":"string"},"forwardTo":{"type":"string"},"greeting":{"type":["string","null"]},"recordingEnabled":{"type":"boolean"},"transcriptionEnabled":{"type":"boolean"},"transcriptionLanguage":{"type":"string","enum":["auto","en","es"]}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["to"],"properties":{"to":{"type":"string","pattern":"^\\+\\d{6,15}$"},"fromNumber":{"type":"string","pattern":"^\\+\\d{6,15}$"},"forwardTo":{"type":"string"},"greeting":{"type":"string","maxLength":1000},"recordOverride":{"type":"boolean"},"transcribeOverride":{"type":"boolean"},"transcriptionLanguage":{"type":"string","enum":["auto","en","es"]},"amd":{"type":"boolean"},"voicemailDropMessage":{"type":"string","maxLength":1000},"ringTimeoutSeconds":{"type":"integer","minimum":5,"maximum":120,"default":30}}}}}},"x-pozy-area":"telephony"}},"/v1/voice/calls/{id}":{"get":{"operationId":"getVoiceCall","summary":"Get a phone call","tags":["Voice"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"call":{"$ref":"#/components/schemas/CallRecord"}}}}}}},"x-pozy-area":"telephony"}},"/v1/voice/calls/{id}/end":{"post":{"operationId":"endVoiceCall","summary":"Hang up a live call","tags":["Voice"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"callId":{"type":"string"},"status":{"type":"string"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"x-pozy-area":"telephony"}},"/v1/voice/calls/{id}/recording":{"get":{"operationId":"getVoiceCallRecording","summary":"Get a call recording","tags":["Voice"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"name":"as","in":"query","required":false,"schema":{"type":"string","enum":["json"]}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string"}}}}}}},"x-pozy-area":"telephony"}},"/v1/voice/calls/{id}/transfer":{"post":{"operationId":"transferVoiceCall","summary":"Blind-transfer a live call","tags":["Voice"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"callId":{"type":"string"},"transferredTo":{"type":"string"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["to"],"properties":{"to":{"type":"string"}}}}}},"x-pozy-area":"telephony"}},"/v1/voice/calls/estimate":{"get":{"operationId":"getVoiceCallEstimate","summary":"Estimate call cost","tags":["Voice"],"parameters":[{"name":"to","in":"query","required":true,"schema":{"type":"string"}},{"name":"from","in":"query","required":false,"schema":{"type":"string"}},{"name":"minutes","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":120,"default":1}},{"name":"recording","in":"query","required":false,"schema":{"type":"boolean"}},{"name":"transcription","in":"query","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"destinationCountry":{"type":["string","null"]},"minutes":{"type":"integer"},"perMinuteUsd":{"type":"number"},"breakdown":{"type":"object","properties":{"carrierCostUSD":{"type":"number"},"recordingCostUSD":{"type":"number"},"transcriptionCostUSD":{"type":"number"},"brandedCallUSD":{"type":"number"},"billableCostUSD":{"type":"number"},"totalCostUSD":{"type":"number"}}}}}}}}},"x-pozy-area":"telephony"}},"/v1/voice/calls/web":{"post":{"operationId":"createVoiceWebSession","summary":"Mint a browser softphone session","tags":["Voice"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"token":{"type":"string"},"credentialId":{"type":"string"},"expiresAt":{"type":"string","format":"date-time"},"sdk":{"type":"string"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"x-pozy-area":"telephony"}},"/v1/voice/calls/web/dial":{"post":{"operationId":"dialVoiceWebCall","summary":"Dial from the browser softphone","tags":["Voice"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"callId":{"type":"string"},"carrierCallControlId":{"type":"string"},"status":{"type":"string","enum":["dialing"]},"direction":{"type":"string","enum":["outbound"]},"from":{"type":"string"},"to":{"type":"string"},"recordingEnabled":{"type":"boolean"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["to","credentialId"],"properties":{"to":{"type":"string","pattern":"^\\+\\d{6,15}$"},"credentialId":{"type":"string"},"fromNumber":{"type":"string","pattern":"^\\+\\d{6,15}$"},"recordOverride":{"type":"boolean"},"ringTimeoutSeconds":{"type":"integer","minimum":5,"maximum":120,"default":30}}}}}},"x-pozy-area":"telephony"}},"/v1/imessage/senders":{"get":{"operationId":"listImessageSenders","summary":"List iMessage senders","tags":["iMessage"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"senders":{"type":"array","items":{"$ref":"#/components/schemas/ImessageSender"}}}}}}}},"x-pozy-area":"messaging"},"post":{"operationId":"registerImessageSender","summary":"Register an iMessage sender","tags":["iMessage"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"account":{"$ref":"#/components/schemas/ImessageSender"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["profileId","sender"],"properties":{"profileId":{"type":"string"},"sender":{"type":"string"},"displayName":{"type":"string","maxLength":100},"provider":{"type":"string","enum":["standard"]}}}}}},"x-pozy-area":"messaging"}},"/v1/imessage/senders/order":{"get":{"operationId":"listImessageSenderOrders","summary":"List iMessage sender orders","tags":["iMessage"],"parameters":[{"name":"includeCanceled","in":"query","required":false,"schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"senders":{"type":"array","items":{"$ref":"#/components/schemas/ImessageSenderLifecycle"}}}}}}}},"x-pozy-area":"messaging"},"post":{"operationId":"orderImessageSender","summary":"Order a new iMessage sender","tags":["iMessage"],"responses":{"202":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"sender":{"$ref":"#/components/schemas/ImessageSenderLifecycle"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["profileId","kind"],"properties":{"profileId":{"type":"string"},"kind":{"type":"string","enum":["phone","email"]},"region":{"type":"string","enum":["US","GB"]},"availableNumberId":{"type":"string"},"zipCode":{"type":"string","pattern":"^[0-9]{5}$"},"emailName":{"type":"string"},"emailDomain":{"type":"string"},"displayName":{"type":"string","maxLength":100},"purchaseIntentId":{"type":"string","maxLength":100},"contact":{"type":"object","required":["firstName"],"properties":{"firstName":{"type":"string","maxLength":64},"lastName":{"type":"string","maxLength":64},"photoUrl":{"type":"string","format":"uri"}}}}}}}},"x-pozy-area":"messaging"}},"/v1/imessage/senders/{senderId}":{"get":{"operationId":"getImessageSender","summary":"Get iMessage sender status","tags":["iMessage"],"parameters":[{"name":"senderId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"sender":{"$ref":"#/components/schemas/ImessageSenderLifecycle"},"health":{"type":["object","null"],"properties":{"imessage":{"type":"string","enum":["active","degradation","outage"]},"whatsapp":{"type":"string","enum":["active","degradation","outage"]}}},"imessageLink":{"type":["string","null"]}}}}}}},"x-pozy-area":"messaging"},"patch":{"operationId":"updateImessageSender","summary":"Update an iMessage sender","tags":["iMessage"],"parameters":[{"name":"senderId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"sender":{"$ref":"#/components/schemas/ImessageSenderLifecycle"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"displayName":{"type":"string","maxLength":100},"contact":{"type":"object","required":["firstName"],"properties":{"firstName":{"type":"string","maxLength":64},"lastName":{"type":"string","maxLength":64},"photoUrl":{"type":"string","format":"uri"}}}}}}}},"x-pozy-area":"messaging"},"delete":{"operationId":"cancelImessageSender","summary":"Cancel an iMessage sender","tags":["iMessage"],"parameters":[{"name":"senderId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"sender":{"$ref":"#/components/schemas/ImessageSenderLifecycle"}}}}}}},"x-pozy-area":"messaging"}},"/v1/imessage/audience":{"get":{"operationId":"listImessageAudience","summary":"List iMessage audience","tags":["iMessage"],"parameters":[{"name":"accountId","in":"query","required":false,"schema":{"type":"string"}},{"name":"status","in":"query","required":false,"schema":{"type":"string","enum":["subscribed","unsubscribed"]}},{"name":"search","in":"query","required":false,"schema":{"type":"string","maxLength":120}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":200,"default":50}},{"name":"skip","in":"query","required":false,"schema":{"type":"integer","minimum":0,"default":0}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"contacts":{"type":"array","items":{"$ref":"#/components/schemas/ImessageAudienceContact"}},"total":{"type":"integer"},"limit":{"type":"integer"},"skip":{"type":"integer"}}}}}}},"x-pozy-area":"messaging"}},"/v1/imessage/sandbox/contacts":{"get":{"operationId":"listImessageSandboxContacts","summary":"List iMessage sandbox contacts","tags":["iMessage"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"sandbox":{"type":"object","properties":{"accountId":{"type":"string"},"handle":{"type":"string"},"contactLimit":{"type":"integer"}}},"contacts":{"type":"array","items":{"$ref":"#/components/schemas/ImessageSandboxContact"}}}}}}}},"x-pozy-area":"messaging"},"post":{"operationId":"addImessageSandboxContact","summary":"Add an iMessage sandbox contact","tags":["iMessage"],"responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"contact":{"$ref":"#/components/schemas/ImessageSandboxContact"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["handle"],"properties":{"handle":{"type":"string"}}}}}},"x-pozy-area":"messaging"}},"/v1/imessage/sandbox/contacts/{contactId}":{"delete":{"operationId":"removeImessageSandboxContact","summary":"Remove an iMessage sandbox contact","tags":["iMessage"],"parameters":[{"name":"contactId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"}}}}}}},"x-pozy-area":"messaging"}},"/v1/imessage/audience/subscription":{"post":{"operationId":"setImessageSubscription","summary":"Subscribe or opt out an iMessage contact","tags":["iMessage"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"conversationId":{"type":"string"},"subscribed":{"type":"boolean"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","conversationId","subscribed"],"properties":{"accountId":{"type":"string"},"conversationId":{"type":"string"},"subscribed":{"type":"boolean"}}}}}},"x-pozy-area":"messaging"}},"/v1/imessage/senders/{senderId}/opt-in-links":{"post":{"operationId":"createImessageOptInLink","summary":"Create a tracked iMessage opt-in link","tags":["iMessage"],"parameters":[{"name":"senderId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"link":{"type":"object","properties":{"id":{"type":"string"},"imessage":{"type":"string"},"sms":{"type":["string","null"]},"whatsapp":{"type":["string","null"]},"url":{"type":"string"}}}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"string","maxLength":500},"parameters":{"type":"object","additionalProperties":{"type":"string"}},"optInCode":{"type":"string","minLength":3,"maxLength":8}}}}}},"x-pozy-area":"messaging"}},"/v1/imessage/senders/available-numbers":{"get":{"operationId":"listImessageAvailableNumbers","summary":"List instantly available iMessage numbers","tags":["iMessage"],"parameters":[{"name":"region","in":"query","required":false,"schema":{"type":"string","enum":["US","GB"]}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"numbers":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"phone":{"type":"string"},"region":{"type":"string"},"location":{"type":"string"}}}},"region":{"type":["string","null"]}}}}}}},"x-pozy-area":"messaging"}},"/v1/imessage/senders/available-numbers/{numberId}/reserve":{"post":{"operationId":"reserveImessageAvailableNumber","summary":"Reserve an available iMessage number","tags":["iMessage"],"parameters":[{"name":"numberId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"numberId":{"type":"string"},"expiresInSeconds":{"type":"integer"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"x-pozy-area":"messaging"}},"/v1/imessage/groups":{"post":{"operationId":"createImessageGroup","summary":"Start an iMessage group chat","tags":["iMessage"],"responses":{"202":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"requestId":{"type":"string"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","contacts","text"],"properties":{"accountId":{"type":"string"},"contacts":{"type":"array","minItems":2,"maxItems":32,"items":{"type":"string"}},"text":{"type":"string","maxLength":10000},"name":{"type":"string","maxLength":32},"channel":{"type":"string","enum":["imessage","sms","rcs","whatsapp"],"default":"imessage"}}}}}},"x-pozy-area":"messaging"}},"/v1/imessage/groups/{conversationId}":{"get":{"operationId":"getImessageGroup","summary":"Get an iMessage group","tags":["iMessage"],"parameters":[{"name":"conversationId","in":"path","required":true,"schema":{"type":"string"}},{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"conversationId":{"type":"string"},"group":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":["string","null"]},"participants":{"type":"array","items":{"type":"string"}},"channel":{"type":["string","null"]},"createdAt":{"type":["string","null"],"format":"date-time"}}}}}}}}},"x-pozy-area":"messaging"},"patch":{"operationId":"updateImessageGroup","summary":"Rename an iMessage group or change its photo","tags":["iMessage"],"parameters":[{"name":"conversationId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"conversationId":{"type":"string"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId"],"properties":{"accountId":{"type":"string"},"name":{"type":"string","maxLength":32},"photoUrl":{"type":"string"}}}}}},"x-pozy-area":"messaging"}},"/v1/imessage/groups/{conversationId}/participants":{"post":{"operationId":"addImessageGroupParticipant","summary":"Add a participant to an iMessage group","tags":["iMessage"],"parameters":[{"name":"conversationId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"conversationId":{"type":"string"},"contact":{"type":"string"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","contact"],"properties":{"accountId":{"type":"string"},"contact":{"type":"string"}}}}}},"x-pozy-area":"messaging"},"delete":{"operationId":"removeImessageGroupParticipant","summary":"Remove a participant from an iMessage group","tags":["iMessage"],"parameters":[{"name":"conversationId","in":"path","required":true,"schema":{"type":"string"}},{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}},{"name":"contact","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"conversationId":{"type":"string"},"contact":{"type":"string"}}}}}}},"x-pozy-area":"messaging"}},"/v1/sms/messages":{"post":{"operationId":"sendSms","summary":"Send an SMS/MMS","tags":["SMS"],"parameters":[{"name":"Idempotency-Key","in":"header","required":false,"schema":{"type":"string","maxLength":255}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"conversationId":{"type":"string"},"status":{"type":"string","enum":["sent"]}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["from","to"],"properties":{"from":{"type":"string"},"to":{"type":"string"},"text":{"type":"string"},"mediaUrls":{"type":"array","maxItems":10,"items":{"type":"string","format":"uri"}},"sendAt":{"type":"string","format":"date-time"}}}}}},"x-pozy-area":"messaging"}},"/v1/rcs/brands":{"get":{"operationId":"listRcsBrands","summary":"List RCS brands","tags":["RCS"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"brands":{"type":"array","items":{"$ref":"#/components/schemas/RcsBrand"}}}}}}}},"x-pozy-area":"messaging"}},"/v1/rcs/agents":{"get":{"operationId":"listRcsAgents","summary":"List RCS agents","tags":["RCS"],"parameters":[{"name":"includeClosed","in":"query","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"agents":{"type":"array","items":{"$ref":"#/components/schemas/RcsAgent"}}}}}}}},"x-pozy-area":"messaging"},"post":{"operationId":"createRcsAgent","summary":"Request an RCS agent","tags":["RCS"],"parameters":[{"name":"Idempotency-Key","in":"header","required":false,"schema":{"type":"string","maxLength":255}}],"responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"agent":{"$ref":"#/components/schemas/RcsAgent"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["profileId","displayName","useCase","profile"],"properties":{"profileId":{"type":"string"},"brandId":{"type":"string"},"brand":{"$ref":"#/components/schemas/RcsBrandInput"},"displayName":{"type":"string","maxLength":40},"useCase":{"type":"string","enum":["MULTI_USE","PROMOTIONAL","TRANSACTIONAL","OTP"]},"profile":{"$ref":"#/components/schemas/RcsAgentProfile"},"smsFallbackFrom":{"type":"string"}}}}}},"x-pozy-area":"messaging"}},"/v1/rcs/agents/{agentId}":{"get":{"operationId":"getRcsAgent","summary":"Get an RCS agent","tags":["RCS"],"parameters":[{"name":"agentId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"agent":{"$ref":"#/components/schemas/RcsAgent"}}}}}}},"x-pozy-area":"messaging"},"patch":{"operationId":"updateRcsAgent","summary":"Update an RCS agent","tags":["RCS"],"parameters":[{"name":"agentId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"agent":{"$ref":"#/components/schemas/RcsAgent"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","minProperties":1,"properties":{"displayName":{"type":"string","maxLength":40},"useCase":{"type":"string","enum":["MULTI_USE","PROMOTIONAL","TRANSACTIONAL","OTP"]},"profile":{"$ref":"#/components/schemas/RcsAgentProfile"},"brand":{"$ref":"#/components/schemas/RcsBrandInput"},"smsFallbackFrom":{"type":["string","null"]}}}}}},"x-pozy-area":"messaging"},"delete":{"operationId":"deactivateRcsAgent","summary":"Deactivate an RCS agent","tags":["RCS"],"parameters":[{"name":"agentId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"agent":{"$ref":"#/components/schemas/RcsAgent"}}}}}}},"x-pozy-area":"messaging"}},"/v1/rcs/agents/{agentId}/launch-request":{"post":{"operationId":"requestRcsAgentLaunch","summary":"Send the launch filing","tags":["RCS"],"parameters":[{"name":"agentId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"agent":{"$ref":"#/components/schemas/RcsAgent"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RcsLaunchRequest"}}}},"x-pozy-area":"messaging"}},"/v1/rcs/agents/{agentId}/test-devices":{"get":{"operationId":"listRcsTestDevices","summary":"List RCS test phones","tags":["RCS"],"parameters":[{"name":"agentId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"testDevices":{"type":"array","items":{"$ref":"#/components/schemas/RcsTestDevice"}}}}}}}},"x-pozy-area":"messaging"},"post":{"operationId":"addRcsTestDevice","summary":"Invite an RCS test phone","tags":["RCS"],"parameters":[{"name":"agentId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"testDevice":{"$ref":"#/components/schemas/RcsTestDevice"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["phoneNumber"],"properties":{"phoneNumber":{"type":"string"}}}}}},"x-pozy-area":"messaging"}},"/v1/rcs/agents/{agentId}/test-devices/{testDeviceId}":{"delete":{"operationId":"removeRcsTestDevice","summary":"Remove an RCS test phone","tags":["RCS"],"parameters":[{"name":"agentId","in":"path","required":true,"schema":{"type":"string"}},{"name":"testDeviceId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"}}}}}}},"x-pozy-area":"messaging"}},"/v1/rcs/assets":{"post":{"operationId":"uploadRcsAsset","summary":"Upload an RCS logo or banner","tags":["RCS"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string","format":"uri"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"type":"object","required":["file","kind"],"properties":{"file":{"type":"string","format":"binary"},"kind":{"type":"string","enum":["logo","banner"]}}}}}},"x-pozy-area":"messaging"}},"/v1/rcs/messages":{"post":{"operationId":"sendRcsMessage","summary":"Send an RCS message","tags":["RCS"],"parameters":[{"name":"Idempotency-Key","in":"header","required":false,"schema":{"type":"string","maxLength":255}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"conversationId":{"type":"string"},"status":{"type":"string","enum":["sent"]}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["agentId","to"],"properties":{"agentId":{"type":"string"},"to":{"type":"string"},"text":{"type":"string","maxLength":3072},"content":{"$ref":"#/components/schemas/RcsContent"},"fallbackText":{"type":"string","maxLength":3072},"ttlSeconds":{"type":"integer","minimum":1}}}}}},"x-pozy-area":"messaging"}},"/v1/rcs/capabilities":{"get":{"operationId":"getRcsCapabilities","summary":"Check RCS capability","tags":["RCS"],"parameters":[{"name":"agentId","in":"query","required":true,"schema":{"type":"string"}},{"name":"numbers","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"capabilities":{"type":"array","items":{"$ref":"#/components/schemas/RcsCapability"}}}}}}}},"x-pozy-area":"messaging"}},"/v1/sms/lookup":{"get":{"operationId":"lookupSmsNumber","summary":"Look up carrier + line type","tags":["SMS"],"parameters":[{"name":"number","in":"query","required":true,"schema":{"type":"string","minLength":8}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"phoneNumber":{"type":"string"},"carrierName":{"type":["string","null"]},"lineType":{"type":"string","enum":["mobile","landline","voip","toll-free","unknown"]},"smsReachable":{"type":"boolean"}}}}}}},"x-pozy-area":"messaging"}},"/v1/sms/opt-outs":{"get":{"operationId":"listSmsOptOuts","summary":"List SMS opt-outs","tags":["SMS"],"parameters":[{"name":"format","in":"query","required":false,"schema":{"type":"string","enum":["json","csv"],"default":"json"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":5000,"default":500}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"optOuts":{"type":"array","items":{"type":"object","properties":{"phoneNumber":{"type":"string"},"optedOutAt":{"type":["string","null"],"format":"date-time"},"keyword":{"type":["string","null"]},"from":{"type":["string","null"]}}}},"count":{"type":"integer"}}}}}}},"x-pozy-area":"messaging"}},"/v1/sms/sender-ids":{"get":{"operationId":"listSmsSenderIds","summary":"List alphanumeric sender IDs","tags":["SMS"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"senderIds":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"senderId":{"type":"string"},"isActive":{"type":"boolean"},"createdAt":{"type":["string","null"],"format":"date-time"}}}}}}}}}},"x-pozy-area":"messaging"},"post":{"operationId":"createSmsSenderId","summary":"Create an alphanumeric sender ID","tags":["SMS"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"senderId":{"type":"string"},"isActive":{"type":"boolean"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["senderId"],"properties":{"senderId":{"type":"string","minLength":3,"maxLength":11}}}}}},"x-pozy-area":"messaging"}},"/v1/sms/sender-ids/limit-request":{"post":{"operationId":"requestSmsSenderIdLimitIncrease","summary":"Request a higher sender ID daily limit","tags":["SMS"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"requested":{"type":"boolean"},"requestedCap":{"type":"integer"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["requestedCap","reason"],"properties":{"requestedCap":{"type":"integer"},"reason":{"type":"string","minLength":10,"maxLength":2000}}}}}},"x-pozy-area":"messaging"}},"/v1/sms/sender-ids/{id}":{"delete":{"operationId":"deleteSmsSenderId","summary":"Delete an alphanumeric sender ID","tags":["SMS"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"deleted":{"type":"boolean"}}}}}}},"x-pozy-area":"messaging"}},"/v1/branded-calling/enterprises":{"get":{"operationId":"listBrandedCallingEnterprises","summary":"List registered businesses","tags":["Branded Calling"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"enterprises":{"type":"array","items":{"$ref":"#/components/schemas/BrandedCallingEnterprise"}}}}}}}},"x-pozy-area":"telephony"},"post":{"operationId":"createBrandedCallingEnterprise","summary":"Register a business for Branded Calling","tags":["Branded Calling"],"parameters":[{"name":"Idempotency-Key","in":"header","required":false,"schema":{"type":"string","maxLength":255}}],"responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BrandedCallingEnterprise"}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["legalName","doingBusinessAs","organizationType","organizationLegalType","countryCode","jurisdictionOfIncorporation","website","fein","industry","numberOfEmployees","organizationContact","billingContact","physicalAddress","billingAddress"],"properties":{"legalName":{"type":"string","minLength":3,"maxLength":64},"doingBusinessAs":{"type":"string","maxLength":255},"organizationType":{"type":"string","enum":["commercial","government","non_profit"]},"organizationLegalType":{"type":"string","enum":["corporation","llc","partnership","nonprofit","other"]},"countryCode":{"type":"string"},"jurisdictionOfIncorporation":{"type":"string","maxLength":255},"website":{"type":"string","format":"uri"},"fein":{"type":"string"},"industry":{"type":"string"},"numberOfEmployees":{"type":"string","enum":["1-10","11-50","51-200","201-500","501-2000","2001-10000","10001+"]},"organizationContact":{"$ref":"#/components/schemas/BrandedCallingContact"},"billingContact":{"$ref":"#/components/schemas/BrandedCallingContact"},"physicalAddress":{"$ref":"#/components/schemas/BrandedCallingAddress"},"billingAddress":{"$ref":"#/components/schemas/BrandedCallingAddress"}}}}}},"x-pozy-area":"telephony"}},"/v1/branded-calling/enterprises/{id}":{"get":{"operationId":"getBrandedCallingEnterprise","summary":"Get a registered business","tags":["Branded Calling"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BrandedCallingEnterprise"}}}}},"x-pozy-area":"telephony"},"delete":{"operationId":"deleteBrandedCallingEnterprise","summary":"Delete a registered business","tags":["Branded Calling"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["deleted"]}}}}}}},"x-pozy-area":"telephony"}},"/v1/branded-calling/share":{"post":{"operationId":"shareBrandedCallingIdentityForm","summary":"Create a caller identity share link","tags":["Branded Calling"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string"},"expiresAt":{"type":"string","format":"date-time"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{"enterpriseId":{"type":"string"},"identityId":{"type":"string"}}}}}},"x-pozy-area":"telephony"}},"/v1/branded-calling/call-reasons":{"get":{"operationId":"listBrandedCallingCallReasons","summary":"List pre-approved call reasons","tags":["Branded Calling"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"callReasons":{"type":"array","items":{"type":"string"}}}}}}}},"x-pozy-area":"telephony"}},"/v1/branded-calling/identities":{"get":{"operationId":"listBrandedCallingIdentities","summary":"List caller identities","tags":["Branded Calling"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"identities":{"type":"array","items":{"$ref":"#/components/schemas/BrandedCallingIdentity"}}}}}}}},"x-pozy-area":"telephony"},"post":{"operationId":"createBrandedCallingIdentity","summary":"Create a caller identity","tags":["Branded Calling"],"parameters":[{"name":"Idempotency-Key","in":"header","required":false,"schema":{"type":"string","maxLength":255}}],"responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BrandedCallingIdentity"}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["enterpriseId","displayName","callReasons","authorizer","references"],"properties":{"enterpriseId":{"type":"string"},"displayName":{"type":"string","minLength":1,"maxLength":35},"callReasons":{"type":"array","minItems":1,"maxItems":10,"items":{"type":"string","maxLength":64}},"logoUrl":{"type":"string"},"authorizer":{"type":"object","required":["name","email"],"properties":{"name":{"type":"string","maxLength":255},"email":{"type":"string","format":"email"}}},"references":{"$ref":"#/components/schemas/BrandedCallingReferences"}}}}}},"x-pozy-area":"telephony"}},"/v1/branded-calling/identities/preflight":{"post":{"operationId":"preflightBrandedCallingIdentity","summary":"Dry-run a caller identity before creating it","tags":["Branded Calling"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"ok":{"type":"boolean"},"findings":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","enum":["display-name-mismatch","call-reasons-manual","authorizer-free-mail","authorizer-domain-mismatch","reference-phone-duplicate","reference-internal","reference-financial-free-mail","reference-timezone-invalid","logo-unreachable"]},"severity":{"type":"string","enum":["block","warn"]},"field":{"type":"string"},"message":{"type":"string"}}}}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["enterpriseId","displayName","callReasons","authorizer","references"],"properties":{"enterpriseId":{"type":"string"},"displayName":{"type":"string","minLength":1,"maxLength":35},"callReasons":{"type":"array","minItems":1,"maxItems":10,"items":{"type":"string","maxLength":64}},"logoUrl":{"type":"string"},"authorizer":{"type":"object","required":["name","email"],"properties":{"name":{"type":"string","maxLength":255},"email":{"type":"string","format":"email"}}},"references":{"$ref":"#/components/schemas/BrandedCallingReferences"}}}}}},"x-pozy-area":"telephony"}},"/v1/branded-calling/identities/{id}":{"get":{"operationId":"getBrandedCallingIdentity","summary":"Get a caller identity","tags":["Branded Calling"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BrandedCallingIdentity"}}}}},"x-pozy-area":"telephony"},"patch":{"operationId":"updateBrandedCallingIdentity","summary":"Edit or resubmit a caller identity","tags":["Branded Calling"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BrandedCallingIdentity"}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"displayName":{"type":"string","minLength":1,"maxLength":35},"callReasons":{"type":"array","minItems":1,"maxItems":10,"items":{"type":"string","maxLength":64}},"logoUrl":{"type":"string"},"authorizer":{"type":"object","required":["name","email"],"properties":{"name":{"type":"string","maxLength":255},"email":{"type":"string","format":"email"}}},"references":{"$ref":"#/components/schemas/BrandedCallingReferences"},"reviewAnswers":{"type":"object","additionalProperties":{"type":"object","properties":{"text":{"type":"string"},"url":{"type":"string","format":"uri"}}}},"reviewNote":{"type":"string","maxLength":4000}}}}}},"x-pozy-area":"telephony"},"delete":{"operationId":"deleteBrandedCallingIdentity","summary":"Delete a caller identity","tags":["Branded Calling"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["deleted"]}}}}}}},"x-pozy-area":"telephony"}},"/v1/branded-calling/identities/{id}/verify-email":{"post":{"operationId":"resendBrandedCallingAuthorizerCode","summary":"Resend the authorizer's code","tags":["Branded Calling"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["sent"]}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"x-pozy-area":"telephony"}},"/v1/branded-calling/identities/{id}/verify-email/confirm":{"post":{"operationId":"confirmBrandedCallingAuthorizerEmail","summary":"Confirm the authorizer's code","tags":["Branded Calling"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BrandedCallingIdentity"}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["code"],"properties":{"code":{"type":"string","pattern":"^[0-9]{6}$"}}}}}},"x-pozy-area":"telephony"}},"/v1/branded-calling/identities/{id}/numbers":{"get":{"operationId":"listBrandedCallingIdentityNumbers","summary":"List the numbers on a caller identity","tags":["Branded Calling"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"numbers":{"type":"array","items":{"$ref":"#/components/schemas/BrandedCallingIdentityNumber"}}}}}}}},"x-pozy-area":"telephony"},"post":{"operationId":"attachBrandedCallingNumbers","summary":"Attach numbers to a verified identity","tags":["Branded Calling"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"numbers":{"type":"array","items":{"$ref":"#/components/schemas/BrandedCallingIdentityNumber"}}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["phoneNumberIds","signature"],"properties":{"phoneNumberIds":{"type":"array","minItems":1,"maxItems":15,"items":{"type":"string"}},"signature":{"type":"object","required":["imageBase64"],"properties":{"imageBase64":{"type":"string"},"signerName":{"type":"string","maxLength":255}}}}}}}},"x-pozy-area":"telephony"},"delete":{"operationId":"detachBrandedCallingNumbers","summary":"Detach numbers from an identity","tags":["Branded Calling"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"removed":{"type":"array","items":{"type":"string"}}}}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["phoneNumbers"],"properties":{"phoneNumbers":{"type":"array","minItems":1,"maxItems":100,"items":{"type":"string"}}}}}}},"x-pozy-area":"telephony"}},"/v1/sms/registrations":{"get":{"operationId":"listSmsRegistrations","summary":"List carrier registrations","tags":["SMS"],"parameters":[{"name":"includeDeactivated","in":"query","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"registrations":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"registrationType":{"type":"string","enum":["standard_10dlc","sole_prop_10dlc","toll_free"]},"displayName":{"type":["string","null"]},"status":{"type":"string","enum":["pending","approved","rejected","requested","changes_requested","deactivated"]},"brandStatus":{"type":"string"},"campaignStatus":{"type":"string"},"brandId":{"type":["string","null"]},"campaignId":{"type":["string","null"]},"declineReason":{"type":["string","null"]},"tfActionRequiredAt":{"type":["string","null"],"format":"date-time"},"phoneNumbers":{"type":"array","items":{"type":"string"}},"awaitingOtp":{"type":"boolean"},"adminReviewNote":{"type":["string","null"]},"lastResponseAt":{"type":["string","null"],"format":"date-time"},"previouslyRejected":{"type":"boolean"},"lastRejectedAt":{"type":["string","null"],"format":"date-time"},"rejectedBeforeSubmission":{"type":"boolean"},"otpExpired":{"type":"boolean"},"reviewRequest":{"oneOf":[{"$ref":"#/components/schemas/SmsRegistrationReviewRequest"},{"type":"null"}]},"trustScore":{"type":["number","null"]},"throughput":{"type":"object","properties":{"label":{"type":"string"},"smsPerMinute":{"type":"number"},"smsPerDay":{"type":"number"}}}}}}}}}}}},"x-pozy-area":"messaging"},"post":{"operationId":"startSmsRegistration","summary":"Start a carrier registration","tags":["SMS"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"registrationId":{"type":"string"},"status":{"type":"string","enum":["pending"]},"awaitingOtp":{"type":"boolean"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["registrationType"],"properties":{"registrationType":{"type":"string","enum":["standard_10dlc","sole_prop_10dlc","toll_free"]},"phoneNumbers":{"type":"array","items":{"type":"string"}},"brand":{"type":"object","required":["entityType","displayName","country","vertical","website","street","city","state","postalCode"],"properties":{"entityType":{"type":"string","enum":["PRIVATE_PROFIT","PUBLIC_PROFIT","NON_PROFIT","GOVERNMENT","SOLE_PROPRIETOR"]},"displayName":{"type":"string"},"companyName":{"type":"string"},"ein":{"type":"string"},"phone":{"type":"string"},"mobilePhone":{"type":"string"},"street":{"type":"string"},"city":{"type":"string"},"state":{"type":"string"},"postalCode":{"type":"string"},"country":{"type":"string","minLength":2,"maxLength":2},"email":{"type":"string","format":"email"},"website":{"type":"string"},"vertical":{"type":"string","enum":["AGRICULTURE","COMMUNICATION","CONSTRUCTION","EDUCATION","ENERGY","ENTERTAINMENT","FINANCIAL","GAMBLING","GOVERNMENT","HEALTHCARE","HOSPITALITY","HUMAN_RESOURCES","INSURANCE","LEGAL","MANUFACTURING","NGO","POLITICAL","POSTAL","PROFESSIONAL","REAL_ESTATE","RETAIL","TECHNOLOGY","TRANSPORTATION"]},"stockSymbol":{"type":"string"}}},"campaign":{"type":"object","required":["usecase","description","messageFlow","sample1","sample2","optinKeywords","optoutKeywords","helpKeywords"],"properties":{"usecase":{"type":"string"},"subUsecases":{"type":"array","minItems":2,"maxItems":5,"items":{"type":"string","enum":["2FA","ACCOUNT_NOTIFICATION","CUSTOMER_CARE","DELIVERY_NOTIFICATION","FRAUD_ALERT","HIGHER_EDUCATION","MARKETING","POLLING_VOTING","PUBLIC_SERVICE_ANNOUNCEMENT","SECURITY_ALERT"]}},"description":{"type":"string","minLength":40,"maxLength":4096},"messageFlow":{"type":"string","minLength":40,"maxLength":2048},"sample1":{"type":"string","minLength":20},"sample2":{"type":"string","minLength":20},"helpMessage":{"type":"string","minLength":20,"maxLength":320},"optinKeywords":{"type":"string"},"optinMessage":{"type":"string","minLength":20,"maxLength":320},"optoutKeywords":{"type":"string"},"optoutMessage":{"type":"string","minLength":20,"maxLength":320},"helpKeywords":{"type":"string"},"embeddedLink":{"type":"boolean"},"embeddedPhone":{"type":"boolean"},"numberPool":{"type":"boolean"},"ageGated":{"type":"boolean"},"directLending":{"type":"boolean"},"privacyPolicyLink":{"type":"string"},"termsAndConditionsLink":{"type":"string"}}},"messagingBrandName":{"type":"string","minLength":2,"maxLength":60},"wizardValues":{"type":"object","additionalProperties":{"type":"string"}},"resubmitRequestId":{"type":"string"},"tollFree":{"type":"object","required":["businessName","corporateWebsite","phoneNumbers","useCase","useCaseSummary","productionMessageContent","optInWorkflow","optInWorkflowImageUrls","messageVolume","additionalInformation","businessAddr1","businessCity","businessState","businessZip","businessContactFirstName","businessContactLastName","businessContactEmail","businessContactPhone","businessRegistrationNumber","businessRegistrationType","businessRegistrationCountry"],"properties":{"businessName":{"type":"string"},"corporateWebsite":{"type":"string","format":"uri"},"phoneNumbers":{"type":"array","minItems":1,"items":{"type":"string"}},"useCase":{"type":"string"},"useCaseSummary":{"type":"string"},"productionMessageContent":{"type":"string"},"optInWorkflow":{"type":"string","maxLength":500},"optInWorkflowImageUrls":{"type":"array","minItems":1,"items":{"type":"string","format":"uri"}},"messageVolume":{"type":"string","enum":["10","100","1,000","10,000","100,000","250,000","500,000","750,000","1,000,000","5,000,000","10,000,000+"]},"additionalInformation":{"type":"string"},"businessAddr1":{"type":"string"},"businessAddr2":{"type":"string"},"businessCity":{"type":"string"},"businessState":{"type":"string"},"businessZip":{"type":"string"},"businessContactFirstName":{"type":"string"},"businessContactLastName":{"type":"string"},"businessContactEmail":{"type":"string","format":"email"},"businessContactPhone":{"type":"string"},"businessRegistrationNumber":{"type":"string"},"businessRegistrationType":{"type":"string"},"businessRegistrationCountry":{"type":"string"}}}}}}}},"x-pozy-area":"messaging"}},"/v1/sms/registrations/preflight":{"post":{"operationId":"preflightSmsRegistration","summary":"Pre-check a carrier registration","tags":["SMS"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"composed":{"type":"object","properties":{"brand":{"type":"object"},"campaign":{"type":"object"}}},"advisories":{"type":"array","items":{"type":"object","properties":{"field":{"type":["string","null"]},"code":{"type":["string","null"]},"concern":{"type":"string"},"severity":{"type":"string","enum":["block","warn"]}}}},"verdict":{"type":"string","enum":["pass","warn","fail","unreviewed"]},"aiUnavailable":{"type":"boolean"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["registrationType","brand","campaign"],"properties":{"registrationType":{"type":"string","enum":["standard_10dlc","sole_prop_10dlc"]},"phoneNumbers":{"type":"array","items":{"type":"string"}},"brand":{"type":"object"},"campaign":{"type":"object"},"messagingBrandName":{"type":"string","minLength":2,"maxLength":60}}}}}},"x-pozy-area":"messaging"}},"/v1/sms/registrations/{id}":{"get":{"operationId":"getSmsRegistration","summary":"Get a carrier registration","tags":["SMS"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"registrationType":{"type":"string","enum":["standard_10dlc","sole_prop_10dlc","toll_free"]},"status":{"type":"string","enum":["pending","approved","rejected","requested","changes_requested","deactivated"]},"brandStatus":{"type":"string"},"campaignStatus":{"type":"string"},"declineReason":{"type":["string","null"]},"phoneNumbers":{"type":"array","items":{"type":"string"}},"awaitingOtp":{"type":"boolean"},"adminReviewNote":{"type":["string","null"]},"reviewRequest":{"oneOf":[{"$ref":"#/components/schemas/SmsRegistrationReviewRequest"},{"type":"null"}]},"campaignContent":{"type":"object","properties":{"messageFlow":{"type":"string"},"sample1":{"type":"string"},"sample2":{"type":"string"}}}}}}}}},"x-pozy-area":"messaging"},"delete":{"operationId":"deactivateSmsRegistration","summary":"Deactivate a brand/campaign registration","tags":["SMS"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["deactivated"]}}}}}}},"x-pozy-area":"messaging"}},"/v1/sms/registrations/{id}/verify-otp":{"post":{"operationId":"verifySmsRegistrationOtp","summary":"Submit the sole-prop OTP","tags":["SMS"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"verified":{"type":"boolean"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["otpPin"],"properties":{"otpPin":{"type":"string","minLength":4,"maxLength":10}}}}}},"x-pozy-area":"messaging"}},"/v1/sms/registrations/{id}/resend-otp":{"post":{"operationId":"resendSmsRegistrationOtp","summary":"Re-send the sole-prop OTP","tags":["SMS"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"sent":{"type":"boolean"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"x-pozy-area":"messaging"}},"/v1/sms/registrations/{id}/appeal":{"post":{"operationId":"appealSmsRegistration","summary":"Appeal a rejected campaign","tags":["SMS"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["pending"]}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["appealReason"],"properties":{"appealReason":{"type":"string","minLength":10,"maxLength":2000},"messageFlow":{"type":"string","minLength":40,"maxLength":2048},"sample1":{"type":"string","minLength":20},"sample2":{"type":"string","minLength":20}}}}}},"x-pozy-area":"messaging"}},"/v1/sms/registrations/{id}/respond":{"post":{"operationId":"respondToSmsRegistrationReview","summary":"Reply to a change request","tags":["SMS"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["requested","rejected"]}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"note":{"type":"string","maxLength":2000},"files":{"type":"array","maxItems":5,"items":{"type":"string"}},"requestId":{"type":"string"},"answers":{"type":"array","maxItems":20,"items":{"type":"object","required":["pointId"],"properties":{"pointId":{"type":"string"},"text":{"type":"string","maxLength":2000},"url":{"type":"string","format":"uri"},"files":{"type":"array","maxItems":5,"items":{"type":"string"}}}}}}}}}},"x-pozy-area":"messaging"}},"/v1/sms/opt-in-proof":{"post":{"operationId":"uploadSmsOptInProofFile","summary":"Upload opt-in form proof","tags":["SMS"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"type":"object","required":["file"],"properties":{"file":{"type":"string","format":"binary"}}}}}},"x-pozy-area":"messaging"}},"/v1/sms/registrations/{id}/opt-in-proof":{"post":{"operationId":"uploadSmsOptInProof","summary":"Upload opt-in form proof for an appeal","tags":["SMS"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"type":"object","required":["file"],"properties":{"file":{"type":"string","format":"binary"}}}}}},"x-pozy-area":"messaging"}},"/v1/sms/registrations/share":{"post":{"operationId":"shareSmsRegistration","summary":"Create a registration share link","tags":["SMS"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string"},"expiresAt":{"type":"string","format":"date-time"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["numberId"],"properties":{"numberId":{"type":"string"}}}}}},"x-pozy-area":"messaging"}},"/v1/whatsapp/template-library":{"get":{"operationId":"getWhatsAppLibraryTemplate","summary":"Look up a library template","tags":["WhatsApp Templates"],"parameters":[{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}},{"name":"name","in":"query","required":true,"schema":{"type":"string"}},{"name":"language","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"template":{"type":["object","null"],"properties":{"name":{"type":"string"},"language":{"type":"string"},"category":{"type":"string"},"body":{"type":"string"},"body_params":{"type":"array","items":{"type":"string"}},"availableLanguages":{"type":"array","items":{"type":"string"}},"buttons":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"text":{"type":"string"}}}}}}}}}}}},"x-pozy-area":"whatsapp"}},"/v1/whatsapp/catalogs":{"get":{"operationId":"listWhatsAppCatalogs","summary":"List the catalogs linked to a WhatsApp number","tags":["WhatsApp"],"parameters":[{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}},{"name":"catalogAccountId","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"wabaId":{"type":"string"},"catalogs":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}}}}}}}}}},"x-pozy-area":"whatsapp"},"post":{"operationId":"linkWhatsAppCatalog","summary":"Link a catalog to a WhatsApp number","tags":["WhatsApp"],"responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"wabaId":{"type":"string"},"catalogs":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}}}}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","catalogId"],"properties":{"accountId":{"type":"string"},"catalogAccountId":{"type":"string"},"catalogId":{"type":"string"}}}}}},"x-pozy-area":"whatsapp"},"delete":{"operationId":"unlinkWhatsAppCatalog","summary":"Unlink a catalog from a WhatsApp number","tags":["WhatsApp"],"parameters":[{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}},{"name":"catalogAccountId","in":"query","required":false,"schema":{"type":"string"}},{"name":"catalogId","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"wabaId":{"type":"string"},"catalogId":{"type":"string"}}}}}}},"x-pozy-area":"whatsapp"}},"/v1/whatsapp/commerce-settings":{"get":{"operationId":"getWhatsAppCommerceSettings","summary":"Get a number's commerce settings","tags":["WhatsApp"],"parameters":[{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}},{"name":"catalogAccountId","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"settings":{"$ref":"#/components/schemas/WhatsAppCommerceSettings"}}}}}}},"x-pozy-area":"whatsapp"},"put":{"operationId":"updateWhatsAppCommerceSettings","summary":"Update a number's commerce settings","tags":["WhatsApp"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"settings":{"$ref":"#/components/schemas/WhatsAppCommerceSettings"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId"],"properties":{"accountId":{"type":"string"},"catalogAccountId":{"type":"string"},"isCartEnabled":{"type":"boolean"},"isCatalogVisible":{"type":"boolean"}}}}}},"x-pozy-area":"whatsapp"}},"/v1/whatsapp/conversational-automation":{"get":{"operationId":"getWhatsAppConversationalAutomation","summary":"Get ice breakers and commands","tags":["WhatsApp"],"parameters":[{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/WhatsAppConversationalAutomation"}}}}}}},"x-pozy-area":"whatsapp"},"post":{"operationId":"setWhatsAppConversationalAutomation","summary":"Set ice breakers and commands","tags":["WhatsApp"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"allOf":[{"type":"object","required":["accountId"],"properties":{"accountId":{"type":"string"}}},{"$ref":"#/components/schemas/WhatsAppConversationalAutomation"}]}}}},"x-pozy-area":"whatsapp"},"delete":{"operationId":"deleteWhatsAppConversationalAutomation","summary":"Clear ice breakers and commands","tags":["WhatsApp"],"parameters":[{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"}}}}}}},"x-pozy-area":"whatsapp"}},"/v1/whatsapp/business-profile":{"get":{"operationId":"getWhatsAppBusinessProfile","summary":"Get business profile","tags":["WhatsApp"],"parameters":[{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"businessProfile":{"type":"object","properties":{"about":{"type":"string"},"address":{"type":"string"},"description":{"type":"string"},"email":{"type":"string"},"profilePictureUrl":{"type":"string","format":"uri"},"websites":{"type":"array","items":{"type":"string"},"maxItems":2},"vertical":{"type":"string"}}}}}}}}},"x-pozy-area":"whatsapp"},"post":{"operationId":"updateWhatsAppBusinessProfile","summary":"Update business profile","tags":["WhatsApp"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId"],"properties":{"accountId":{"type":"string"},"about":{"type":"string","maxLength":139},"address":{"type":"string"},"description":{"type":"string","maxLength":512},"email":{"type":"string","format":"email"},"websites":{"type":"array","maxItems":2,"items":{"type":"string","format":"uri"}},"vertical":{"type":"string"},"profilePictureHandle":{"type":"string"}}}}}},"x-pozy-area":"whatsapp"}},"/v1/whatsapp/business-profile/photo":{"post":{"operationId":"uploadWhatsAppProfilePhoto","summary":"Upload profile picture","tags":["WhatsApp"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"type":"object","required":["accountId","file"],"properties":{"accountId":{"type":"string"},"file":{"type":"string","format":"binary"}}}}}},"x-pozy-area":"whatsapp"}},"/v1/whatsapp/business-profile/display-name":{"get":{"operationId":"getWhatsAppDisplayName","summary":"Get display name status","tags":["WhatsApp"],"parameters":[{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"displayName":{"type":"object","properties":{"name":{"type":"string"},"status":{"type":"string","enum":["APPROVED","PENDING_REVIEW","DECLINED","NONE"]},"phoneNumber":{"type":"string"}}}}}}}}},"x-pozy-area":"whatsapp"},"post":{"operationId":"updateWhatsAppDisplayName","summary":"Request display name change","tags":["WhatsApp"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"},"displayName":{"type":"object","properties":{"name":{"type":"string"},"status":{"type":"string","enum":["PENDING_REVIEW"]}}}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","displayName"],"properties":{"accountId":{"type":"string"},"displayName":{"type":"string","minLength":3,"maxLength":512}}}}}},"x-pozy-area":"whatsapp"}},"/v1/whatsapp/business-profile/username":{"get":{"operationId":"getWhatsappBusinessUsername","summary":"Get business username","tags":["WhatsApp"],"parameters":[{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"username":{"type":["string","null"]},"status":{"type":"string","enum":["approved","reserved","none"]}}}}}}},"x-pozy-area":"whatsapp"},"post":{"operationId":"setWhatsappBusinessUsername","summary":"Set business username","tags":["WhatsApp"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"username":{"type":"string"},"status":{"type":"string","enum":["approved","reserved","none"]}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","username"],"properties":{"accountId":{"type":"string"},"username":{"type":"string","minLength":3,"maxLength":35},"transferAction":{"type":"string","enum":["none","force_transfer"],"default":"none"}}}}}},"x-pozy-area":"whatsapp"},"delete":{"operationId":"deleteWhatsappBusinessUsername","summary":"Delete business username","tags":["WhatsApp"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"}}}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId"],"properties":{"accountId":{"type":"string"}}}}}},"x-pozy-area":"whatsapp"}},"/v1/whatsapp/business-profile/username/suggestions":{"get":{"operationId":"getWhatsappBusinessUsernameSuggestions","summary":"Get username suggestions","tags":["WhatsApp"],"parameters":[{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"suggestions":{"type":"array","items":{"type":"string"}}}}}}}},"x-pozy-area":"whatsapp"}},"/v1/whatsapp/number-info":{"get":{"operationId":"getWhatsAppNumberInfo","summary":"Get number status","tags":["WhatsApp Phone Numbers"],"parameters":[{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"phone":{"type":"object","properties":{"display_phone_number":{"type":"string"},"verified_name":{"type":"string"},"name_status":{"type":"string"},"quality_rating":{"type":"string"},"messaging_limit_tier":{"type":"string"},"throughput":{"type":"object","properties":{"level":{"type":"string"}}},"status":{"type":"string"},"is_official_business_account":{"type":"boolean"},"platform_type":{"type":"string"},"health_status":{"type":"object"}}},"waba":{"type":["object","null"],"properties":{"name":{"type":"string"},"business_verification_status":{"type":"string"},"timezone_id":{"type":"string"},"health_status":{"type":"object"}}}}}}}}},"x-pozy-area":"whatsapp"}},"/v1/whatsapp/pricing-analytics":{"get":{"operationId":"getWhatsAppPricingAnalytics","summary":"Get pricing analytics","tags":["WhatsApp Phone Numbers"],"parameters":[{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}},{"name":"start","in":"query","required":true,"schema":{"type":"string","format":"date-time"}},{"name":"end","in":"query","required":true,"schema":{"type":"string","format":"date-time"}},{"name":"granularity","in":"query","required":true,"schema":{"type":"string","enum":["HALF_HOUR","DAILY","MONTHLY"]}},{"name":"dimensions","in":"query","required":false,"schema":{"type":"string"}},{"name":"metricTypes","in":"query","required":false,"schema":{"type":"string"}},{"name":"pricingTypes","in":"query","required":false,"schema":{"type":"string"}},{"name":"pricingCategories","in":"query","required":false,"schema":{"type":"string"}},{"name":"countryCodes","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","required":["accountId","phoneNumber","granularity","start","end","dataPoints"],"properties":{"accountId":{"type":"string"},"phoneNumber":{"type":"string"},"granularity":{"type":"string","enum":["HALF_HOUR","DAILY","MONTHLY"]},"start":{"type":"string","format":"date-time"},"end":{"type":"string","format":"date-time"},"dataPoints":{"type":"array","items":{"type":"object","required":["start","end","phoneNumber","country","tier","pricingType","pricingCategory","volume","cost"],"properties":{"start":{"type":"string","format":"date-time"},"end":{"type":"string","format":"date-time"},"phoneNumber":{"type":["string","null"]},"country":{"type":["string","null"]},"tier":{"type":["string","null"]},"pricingType":{"type":["string","null"]},"pricingCategory":{"type":["string","null"]},"volume":{"type":["integer","null"]},"cost":{"type":["number","null"]}}}}}}}}}},"x-pozy-area":"whatsapp"}},"/v1/whatsapp/block-users/status":{"get":{"operationId":"getWhatsAppBlockStatus","summary":"Check if a user is blocked","tags":["WhatsApp"],"parameters":[{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}},{"name":"user","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"blocked":{"type":"boolean"}}}}}}},"x-pozy-area":"whatsapp"}},"/v1/whatsapp/block-users":{"get":{"operationId":"getWhatsAppBlockedUsers","summary":"List blocked users","tags":["WhatsApp"],"parameters":[{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":100}},{"name":"after","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"blockedUsers":{"type":"array","items":{"type":"object","properties":{"waId":{"type":"string"}}}},"nextCursor":{"type":["string","null"]}}}}}}},"x-pozy-area":"whatsapp"},"post":{"operationId":"blockWhatsAppUsers","summary":"Block users","tags":["WhatsApp"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"blocked":{"type":"array","items":{"type":"object","properties":{"input":{"type":"string"},"waId":{"type":"string"}}}},"failed":{"type":"array","items":{"type":"object","properties":{"input":{"type":"string"},"errors":{"type":"array","items":{"type":"string"}}}}}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","users"],"properties":{"accountId":{"type":"string"},"users":{"type":"array","minItems":1,"maxItems":1000,"items":{"type":"string"}}}}}}},"x-pozy-area":"whatsapp"},"delete":{"operationId":"unblockWhatsAppUsers","summary":"Unblock users","tags":["WhatsApp"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"unblocked":{"type":"array","items":{"type":"object","properties":{"input":{"type":"string"},"waId":{"type":"string"}}}},"failed":{"type":"array","items":{"type":"object","properties":{"input":{"type":"string"},"errors":{"type":"array","items":{"type":"string"}}}}}}}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","users"],"properties":{"accountId":{"type":"string"},"users":{"type":"array","minItems":1,"maxItems":1000,"items":{"type":"string"}}}}}}},"x-pozy-area":"whatsapp"}},"/v1/whatsapp/account-events":{"get":{"operationId":"listWhatsAppAccountEvents","summary":"List account notifications","tags":["WhatsApp"],"parameters":[{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":200,"default":50}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"events":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"accountId":{"type":"string"},"type":{"type":"string"},"severity":{"type":"string","enum":["info","success","warning","critical"]},"title":{"type":"string"},"detail":{"type":["string","null"]},"createdAt":{"type":"string","format":"date-time"}}}}}}}}}},"x-pozy-area":"whatsapp"}},"/v1/whatsapp/dataset":{"get":{"operationId":"getWhatsAppDataset","summary":"Get CTWA conversions dataset","tags":["WhatsApp"],"parameters":[{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"datasetId":{"type":["string","null"]}}}}}}},"x-pozy-area":"whatsapp"},"post":{"operationId":"createWhatsAppDataset","summary":"Provision CTWA dataset","tags":["WhatsApp"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"datasetId":{"type":"string"},"created":{"type":"boolean"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId"],"properties":{"accountId":{"type":"string"}}}}}},"x-pozy-area":"whatsapp"}},"/v1/phone-numbers":{"get":{"operationId":"listPhoneNumbers","summary":"List phone numbers","tags":["Phone Numbers"],"parameters":[{"name":"status","in":"query","required":false,"schema":{"type":"string","enum":["provisioning","verifying","pending_payment","pending_regulatory","regulatory_declined","active","suspended","releasing","released"]}},{"name":"profileId","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"numbers":{"type":"array","items":{"$ref":"#/components/schemas/OwnedPhoneNumber"}},"connected":{"type":"array","items":{"type":"object","properties":{"accountId":{"type":"string"},"phoneNumber":{"type":["string","null"]},"displayName":{"type":["string","null"]},"profileId":{"type":["string","null"]},"connectedAt":{"type":["string","null"],"format":"date-time"},"callingEnabled":{"type":"boolean"}}}},"imessage":{"type":"array","items":{"$ref":"#/components/schemas/ImessageSenderLifecycle"}},"sandbox":{"type":["object","null"],"properties":{"phoneNumber":{"type":"string"},"accountId":{"type":["string","null"]},"template":{"type":"object","properties":{"name":{"type":"string"},"language":{"type":"string"}}},"isSandbox":{"type":"boolean"}}}}}}}}},"x-pozy-area":"telephony"}},"/v1/phone-numbers/{id}":{"get":{"operationId":"getPhoneNumber","summary":"Get phone number","tags":["Phone Numbers"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"phoneNumber":{"type":"object","properties":{"id":{"type":"string"},"phoneNumber":{"type":"string"},"status":{"type":"string","enum":["pending_payment","pending_regulatory","regulatory_declined","provisioning","verifying","active","suspended","releasing","released"]},"country":{"type":"string"},"metaPreverifiedId":{"type":"string"},"metaVerificationStatus":{"type":"string"},"identityVerificationUrl":{"type":["string","null"]},"endUserFirstName":{"type":["string","null"]},"endUserLastName":{"type":["string","null"]},"regulatoryDeclineReason":{"type":["string","null"]},"provisionedAt":{"type":"string","format":"date-time"},"sipTrunkId":{"type":["string","null"]}}}}}}}}},"x-pozy-area":"telephony"},"delete":{"operationId":"releasePhoneNumber","summary":"Release phone number","tags":["Phone Numbers"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"phoneNumber":{"type":"object","properties":{"id":{"type":"string"},"phoneNumber":{"type":"string"},"status":{"type":"string"},"releasedAt":{"type":"string","format":"date-time"}}}}}}}}},"x-pozy-area":"telephony"}},"/v1/phone-numbers/purchase":{"post":{"operationId":"purchasePhoneNumber","summary":"Purchase phone number","tags":["Phone Numbers"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"message":{"type":"string"},"checkoutUrl":{"type":"string","format":"uri"}}},{"type":"object","properties":{"message":{"type":"string"},"phoneNumber":{"type":"object","properties":{"id":{"type":"string"},"phoneNumber":{"type":"string"},"status":{"type":"string"},"country":{"type":"string"},"provisionedAt":{"type":"string","format":"date-time"},"metaPreverifiedId":{"type":"string"},"metaVerificationStatus":{"type":"string"},"profileId":{"type":"string"}}}}},{"type":"object","properties":{"status":{"type":"string","enum":["already_purchased"]},"numberId":{"type":"string"},"phoneNumber":{"type":"string"},"profileId":{"type":"string"}}}]}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["profileId"],"properties":{"profileId":{"type":"string"},"country":{"type":"string","default":"US"},"numberType":{"type":"string","enum":["local","mobile","national","toll_free"]},"areaCode":{"type":"string","pattern":"^\\d{1,4}$"},"claimId":{"type":"string"},"phoneNumber":{"type":"string","pattern":"^\\+[1-9]\\d{6,14}$"},"connectWhatsapp":{"type":"boolean","default":true},"wantsSms":{"type":"boolean","default":false},"wantsWhatsapp":{"type":"boolean","default":false},"purchaseIntentId":{"type":"string","maxLength":100},"allowMultiple":{"type":"boolean","default":false}}}}}},"x-pozy-area":"telephony"}},"/v1/phone-numbers/claims/{claimId}":{"get":{"operationId":"getPhoneNumberClaim","summary":"Resolve a number claim","tags":["Phone Numbers"],"parameters":[{"name":"claimId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"country":{"type":"object","properties":{"code":{"type":"string"},"needsKyc":{"type":"boolean"},"monthlyCents":{"type":"integer"},"types":{"type":"array","items":{"type":"object"}}}},"type":{"type":"object"},"area":{"type":["object","null"],"properties":{"ndc":{"type":"string"},"name":{"type":"string"},"count":{"type":"integer"}}},"phoneNumber":{"type":["string","null"]}}}}}}},"x-pozy-area":"telephony"}},"/v1/phone-numbers/countries":{"get":{"operationId":"listPhoneNumberCountries","summary":"List offerable number countries","tags":["Phone Numbers"],"security":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"countries":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string"},"tier":{"type":"integer","enum":[1,2,3,4]},"monthlyCents":{"type":"integer"},"needsKyc":{"type":"boolean"},"callsAvailable":{"type":"boolean"},"whatsappAvailable":{"type":"boolean"},"smsAvailable":{"type":"boolean"},"outboundCallingAvailable":{"type":"boolean"},"inStock":{"type":"boolean"},"preOrderable":{"type":"boolean"},"types":{"type":"array","items":{"type":"object","properties":{"numberType":{"type":"string","enum":["local","mobile","national","toll_free"]},"tier":{"type":["integer","null"],"enum":[1,2,3,4,null]},"needsKyc":{"type":"boolean"},"monthlyCents":{"type":"integer"},"whatsappAvailable":{"type":"boolean"},"smsAvailable":{"type":"boolean"},"callsAvailable":{"type":"boolean"},"inStock":{"type":"boolean"},"fulfilment":{"type":"string","enum":["instant","request"]},"preOrderable":{"type":"boolean"}}}}}}}}}}}}},"x-pozy-area":"telephony"}},"/v1/phone-numbers/available":{"get":{"operationId":"searchAvailablePhoneNumbers","summary":"Search available numbers","tags":["Phone Numbers"],"parameters":[{"name":"country","in":"query","required":false,"schema":{"type":"string","default":"US"}},{"name":"numberType","in":"query","required":false,"schema":{"type":"string","enum":["local","mobile","national","toll_free"]}},{"name":"areaCode","in":"query","required":false,"schema":{"type":"string"}},{"name":"type","in":"query","required":false,"schema":{"type":"string"}},{"name":"prefix","in":"query","required":false,"schema":{"type":"string"}},{"name":"locality","in":"query","required":false,"schema":{"type":"string"}},{"name":"contains","in":"query","required":false,"schema":{"type":"string"}},{"name":"sms","in":"query","required":false,"schema":{"type":"boolean"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","default":20,"maximum":100}},{"name":"masked","in":"query","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"country":{"type":"string"},"numberType":{"type":"string"},"requireSms":{"type":"boolean"},"numbers":{"type":"array","items":{"type":"object","properties":{"phoneNumber":{"type":"string"},"features":{"type":"array","items":{"type":"string"}},"locality":{"type":"string"},"bestEffort":{"type":"boolean"},"maskedNumber":{"type":"string"},"numberType":{"type":"string"},"claimId":{"type":"string"},"claimUrl":{"type":"string"}}}},"masked":{"type":"boolean"},"near":{"type":["string","null"]},"claimId":{"type":"string"},"claimUrl":{"type":"string"}}}}}}},"x-pozy-area":"telephony"}},"/v1/phone-numbers/availability":{"get":{"operationId":"checkPhoneNumberAvailability","summary":"Check country availability","tags":["Phone Numbers"],"parameters":[{"name":"country","in":"query","required":true,"schema":{"type":"string"}},{"name":"numberType","in":"query","required":false,"schema":{"type":"string","enum":["local","mobile","national","toll_free"]}},{"name":"sms","in":"query","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"country":{"type":"string"},"numberType":{"type":"string"},"available":{"type":"boolean"},"preOrderable":{"type":"boolean"},"addressConstraint":{"type":"string","enum":["geo","country","none"]},"areas":{"type":"array","items":{"type":"string"}},"areaOptions":{"type":"array","items":{"type":"object","properties":{"ndc":{"type":"string"},"name":{"type":"string"},"count":{"type":"integer"}}}},"soldOutAreas":{"type":"array","items":{"type":"object","properties":{"ndc":{"type":"string"},"name":{"type":"string"},"preOrderable":{"type":"boolean"}}}},"areaAvailability":{"type":"object","properties":{"inStock":{"type":"array","items":{"type":"object","properties":{"ndc":{"type":"string"},"name":{"type":"string"},"count":{"type":"integer"},"ndcs":{"type":"array","items":{"type":"string"}},"aliases":{"type":"array","items":{"type":"string"}}}}},"preOrder":{"type":"array","items":{"type":"object","properties":{"ndc":{"type":"string"},"name":{"type":"string"},"ndcs":{"type":"array","items":{"type":"string"}},"aliases":{"type":"array","items":{"type":"string"}}}}},"outOfStock":{"type":"array","items":{"type":"object","properties":{"ndc":{"type":"string"},"name":{"type":"string"},"listed":{"type":"integer"},"ndcs":{"type":"array","items":{"type":"string"}},"aliases":{"type":"array","items":{"type":"string"}}}}}}}}}}}}},"x-pozy-area":"telephony"}},"/v1/whatsapp/phone-numbers":{"get":{"operationId":"getWhatsAppPhoneNumbers","summary":"List phone numbers","tags":["WhatsApp Phone Numbers"],"deprecated":true,"parameters":[{"name":"status","in":"query","required":false,"schema":{"type":"string","enum":["provisioning","verifying","pending_payment","pending_regulatory","regulatory_declined","active","suspended","releasing","released"]}},{"name":"profileId","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"numbers":{"type":"array","items":{"$ref":"#/components/schemas/OwnedPhoneNumber"}},"connected":{"type":"array","items":{"type":"object","properties":{"accountId":{"type":"string"},"phoneNumber":{"type":["string","null"]},"displayName":{"type":["string","null"]},"profileId":{"type":["string","null"]},"connectedAt":{"type":["string","null"],"format":"date-time"},"callingEnabled":{"type":"boolean"}}}},"imessage":{"type":"array","items":{"$ref":"#/components/schemas/ImessageSenderLifecycle"}},"sandbox":{"type":["object","null"],"properties":{"phoneNumber":{"type":"string"},"accountId":{"type":["string","null"]},"template":{"type":"object","properties":{"name":{"type":"string"},"language":{"type":"string"}}},"isSandbox":{"type":"boolean"}}}}}}}}},"x-pozy-area":"whatsapp"}},"/v1/whatsapp/phone-numbers/purchase":{"post":{"operationId":"purchaseWhatsAppPhoneNumber","summary":"Purchase phone number","tags":["WhatsApp Phone Numbers"],"deprecated":true,"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"message":{"type":"string"},"checkoutUrl":{"type":"string","format":"uri"}}},{"type":"object","properties":{"message":{"type":"string"},"phoneNumber":{"type":"object","properties":{"id":{"type":"string"},"phoneNumber":{"type":"string"},"status":{"type":"string"},"country":{"type":"string"},"provisionedAt":{"type":"string","format":"date-time"},"metaPreverifiedId":{"type":"string"},"metaVerificationStatus":{"type":"string"}}}}},{"type":"object","properties":{"status":{"type":"string","enum":["already_purchased"]},"numberId":{"type":"string"},"phoneNumber":{"type":"string"}}}]}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["profileId"],"properties":{"profileId":{"type":"string"},"country":{"type":"string","default":"US"},"phoneNumber":{"type":"string","pattern":"^\\+[1-9]\\d{6,14}$"},"purchaseIntentId":{"type":"string","maxLength":100},"allowMultiple":{"type":"boolean","default":false}}}}}},"x-pozy-area":"whatsapp"}},"/v1/whatsapp/phone-numbers/countries":{"get":{"operationId":"listWhatsAppNumberCountries","summary":"List offerable number countries","tags":["WhatsApp Phone Numbers"],"deprecated":true,"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"countries":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string"},"tier":{"type":"integer","enum":[1,2,3,4]},"monthlyCents":{"type":"integer"},"needsKyc":{"type":"boolean"},"outboundCallingAvailable":{"type":"boolean"}}}}}}}}}},"x-pozy-area":"whatsapp"}},"/v1/whatsapp/phone-numbers/available":{"get":{"operationId":"searchAvailableWhatsAppNumbers","summary":"Search available numbers","tags":["WhatsApp Phone Numbers"],"deprecated":true,"parameters":[{"name":"country","in":"query","required":false,"schema":{"type":"string","default":"US"}},{"name":"numberType","in":"query","required":false,"schema":{"type":"string","enum":["local","mobile","national","toll_free"]}},{"name":"areaCode","in":"query","required":false,"schema":{"type":"string"}},{"name":"type","in":"query","required":false,"schema":{"type":"string"}},{"name":"prefix","in":"query","required":false,"schema":{"type":"string"}},{"name":"locality","in":"query","required":false,"schema":{"type":"string"}},{"name":"contains","in":"query","required":false,"schema":{"type":"string"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","default":20,"maximum":100}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"country":{"type":"string"},"numberType":{"type":"string"},"numbers":{"type":"array","items":{"type":"object","properties":{"phoneNumber":{"type":"string"},"locality":{"type":"string"},"bestEffort":{"type":"boolean"}}}}}}}}}},"x-pozy-area":"whatsapp"}},"/v1/whatsapp/phone-numbers/availability":{"get":{"operationId":"checkWhatsAppNumberAvailability","summary":"Check country availability","tags":["WhatsApp Phone Numbers"],"deprecated":true,"parameters":[{"name":"country","in":"query","required":true,"schema":{"type":"string"}},{"name":"numberType","in":"query","required":false,"schema":{"type":"string","enum":["local","mobile","national","toll_free"]}},{"name":"sms","in":"query","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"country":{"type":"string"},"numberType":{"type":"string"},"available":{"type":"boolean"},"preOrderable":{"type":"boolean"},"addressConstraint":{"type":"string","enum":["geo","country","none"]},"areas":{"type":"array","items":{"type":"string"}},"areaOptions":{"type":"array","items":{"type":"object","properties":{"ndc":{"type":"string"},"name":{"type":"string"},"count":{"type":"integer"}}}},"soldOutAreas":{"type":"array","items":{"type":"object","properties":{"ndc":{"type":"string"},"name":{"type":"string"},"preOrderable":{"type":"boolean"}}}},"areaAvailability":{"type":"object","properties":{"inStock":{"type":"array","items":{"type":"object","properties":{"ndc":{"type":"string"},"name":{"type":"string"},"count":{"type":"integer"},"ndcs":{"type":"array","items":{"type":"string"}},"aliases":{"type":"array","items":{"type":"string"}}}}},"preOrder":{"type":"array","items":{"type":"object","properties":{"ndc":{"type":"string"},"name":{"type":"string"},"ndcs":{"type":"array","items":{"type":"string"}},"aliases":{"type":"array","items":{"type":"string"}}}}},"outOfStock":{"type":"array","items":{"type":"object","properties":{"ndc":{"type":"string"},"name":{"type":"string"},"listed":{"type":"integer"},"ndcs":{"type":"array","items":{"type":"string"}},"aliases":{"type":"array","items":{"type":"string"}}}}}}}}}}}}},"x-pozy-area":"whatsapp"}},"/v1/phone-numbers/kyc":{"get":{"operationId":"getPhoneNumberKycForm","summary":"Get KYC form spec","tags":["Phone Numbers"],"parameters":[{"name":"country","in":"query","required":true,"schema":{"type":"string"}},{"name":"numberType","in":"query","required":false,"schema":{"type":"string","enum":["local","mobile","national","toll_free"]}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"country":{"type":"string"},"numberType":{"type":"string"},"fields":{"type":"array","items":{"type":"object","properties":{"requirementId":{"type":"string"},"label":{"type":"string"},"kind":{"type":"string","enum":["text","date","address","file","action"]},"description":{"type":["string","null"]},"example":{"type":["string","null"]},"localTo":{"type":["string","null"]}}}},"reusable":{"type":["object","null"],"properties":{"available":{"type":"boolean"},"fromPhoneNumber":{"type":"string"},"details":{"type":"array","items":{"type":"object","properties":{"label":{"type":"string"},"value":{"type":"string"}}}},"options":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"fromPhoneNumber":{"type":"string"},"instant":{"type":"boolean"},"details":{"type":"array","items":{"type":"object","properties":{"label":{"type":"string"},"value":{"type":"string"},"documentId":{"type":"string"}}}}}}}}},"pendingReview":{"type":"boolean"}}}}}}},"x-pozy-area":"telephony"},"post":{"operationId":"submitPhoneNumberKyc","summary":"Submit KYC","tags":["Phone Numbers"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["kyc_submitted","kyc_reused","kyc_already_submitted"]},"preOrder":{"type":"boolean"},"phoneNumber":{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string"},"country":{"type":"string"}}},"numbers":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string"},"phoneNumber":{"type":"string"},"country":{"type":"string"}}}}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["profileId","country"],"properties":{"profileId":{"type":"string"},"country":{"type":"string"},"submissionId":{"type":"string"},"quantity":{"type":"integer","minimum":1,"maximum":5,"default":1},"reuse":{"type":"boolean"},"reuseOptionId":{"type":"string"},"reuseFrom":{"type":"string"},"areaCode":{"type":"string","pattern":"^\\d{1,4}$"},"phoneNumber":{"type":"string","pattern":"^\\+[1-9]\\d{6,14}$"},"preOrder":{"type":"boolean"},"endUserFirstName":{"type":"string"},"endUserLastName":{"type":"string"},"values":{"type":"object","additionalProperties":{"type":"string"}},"documents":{"type":"array","items":{"oneOf":[{"type":"object","required":["requirementId","filename","base64"],"properties":{"requirementId":{"type":"string"},"filename":{"type":"string"},"base64":{"type":"string"}}},{"type":"object","required":["requirementId","documentId"],"properties":{"requirementId":{"type":"string"},"documentId":{"type":"string"},"issuedAt":{"type":"string","format":"date"}}}]}},"address":{"type":"object","properties":{"requirementId":{"type":"string"},"country_code":{"type":"string"},"business_name":{"type":"string"},"first_name":{"type":"string"},"last_name":{"type":"string"},"street_address":{"type":"string"},"extended_address":{"type":"string"},"locality":{"type":"string"},"administrative_area":{"type":"string"},"postal_code":{"type":"string"}}}}}}}},"x-pozy-area":"telephony"}},"/v1/phone-numbers/kyc/document/{documentId}":{"get":{"operationId":"viewPhoneNumberKycDocument","summary":"View a KYC document on file","tags":["Phone Numbers"],"parameters":[{"name":"documentId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/pdf":{"schema":{"type":"string","format":"binary"}}}}},"x-pozy-area":"telephony"}},"/v1/phone-numbers/kyc/upload-document":{"post":{"operationId":"uploadPhoneNumberKycDocument","summary":"Upload a KYC document","tags":["Phone Numbers"],"parameters":[{"name":"X-Filename","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"documentId":{"type":"string"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/octet-stream":{"schema":{"type":"string","format":"binary"}}}},"x-pozy-area":"telephony"}},"/v1/phone-numbers/kyc/validate-address":{"post":{"operationId":"validatePhoneNumberKycAddress","summary":"Pre-validate KYC address","tags":["Phone Numbers"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"ok":{"type":"boolean"},"skipped":{"type":"boolean"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["country","street_address","locality","postal_code"],"properties":{"country":{"type":"string","minLength":2,"maxLength":2},"street_address":{"type":"string"},"extended_address":{"type":"string"},"locality":{"type":"string"},"administrative_area":{"type":"string"},"postal_code":{"type":"string"}}}}}},"x-pozy-area":"telephony"}},"/v1/phone-numbers/kyc/share":{"post":{"operationId":"createPhoneNumberKycLink","summary":"Create a hosted KYC link","tags":["Phone Numbers"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string"},"token":{"type":"string"},"expiresAt":{"type":"string","format":"date-time"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["profileId","country"],"properties":{"profileId":{"type":"string"},"country":{"type":"string","minLength":2,"maxLength":2},"areaCode":{"type":"string","pattern":"^\\d{1,4}$"},"language":{"type":"string","enum":["en","es","pt-BR"]},"branding":{"type":"object","properties":{"companyName":{"type":"string","maxLength":60},"logoUrl":{"type":"string","format":"uri"},"brandColor":{"type":"string","pattern":"^#[0-9a-fA-F]{6}$"}}},"redirect_url":{"type":"string","format":"uri"}}}}}},"x-pozy-area":"telephony"}},"/v1/phone-numbers/port-in":{"get":{"operationId":"listPhoneNumberPortIns","summary":"List port-in orders","tags":["Phone Numbers"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"orders":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string","enum":["draft","pending","foc_confirmed","ported","exception","cancelled"]},"carrierStatusValue":{"type":["string","null"]},"phoneNumbers":{"type":"array","items":{"type":"string"}},"fastPortEligible":{"type":["boolean","null"]},"focDatetimeRequested":{"type":["string","null"],"format":"date-time"},"focDatetimeActual":{"type":["string","null"],"format":"date-time"},"declineReason":{"type":["string","null"]},"submittedAt":{"type":["string","null"],"format":"date-time"},"portedAt":{"type":["string","null"],"format":"date-time"},"createdAt":{"type":"string","format":"date-time"}}}}}}}}}},"x-pozy-area":"telephony"},"post":{"operationId":"createPhoneNumberPortIn","summary":"Port numbers in","tags":["Phone Numbers"],"responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"carrierPortingOrderId":{"type":"string"},"status":{"type":"string","enum":["draft","pending","foc_confirmed","ported","exception","cancelled"]},"phoneNumbers":{"type":"array","items":{"type":"string"}},"orders":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"carrierPortingOrderId":{"type":"string"},"status":{"type":"string"},"phoneNumbers":{"type":"array","items":{"type":"string"}},"error":{"type":"string"}}}}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["phoneNumbers","endUser","loaDocumentId","invoiceDocumentId"],"properties":{"phoneNumbers":{"type":"array","minItems":1,"maxItems":50,"items":{"type":"string"}},"endUser":{"type":"object","required":["entityName","authPersonName","accountNumber","streetAddress","locality","postalCode","countryCode"],"properties":{"entityName":{"type":"string"},"authPersonName":{"type":"string"},"billingPhoneNumber":{"type":"string"},"accountNumber":{"type":"string"},"pinPasscode":{"type":"string"},"taxIdentifier":{"type":"string","maxLength":50},"businessIdentifier":{"type":"string","maxLength":50},"streetAddress":{"type":"string"},"extendedAddress":{"type":"string"},"locality":{"type":"string"},"administrativeArea":{"type":"string"},"postalCode":{"type":"string"},"countryCode":{"type":"string","minLength":2,"maxLength":2,"enum":["US","CA","GB","ES","DE","FR","NL","AU","BR"]}}},"loaDocumentId":{"type":"string"},"invoiceDocumentId":{"type":"string"},"focDatetimeRequested":{"type":"string","format":"date-time"},"customerReference":{"type":"string","maxLength":100},"portType":{"type":"string","enum":["full","partial"],"default":"full"},"requirements":{"type":"array","maxItems":30,"items":{"type":"object","required":["requirementTypeId","fieldValue"],"properties":{"requirementTypeId":{"type":"string"},"fieldValue":{"type":"string","maxLength":1000}}}}}}}}},"x-pozy-area":"telephony"}},"/v1/phone-numbers/port-in/check":{"post":{"operationId":"checkPhoneNumberPortability","summary":"Check portability","tags":["Phone Numbers"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"phoneNumber":{"type":"string"},"portable":{"type":"boolean"},"fastPortable":{"type":"boolean"},"messagingCapable":{"type":["boolean","null"]},"lineType":{"type":["string","null"]},"carrierName":{"type":["string","null"]},"countryCode":{"type":["string","null"]},"phoneNumberType":{"type":["string","null"]},"notPortableReason":{"type":["string","null"]},"claimId":{"type":"string"},"claimUrl":{"type":"string"}}}}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["phoneNumbers"],"properties":{"phoneNumbers":{"type":"array","minItems":1,"maxItems":50,"items":{"type":"string"}},"claimLinks":{"type":"boolean"}}}}}},"x-pozy-area":"telephony"}},"/v1/phone-numbers/port-in/claims/{claimId}":{"get":{"operationId":"getPhoneNumberPortClaim","summary":"Resolve a port claim","tags":["Phone Numbers"],"parameters":[{"name":"claimId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"phoneNumber":{"type":"string"},"countryCode":{"type":["string","null"]}}}}}}},"x-pozy-area":"telephony"}},"/v1/phone-numbers/port-in/documents":{"post":{"operationId":"uploadPhoneNumberPortInDocument","summary":"Upload a porting document","tags":["Phone Numbers"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"documentId":{"type":"string"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"type":"object","required":["file"],"properties":{"file":{"type":"string","format":"binary"},"kind":{"type":"string"}}}}}},"x-pozy-area":"telephony"}},"/v1/phone-numbers/port-in/requirements":{"get":{"operationId":"getPhoneNumberPortInRequirements","summary":"Country porting requirements","tags":["Phone Numbers"],"parameters":[{"name":"country","in":"query","required":true,"schema":{"type":"string","minLength":2,"maxLength":2}},{"name":"numberType","in":"query","required":false,"schema":{"type":"string","enum":["local","mobile","national","toll_free"],"default":"local"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"country":{"type":"string"},"numberType":{"type":"string"},"supported":{"type":"boolean"},"fields":{"type":"array","items":{"type":"object","properties":{"requirementId":{"type":"string"},"label":{"type":"string"},"kind":{"type":"string","enum":["text","date","address","file","action"]},"description":{"type":"string"},"example":{"type":"string"},"acceptableValues":{"type":"array","items":{"type":"string"}}}}}}}}}}},"x-pozy-area":"telephony"}},"/v1/phone-numbers/port-in/{id}/requirements":{"get":{"operationId":"getPhoneNumberPortInOrderRequirements","summary":"A port-in order's pending requirements","tags":["Phone Numbers"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"country":{"type":"string"},"requirements":{"type":"array","items":{"type":"object","properties":{"requirementId":{"type":"string"},"label":{"type":"string"},"kind":{"type":"string","enum":["text","date","address","file","action"]},"description":{"type":"string"},"example":{"type":"string"},"acceptableValues":{"type":"array","items":{"type":"string"}},"status":{"type":"string"},"filled":{"type":"boolean"}}}}}}}}}},"x-pozy-area":"telephony"}},"/v1/phone-numbers/port-in/{id}":{"delete":{"operationId":"cancelPhoneNumberPortIn","summary":"Cancel a port-in","tags":["Phone Numbers"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string","enum":["draft","pending","foc_confirmed","ported","exception","cancelled"]}}}}}}},"x-pozy-area":"telephony"}},"/v1/phone-numbers/kyc/review-packet":{"post":{"operationId":"reviewPhoneNumberKycPacket","summary":"Pre-review a KYC packet","tags":["Phone Numbers"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"advisories":{"type":"array","items":{"type":"object","properties":{"requirementId":{"type":"string"},"concern":{"type":"string"}}}}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["country","numberType","docs"],"properties":{"country":{"type":"string","minLength":2,"maxLength":2},"numberType":{"type":"string"},"values":{"type":"object","additionalProperties":{"type":"string"}},"address":{"type":"object","additionalProperties":{"type":"string"}},"docs":{"type":"array","minItems":1,"maxItems":4,"items":{"type":"object","required":["requirementId","documentId"],"properties":{"requirementId":{"type":"string"},"documentId":{"type":"string"},"issuedAt":{"type":"string","format":"date"}}}}}}}}},"x-pozy-area":"telephony"}},"/v1/phone-numbers/{id}/remediate":{"get":{"operationId":"getPhoneNumberRemediation","summary":"Get declined requirements","tags":["Phone Numbers"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"country":{"type":"string"},"numberType":{"type":"string"},"declineReason":{"type":["string","null"]},"fields":{"type":"array","items":{"type":"object"}}}}}}}},"x-pozy-area":"telephony"},"post":{"operationId":"remediatePhoneNumber","summary":"Resubmit a declined number","tags":["Phone Numbers"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string"},"phoneNumber":{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string"}}}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"values":{"type":"object","additionalProperties":{"type":"string"}},"documents":{"type":"array","items":{"oneOf":[{"type":"object","required":["requirementId","filename","base64"],"properties":{"requirementId":{"type":"string"},"filename":{"type":"string"},"base64":{"type":"string"}}},{"type":"object","required":["requirementId","documentId"],"properties":{"requirementId":{"type":"string"},"documentId":{"type":"string"}}}]}},"address":{"type":"object"}}}}}},"x-pozy-area":"telephony"}},"/v1/phone-numbers/{id}/remediate/reply":{"post":{"operationId":"replyToPhoneNumberReviewer","summary":"Reply to the regulatory reviewer","tags":["Phone Numbers"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"posted":{"type":"boolean"},"attachments":{"type":"integer"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"text":{"type":"string","maxLength":2000},"attachments":{"type":"array","maxItems":5,"items":{"type":"object","required":["filename","base64"],"properties":{"filename":{"type":"string"},"base64":{"type":"string"}}}}}}}}},"x-pozy-area":"telephony"}},"/v1/phone-numbers/{id}/remediate/respond":{"post":{"operationId":"respondToPhoneNumberReviewer","summary":"Respond to the regulatory reviewer (message + corrections)","tags":["Phone Numbers"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["resubmitted","replied"]},"posted":{"type":"boolean"},"phoneNumber":{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string"}}},"siblingsResubmitted":{"type":"integer"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","maxLength":2000},"documents":{"type":"array","items":{"type":"object","required":["requirementId"],"properties":{"requirementId":{"type":"string"},"filename":{"type":"string"},"base64":{"type":"string"},"documentId":{"type":"string"},"issuedAt":{"type":"string","format":"date"}}}},"address":{"type":"object"},"entityType":{"type":["string","null"],"enum":["individual","business",null]},"attachments":{"type":"array","maxItems":5,"items":{"type":"object","required":["filename","base64"],"properties":{"filename":{"type":"string"},"base64":{"type":"string"}}}}}}}}},"x-pozy-area":"telephony"}},"/v1/whatsapp/phone-numbers/kyc":{"get":{"operationId":"getWhatsAppNumberKycForm","summary":"Get KYC form spec","tags":["WhatsApp Phone Numbers"],"deprecated":true,"parameters":[{"name":"country","in":"query","required":true,"schema":{"type":"string"}},{"name":"profileId","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"country":{"type":"string"},"numberType":{"type":"string"},"fields":{"type":"array","items":{"type":"object","properties":{"requirementId":{"type":"string"},"label":{"type":"string"},"kind":{"type":"string","enum":["text","date","address","file","action"]},"description":{"type":["string","null"]},"example":{"type":["string","null"]},"localTo":{"type":["string","null"]},"audience":{"type":["string","null"],"enum":["business","individual",null]}}}},"reusable":{"type":["object","null"],"properties":{"available":{"type":"boolean"},"fromPhoneNumber":{"type":"string"},"details":{"type":"array","items":{"type":"object","properties":{"label":{"type":"string"},"value":{"type":"string"}}}},"options":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"fromPhoneNumber":{"type":"string"},"instant":{"type":"boolean"},"details":{"type":"array","items":{"type":"object","properties":{"label":{"type":"string"},"value":{"type":"string"},"documentId":{"type":"string"}}}}}}}}},"pendingReview":{"type":"boolean"}}}}}}},"x-pozy-area":"whatsapp"},"post":{"operationId":"submitWhatsAppNumberKyc","summary":"Submit KYC","tags":["WhatsApp Phone Numbers"],"deprecated":true,"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["kyc_submitted","kyc_reused","kyc_already_submitted"]},"preOrder":{"type":"boolean"},"phoneNumber":{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string"},"country":{"type":"string"}}},"numbers":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string"},"phoneNumber":{"type":"string"},"country":{"type":"string"}}}}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["profileId","country"],"properties":{"profileId":{"type":"string"},"country":{"type":"string"},"submissionId":{"type":"string"},"quantity":{"type":"integer","minimum":1,"maximum":5,"default":1},"reuse":{"type":"boolean"},"reuseOptionId":{"type":"string"},"reuseFrom":{"type":"string"},"areaCode":{"type":"string","pattern":"^\\d{1,4}$"},"phoneNumber":{"type":"string","pattern":"^\\+[1-9]\\d{6,14}$"},"preOrder":{"type":"boolean"},"endUserFirstName":{"type":"string"},"endUserLastName":{"type":"string"},"values":{"type":"object","additionalProperties":{"type":"string"}},"documents":{"type":"array","items":{"oneOf":[{"type":"object","required":["requirementId","filename","base64"],"properties":{"requirementId":{"type":"string"},"filename":{"type":"string"},"base64":{"type":"string"}}},{"type":"object","required":["requirementId","documentId"],"properties":{"requirementId":{"type":"string"},"documentId":{"type":"string"}}}]}},"address":{"type":"object","properties":{"requirementId":{"type":"string"},"country_code":{"type":"string"},"business_name":{"type":"string"},"first_name":{"type":"string"},"last_name":{"type":"string"},"street_address":{"type":"string"},"extended_address":{"type":"string"},"locality":{"type":"string"},"administrative_area":{"type":"string"},"postal_code":{"type":"string"}}}}}}}},"x-pozy-area":"whatsapp"}},"/v1/whatsapp/phone-numbers/kyc/upload-document":{"post":{"operationId":"uploadWhatsAppNumberKycDocument","summary":"Upload a KYC document","tags":["WhatsApp Phone Numbers"],"deprecated":true,"parameters":[{"name":"X-Filename","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"documentId":{"type":"string"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/octet-stream":{"schema":{"type":"string","format":"binary"}}}},"x-pozy-area":"whatsapp"}},"/v1/whatsapp/phone-numbers/kyc/validate-address":{"post":{"operationId":"validateWhatsAppNumberKycAddress","summary":"Pre-validate KYC address","tags":["WhatsApp Phone Numbers"],"deprecated":true,"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"ok":{"type":"boolean"},"skipped":{"type":"boolean"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["country","street_address","locality","postal_code"],"properties":{"country":{"type":"string","minLength":2,"maxLength":2},"street_address":{"type":"string"},"extended_address":{"type":"string"},"locality":{"type":"string"},"administrative_area":{"type":"string"},"postal_code":{"type":"string"}}}}}},"x-pozy-area":"whatsapp"}},"/v1/whatsapp/phone-numbers/kyc/share":{"post":{"operationId":"createWhatsAppNumberKycLink","summary":"Create a hosted KYC link","tags":["WhatsApp Phone Numbers"],"deprecated":true,"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string"},"token":{"type":"string"},"expiresAt":{"type":"string","format":"date-time"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["profileId","country"],"properties":{"profileId":{"type":"string"},"country":{"type":"string","minLength":2,"maxLength":2},"areaCode":{"type":"string","pattern":"^\\d{1,4}$"},"language":{"type":"string","enum":["en","es","pt-BR"]},"branding":{"type":"object","properties":{"companyName":{"type":"string","maxLength":60},"logoUrl":{"type":"string","format":"uri"},"brandColor":{"type":"string","pattern":"^#[0-9a-fA-F]{6}$"}}},"redirect_url":{"type":"string","format":"uri"}}}}}},"x-pozy-area":"whatsapp"}},"/v1/whatsapp/phone-numbers/{id}/profile":{"patch":{"operationId":"moveWhatsAppNumberToProfile","summary":"Move a number to another profile","tags":["WhatsApp Phone Numbers"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"profileId":{"type":"string"},"movedPlatforms":{"type":"array","items":{"type":"string"}}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["profileId"],"properties":{"profileId":{"type":"string"}}}}}},"x-pozy-area":"whatsapp"}},"/v1/whatsapp/phone-numbers/{id}/remediate":{"get":{"operationId":"getWhatsAppNumberRemediation","summary":"Get declined requirements","tags":["WhatsApp Phone Numbers"],"deprecated":true,"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"country":{"type":"string"},"numberType":{"type":"string"},"declineReason":{"type":["string","null"]},"fields":{"type":"array","items":{"type":"object"}}}}}}}},"x-pozy-area":"whatsapp"},"post":{"operationId":"remediateWhatsAppNumber","summary":"Resubmit a declined number","tags":["WhatsApp Phone Numbers"],"deprecated":true,"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string"},"phoneNumber":{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string"}}}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"values":{"type":"object","additionalProperties":{"type":"string"}},"documents":{"type":"array","items":{"oneOf":[{"type":"object","required":["requirementId","filename","base64"],"properties":{"requirementId":{"type":"string"},"filename":{"type":"string"},"base64":{"type":"string"}}},{"type":"object","required":["requirementId","documentId"],"properties":{"requirementId":{"type":"string"},"documentId":{"type":"string"}}}]}},"address":{"type":"object"}}}}}},"x-pozy-area":"whatsapp"}},"/v1/phone-numbers/{id}/voice":{"post":{"operationId":"enableVoiceOnNumber","summary":"Enable phone calling on a number","tags":["Voice"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"enabled":{"type":"boolean"},"phoneNumber":{"type":"string"},"pstnForwardTo":{"type":["string","null"]},"recordingEnabled":{"type":"boolean"},"transcriptionEnabled":{"type":"boolean"},"transcriptionLanguage":{"type":"string","enum":["auto","en","es"]},"voicemailEnabled":{"type":"boolean"},"voicemailGreeting":{"type":["string","null"]},"businessHoursEnabled":{"type":"boolean"},"businessHoursTimezone":{"type":["string","null"]},"businessHours":{"type":"array","items":{"type":"object","properties":{"day":{"type":"integer"},"open":{"type":"string"},"close":{"type":"string"}}}},"blockedCallers":{"type":"array","items":{"type":"string"}},"forwardCallerId":{"type":"string","enum":["business","caller"]},"ivrEnabled":{"type":"boolean"},"ivrPrompt":{"type":["string","null"]},"ivrOptions":{"type":"array","items":{"type":"object","properties":{"digit":{"type":"string"},"forwardTo":{"type":"string"},"label":{"type":"string"}}}}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{"forwardTo":{"type":"string"},"recordingEnabled":{"type":"boolean"},"transcriptionEnabled":{"type":"boolean"},"transcriptionLanguage":{"type":"string","enum":["auto","en","es"]},"voicemailEnabled":{"type":"boolean"},"voicemailGreeting":{"type":"string","maxLength":1000},"businessHoursEnabled":{"type":"boolean"},"businessHoursTimezone":{"type":"string","maxLength":64},"businessHours":{"type":"array","maxItems":21,"items":{"type":"object","required":["day","open","close"],"properties":{"day":{"type":"integer","minimum":0,"maximum":6},"open":{"type":"string","pattern":"^\\d{2}:\\d{2}$"},"close":{"type":"string","pattern":"^\\d{2}:\\d{2}$"}}}},"blockedCallers":{"type":"array","maxItems":1000,"items":{"type":"string"}},"forwardCallerId":{"type":"string","enum":["business","caller"]},"ivrEnabled":{"type":"boolean"},"ivrPrompt":{"type":"string","maxLength":1000},"ivrOptions":{"type":"array","maxItems":12,"items":{"type":"object","required":["digit","forwardTo"],"properties":{"digit":{"type":"string","pattern":"^[0-9*#]$"},"forwardTo":{"type":"string"},"label":{"type":"string","maxLength":80}}}}}}}}},"x-pozy-area":"telephony"},"delete":{"operationId":"disableVoiceOnNumber","summary":"Disable phone calling on a number","tags":["Voice"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"enabled":{"type":"boolean"},"phoneNumber":{"type":"string"}}}}}}},"x-pozy-area":"telephony"}},"/v1/phone-numbers/stock-watches":{"get":{"operationId":"listPhoneNumberStockWatches","summary":"List stock watches","tags":["Phone Numbers"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"watches":{"type":"array","items":{"$ref":"#/components/schemas/PhoneNumberStockWatch"}}}}}}}},"x-pozy-area":"telephony"},"post":{"operationId":"createPhoneNumberStockWatch","summary":"Watch an out-of-stock country","tags":["Phone Numbers"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/PhoneNumberStockWatch"},{"type":"object","properties":{"preOrderable":{"type":"boolean"}}}]}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["country"],"properties":{"country":{"type":"string","minLength":2,"maxLength":2},"numberType":{"type":"string","enum":["local","mobile","national","toll_free"]},"areaCode":{"type":"string","pattern":"^\\d{1,4}$"}}}}}},"x-pozy-area":"telephony"}},"/v1/phone-numbers/stock-watches/{id}":{"delete":{"operationId":"deletePhoneNumberStockWatch","summary":"Stop watching a country","tags":["Phone Numbers"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"deleted":{"type":"boolean"}}}}}}},"x-pozy-area":"telephony"}},"/v1/phone-numbers/sip-trunks":{"get":{"operationId":"listSipTrunks","summary":"List SIP trunks","tags":["Voice"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"trunks":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"label":{"type":"string"},"sipHost":{"type":"string"},"sipPort":{"type":"integer"},"transport":{"type":"string","enum":["tls","tcp","udp"]},"termination":{"type":"object","properties":{"uri":{"type":"string"},"username":{"type":"string"}}},"numbersAttached":{"type":"integer"},"createdAt":{"type":["string","null"],"format":"date-time"}}}},"enabled":{"type":"boolean"}}}}}}},"x-pozy-area":"telephony"},"post":{"operationId":"createSipTrunk","summary":"Create a SIP trunk","tags":["Voice"],"responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"label":{"type":"string"},"sipHost":{"type":"string"},"sipPort":{"type":"integer"},"transport":{"type":"string","enum":["tls","tcp","udp"]},"termination":{"type":"object","properties":{"uri":{"type":"string"},"username":{"type":"string"}}},"numbersAttached":{"type":"integer"},"createdAt":{"type":["string","null"],"format":"date-time"},"digestPassword":{"type":"string"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["label","sipHost"],"properties":{"label":{"type":"string","maxLength":80},"sipHost":{"type":"string"},"sipPort":{"type":"integer","minimum":1,"maximum":65535},"transport":{"type":"string","enum":["tls","tcp","udp"]}}}}}},"x-pozy-area":"telephony"}},"/v1/phone-numbers/sip-trunks/{id}":{"get":{"operationId":"getSipTrunk","summary":"Get a SIP trunk","tags":["Voice"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"label":{"type":"string"},"sipHost":{"type":"string"},"sipPort":{"type":"integer"},"transport":{"type":"string","enum":["tls","tcp","udp"]},"termination":{"type":"object","properties":{"uri":{"type":"string"},"username":{"type":"string"}}},"numbersAttached":{"type":"integer"},"createdAt":{"type":["string","null"],"format":"date-time"},"numbers":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"phoneNumber":{"type":"string"}}}}}}}}}},"x-pozy-area":"telephony"},"delete":{"operationId":"deleteSipTrunk","summary":"Delete a SIP trunk","tags":["Voice"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"deleted":{"type":"boolean"}}}}}}},"x-pozy-area":"telephony"}},"/v1/phone-numbers/sip-trunks/{id}/rotate-credentials":{"post":{"operationId":"rotateSipTrunkCredentials","summary":"Rotate a SIP trunk's password","tags":["Voice"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"termination":{"type":"object","properties":{"uri":{"type":"string"},"username":{"type":"string"}}},"digestPassword":{"type":"string"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"x-pozy-area":"telephony"}},"/v1/phone-numbers/{id}/sip-trunk":{"post":{"operationId":"attachNumberToSipTrunk","summary":"Attach a number to a SIP trunk","tags":["Voice"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"attached":{"type":"boolean"},"phoneNumber":{"type":"string"},"trunkId":{"type":"string"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["trunkId"],"properties":{"trunkId":{"type":"string"}}}}}},"x-pozy-area":"telephony"},"delete":{"operationId":"detachNumberFromSipTrunk","summary":"Detach a number from its SIP trunk","tags":["Voice"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"attached":{"type":"boolean"},"phoneNumber":{"type":"string"}}}}}}},"x-pozy-area":"telephony"}},"/v1/phone-numbers/{id}/sms":{"post":{"operationId":"enableSmsOnNumber","summary":"Enable SMS on a number","tags":["SMS"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"enabled":{"type":"boolean"},"id":{"type":"string"},"phoneNumber":{"type":"string"},"isActive":{"type":"boolean"},"country":{"type":"string"},"smsCapable":{"type":["boolean","null"]},"mmsCapable":{"type":"boolean"},"domesticOnly":{"type":"boolean"},"notReady":{"type":"boolean"},"needsRegistration":{"type":"boolean"},"alreadyRegistered":{"type":"boolean"},"registrationStatus":{"type":["string","null"],"enum":["pending","approved","rejected",null]},"reusable":{"type":["object","null"],"properties":{"registrationId":{"type":"string"},"status":{"type":"string"}}},"message":{"type":"string"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"x-pozy-area":"messaging"},"delete":{"operationId":"disableSmsOnNumber","summary":"Disable SMS on a number","tags":["SMS"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"enabled":{"type":"boolean"},"phoneNumber":{"type":"string"},"disabled":{"type":"boolean"}}}}}}},"x-pozy-area":"messaging"}},"/v1/phone-numbers/{id}/sms/reuse-registration":{"post":{"operationId":"reuseSmsRegistrationForNumber","summary":"Add number to SMS registration","tags":["SMS"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"registrationId":{"type":"string"},"status":{"type":"string","enum":["pending","approved","rejected","requested","changes_requested","deactivated"]}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"x-pozy-area":"messaging"}},"/v1/phone-numbers/{id}/whatsapp/request-code":{"post":{"operationId":"requestPhoneNumberWhatsAppCode","summary":"Request the WhatsApp verification code for a number","tags":["Phone Numbers"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"method":{"type":"string","enum":["SMS","VOICE"]},"alreadyVerified":{"type":"boolean"},"replaced":{"type":"boolean"},"newPhoneNumber":{"type":"string"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{"method":{"type":"string","enum":["SMS","VOICE"]}}}}}},"x-pozy-area":"telephony"}},"/v1/phone-numbers/{id}/whatsapp/calling":{"get":{"operationId":"getWhatsAppCalling","summary":"Get calling config for a number","tags":["WhatsApp Calling"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"phoneNumber":{"type":"string"},"callingEnabled":{"type":"boolean"},"callDeepLink":{"type":["string","null"]},"forwardTo":{"type":["string","null"]},"recordingEnabled":{"type":"boolean"},"sipAuthUsername":{"type":["string","null"]},"sipAuthPasswordConfigured":{"type":"boolean"},"callIconCountries":{"type":["array","null"],"items":{"type":"string","minLength":2,"maxLength":2}},"outboundDisabled":{"type":"boolean"},"callerIdMode":{"type":"string","enum":["business","platform"]},"callerIdVerified":{"type":"boolean"},"maxCallDurationSeconds":{"type":["integer","null"]},"forwardCallerId":{"type":"string","enum":["business","caller"]}}}}}}},"x-pozy-area":"whatsapp"},"post":{"operationId":"enableWhatsAppCalling","summary":"Enable calling on a number","tags":["WhatsApp Calling"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"callingEnabled":{"type":"boolean"},"sipHostname":{"type":"string"},"forwardTo":{"type":"string"},"callerIdMode":{"type":"string","enum":["business","platform"]}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","forwardTo"],"properties":{"accountId":{"type":"string"},"forwardTo":{"type":"string"},"sipAuthUsername":{"type":"string"},"sipAuthPassword":{"type":"string"},"recordingEnabled":{"type":"boolean","default":false},"callIconCountries":{"type":"array","items":{"type":"string","minLength":2,"maxLength":2}},"maxCallDurationSeconds":{"type":"integer","minimum":30,"maximum":14400},"forwardCallerId":{"type":"string","enum":["business","caller"],"default":"business"}}}}}},"x-pozy-area":"whatsapp"},"patch":{"operationId":"updateWhatsAppCalling","summary":"Update calling config","tags":["WhatsApp Calling"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId"],"properties":{"accountId":{"type":"string"},"forwardTo":{"type":"string"},"sipAuthUsername":{"type":["string","null"]},"sipAuthPassword":{"type":["string","null"]},"recordingEnabled":{"type":"boolean"},"callIconCountries":{"type":["array","null"],"items":{"type":"string","minLength":2,"maxLength":2}},"maxCallDurationSeconds":{"type":["integer","null"],"minimum":30,"maximum":14400},"forwardCallerId":{"type":"string","enum":["business","caller"]}}}}}},"x-pozy-area":"whatsapp"},"delete":{"operationId":"disableWhatsAppCalling","summary":"Disable calling on a number","tags":["WhatsApp Calling"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"}},"x-pozy-area":"whatsapp"}},"/v1/phone-numbers/{id}/whatsapp/caller-id-verification":{"post":{"operationId":"startWhatsAppCallerIdVerification","summary":"Start caller-ID verification for a customer-brought number","tags":["WhatsApp Calling"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"verified":{"type":"boolean"},"codeSent":{"type":"boolean"},"method":{"type":"string","enum":["sms","call"]}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{"method":{"type":"string","enum":["sms","call"],"default":"sms"}}}}}},"x-pozy-area":"whatsapp"}},"/v1/phone-numbers/{id}/whatsapp/caller-id-verification/verify":{"post":{"operationId":"verifyWhatsAppCallerId","summary":"Confirm the caller-ID verification code","tags":["WhatsApp Calling"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"verified":{"type":"boolean"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["code"],"properties":{"code":{"type":"string","minLength":4,"maxLength":10}}}}}},"x-pozy-area":"whatsapp"}},"/v1/whatsapp/phone-numbers/{phoneNumberId}":{"get":{"operationId":"getWhatsAppPhoneNumber","summary":"Get phone number","tags":["WhatsApp Phone Numbers"],"deprecated":true,"parameters":[{"name":"phoneNumberId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"phoneNumber":{"type":"object","properties":{"id":{"type":"string"},"phoneNumber":{"type":"string"},"status":{"type":"string","enum":["pending_payment","pending_regulatory","regulatory_declined","provisioning","verifying","active","suspended","releasing","released"]},"country":{"type":"string"},"metaPreverifiedId":{"type":"string"},"metaVerificationStatus":{"type":"string"},"identityVerificationUrl":{"type":["string","null"]},"endUserFirstName":{"type":["string","null"]},"endUserLastName":{"type":["string","null"]},"regulatoryDeclineReason":{"type":["string","null"]},"provisionedAt":{"type":"string","format":"date-time"},"sipTrunkId":{"type":["string","null"]}}}}}}}}},"x-pozy-area":"whatsapp"},"delete":{"operationId":"releaseWhatsAppPhoneNumber","summary":"Release phone number","tags":["WhatsApp Phone Numbers"],"deprecated":true,"parameters":[{"name":"phoneNumberId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"phoneNumber":{"type":"object","properties":{"id":{"type":"string"},"phoneNumber":{"type":"string"},"status":{"type":"string"},"releasedAt":{"type":"string","format":"date-time"}}}}}}}}},"x-pozy-area":"whatsapp"}},"/v1/whatsapp/sandbox/sessions":{"get":{"operationId":"listWhatsAppSandboxSessions","summary":"List your sandbox sessions","tags":["WhatsApp Sandbox"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"sessions":{"type":"array","items":{"$ref":"#/components/schemas/WhatsAppSandboxSession"}},"sandboxNumber":{"type":["string","null"]}}}}}}},"x-pozy-area":"whatsapp"},"post":{"operationId":"createWhatsAppSandboxSession","summary":"Start a sandbox activation","tags":["WhatsApp Sandbox"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"session":{"$ref":"#/components/schemas/WhatsAppSandboxSession"},"sandboxNumber":{"type":"string"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["phone"],"properties":{"phone":{"type":"string"}}}}}},"x-pozy-area":"whatsapp"}},"/v1/whatsapp/sandbox/sessions/{sessionId}":{"delete":{"operationId":"deleteWhatsAppSandboxSession","summary":"Revoke a sandbox session","tags":["WhatsApp Sandbox"],"parameters":[{"name":"sessionId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"}}}}}}},"x-pozy-area":"whatsapp"}},"/v1/whatsapp/wa-groups":{"get":{"operationId":"listWhatsAppGroupChats","summary":"List active groups","tags":["WhatsApp"],"parameters":[{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","default":25,"maximum":1024}},{"name":"after","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"groups":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"subject":{"type":"string"},"createdAt":{"type":"string"}}}},"paging":{"type":"object","properties":{"cursors":{"type":"object","properties":{"after":{"type":"string"},"before":{"type":"string"}}}}}}}}}}},"x-pozy-area":"whatsapp"},"post":{"operationId":"createWhatsAppGroupChat","summary":"Create group","tags":["WhatsApp"],"responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"group":{"type":"object","properties":{"groupId":{"type":"string"},"inviteLink":{"type":"string"}}}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","subject"],"properties":{"accountId":{"type":"string"},"subject":{"type":"string","maxLength":128},"description":{"type":"string","maxLength":2048},"joinApprovalMode":{"type":"string","enum":["approval_required","auto_approve"]}}}}}},"x-pozy-area":"whatsapp"}},"/v1/whatsapp/wa-groups/{groupId}":{"get":{"operationId":"getWhatsAppGroupChat","summary":"Get group info","tags":["WhatsApp"],"parameters":[{"name":"groupId","in":"path","required":true,"schema":{"type":"string"}},{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"group":{"type":"object","properties":{"id":{"type":"string"},"subject":{"type":"string"},"description":{"type":"string"},"joinApprovalMode":{"type":"string"},"participants":{"type":"array","items":{"type":"object","properties":{"user":{"type":"string"},"admin":{"type":"string"}}}},"participantCount":{"type":"integer"},"createdAt":{"type":"integer"},"isSuspended":{"type":"boolean"}}}}}}}}},"x-pozy-area":"whatsapp"},"post":{"operationId":"updateWhatsAppGroupChat","summary":"Update group settings","tags":["WhatsApp"],"parameters":[{"name":"groupId","in":"path","required":true,"schema":{"type":"string"}},{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"subject":{"type":"string","maxLength":128},"description":{"type":"string","maxLength":2048},"joinApprovalMode":{"type":"string","enum":["approval_required","auto_approve"]}}}}}},"x-pozy-area":"whatsapp"},"delete":{"operationId":"deleteWhatsAppGroupChat","summary":"Delete group","tags":["WhatsApp"],"parameters":[{"name":"groupId","in":"path","required":true,"schema":{"type":"string"}},{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}},"x-pozy-area":"whatsapp"}},"/v1/whatsapp/wa-groups/{groupId}/participants":{"post":{"operationId":"addWhatsAppGroupParticipants","summary":"Add participants","tags":["WhatsApp"],"parameters":[{"name":"groupId","in":"path","required":true,"schema":{"type":"string"}},{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["phoneNumbers"],"properties":{"phoneNumbers":{"type":"array","maxItems":8,"items":{"type":"string"}}}}}}},"x-pozy-area":"whatsapp"},"delete":{"operationId":"removeWhatsAppGroupParticipants","summary":"Remove participants","tags":["WhatsApp"],"parameters":[{"name":"groupId","in":"path","required":true,"schema":{"type":"string"}},{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["phoneNumbers"],"properties":{"phoneNumbers":{"type":"array","items":{"type":"string"}}}}}}},"x-pozy-area":"whatsapp"}},"/v1/whatsapp/wa-groups/{groupId}/invite-link":{"post":{"operationId":"createWhatsAppGroupInviteLink","summary":"Create invite link","tags":["WhatsApp"],"parameters":[{"name":"groupId","in":"path","required":true,"schema":{"type":"string"}},{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"inviteLink":{"type":"string"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"x-pozy-area":"whatsapp"}},"/v1/whatsapp/wa-groups/{groupId}/join-requests":{"get":{"operationId":"listWhatsAppGroupJoinRequests","summary":"List join requests","tags":["WhatsApp"],"parameters":[{"name":"groupId","in":"path","required":true,"schema":{"type":"string"}},{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"joinRequests":{"type":"array","items":{"type":"object","properties":{"user":{"type":"string"},"timestamp":{"type":"integer"}}}}}}}}}},"x-pozy-area":"whatsapp"},"post":{"operationId":"approveWhatsAppGroupJoinRequests","summary":"Approve join requests","tags":["WhatsApp"],"parameters":[{"name":"groupId","in":"path","required":true,"schema":{"type":"string"}},{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["phoneNumbers"],"properties":{"phoneNumbers":{"type":"array","items":{"type":"string"}}}}}}},"x-pozy-area":"whatsapp"},"delete":{"operationId":"rejectWhatsAppGroupJoinRequests","summary":"Reject join requests","tags":["WhatsApp"],"parameters":[{"name":"groupId","in":"path","required":true,"schema":{"type":"string"}},{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["phoneNumbers"],"properties":{"phoneNumbers":{"type":"array","items":{"type":"string"}}}}}}},"x-pozy-area":"whatsapp"}},"/v1/whatsapp/flows":{"get":{"operationId":"listWhatsAppFlows","summary":"List flows","tags":["WhatsApp Flows"],"parameters":[{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"flows":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"status":{"type":"string","enum":["DRAFT","PUBLISHED","DEPRECATED","BLOCKED","THROTTLED"]},"categories":{"type":"array","items":{"type":"string"}},"validation_errors":{"type":"array","items":{"type":"object"}},"version":{"type":"integer"},"lineageId":{"type":"string"}}}}}}}}}},"x-pozy-area":"whatsapp"},"post":{"operationId":"createWhatsAppFlow","summary":"Create flow","tags":["WhatsApp Flows"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"flow":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"status":{"type":"string"},"categories":{"type":"array","items":{"type":"string"}},"version":{"type":"integer"},"lineageId":{"type":"string"}}}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","name","categories"],"properties":{"accountId":{"type":"string"},"name":{"type":"string","maxLength":128},"categories":{"type":"array","minItems":1,"items":{"type":"string","enum":["SIGN_UP","SIGN_IN","APPOINTMENT_BOOKING","LEAD_GENERATION","CONTACT_US","CUSTOMER_SUPPORT","SURVEY","OTHER"]}},"cloneFlowId":{"type":"string"},"asVersion":{"type":"boolean"},"endpointUri":{"type":"string","format":"uri"}}}}}},"x-pozy-area":"whatsapp"}},"/v1/whatsapp/flows/{flowId}":{"get":{"operationId":"getWhatsAppFlow","summary":"Get flow","tags":["WhatsApp Flows"],"parameters":[{"name":"flowId","in":"path","required":true,"schema":{"type":"string"}},{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}},{"name":"fields","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"flow":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"status":{"type":"string"},"categories":{"type":"array","items":{"type":"string"}},"validation_errors":{"type":"array","items":{"type":"object"}},"json_version":{"type":"string"},"preview":{"type":"object","properties":{"preview_url":{"type":"string"},"expires_at":{"type":"string"}}}}}}}}}}},"x-pozy-area":"whatsapp"},"patch":{"operationId":"updateWhatsAppFlow","summary":"Update flow","tags":["WhatsApp Flows"],"parameters":[{"name":"flowId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId"],"properties":{"accountId":{"type":"string"},"name":{"type":"string","maxLength":128},"categories":{"type":"array","minItems":1,"items":{"type":"string","enum":["SIGN_UP","SIGN_IN","APPOINTMENT_BOOKING","LEAD_GENERATION","CONTACT_US","CUSTOMER_SUPPORT","SURVEY","OTHER"]}},"endpointUri":{"type":"string","format":"uri"}}}}}},"x-pozy-area":"whatsapp"},"delete":{"operationId":"deleteWhatsAppFlow","summary":"Delete flow","tags":["WhatsApp Flows"],"parameters":[{"name":"flowId","in":"path","required":true,"schema":{"type":"string"}},{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"}}}}}}},"x-pozy-area":"whatsapp"}},"/v1/whatsapp/flows/{flowId}/json":{"get":{"operationId":"getWhatsAppFlowJson","summary":"Get flow JSON asset","tags":["WhatsApp Flows"],"parameters":[{"name":"flowId","in":"path","required":true,"schema":{"type":"string"}},{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"assets":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"asset_type":{"type":"string"},"download_url":{"type":"string"}}}}}}}}}},"x-pozy-area":"whatsapp"},"put":{"operationId":"uploadWhatsAppFlowJson","summary":"Upload flow JSON","tags":["WhatsApp Flows"],"parameters":[{"name":"flowId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"validation_errors":{"type":"array","items":{"type":"object","properties":{"error":{"type":"string"},"error_type":{"type":"string"},"message":{"type":"string"},"line_start":{"type":"integer"},"line_end":{"type":"integer"},"column_start":{"type":"integer"},"column_end":{"type":"integer"}}}}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","flow_json"],"properties":{"accountId":{"type":"string"},"flow_json":{"oneOf":[{"type":"object"},{"type":"string"}]}}}}}},"x-pozy-area":"whatsapp"}},"/v1/whatsapp/flows/{flowId}/preview":{"get":{"operationId":"getWhatsAppFlowPreview","summary":"Get flow preview URL","tags":["WhatsApp Flows"],"parameters":[{"name":"flowId","in":"path","required":true,"schema":{"type":"string"}},{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}},{"name":"invalidate","in":"query","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"preview_url":{"type":["string","null"]},"expires_at":{"type":["string","null"]}}}}}}},"x-pozy-area":"whatsapp"}},"/v1/whatsapp/flows/{flowId}/versions":{"get":{"operationId":"listWhatsAppFlowVersions","summary":"List flow versions","tags":["WhatsApp Flows"],"parameters":[{"name":"flowId","in":"path","required":true,"schema":{"type":"string"}},{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"versions":{"type":"array","items":{"type":"object","properties":{"flowId":{"type":"string"},"version":{"type":"integer"},"parentFlowId":{"type":["string","null"]},"name":{"type":["string","null"]},"status":{"type":["string","null"]},"missing":{"type":"boolean"}}}}}}}}}},"x-pozy-area":"whatsapp"}},"/v1/whatsapp/flows/{flowId}/publish":{"post":{"operationId":"publishWhatsAppFlow","summary":"Publish flow","tags":["WhatsApp Flows"],"parameters":[{"name":"flowId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId"],"properties":{"accountId":{"type":"string"}}}}}},"x-pozy-area":"whatsapp"}},"/v1/whatsapp/flows/{flowId}/deprecate":{"post":{"operationId":"deprecateWhatsAppFlow","summary":"Deprecate flow","tags":["WhatsApp Flows"],"parameters":[{"name":"flowId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId"],"properties":{"accountId":{"type":"string"}}}}}},"x-pozy-area":"whatsapp"}},"/v1/whatsapp/flows/encryption-key":{"get":{"operationId":"getWhatsAppFlowsEncryptionKey","summary":"Get Flows encryption key status","tags":["WhatsApp Flows"],"parameters":[{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"publicKey":{"type":["string","null"]},"signatureStatus":{"type":["string","null"],"enum":["VALID","MISMATCH"]},"registered":{"type":"boolean"}}}}}}},"x-pozy-area":"whatsapp"},"post":{"operationId":"setWhatsAppFlowsEncryptionKey","summary":"Register a Flows encryption key","tags":["WhatsApp Flows"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","businessPublicKey"],"properties":{"accountId":{"type":"string"},"businessPublicKey":{"type":"string"}}}}}},"x-pozy-area":"whatsapp"}},"/v1/whatsapp/flows/send":{"post":{"operationId":"sendWhatsAppFlowMessage","summary":"Send flow message","tags":["WhatsApp Flows"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"messageId":{"type":"string"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","to","flow_id","flow_cta","body"],"properties":{"accountId":{"type":"string"},"to":{"type":"string"},"flow_id":{"type":"string"},"flow_cta":{"type":"string","maxLength":20},"flow_action":{"type":"string","enum":["navigate","data_exchange"],"default":"navigate"},"flow_token":{"type":"string","maxLength":200},"flow_action_payload":{"type":"object","properties":{"screen":{"type":"string"},"data":{"type":"object"}}},"body":{"type":"string"},"header":{"type":"object","properties":{"type":{"type":"string","enum":["text"]},"text":{"type":"string"}}},"footer":{"type":"string"},"draft":{"type":"boolean"}}}}}},"x-pozy-area":"whatsapp"}},"/v1/whatsapp/flow-responses":{"get":{"operationId":"listWhatsAppFlowResponses","summary":"List flow responses","tags":["WhatsApp Flows"],"parameters":[{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}},{"name":"flowId","in":"query","required":false,"schema":{"type":"string"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":200,"default":50}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"responses":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"receivedAt":{"type":"string","format":"date-time"},"from":{"type":["string","null"]},"senderName":{"type":["string","null"]},"conversationId":{"type":["string","null"]},"flowToken":{"type":["string","null"]},"data":{"type":"object"},"raw":{"type":["string","null"]}}}}}}}}}},"x-pozy-area":"whatsapp"}},"/v1/contacts":{"get":{"operationId":"listContacts","summary":"List contacts","tags":["Contacts"],"parameters":[{"name":"profileId","in":"query","required":false,"schema":{"type":"string"}},{"name":"accountId","in":"query","required":false,"schema":{"type":"string"}},{"name":"search","in":"query","required":false,"schema":{"type":"string"}},{"name":"tag","in":"query","required":false,"schema":{"type":"string"}},{"name":"tags","in":"query","required":false,"schema":{"type":"string"}},{"name":"platform","in":"query","required":false,"schema":{"type":"string","enum":["instagram","facebook","telegram","twitter","bluesky","reddit","whatsapp","slack","sms"]}},{"name":"isSubscribed","in":"query","required":false,"schema":{"type":"string","enum":["true","false"]}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","default":50,"maximum":200}},{"name":"skip","in":"query","required":false,"schema":{"type":"integer","default":0}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"contacts":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"email":{"type":"string"},"company":{"type":"string"},"avatarUrl":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}},"isSubscribed":{"type":"boolean"},"isBlocked":{"type":"boolean"},"lastMessageSentAt":{"type":"string","format":"date-time"},"lastMessageReceivedAt":{"type":"string","format":"date-time"},"messagesSentCount":{"type":"integer"},"messagesReceivedCount":{"type":"integer"},"customFields":{"type":"object"},"notes":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"platform":{"type":"string"},"platformIdentifier":{"type":"string"},"displayIdentifier":{"type":"string"}}}},"filters":{"type":"object","properties":{"tags":{"type":"array","items":{"type":"string"}}}},"pagination":{"type":"object","properties":{"total":{"type":"integer"},"limit":{"type":"integer"},"skip":{"type":"integer"},"hasMore":{"type":"boolean"}}}}}}}}},"x-pozy-area":"automations"},"post":{"operationId":"createContact","summary":"Create contact","tags":["Contacts"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"contact":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"email":{"type":"string"},"company":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}},"isSubscribed":{"type":"boolean"},"isBlocked":{"type":"boolean"},"customFields":{"type":"object"},"notes":{"type":"string"},"createdAt":{"type":"string","format":"date-time"}}},"channel":{"type":"object","properties":{"id":{"type":"string"},"platform":{"type":"string"},"platformIdentifier":{"type":"string"},"displayIdentifier":{"type":"string"}}},"warning":{"type":"string"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["profileId","name"],"properties":{"profileId":{"type":"string"},"name":{"type":"string"},"email":{"type":"string"},"company":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}},"isSubscribed":{"type":"boolean","default":true},"notes":{"type":"string"},"accountId":{"type":"string"},"platform":{"type":"string","enum":["instagram","facebook","telegram","twitter","bluesky","reddit","whatsapp","slack","sms"]},"platformIdentifier":{"type":"string"},"displayIdentifier":{"type":"string"}}}}}},"x-pozy-area":"automations"}},"/v1/contacts/{contactId}":{"get":{"operationId":"getContact","summary":"Get contact","tags":["Contacts"],"parameters":[{"name":"contactId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"contact":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"email":{"type":"string"},"company":{"type":"string"},"avatarUrl":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}},"isSubscribed":{"type":"boolean"},"isBlocked":{"type":"boolean"},"messagesSentCount":{"type":"integer"},"messagesReceivedCount":{"type":"integer"},"lastMessageSentAt":{"type":["string","null"],"format":"date-time"},"lastMessageReceivedAt":{"type":["string","null"],"format":"date-time"},"customFields":{"type":"object"},"notes":{"type":"string"},"conversationIds":{"type":"array","items":{"type":"string"}},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}}},"channels":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"accountId":{"type":"string"},"platform":{"type":"string"},"platformIdentifier":{"type":"string"},"displayIdentifier":{"type":"string"},"isSubscribed":{"type":"boolean"},"conversationId":{"type":"string"},"lastActiveAt":{"type":["string","null"],"format":"date-time"},"createdAt":{"type":"string","format":"date-time"}}}}}}}}}},"x-pozy-area":"automations"},"patch":{"operationId":"updateContact","summary":"Update contact","tags":["Contacts"],"parameters":[{"name":"contactId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"contact":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"email":{"type":"string"},"company":{"type":"string"},"avatarUrl":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}},"isSubscribed":{"type":"boolean"},"isBlocked":{"type":"boolean"},"notes":{"type":"string"},"updatedAt":{"type":"string","format":"date-time"}}}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"email":{"type":"string"},"company":{"type":"string"},"avatarUrl":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}},"isSubscribed":{"type":"boolean"},"isBlocked":{"type":"boolean"},"notes":{"type":"string"}}}}}},"x-pozy-area":"automations"},"delete":{"operationId":"deleteContact","summary":"Delete contact","tags":["Contacts"],"parameters":[{"name":"contactId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"}},"x-pozy-area":"automations"}},"/v1/contacts/{contactId}/channels":{"get":{"operationId":"getContactChannels","summary":"List channels for a contact","tags":["Contacts"],"parameters":[{"name":"contactId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"channels":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"accountId":{"type":"string"},"platform":{"type":"string"},"platformIdentifier":{"type":"string"},"displayIdentifier":{"type":"string"},"isSubscribed":{"type":"boolean"},"conversationId":{"type":"string"},"metadata":{"type":"object"},"createdAt":{"type":"string","format":"date-time"}}}}}}}}}},"x-pozy-area":"automations"}},"/v1/contacts/bulk":{"post":{"operationId":"bulkCreateContacts","summary":"Bulk create contacts","tags":["Contacts"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"created":{"type":"integer"},"skipped":{"type":"integer"},"errors":{"type":"array","items":{"type":"string"}},"total":{"type":"integer"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["profileId","contacts"],"properties":{"profileId":{"type":"string"},"accountId":{"type":"string"},"platform":{"type":"string"},"contacts":{"type":"array","maxItems":1000,"items":{"type":"object","required":["name"],"properties":{"name":{"type":"string"},"platformIdentifier":{"type":"string"},"displayIdentifier":{"type":"string"},"email":{"type":"string"},"company":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}}}}}}}}}},"x-pozy-area":"automations"}},"/v1/contacts/{contactId}/fields/{slug}":{"put":{"operationId":"setContactFieldValue","summary":"Set custom field value","tags":["Custom Fields"],"parameters":[{"name":"contactId","in":"path","required":true,"schema":{"type":"string"}},{"name":"slug","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["value"],"properties":{"value":{}}}}}},"x-pozy-area":"automations"},"delete":{"operationId":"clearContactFieldValue","summary":"Clear custom field value","tags":["Custom Fields"],"parameters":[{"name":"contactId","in":"path","required":true,"schema":{"type":"string"}},{"name":"slug","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"}},"x-pozy-area":"automations"}},"/v1/custom-fields":{"get":{"operationId":"listCustomFields","summary":"List custom field definitions","tags":["Custom Fields"],"parameters":[{"name":"profileId","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"fields":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"slug":{"type":"string"},"type":{"type":"string","enum":["text","number","date","boolean","select"]},"options":{"type":"array","items":{"type":"string"}},"createdAt":{"type":"string","format":"date-time"}}}}}}}}}},"x-pozy-area":"automations"},"post":{"operationId":"createCustomField","summary":"Create custom field","tags":["Custom Fields"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"field":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"slug":{"type":"string"},"type":{"type":"string","enum":["text","number","date","boolean","select"]},"options":{"type":"array","items":{"type":"string"}},"createdAt":{"type":"string","format":"date-time"}}}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["profileId","name","type"],"properties":{"profileId":{"type":"string"},"name":{"type":"string"},"slug":{"type":"string"},"type":{"type":"string","enum":["text","number","date","boolean","select"]},"options":{"type":"array","items":{"type":"string"}}}}}}},"x-pozy-area":"automations"}},"/v1/custom-fields/{fieldId}":{"patch":{"operationId":"updateCustomField","summary":"Update custom field","tags":["Custom Fields"],"parameters":[{"name":"fieldId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"field":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"slug":{"type":"string"},"type":{"type":"string"},"options":{"type":"array","items":{"type":"string"}}}}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"options":{"type":"array","items":{"type":"string"}}}}}}},"x-pozy-area":"automations"},"delete":{"operationId":"deleteCustomField","summary":"Delete custom field","tags":["Custom Fields"],"parameters":[{"name":"fieldId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"}},"x-pozy-area":"automations"}},"/v1/broadcasts":{"get":{"operationId":"listBroadcasts","summary":"List broadcasts","tags":["Broadcasts"],"parameters":[{"name":"profileId","in":"query","required":false,"schema":{"type":"string"}},{"name":"status","in":"query","required":false,"schema":{"type":"string","enum":["draft","scheduled","sending","completed","failed","cancelled"]}},{"name":"platform","in":"query","required":false,"schema":{"type":"string"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","default":50}},{"name":"skip","in":"query","required":false,"schema":{"type":"integer","default":0}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"broadcasts":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"platform":{"type":"string"},"accountId":{"type":"string"},"accountName":{"type":"string"},"status":{"type":"string","enum":["draft","scheduled","sending","completed","failed","cancelled"]},"messagePreview":{"type":"string"},"scheduledAt":{"type":"string","format":"date-time"},"startedAt":{"type":"string","format":"date-time"},"completedAt":{"type":"string","format":"date-time"},"recipientCount":{"type":"integer"},"sentCount":{"type":"integer"},"deliveredCount":{"type":"integer"},"readCount":{"type":"integer"},"failedCount":{"type":"integer"},"createdAt":{"type":"string","format":"date-time"}}}},"pagination":{"type":"object","properties":{"total":{"type":"integer"},"limit":{"type":"integer"},"skip":{"type":"integer"},"hasMore":{"type":"boolean"}}}}}}}}},"x-pozy-area":"automations"},"post":{"operationId":"createBroadcast","summary":"Create broadcast draft","tags":["Broadcasts"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"broadcast":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"platform":{"type":"string"},"accountId":{"type":"string"},"status":{"type":"string"},"createdAt":{"type":"string","format":"date-time"}}}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["profileId","accountId","platform","name"],"properties":{"profileId":{"type":"string"},"accountId":{"type":"string"},"platform":{"type":"string","enum":["instagram","facebook","telegram","twitter","bluesky","reddit","whatsapp","sms","slack","imessage"]},"name":{"type":"string"},"description":{"type":"string"},"message":{"type":"object","properties":{"text":{"type":"string"},"attachments":{"type":"array","maxItems":10,"items":{"type":"object","properties":{"type":{"type":"string"},"url":{"type":"string"},"filename":{"type":"string"}}}},"messageTag":{"type":"string","enum":["CONFIRMED_EVENT_UPDATE","POST_PURCHASE_UPDATE","ACCOUNT_UPDATE","HUMAN_AGENT"]}}},"template":{"type":"object","properties":{"name":{"type":"string"},"language":{"type":"string"},"components":{"type":"array","items":{"type":"object","additionalProperties":true}},"variableMapping":{"type":"object","additionalProperties":{"type":"object","properties":{"field":{"type":"string","enum":["name","phone","email","company","custom"]},"customValue":{"type":"string"}}}}}},"segmentFilters":{"type":"object","properties":{"tags":{"type":"array","items":{"type":"string"}},"isSubscribed":{"type":"boolean"},"customFields":{"type":"object","additionalProperties":true}}}}}}}},"x-pozy-area":"automations"}},"/v1/broadcasts/{broadcastId}":{"get":{"operationId":"getBroadcast","summary":"Get broadcast details","tags":["Broadcasts"],"parameters":[{"name":"broadcastId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"broadcast":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"platform":{"type":"string"},"accountId":{"type":"string"},"message":{"type":"object","properties":{"text":{"type":"string"}}},"template":{"type":"object","properties":{"name":{"type":"string"},"language":{"type":"string"}}},"segmentFilters":{"type":"object","properties":{"tags":{"type":"array","items":{"type":"string"}},"isSubscribed":{"type":"boolean"},"customFields":{"type":"object","additionalProperties":true}}},"status":{"type":"string","enum":["draft","scheduled","sending","completed","failed","cancelled"]},"scheduledAt":{"type":"string","format":"date-time"},"startedAt":{"type":"string","format":"date-time"},"completedAt":{"type":"string","format":"date-time"},"recipientCount":{"type":"integer"},"sentCount":{"type":"integer"},"deliveredCount":{"type":"integer"},"readCount":{"type":"integer"},"failedCount":{"type":"integer"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}}}}}}}}},"x-pozy-area":"automations"},"patch":{"operationId":"updateBroadcast","summary":"Update broadcast","tags":["Broadcasts"],"parameters":[{"name":"broadcastId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"broadcast":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"status":{"type":"string"},"updatedAt":{"type":"string","format":"date-time"}}}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"message":{"type":"object","properties":{"text":{"type":"string"},"attachments":{"type":"array","maxItems":10,"items":{"type":"object","properties":{"type":{"type":"string"},"url":{"type":"string"},"filename":{"type":"string"}}}},"messageTag":{"type":"string","enum":["CONFIRMED_EVENT_UPDATE","POST_PURCHASE_UPDATE","ACCOUNT_UPDATE","HUMAN_AGENT"]}}},"template":{"type":"object","properties":{"name":{"type":"string"},"language":{"type":"string"},"variableMapping":{"type":"object","additionalProperties":{"type":"object","properties":{"field":{"type":"string","enum":["name","phone","email","company","custom"]},"customValue":{"type":"string"}}}}}},"segmentFilters":{"type":"object"}}}}}},"x-pozy-area":"automations"},"delete":{"operationId":"deleteBroadcast","summary":"Delete broadcast","tags":["Broadcasts"],"parameters":[{"name":"broadcastId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"}},"x-pozy-area":"automations"}},"/v1/broadcasts/{broadcastId}/send":{"post":{"operationId":"sendBroadcast","summary":"Send broadcast now","tags":["Broadcasts"],"parameters":[{"name":"broadcastId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"status":{"type":"string","enum":["sending","completed","failed"]},"sent":{"type":"integer"},"failed":{"type":"integer"},"recipientCount":{"type":"integer"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"x-pozy-area":"automations"}},"/v1/broadcasts/{broadcastId}/schedule":{"post":{"operationId":"scheduleBroadcast","summary":"Schedule broadcast for later","tags":["Broadcasts"],"parameters":[{"name":"broadcastId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"broadcast":{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string"},"scheduledAt":{"type":"string","format":"date-time"}}}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["scheduledAt"],"properties":{"scheduledAt":{"type":"string","format":"date-time"}}}}}},"x-pozy-area":"automations"}},"/v1/broadcasts/{broadcastId}/cancel":{"post":{"operationId":"cancelBroadcast","summary":"Cancel broadcast","tags":["Broadcasts"],"parameters":[{"name":"broadcastId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"broadcast":{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string"}}}}}}}}},"x-pozy-area":"automations"}},"/v1/broadcasts/{broadcastId}/recipients":{"get":{"operationId":"listBroadcastRecipients","summary":"List broadcast recipients","tags":["Broadcasts"],"parameters":[{"name":"broadcastId","in":"path","required":true,"schema":{"type":"string"}},{"name":"status","in":"query","required":false,"schema":{"type":"string","enum":["pending","sent","delivered","read","failed"]}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","default":50}},{"name":"skip","in":"query","required":false,"schema":{"type":"integer","default":0}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"recipients":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"contactId":{"type":"string"},"channelId":{"type":"string"},"platformIdentifier":{"type":"string"},"contactName":{"type":["string","null"]},"status":{"type":"string","enum":["pending","sent","delivered","read","failed"]},"messageId":{"type":"string"},"error":{"type":"string"},"errorCode":{"type":["integer","null"]},"errorExplanation":{"type":["string","null"]},"errorTraceId":{"type":["string","null"]},"sentAt":{"type":"string","format":"date-time"},"deliveredAt":{"type":"string","format":"date-time"},"readAt":{"type":"string","format":"date-time"}}}},"pagination":{"type":"object","properties":{"total":{"type":"integer"},"limit":{"type":"integer"},"skip":{"type":"integer"},"hasMore":{"type":"boolean"}}},"summary":{"type":"object","properties":{"total":{"type":"integer"},"pending":{"type":"integer"},"sent":{"type":"integer"},"delivered":{"type":"integer"},"read":{"type":"integer"},"failed":{"type":"integer"}}}}}}}}},"x-pozy-area":"automations"},"post":{"operationId":"addBroadcastRecipients","summary":"Add recipients to a broadcast","tags":["Broadcasts"],"parameters":[{"name":"broadcastId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"added":{"type":"integer"},"skipped":{"type":"integer"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"contactIds":{"type":"array","items":{"type":"string"}},"phones":{"type":"array","items":{"type":"string"},"maxItems":20000},"useSegment":{"type":"boolean"}}}}}},"x-pozy-area":"automations"}},"/v1/support/runs":{"get":{"operationId":"listSupportAnswers","summary":"List a thread's support answers","tags":["Support Assistant"],"parameters":[{"name":"threadId","in":"query","required":true,"schema":{"type":"string"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":50,"default":20}},{"name":"cursor","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","required":["runs","nextCursor"],"properties":{"runs":{"type":"array","items":{"$ref":"#/components/schemas/SupportRun"}},"nextCursor":{"type":["string","null"]}}}}}}},"x-pozy-area":"workspace"},"post":{"operationId":"askSupportQuestion","summary":"Ask a support question","tags":["Support Assistant"],"parameters":[{"name":"Idempotency-Key","in":"header","required":false,"schema":{"type":"string","maxLength":255}}],"responses":{"202":{"description":"Success","content":{"application/json":{"schema":{"type":"object","required":["runId","threadId","status","pollAfterSeconds"],"properties":{"runId":{"type":"string"},"threadId":{"type":"string"},"status":{"type":"string","enum":["queued"]},"pollAfterSeconds":{"type":"integer"}}}}}},"429":{"description":"support_ticket_limit: The workspace sent 5 questions to the Pozy team today. Each one gets an email reply; for anything urgent write to support@pozy.ai.","x-pozy-error-codes":["support_ticket_limit"],"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["message"],"properties":{"message":{"type":"string","minLength":1,"maxLength":10000},"threadId":{"type":"string"},"context":{"type":"object","additionalProperties":false,"properties":{"postId":{"type":"string"},"accountId":{"type":"string"},"profileId":{"type":"string"},"requestId":{"type":"string","maxLength":128,"pattern":"^[\\w.-]{1,128}$"}}},"maxCostUsd":{"type":"number","minimum":0.5,"maximum":3,"default":3}}}}}},"x-pozy-area":"workspace"}},"/v1/support/runs/{runId}":{"get":{"operationId":"getSupportAnswer","summary":"Get a support answer","tags":["Support Assistant"],"parameters":[{"name":"runId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SupportRun"}}}}},"x-pozy-area":"workspace"}},"/v1/workflows":{"get":{"operationId":"listWorkflows","summary":"List workflows","tags":["Workflows"],"parameters":[{"name":"profileId","in":"query","required":false,"schema":{"type":"string"}},{"name":"status","in":"query","required":false,"schema":{"type":"string","enum":["draft","active","paused"]}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","default":50}},{"name":"skip","in":"query","required":false,"schema":{"type":"integer","default":0}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"workflows":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"platform":{"type":"string"},"accountId":{"type":"string"},"accountName":{"type":"string"},"status":{"type":"string","enum":["draft","active","paused"]},"nodeCount":{"type":"integer"},"totalStarted":{"type":"integer"},"totalCompleted":{"type":"integer"},"totalExited":{"type":"integer"},"createdAt":{"type":"string","format":"date-time"}}}},"pagination":{"type":"object","properties":{"total":{"type":"integer"},"limit":{"type":"integer"},"skip":{"type":"integer"},"hasMore":{"type":"boolean"}}}}}}}}},"x-pozy-area":"automations"},"post":{"operationId":"createWorkflow","summary":"Create workflow","tags":["Workflows"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"workflow":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"platform":{"type":"string"},"status":{"type":"string"},"nodeCount":{"type":"integer"},"entryNodeId":{"type":"string"},"createdAt":{"type":"string","format":"date-time"}}}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["profileId","accountId","name"],"properties":{"profileId":{"type":"string"},"accountId":{"type":"string"},"platform":{"type":"string","enum":["whatsapp","instagram","facebook","telegram","twitter","bluesky","reddit","tiktok"],"default":"whatsapp"},"name":{"type":"string"},"description":{"type":"string"},"nodes":{"type":"array","items":{"$ref":"#/components/schemas/WorkflowNode"}},"edges":{"type":"array","items":{"$ref":"#/components/schemas/WorkflowEdge"}},"entryNodeId":{"type":"string"}}}}}},"x-pozy-area":"automations"}},"/v1/workflows/{workflowId}":{"get":{"operationId":"getWorkflow","summary":"Get workflow with graph","tags":["Workflows"],"parameters":[{"name":"workflowId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"workflow":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"platform":{"type":"string"},"accountId":{"type":"string"},"profileId":{"type":"string"},"status":{"type":"string","enum":["draft","active","paused"]},"entryNodeId":{"type":"string"},"nodes":{"type":"array","items":{"$ref":"#/components/schemas/WorkflowNode"}},"edges":{"type":"array","items":{"$ref":"#/components/schemas/WorkflowEdge"}},"totalStarted":{"type":"integer"},"totalCompleted":{"type":"integer"},"totalExited":{"type":"integer"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}}}}}}}}},"x-pozy-area":"automations"},"patch":{"operationId":"updateWorkflow","summary":"Update workflow","tags":["Workflows"],"parameters":[{"name":"workflowId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"workflow":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"status":{"type":"string"},"entryNodeId":{"type":"string"},"nodeCount":{"type":"integer"},"updatedAt":{"type":"string","format":"date-time"}}}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"nodes":{"type":"array","items":{"$ref":"#/components/schemas/WorkflowNode"}},"edges":{"type":"array","items":{"$ref":"#/components/schemas/WorkflowEdge"}},"entryNodeId":{"type":["string","null"]},"accountId":{"type":"string"}}}}}},"x-pozy-area":"automations"},"delete":{"operationId":"deleteWorkflow","summary":"Delete workflow","tags":["Workflows"],"parameters":[{"name":"workflowId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"}},"x-pozy-area":"automations"}},"/v1/workflows/{workflowId}/activate":{"post":{"operationId":"activateWorkflow","summary":"Activate workflow","tags":["Workflows"],"parameters":[{"name":"workflowId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"workflow":{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string"},"entryNodeId":{"type":"string"}}}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"x-pozy-area":"automations"}},"/v1/workflows/{workflowId}/pause":{"post":{"operationId":"pauseWorkflow","summary":"Pause workflow","tags":["Workflows"],"parameters":[{"name":"workflowId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"workflow":{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string"}}}}}}}}},"x-pozy-area":"automations"}},"/v1/workflows/{workflowId}/executions":{"get":{"operationId":"listWorkflowExecutions","summary":"List workflow runs","tags":["Workflows"],"parameters":[{"name":"workflowId","in":"path","required":true,"schema":{"type":"string"}},{"name":"status","in":"query","required":false,"schema":{"type":"string","enum":["running","waiting","completed","exited","failed"]}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","default":25}},{"name":"skip","in":"query","required":false,"schema":{"type":"integer","default":0}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"executions":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string","enum":["running","waiting","completed","exited","failed"]},"currentNodeId":{"type":"string"},"waitingFor":{"type":["object","null"],"properties":{"kind":{"type":"string","enum":["timer","reply"]},"nodeId":{"type":"string"}}},"variables":{"type":"object","additionalProperties":true},"platformIdentifier":{"type":"string"},"conversationId":{"type":["string","null"]},"stepCount":{"type":"integer"},"lastError":{"type":["string","null"]},"resumeAt":{"type":["string","null"],"format":"date-time"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"completedAt":{"type":["string","null"],"format":"date-time"}}}},"pagination":{"type":"object","properties":{"total":{"type":"integer"},"limit":{"type":"integer"},"skip":{"type":"integer"},"hasMore":{"type":"boolean"}}}}}}}}},"x-pozy-area":"automations"},"post":{"operationId":"triggerWorkflow","summary":"Manually start a workflow run","tags":["Workflows"],"parameters":[{"name":"workflowId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"execution":{"type":["object","null"],"properties":{"id":{"type":"string"},"status":{"type":"string"},"currentNodeId":{"type":"string"},"waitingFor":{"type":["object","null"]},"variables":{"type":"object","additionalProperties":true},"conversationId":{"type":"string"}}}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"to":{"type":"string"},"conversationId":{"type":"string"},"text":{"type":"string"}}}}}},"x-pozy-area":"automations"}},"/v1/workflows/{workflowId}/trigger":{"post":{"operationId":"triggerApiCallWorkflow","summary":"Start an API-triggered workflow","tags":["Workflows"],"parameters":[{"name":"workflowId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"type":"object","required":["executionId"],"properties":{"executionId":{"type":"string"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"conversationId":{"type":"string"},"contactId":{"type":"string"},"to":{"type":"string"},"variables":{"type":"object","additionalProperties":true}}}}}},"x-pozy-area":"automations"}},"/v1/workflows/{workflowId}/executions/{executionId}/events":{"get":{"operationId":"listWorkflowExecutionEvents","summary":"Get an execution's timeline","tags":["Workflows"],"parameters":[{"name":"workflowId","in":"path","required":true,"schema":{"type":"string"}},{"name":"executionId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"execution":{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string","enum":["running","waiting","completed","exited","failed"]},"startedAt":{"type":["string","null"],"format":"date-time"},"completedAt":{"type":["string","null"],"format":"date-time"}}},"events":{"type":"array","items":{"$ref":"#/components/schemas/WorkflowExecutionEvent"}}}}}}}},"x-pozy-area":"automations"}},"/v1/workflows/{workflowId}/duplicate":{"post":{"operationId":"duplicateWorkflow","summary":"Duplicate a workflow","tags":["Workflows"],"parameters":[{"name":"workflowId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"workflow":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"status":{"type":"string","enum":["draft"]},"platform":{"type":"string"},"accountId":{"type":"string"},"profileId":{"type":"string"},"entryNodeId":{"type":["string","null"]},"nodeCount":{"type":"integer"},"createdAt":{"type":"string","format":"date-time"}}}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"x-pozy-area":"automations"}},"/v1/workflows/{workflowId}/versions":{"get":{"operationId":"listWorkflowVersions","summary":"List a workflow's version history","tags":["Workflows"],"parameters":[{"name":"workflowId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"versions":{"type":"array","items":{"type":"object","properties":{"version":{"type":"integer"},"name":{"type":"string"},"description":{"type":["string","null"]},"createdBy":{"type":["string","null"]},"createdByEmail":{"type":["string","null"]},"restoredFromVersion":{"type":["integer","null"]},"createdAt":{"type":"string","format":"date-time"}}}}}}}}}},"x-pozy-area":"automations"}},"/v1/workflows/{workflowId}/versions/{version}":{"get":{"operationId":"getWorkflowVersion","summary":"Get a specific workflow version","tags":["Workflows"],"parameters":[{"name":"workflowId","in":"path","required":true,"schema":{"type":"string"}},{"name":"version","in":"path","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"version":{"type":"object","properties":{"version":{"type":"integer"},"name":{"type":"string"},"description":{"type":["string","null"]},"entryNodeId":{"type":["string","null"]},"nodes":{"type":"array","items":{"$ref":"#/components/schemas/WorkflowNode"}},"edges":{"type":"array","items":{"$ref":"#/components/schemas/WorkflowEdge"}},"platform":{"type":"string"},"accountId":{"type":"string"},"profileId":{"type":"string"},"createdBy":{"type":["string","null"]},"createdByEmail":{"type":["string","null"]},"restoredFromVersion":{"type":["integer","null"]},"createdAt":{"type":"string","format":"date-time"}}}}}}}}},"x-pozy-area":"automations"}},"/v1/workflows/{workflowId}/versions/{version}/restore":{"post":{"operationId":"restoreWorkflowVersion","summary":"Restore a workflow version","tags":["Workflows"],"parameters":[{"name":"workflowId","in":"path","required":true,"schema":{"type":"string"}},{"name":"version","in":"path","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"workflow":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"status":{"type":"string"},"entryNodeId":{"type":["string","null"]},"nodeCount":{"type":"integer"},"updatedAt":{"type":"string","format":"date-time"}}},"restoredFromVersion":{"type":"integer"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"x-pozy-area":"automations"}},"/v1/sequences":{"get":{"operationId":"listSequences","summary":"List sequences","tags":["Sequences"],"parameters":[{"name":"profileId","in":"query","required":false,"schema":{"type":"string"}},{"name":"status","in":"query","required":false,"schema":{"type":"string","enum":["draft","active","paused"]}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","default":50}},{"name":"skip","in":"query","required":false,"schema":{"type":"integer","default":0}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"sequences":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"platform":{"type":"string"},"accountId":{"type":"string"},"accountName":{"type":"string"},"messagePreview":{"type":"string"},"status":{"type":"string","enum":["draft","active","paused"]},"stepsCount":{"type":"integer"},"exitOnReply":{"type":"boolean"},"exitOnUnsubscribe":{"type":"boolean"},"totalEnrolled":{"type":"integer"},"totalCompleted":{"type":"integer"},"totalExited":{"type":"integer"},"createdAt":{"type":"string","format":"date-time"}}}},"pagination":{"type":"object","properties":{"total":{"type":"integer"},"limit":{"type":"integer"},"skip":{"type":"integer"},"hasMore":{"type":"boolean"}}}}}}}}},"x-pozy-area":"automations"},"post":{"operationId":"createSequence","summary":"Create sequence","tags":["Sequences"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"sequence":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"platform":{"type":"string"},"status":{"type":"string"},"stepsCount":{"type":"integer"},"createdAt":{"type":"string","format":"date-time"}}}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["profileId","accountId","platform","name"],"properties":{"profileId":{"type":"string"},"accountId":{"type":"string"},"platform":{"type":"string","enum":["instagram","facebook","telegram","twitter","bluesky","reddit","whatsapp","slack"]},"name":{"type":"string"},"description":{"type":"string"},"steps":{"type":"array","items":{"type":"object","required":["order","delayMinutes"],"properties":{"order":{"type":"integer"},"delayMinutes":{"type":"integer"},"message":{"type":"object","properties":{"text":{"type":"string"}}},"template":{"type":"object","properties":{"name":{"type":"string"},"language":{"type":"string"},"variableMapping":{"type":"object","additionalProperties":{"type":"object","properties":{"field":{"type":"string","enum":["name","phone","email","company","custom"]},"customValue":{"type":"string"}}}}}}}}},"exitOnReply":{"type":"boolean","default":true},"exitOnUnsubscribe":{"type":"boolean","default":true}}}}}},"x-pozy-area":"automations"}},"/v1/sequences/{sequenceId}":{"get":{"operationId":"getSequence","summary":"Get sequence with steps","tags":["Sequences"],"parameters":[{"name":"sequenceId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"sequence":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"platform":{"type":"string"},"accountId":{"type":"string"},"status":{"type":"string","enum":["draft","active","paused"]},"steps":{"type":"array","items":{"type":"object","properties":{"order":{"type":"integer"},"delayMinutes":{"type":"integer"},"message":{"type":"object","properties":{"text":{"type":"string"}}},"template":{"type":"object","properties":{"name":{"type":"string"},"language":{"type":"string"},"variableMapping":{"type":"object"}}}}}},"exitOnReply":{"type":"boolean"},"exitOnUnsubscribe":{"type":"boolean"},"totalEnrolled":{"type":"integer"},"totalCompleted":{"type":"integer"},"totalExited":{"type":"integer"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}}}}}}}}},"x-pozy-area":"automations"},"patch":{"operationId":"updateSequence","summary":"Update sequence","tags":["Sequences"],"parameters":[{"name":"sequenceId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"sequence":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"status":{"type":"string"},"steps":{"type":"array","items":{"type":"object"}},"exitOnReply":{"type":"boolean"},"exitOnUnsubscribe":{"type":"boolean"},"updatedAt":{"type":"string","format":"date-time"}}}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"steps":{"type":"array","items":{"type":"object","required":["order","delayMinutes"],"properties":{"order":{"type":"integer"},"delayMinutes":{"type":"integer"},"message":{"type":"object","properties":{"text":{"type":"string"}}},"template":{"type":"object","properties":{"name":{"type":"string"},"language":{"type":"string"},"variableMapping":{"type":"object","additionalProperties":{"type":"object","properties":{"field":{"type":"string","enum":["name","phone","email","company","custom"]},"customValue":{"type":"string"}}}}}}}}},"exitOnReply":{"type":"boolean"},"exitOnUnsubscribe":{"type":"boolean"}}}}}},"x-pozy-area":"automations"},"delete":{"operationId":"deleteSequence","summary":"Delete sequence","tags":["Sequences"],"parameters":[{"name":"sequenceId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"}},"x-pozy-area":"automations"}},"/v1/sequences/{sequenceId}/activate":{"post":{"operationId":"activateSequence","summary":"Activate sequence","tags":["Sequences"],"parameters":[{"name":"sequenceId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"sequence":{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string"}}}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"x-pozy-area":"automations"}},"/v1/sequences/{sequenceId}/pause":{"post":{"operationId":"pauseSequence","summary":"Pause sequence","tags":["Sequences"],"parameters":[{"name":"sequenceId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"sequence":{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string"}}}}}}}}},"x-pozy-area":"automations"}},"/v1/sequences/{sequenceId}/enroll":{"post":{"operationId":"enrollContacts","summary":"Enroll contacts in a sequence","tags":["Sequences"],"parameters":[{"name":"sequenceId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"enrolled":{"type":"integer"},"failed":{"type":"integer"},"results":{"type":"array","items":{"type":"object","properties":{"contactId":{"type":"string"},"success":{"type":"boolean"},"error":{"type":"string"}}}}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["contactIds"],"properties":{"contactIds":{"type":"array","items":{"type":"string"}},"channelIds":{"type":"array","items":{"type":"string"}}}}}}},"x-pozy-area":"automations"}},"/v1/sequences/{sequenceId}/enroll/{contactId}":{"delete":{"operationId":"unenrollContact","summary":"Unenroll contact","tags":["Sequences"],"parameters":[{"name":"sequenceId","in":"path","required":true,"schema":{"type":"string"}},{"name":"contactId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"}},"x-pozy-area":"automations"}},"/v1/sequences/{sequenceId}/enrollments":{"get":{"operationId":"listSequenceEnrollments","summary":"List enrollments for a sequence","tags":["Sequences"],"parameters":[{"name":"sequenceId","in":"path","required":true,"schema":{"type":"string"}},{"name":"status","in":"query","required":false,"schema":{"type":"string","enum":["active","completed","exited","paused"]}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","default":50}},{"name":"skip","in":"query","required":false,"schema":{"type":"integer","default":0}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"enrollments":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"contactId":{"type":"string"},"channelId":{"type":"string"},"platformIdentifier":{"type":"string"},"contactName":{"type":"string"},"currentStepIndex":{"type":"integer"},"status":{"type":"string","enum":["active","completed","exited","paused"]},"exitReason":{"type":["string","null"]},"nextStepAt":{"type":["string","null"],"format":"date-time"},"stepsSent":{"type":"integer"},"lastStepSentAt":{"type":["string","null"],"format":"date-time"},"createdAt":{"type":"string","format":"date-time"}}}},"pagination":{"type":"object","properties":{"total":{"type":"integer"},"limit":{"type":"integer"},"skip":{"type":"integer"},"hasMore":{"type":"boolean"}}}}}}}}},"x-pozy-area":"automations"}},"/v1/comment-automations":{"get":{"operationId":"listCommentAutomations","summary":"List comment-to-DM automations","tags":["Comment Automations"],"parameters":[{"name":"profileId","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"automations":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"platform":{"type":"string","enum":["instagram","facebook","tiktok","threads","linkedin","youtube"]},"trigger":{"type":"string","enum":["comment","live_comment","story_reply","story_mention"]},"accountId":{"type":"string"},"platformPostId":{"type":"string"},"postTitle":{"type":"string"},"postId":{"type":"string"},"keywords":{"type":"array","items":{"type":"string"}},"matchMode":{"type":"string","enum":["exact","contains","word"]},"excludeKeywords":{"type":"array","items":{"type":"string"}},"typoTolerance":{"type":"boolean"},"dmMessage":{"type":"string"},"buttons":{"type":"array","items":{"$ref":"#/components/schemas/DmButton"}},"template":{"$ref":"#/components/schemas/CommentAutomationTemplate"},"commentReply":{"type":"string"},"dmMessageVariations":{"type":"array","items":{"type":"string"}},"commentReplyVariations":{"type":"array","items":{"type":"string"}},"linkTracking":{"type":"boolean"},"clickTag":{"type":"string"},"dmDelaySeconds":{"type":"integer"},"commentReplyDelaySeconds":{"type":"integer"},"alsoMatchInDms":{"type":"boolean"},"repeatPolicy":{"$ref":"#/components/schemas/CommentAutomationRepeatPolicy"},"dedupeSameTextHours":{"type":"integer"},"publicReplyPolicy":{"type":"string","enum":["after_dm","always"]},"actions":{"$ref":"#/components/schemas/CommentAutomationActions"},"quickReplies":{"type":"array","items":{"$ref":"#/components/schemas/CommentAutomationQuickReply"}},"dmMedia":{"$ref":"#/components/schemas/CommentAutomationDmMedia"},"audience":{"$ref":"#/components/schemas/CommentAutomationAudience"},"followGate":{"$ref":"#/components/schemas/CommentAutomationFollowGate"},"isActive":{"type":"boolean"},"stats":{"$ref":"#/components/schemas/CommentAutomationStats"},"createdAt":{"type":"string","format":"date-time"}}}}}}}}}},"x-pozy-area":"automations"},"post":{"operationId":"createCommentAutomation","summary":"Create comment-to-DM automation","tags":["Comment Automations"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"automation":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"platform":{"type":"string","enum":["instagram","facebook","tiktok","threads","linkedin","youtube"]},"trigger":{"type":"string","enum":["comment","live_comment","story_reply","story_mention"]},"platformPostId":{"type":"string"},"keywords":{"type":"array","items":{"type":"string"}},"matchMode":{"type":"string","enum":["exact","contains","word"]},"excludeKeywords":{"type":"array","items":{"type":"string"}},"typoTolerance":{"type":"boolean"},"dmMessage":{"type":"string"},"buttons":{"type":"array","items":{"$ref":"#/components/schemas/DmButton"}},"template":{"$ref":"#/components/schemas/CommentAutomationTemplate"},"commentReply":{"type":"string"},"dmMessageVariations":{"type":"array","items":{"type":"string"}},"commentReplyVariations":{"type":"array","items":{"type":"string"}},"linkTracking":{"type":"boolean"},"clickTag":{"type":"string"},"dmDelaySeconds":{"type":"integer"},"commentReplyDelaySeconds":{"type":"integer"},"audience":{"$ref":"#/components/schemas/CommentAutomationAudience"},"followGate":{"$ref":"#/components/schemas/CommentAutomationFollowGate"},"alsoMatchInDms":{"type":"boolean"},"repeatPolicy":{"$ref":"#/components/schemas/CommentAutomationRepeatPolicy"},"dedupeSameTextHours":{"type":"integer"},"publicReplyPolicy":{"type":"string","enum":["after_dm","always"]},"actions":{"$ref":"#/components/schemas/CommentAutomationActions"},"quickReplies":{"type":"array","items":{"$ref":"#/components/schemas/CommentAutomationQuickReply"}},"dmMedia":{"$ref":"#/components/schemas/CommentAutomationDmMedia"},"isActive":{"type":"boolean"},"stats":{"$ref":"#/components/schemas/CommentAutomationStats"},"createdAt":{"type":"string","format":"date-time"}}}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["profileId","accountId","name"],"properties":{"profileId":{"type":"string"},"accountId":{"type":"string"},"trigger":{"type":"string","enum":["comment","live_comment","story_reply","story_mention"],"default":"comment"},"platformPostId":{"type":"string"},"postId":{"type":"string","pattern":"^[a-fA-F0-9]{24}$"},"postTitle":{"type":"string"},"name":{"type":"string"},"keywords":{"type":"array","items":{"type":"string"}},"matchMode":{"type":"string","enum":["exact","contains","word"],"default":"contains"},"excludeKeywords":{"type":"array","items":{"type":"string"}},"typoTolerance":{"type":"boolean"},"dmMessage":{"type":"string"},"buttons":{"type":"array","maxItems":3,"items":{"$ref":"#/components/schemas/DmButton"}},"template":{"allOf":[{"$ref":"#/components/schemas/CommentAutomationTemplate"}]},"commentReply":{"type":"string"},"dmMessageVariations":{"type":"array","maxItems":5,"items":{"type":"string"}},"commentReplyVariations":{"type":"array","maxItems":5,"items":{"type":"string"}},"linkTracking":{"type":"boolean","default":true},"clickTag":{"type":"string"},"dmDelaySeconds":{"type":"integer","minimum":0,"maximum":86400},"commentReplyDelaySeconds":{"type":"integer","minimum":0,"maximum":86400},"alsoMatchInDms":{"type":"boolean","default":false},"audience":{"$ref":"#/components/schemas/CommentAutomationAudience"},"followGate":{"$ref":"#/components/schemas/CommentAutomationFollowGate"},"repeatPolicy":{"$ref":"#/components/schemas/CommentAutomationRepeatPolicy"},"dedupeSameTextHours":{"type":["integer","null"],"minimum":1,"maximum":8760},"publicReplyPolicy":{"type":"string","enum":["after_dm","always"],"default":"after_dm"},"actions":{"$ref":"#/components/schemas/CommentAutomationActions"},"quickReplies":{"type":"array","maxItems":13,"items":{"$ref":"#/components/schemas/CommentAutomationQuickReply"}},"dmMedia":{"oneOf":[{"$ref":"#/components/schemas/CommentAutomationDmMedia"},{"type":"null"}]},"isActive":{"type":"boolean","default":true}}}}}},"x-pozy-area":"automations"}},"/v1/comment-automations/{automationId}":{"get":{"operationId":"getCommentAutomation","summary":"Get automation details","tags":["Comment Automations"],"parameters":[{"name":"automationId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"automation":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"platform":{"type":"string","enum":["instagram","facebook","tiktok","threads","linkedin","youtube"]},"trigger":{"type":"string","enum":["comment","live_comment","story_reply","story_mention"]},"accountId":{"type":"string"},"platformPostId":{"type":"string"},"postId":{"type":"string"},"postTitle":{"type":"string"},"keywords":{"type":"array","items":{"type":"string"}},"matchMode":{"type":"string","enum":["exact","contains","word"]},"excludeKeywords":{"type":"array","items":{"type":"string"}},"typoTolerance":{"type":"boolean"},"dmMessage":{"type":"string"},"buttons":{"type":"array","items":{"$ref":"#/components/schemas/DmButton"}},"template":{"$ref":"#/components/schemas/CommentAutomationTemplate"},"commentReply":{"type":"string"},"dmMessageVariations":{"type":"array","items":{"type":"string"}},"commentReplyVariations":{"type":"array","items":{"type":"string"}},"linkTracking":{"type":"boolean"},"clickTag":{"type":"string"},"dmDelaySeconds":{"type":"integer"},"commentReplyDelaySeconds":{"type":"integer"},"audience":{"$ref":"#/components/schemas/CommentAutomationAudience"},"followGate":{"$ref":"#/components/schemas/CommentAutomationFollowGate"},"alsoMatchInDms":{"type":"boolean"},"repeatPolicy":{"$ref":"#/components/schemas/CommentAutomationRepeatPolicy"},"dedupeSameTextHours":{"type":"integer"},"publicReplyPolicy":{"type":"string","enum":["after_dm","always"]},"actions":{"$ref":"#/components/schemas/CommentAutomationActions"},"quickReplies":{"type":"array","items":{"$ref":"#/components/schemas/CommentAutomationQuickReply"}},"dmMedia":{"$ref":"#/components/schemas/CommentAutomationDmMedia"},"isActive":{"type":"boolean"},"stats":{"$ref":"#/components/schemas/CommentAutomationStats"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}}},"logs":{"type":"array","items":{"$ref":"#/components/schemas/CommentAutomationLog"}}}}}}}},"x-pozy-area":"automations"},"patch":{"operationId":"updateCommentAutomation","summary":"Update automation settings","tags":["Comment Automations"],"parameters":[{"name":"automationId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"automation":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"keywords":{"type":"array","items":{"type":"string"}},"matchMode":{"type":"string","enum":["exact","contains","word"]},"excludeKeywords":{"type":"array","items":{"type":"string"}},"typoTolerance":{"type":"boolean"},"dmMessage":{"type":"string"},"buttons":{"type":"array","items":{"$ref":"#/components/schemas/DmButton"}},"template":{"$ref":"#/components/schemas/CommentAutomationTemplate"},"commentReply":{"type":"string"},"dmMessageVariations":{"type":"array","items":{"type":"string"}},"commentReplyVariations":{"type":"array","items":{"type":"string"}},"audience":{"$ref":"#/components/schemas/CommentAutomationAudience"},"followGate":{"$ref":"#/components/schemas/CommentAutomationFollowGate"},"alsoMatchInDms":{"type":"boolean"},"repeatPolicy":{"$ref":"#/components/schemas/CommentAutomationRepeatPolicy"},"dedupeSameTextHours":{"type":"integer"},"publicReplyPolicy":{"type":"string","enum":["after_dm","always"]},"actions":{"$ref":"#/components/schemas/CommentAutomationActions"},"quickReplies":{"type":"array","items":{"$ref":"#/components/schemas/CommentAutomationQuickReply"}},"dmMedia":{"$ref":"#/components/schemas/CommentAutomationDmMedia"},"isActive":{"type":"boolean"},"stats":{"$ref":"#/components/schemas/CommentAutomationStats"},"updatedAt":{"type":"string","format":"date-time"}}}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"trigger":{"type":"string","enum":["comment","live_comment","story_reply","story_mention"]},"keywords":{"type":"array","items":{"type":"string"}},"matchMode":{"type":"string","enum":["exact","contains","word"]},"excludeKeywords":{"type":"array","items":{"type":"string"}},"typoTolerance":{"type":"boolean"},"platformPostId":{"type":["string","null"]},"postId":{"type":["string","null"],"pattern":"^[a-fA-F0-9]{24}$"},"postTitle":{"type":["string","null"]},"dmMessage":{"type":"string"},"buttons":{"type":"array","maxItems":3,"items":{"$ref":"#/components/schemas/DmButton"}},"template":{"oneOf":[{"$ref":"#/components/schemas/CommentAutomationTemplate"},{"type":"null"}]},"commentReply":{"type":"string"},"dmMessageVariations":{"type":"array","maxItems":5,"items":{"type":"string"}},"commentReplyVariations":{"type":"array","maxItems":5,"items":{"type":"string"}},"linkTracking":{"type":"boolean"},"clickTag":{"type":"string"},"alsoMatchInDms":{"type":"boolean"},"dmDelaySeconds":{"type":"integer","minimum":0,"maximum":86400},"commentReplyDelaySeconds":{"type":"integer","minimum":0,"maximum":86400},"audience":{"$ref":"#/components/schemas/CommentAutomationAudience"},"followGate":{"$ref":"#/components/schemas/CommentAutomationFollowGate"},"isActive":{"type":"boolean"},"repeatPolicy":{"$ref":"#/components/schemas/CommentAutomationRepeatPolicy"},"dedupeSameTextHours":{"type":["integer","null"],"minimum":1,"maximum":8760},"publicReplyPolicy":{"type":"string","enum":["after_dm","always"]},"actions":{"$ref":"#/components/schemas/CommentAutomationActions"},"quickReplies":{"type":["array","null"],"maxItems":13,"items":{"$ref":"#/components/schemas/CommentAutomationQuickReply"}},"dmMedia":{"oneOf":[{"$ref":"#/components/schemas/CommentAutomationDmMedia"},{"type":"null"}]}}}}}},"x-pozy-area":"automations"},"delete":{"operationId":"deleteCommentAutomation","summary":"Delete automation","tags":["Comment Automations"],"parameters":[{"name":"automationId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"}},"x-pozy-area":"automations"}},"/v1/comment-automations/{automationId}/logs":{"get":{"operationId":"listCommentAutomationLogs","summary":"List automation logs","tags":["Comment Automations"],"parameters":[{"name":"automationId","in":"path","required":true,"schema":{"type":"string"}},{"name":"status","in":"query","required":false,"schema":{"type":"string","enum":["pending","sent","failed","skipped","gated"]}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","default":50,"minimum":1,"maximum":200}},{"name":"skip","in":"query","required":false,"schema":{"type":"integer","default":0,"minimum":0}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"logs":{"type":"array","items":{"$ref":"#/components/schemas/CommentAutomationLog"}},"pagination":{"type":"object","properties":{"total":{"type":"integer"},"limit":{"type":"integer"},"skip":{"type":"integer"},"hasMore":{"type":"boolean"}}},"misses":{"type":"object","properties":{"total":{"type":"integer"},"retentionDays":{"type":"integer"},"samples":{"type":"array","items":{"type":"object","properties":{"commentText":{"type":"string"},"commenterName":{"type":"string"},"excludedBy":{"type":"string"},"at":{"type":"string","format":"date-time"}}}}}}}}}}}},"x-pozy-area":"automations"}},"/v1/ads":{"get":{"operationId":"listAds","summary":"List ads","tags":["Ad Campaigns"],"parameters":[{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"default":1}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":500,"default":50}},{"name":"source","in":"query","required":false,"schema":{"type":"string","enum":["pozy","all"],"default":"all"}},{"name":"status","in":"query","required":false,"schema":{"$ref":"#/components/schemas/AdStatus"}},{"name":"platform","in":"query","required":false,"schema":{"type":"string","enum":["facebook","instagram","tiktok","linkedin","pinterest","google","twitter","openai","reddit"]}},{"name":"accountId","in":"query","required":false,"schema":{"type":"string"}},{"name":"adAccountId","in":"query","required":false,"schema":{"type":"string"}},{"name":"pageId","in":"query","required":false,"schema":{"type":"string"}},{"name":"profileId","in":"query","required":false,"schema":{"type":"string"}},{"name":"campaignId","in":"query","required":false,"schema":{"type":"string"}},{"name":"adSetId","in":"query","required":false,"schema":{"type":"string"}},{"name":"platformAdId","in":"query","required":false,"schema":{"type":"string"}},{"name":"effectiveObjectStoryId","in":"query","required":false,"schema":{"type":"string"}},{"name":"effectiveInstagramMediaId","in":"query","required":false,"schema":{"type":"string"}},{"name":"fromDate","in":"query","required":false,"schema":{"type":"string","format":"date"}},{"name":"toDate","in":"query","required":false,"schema":{"type":"string","format":"date"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdsListResponse"}}}}},"x-pozy-area":"ads"}},"/v1/ads/search-terms":{"get":{"operationId":"getAdsSearchTerms","summary":"Google Ads search terms report","tags":["Ad Insights"],"parameters":[{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}},{"name":"adAccountId","in":"query","required":false,"schema":{"type":"string"}},{"name":"customerId","in":"query","required":false,"schema":{"type":"string"}},{"name":"fromDate","in":"query","required":false,"schema":{"type":"string","format":"date"}},{"name":"toDate","in":"query","required":false,"schema":{"type":"string","format":"date"}},{"name":"campaignId","in":"query","required":false,"schema":{"type":"string"}},{"name":"adSetId","in":"query","required":false,"schema":{"type":"string"}},{"name":"adGroupId","in":"query","required":false,"schema":{"type":"string"}},{"name":"pageToken","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"customerId":{"type":"string"},"data":{"type":"array","items":{"type":"object","properties":{"searchTerm":{"type":["string","null"]},"status":{"type":["string","null"]},"matchType":{"type":["string","null"]},"matchSource":{"type":["string","null"]},"campaignId":{"type":["string","null"]},"campaignName":{"type":["string","null"]},"adGroupId":{"type":["string","null"]},"adGroupName":{"type":["string","null"]},"impressions":{"type":"integer"},"clicks":{"type":"integer"},"costMicros":{"type":"integer"},"conversions":{"type":"number"},"conversionsValue":{"type":"number"}}}},"paging":{"type":"object","properties":{"nextPageToken":{"type":["string","null"]}}},"cachedAt":{"type":["string","null"],"format":"date-time"},"stale":{"type":"boolean"}}}}}}},"x-pozy-area":"ads"}},"/v1/ads/recommendations":{"get":{"operationId":"listGoogleRecommendations","summary":"List Google Ads recommendations","tags":["Ad Campaigns"],"parameters":[{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}},{"name":"adAccountId","in":"query","required":false,"schema":{"type":"string"}},{"name":"customerId","in":"query","required":false,"schema":{"type":"string"}},{"name":"campaignId","in":"query","required":false,"schema":{"type":"string","pattern":"^\\d+$"}},{"name":"types","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","required":["adAccountId","recommendations","cachedAt","stale"],"properties":{"adAccountId":{"type":"string"},"recommendations":{"type":"array","items":{"$ref":"#/components/schemas/GoogleRecommendation"}},"cachedAt":{"type":["string","null"],"format":"date-time"},"stale":{"type":"boolean"}}}}}}},"x-pozy-area":"ads"}},"/v1/ads/recommendations/apply":{"post":{"operationId":"applyGoogleRecommendations","summary":"Apply Google Ads recommendations","tags":["Ad Campaigns"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","required":["adAccountId","results"],"properties":{"adAccountId":{"type":"string"},"results":{"type":"array","items":{"$ref":"#/components/schemas/GoogleRecommendationResult"}}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","recommendations"],"properties":{"accountId":{"type":"string"},"adAccountId":{"type":"string"},"recommendations":{"type":"array","minItems":1,"maxItems":100,"items":{"type":"object","required":["resourceName"],"properties":{"resourceName":{"type":"string"},"parameters":{"type":"object","additionalProperties":true}}}}}}}}},"x-pozy-area":"ads"}},"/v1/ads/recommendations/dismiss":{"post":{"operationId":"dismissGoogleRecommendations","summary":"Dismiss Google Ads recommendations","tags":["Ad Campaigns"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","required":["adAccountId","results"],"properties":{"adAccountId":{"type":"string"},"results":{"type":"array","items":{"$ref":"#/components/schemas/GoogleRecommendationResult"}}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","resourceNames"],"properties":{"accountId":{"type":"string"},"adAccountId":{"type":"string"},"resourceNames":{"type":"array","minItems":1,"maxItems":100,"items":{"type":"string"}}}}}}},"x-pozy-area":"ads"}},"/v1/ads/bid-strategies":{"get":{"operationId":"listBidStrategies","summary":"List portfolio bid strategies","tags":["Ad Campaigns"],"parameters":[{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}},{"name":"adAccountId","in":"query","required":false,"schema":{"type":"string"}},{"name":"customerId","in":"query","required":false,"schema":{"type":"string"}},{"name":"fromDate","in":"query","required":false,"schema":{"type":"string","format":"date"}},{"name":"toDate","in":"query","required":false,"schema":{"type":"string","format":"date"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"customerId":{"type":"string"},"currency":{"type":"string"},"strategies":{"type":"array","items":{"$ref":"#/components/schemas/PortfolioBidStrategy"}},"cachedAt":{"type":["string","null"],"format":"date-time"},"stale":{"type":"boolean"}}}}}}},"x-pozy-area":"ads"},"post":{"operationId":"createBidStrategy","summary":"Create portfolio bid strategy","tags":["Ad Campaigns"],"responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"strategy":{"type":"object","properties":{"customerId":{"type":"string"},"id":{"type":"string"},"resourceName":{"type":"string"}}}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","name","type"],"properties":{"accountId":{"type":"string"},"adAccountId":{"type":"string"},"customerId":{"type":"string","deprecated":true},"name":{"type":"string","minLength":1,"maxLength":255},"type":{"type":"string","enum":["TARGET_CPA","TARGET_ROAS","MAXIMIZE_CONVERSIONS","MAXIMIZE_CONVERSION_VALUE","TARGET_IMPRESSION_SHARE"]},"targetCpa":{"type":"number","exclusiveMinimum":0},"targetRoas":{"type":"number","exclusiveMinimum":0},"targetImpressionShare":{"allOf":[{"$ref":"#/components/schemas/GoogleTargetImpressionShare"}]}}}}}},"x-pozy-area":"ads"}},"/v1/ads/bid-strategies/{strategyId}":{"patch":{"operationId":"updateBidStrategy","summary":"Update portfolio bid strategy","tags":["Ad Campaigns"],"parameters":[{"name":"strategyId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"strategy":{"type":"object","properties":{"customerId":{"type":"string"}}}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId"],"properties":{"accountId":{"type":"string"},"adAccountId":{"type":"string"},"customerId":{"type":"string","deprecated":true},"name":{"type":"string","minLength":1,"maxLength":255},"type":{"type":"string","enum":["TARGET_CPA","TARGET_ROAS","MAXIMIZE_CONVERSIONS","MAXIMIZE_CONVERSION_VALUE","TARGET_IMPRESSION_SHARE"]},"targetCpa":{"type":"number","exclusiveMinimum":0},"targetRoas":{"type":"number","exclusiveMinimum":0},"targetImpressionShare":{"allOf":[{"$ref":"#/components/schemas/GoogleTargetImpressionShare"}]}}}}}},"x-pozy-area":"ads"}},"/v1/ads/shared-budgets":{"get":{"operationId":"listSharedBudgets","summary":"List shared budgets","tags":["Ad Campaigns"],"parameters":[{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}},{"name":"adAccountId","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"customerId":{"type":"string"},"budgets":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"amount":{"type":["number","null"]},"type":{"type":["string","null"],"enum":["daily","lifetime",null]},"deliveryMethod":{"type":["string","null"]},"status":{"type":["string","null"]},"campaignCount":{"type":"integer"}}}}}}}}}},"x-pozy-area":"ads"},"post":{"operationId":"createSharedBudget","summary":"Create a shared budget","tags":["Ad Campaigns"],"responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"budget":{"type":"object","properties":{"customerId":{"type":"string"},"id":{"type":"string"},"resourceName":{"type":"string"}}}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","name","amount"],"properties":{"accountId":{"type":"string"},"adAccountId":{"type":"string"},"name":{"type":"string","minLength":1,"maxLength":255},"amount":{"type":"number","exclusiveMinimum":0},"type":{"type":"string","enum":["daily","lifetime"],"default":"daily"}}}}}},"x-pozy-area":"ads"}},"/v1/ads/local-services/leads":{"get":{"operationId":"listLocalServicesLeads","summary":"Google Local Services Ads leads","tags":["Ad Insights"],"parameters":[{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}},{"name":"adAccountId","in":"query","required":false,"schema":{"type":"string"}},{"name":"customerId","in":"query","required":false,"schema":{"type":"string"}},{"name":"fromDate","in":"query","required":false,"schema":{"type":"string","format":"date"}},{"name":"toDate","in":"query","required":false,"schema":{"type":"string","format":"date"}},{"name":"leadType","in":"query","required":false,"schema":{"type":"string","enum":["PHONE_CALL","MESSAGE","BOOKING"]}},{"name":"leadStatus","in":"query","required":false,"schema":{"type":"string"}},{"name":"chargedOnly","in":"query","required":false,"schema":{"type":"boolean"}},{"name":"pageToken","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"customerId":{"type":"string"},"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":["string","null"]},"leadType":{"type":["string","null"]},"categoryId":{"type":["string","null"]},"serviceId":{"type":["string","null"]},"contact":{"type":["object","null"],"properties":{"consumerName":{"type":["string","null"]},"email":{"type":["string","null"]},"phoneNumber":{"type":["string","null"]}}},"status":{"type":["string","null"]},"createdTime":{"type":["string","null"]},"locale":{"type":["string","null"]},"charged":{"type":"boolean"},"creditState":{"type":["string","null"]},"creditStateLastUpdate":{"type":["string","null"]}}}},"paging":{"type":"object","properties":{"nextPageToken":{"type":["string","null"]}}}}}}}}},"x-pozy-area":"ads"}},"/v1/ads/local-services/leads/{leadId}/conversations":{"get":{"operationId":"listLocalServicesLeadConversations","summary":"List lead conversations","tags":["Ad Insights"],"parameters":[{"name":"leadId","in":"path","required":true,"schema":{"type":"string"}},{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}},{"name":"adAccountId","in":"query","required":false,"schema":{"type":"string"}},{"name":"customerId","in":"query","required":false,"schema":{"type":"string"}},{"name":"pageToken","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"customerId":{"type":"string"},"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":["string","null"]},"channel":{"type":["string","null"]},"participantType":{"type":["string","null"]},"eventDateTime":{"type":["string","null"]},"phoneCall":{"type":["object","null"],"properties":{"callDurationMillis":{"type":["integer","null"]},"callRecordingUrl":{"type":["string","null"]}}},"message":{"type":["object","null"],"properties":{"text":{"type":["string","null"]},"attachmentUrls":{"type":"array","items":{"type":"string"}}}}}}},"paging":{"type":"object","properties":{"nextPageToken":{"type":["string","null"]}}}}}}}}},"x-pozy-area":"ads"}},"/v1/ads/keywords":{"get":{"operationId":"listAdKeywords","summary":"List Search keywords","tags":["Ad Campaigns"],"parameters":[{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"default":1}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":500,"default":50}},{"name":"accountId","in":"query","required":false,"schema":{"type":"string"}},{"name":"adAccountId","in":"query","required":false,"schema":{"type":"string"}},{"name":"profileId","in":"query","required":false,"schema":{"type":"string"}},{"name":"campaignId","in":"query","required":false,"schema":{"type":"string"}},{"name":"adSetId","in":"query","required":false,"schema":{"type":"string"}},{"name":"status","in":"query","required":false,"schema":{"type":"string","enum":["active","paused"]}},{"name":"matchType","in":"query","required":false,"schema":{"type":"string","enum":["exact","phrase","broad","unknown"]}},{"name":"negative","in":"query","required":false,"schema":{"type":"boolean"}},{"name":"search","in":"query","required":false,"schema":{"type":"string","maxLength":200}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"keywords":{"type":"array","items":{"$ref":"#/components/schemas/AdKeyword"}},"pagination":{"$ref":"#/components/schemas/Pagination"}}}}}}},"x-pozy-area":"ads"},"post":{"operationId":"addAdKeywords","summary":"Add Search ad-group keywords","tags":["Ad Campaigns"],"responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"keywords":{"type":"array","items":{"$ref":"#/components/schemas/AdKeyword"}}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","adSetId","keywords"],"properties":{"accountId":{"type":"string"},"adSetId":{"type":"string"},"keywords":{"type":"array","minItems":1,"maxItems":1000,"items":{"anyOf":[{"type":"string"},{"type":"object","required":["text"],"properties":{"text":{"type":"string","minLength":1,"maxLength":80},"matchType":{"type":"string","enum":["exact","phrase","broad"]}}}]}},"negative":{"type":"boolean","default":false}}}}}},"x-pozy-area":"ads"}},"/v1/ads/keywords/{keywordId}":{"patch":{"operationId":"updateAdKeyword","summary":"Pause or enable a Search keyword","tags":["Ad Campaigns"],"parameters":[{"name":"keywordId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"keyword":{"$ref":"#/components/schemas/AdKeyword"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["status"],"properties":{"status":{"type":"string","enum":["active","paused"]}}}}}},"x-pozy-area":"ads"},"delete":{"operationId":"removeAdKeyword","summary":"Remove a Search keyword","tags":["Ad Campaigns"],"parameters":[{"name":"keywordId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"removed":{"type":"boolean"},"keywordId":{"type":"string"},"platformCriterionId":{"type":"string"},"resourceName":{"type":"string"},"campaignId":{"type":"string"},"adSetId":{"type":"string"}}}}}}},"x-pozy-area":"ads"}},"/v1/ads/rules":{"get":{"operationId":"listAdRules","summary":"List ad rules","tags":["Ad Rules"],"parameters":[{"name":"accountId","in":"query","required":false,"schema":{"type":"string"}},{"name":"adAccountId","in":"query","required":false,"schema":{"type":"string"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":100,"default":50}},{"name":"skip","in":"query","required":false,"schema":{"type":"integer","minimum":0,"default":0}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","required":["rules"],"properties":{"rules":{"type":"array","items":{"$ref":"#/components/schemas/AdRule"}}}}}}}},"x-pozy-area":"ads"},"post":{"operationId":"createAdRule","summary":"Create an ad rule","tags":["Ad Rules"],"responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"type":"object","required":["rule"],"properties":{"rule":{"$ref":"#/components/schemas/AdRule"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["name","accountId","adAccountId","level","conditions","actions"],"properties":{"name":{"type":"string","minLength":1,"maxLength":200},"accountId":{"type":"string"},"adAccountId":{"type":"string"},"level":{"$ref":"#/components/schemas/AdRuleLevel"},"campaignIds":{"type":"array","minItems":1,"maxItems":100,"items":{"type":"string"}},"conditions":{"$ref":"#/components/schemas/AdRuleConditions"},"actions":{"$ref":"#/components/schemas/AdRuleActions"},"schedule":{"allOf":[{"$ref":"#/components/schemas/AdRuleSchedule"}]},"cooldownMinutes":{"type":"integer","minimum":0,"maximum":43200,"default":1440},"enabled":{"type":"boolean","default":true}}}}}},"x-pozy-area":"ads"}},"/v1/ads/rules/templates":{"get":{"operationId":"listAdRuleTemplates","summary":"List ready-made ad rules","tags":["Ad Rules"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","required":["templates"],"properties":{"templates":{"type":"array","items":{"type":"object","required":["id","name","description","level","conditions","actions","schedule","cooldownMinutes","platforms"],"properties":{"id":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"level":{"$ref":"#/components/schemas/AdRuleLevel"},"conditions":{"$ref":"#/components/schemas/AdRuleConditions"},"actions":{"$ref":"#/components/schemas/AdRuleActions"},"schedule":{"$ref":"#/components/schemas/AdRuleSchedule"},"cooldownMinutes":{"type":"integer"},"platforms":{"type":["array","null"],"items":{"type":"string"}}}}}}}}}}},"x-pozy-area":"ads"}},"/v1/ads/rules/activity":{"get":{"operationId":"listAdRuleActivity","summary":"List every change ad rules made","tags":["Ad Rules"],"parameters":[{"name":"ruleId","in":"query","required":false,"schema":{"type":"string"}},{"name":"accountId","in":"query","required":false,"schema":{"type":"string"}},{"name":"type","in":"query","required":false,"schema":{"type":"string","enum":["pause","activate","adjust_budget"]}},{"name":"from","in":"query","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"to","in":"query","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":100,"default":50}},{"name":"cursor","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","required":["activity","nextCursor"],"properties":{"activity":{"type":"array","items":{"$ref":"#/components/schemas/AdRuleActivityEntry"}},"nextCursor":{"type":["string","null"]}}}}}}},"x-pozy-area":"ads"}},"/v1/ads/rules/{ruleId}":{"get":{"operationId":"getAdRule","summary":"Get an ad rule","tags":["Ad Rules"],"parameters":[{"name":"ruleId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","required":["rule"],"properties":{"rule":{"$ref":"#/components/schemas/AdRule"}}}}}}},"x-pozy-area":"ads"},"patch":{"operationId":"updateAdRule","summary":"Update an ad rule","tags":["Ad Rules"],"parameters":[{"name":"ruleId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","required":["rule"],"properties":{"rule":{"$ref":"#/components/schemas/AdRule"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":200},"level":{"$ref":"#/components/schemas/AdRuleLevel"},"campaignIds":{"type":["array","null"],"minItems":1,"maxItems":100,"items":{"type":"string"}},"conditions":{"$ref":"#/components/schemas/AdRuleConditions"},"actions":{"$ref":"#/components/schemas/AdRuleActions"},"schedule":{"$ref":"#/components/schemas/AdRuleSchedule"},"cooldownMinutes":{"type":"integer","minimum":0,"maximum":43200},"enabled":{"type":"boolean"}}}}}},"x-pozy-area":"ads"},"delete":{"operationId":"deleteAdRule","summary":"Delete an ad rule","tags":["Ad Rules"],"parameters":[{"name":"ruleId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"}}}}}}},"x-pozy-area":"ads"}},"/v1/ads/rules/{ruleId}/preview":{"post":{"operationId":"previewAdRule","summary":"Preview an ad rule","tags":["Ad Rules"],"parameters":[{"name":"ruleId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdRuleEvaluation"}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"x-pozy-area":"ads"}},"/v1/ads/rules/{ruleId}/runs":{"get":{"operationId":"listAdRuleRuns","summary":"List an ad rule's runs","tags":["Ad Rules"],"parameters":[{"name":"ruleId","in":"path","required":true,"schema":{"type":"string"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":100,"default":20}},{"name":"skip","in":"query","required":false,"schema":{"type":"integer","minimum":0,"default":0}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","required":["runs"],"properties":{"runs":{"type":"array","items":{"$ref":"#/components/schemas/AdRuleRun"}}}}}}}},"x-pozy-area":"ads"}},"/v1/ads/campaigns":{"get":{"operationId":"listAdCampaigns","summary":"List campaigns","tags":["Ad Campaigns"],"parameters":[{"name":"includeEmpty","in":"query","required":false,"schema":{"type":"boolean"}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"default":1}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":100,"default":20}},{"name":"source","in":"query","required":false,"schema":{"type":"string","enum":["pozy","all"],"default":"all"}},{"name":"platform","in":"query","required":false,"schema":{"type":"string","enum":["facebook","instagram","tiktok","linkedin","pinterest","google","twitter","openai","reddit"]}},{"name":"status","in":"query","required":false,"schema":{"$ref":"#/components/schemas/AdStatus"}},{"name":"adAccountId","in":"query","required":false,"schema":{"type":"string"}},{"name":"campaignId","in":"query","required":false,"schema":{"type":"string"}},{"name":"pageId","in":"query","required":false,"schema":{"type":"string"}},{"name":"accountId","in":"query","required":false,"schema":{"type":"string"}},{"name":"profileId","in":"query","required":false,"schema":{"type":"string"}},{"name":"fromDate","in":"query","required":false,"schema":{"type":"string","format":"date"}},{"name":"toDate","in":"query","required":false,"schema":{"type":"string","format":"date"}},{"name":"hasDelivery","in":"query","required":false,"schema":{"type":"boolean"}},{"name":"minSpend","in":"query","required":false,"schema":{"type":"number","minimum":0}},{"name":"live","in":"query","required":false,"schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"campaigns":{"type":"array","items":{"$ref":"#/components/schemas/AdCampaign"}},"pagination":{"$ref":"#/components/schemas/Pagination"}}}}}}},"x-pozy-area":"ads"},"post":{"operationId":"createAdCampaign","summary":"Create a standalone campaign","tags":["Ad Campaigns"],"parameters":[{"name":"Idempotency-Key","in":"header","required":false,"schema":{"type":"string","maxLength":255}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"validateOnly":{"type":"boolean"},"adAccountId":{"type":"string"},"campaignId":{"type":"string","const":""},"objective":{"type":"string"},"status":{"type":"string","const":"VALIDATED"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","adAccountId","name","goal"],"properties":{"accountId":{"type":"string"},"adAccountId":{"type":"string"},"name":{"type":"string","maxLength":255},"goal":{"type":"string","enum":["engagement","traffic","awareness","video_views","lead_generation","lead_conversion","job_applicants","conversions","app_promotion","catalog_sales","page_likes","page_visits"]},"isSkadnetworkAttribution":{"type":"boolean"},"promotedObject":{"$ref":"#/components/schemas/AdPromotedObject"},"buyingType":{"type":"string","enum":["AUCTION","RESERVED"]},"validateOnly":{"type":"boolean"},"specialAdCategories":{"type":"array","items":{"type":"string","enum":["HOUSING","EMPLOYMENT","CREDIT","ISSUES_ELECTIONS_POLITICS","FINANCIAL_PRODUCTS_SERVICES","ONLINE_GAMBLING_AND_GAMING"]}},"budgetAmount":{"type":"number"},"budgetType":{"type":"string","enum":["daily","lifetime"]},"status":{"type":"string","enum":["ACTIVE","PAUSED"],"default":"PAUSED"},"startDate":{"type":"string","format":"date-time"},"endDate":{"type":"string","format":"date-time"},"locationTargetingType":{"allOf":[{"$ref":"#/components/schemas/GoogleLocationTargetingType"}]},"bidStrategy":{"type":"string","enum":["LOWEST_COST_WITHOUT_CAP","LOWEST_COST_WITH_BID_CAP","COST_CAP","LOWEST_COST_WITH_MIN_ROAS"]},"bidAmount":{"type":"number"},"roasAverageFloor":{"type":"number"},"portfolioBidStrategyId":{"type":"string","pattern":"^\\d+$"},"targetImpressionShare":{"allOf":[{"$ref":"#/components/schemas/GoogleTargetImpressionShare"}]},"manualCpc":{"$ref":"#/components/schemas/GoogleManualCpc"},"networkSettings":{"$ref":"#/components/schemas/GoogleNetworkSettings"}}}}}},"x-pozy-area":"ads"}},"/v1/ads/campaigns/{campaignId}/status":{"put":{"operationId":"updateAdCampaignStatus","summary":"Pause or resume a campaign","tags":["Ad Campaigns"],"parameters":[{"name":"campaignId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["active","paused"]},"platformCampaignStatus":{"type":["string","null"]},"statusReadAt":{"type":["string","null"],"format":"date-time"},"updated":{"type":"integer","enum":[0,1]},"skipped":{"type":"integer","enum":[0,1]},"skippedReasons":{"type":"array","items":{"type":"string"}}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["status","platform"],"properties":{"status":{"type":"string","enum":["active","paused"]},"platform":{"type":"string","enum":["facebook","instagram","tiktok","linkedin","pinterest","google","twitter","openai","reddit"]}}}}}},"x-pozy-area":"ads"}},"/v1/ads/campaigns/{campaignId}/ad-schedule":{"get":{"operationId":"getCampaignAdSchedule","summary":"Read a campaign's ad schedule (dayparting)","tags":["Ad Campaigns"],"parameters":[{"name":"campaignId","in":"path","required":true,"schema":{"type":"string"}},{"name":"platform","in":"query","required":false,"schema":{"type":"string","enum":["google"]}},{"name":"includePerformance","in":"query","required":false,"schema":{"type":"boolean"}},{"name":"windowDays","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":90,"default":30}},{"name":"fromDate","in":"query","required":false,"schema":{"type":"string","format":"date"}},{"name":"toDate","in":"query","required":false,"schema":{"type":"string","format":"date"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"campaignId":{"type":"string"},"schedule":{"type":"array","items":{"$ref":"#/components/schemas/AdScheduleWindow"}},"servesAroundTheClock":{"type":"boolean"},"cachedAt":{"type":["string","null"],"format":"date-time"},"stale":{"type":"boolean"},"performance":{"type":"object","properties":{"windowDays":{"type":["integer","null"]},"byDayOfWeek":{"type":"array","items":{"type":"object","properties":{"dayOfWeek":{"type":"string","enum":["MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY","SUNDAY"]},"impressions":{"type":"integer"},"clicks":{"type":"integer"},"cost":{"type":"number"},"conversions":{"type":"number"}}}},"byHour":{"type":"array","items":{"type":"object","properties":{"hour":{"type":"integer","minimum":0,"maximum":23},"impressions":{"type":"integer"},"clicks":{"type":"integer"},"cost":{"type":"number"},"conversions":{"type":"number"}}}}}}}}}}}},"x-pozy-area":"ads"},"put":{"operationId":"updateCampaignAdSchedule","summary":"Replace a campaign's ad schedule (dayparting)","tags":["Ad Campaigns"],"parameters":[{"name":"campaignId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"campaignId":{"type":"string"},"schedule":{"type":"array","items":{"$ref":"#/components/schemas/AdScheduleWindow"}},"servesAroundTheClock":{"type":"boolean"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["schedule"],"properties":{"schedule":{"type":"array","maxItems":42,"items":{"type":"object","required":["dayOfWeek","startHour","endHour"],"properties":{"dayOfWeek":{"type":"string","enum":["MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY","SUNDAY"]},"startHour":{"type":"integer","minimum":0,"maximum":23},"startMinute":{"type":"integer","enum":[0,15,30,45],"default":0},"endHour":{"type":"integer","minimum":0,"maximum":24},"endMinute":{"type":"integer","enum":[0,15,30,45],"default":0},"bidModifier":{"type":["number","null"],"minimum":0.1,"maximum":10}}}}}}}}},"x-pozy-area":"ads"}},"/v1/ads/campaigns/{campaignId}/bidding":{"get":{"operationId":"getCampaignBidding","summary":"Read a campaign's current bidding","tags":["Ad Campaigns"],"parameters":[{"name":"campaignId","in":"path","required":true,"schema":{"type":"string"}},{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}},{"name":"platform","in":"query","required":true,"schema":{"type":"string","enum":["google"]}},{"name":"adAccountId","in":"query","required":false,"schema":{"type":"string"}},{"name":"customerId","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"campaignId":{"type":"string"}}},{"$ref":"#/components/schemas/CampaignBidding"}]}}}}},"x-pozy-area":"ads"}},"/v1/ads/campaigns/{campaignId}":{"get":{"operationId":"getAdCampaignDetails","summary":"Get live campaign details","tags":["Ad Campaigns"],"parameters":[{"name":"campaignId","in":"path","required":true,"schema":{"type":"string"}},{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}},{"name":"fields","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"campaign":{"type":"object"}}}}}}},"x-pozy-area":"ads"},"put":{"operationId":"updateAdCampaign","summary":"Update a campaign","tags":["Ad Campaigns"],"parameters":[{"name":"campaignId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"updated":{"type":"integer"},"budget":{"$ref":"#/components/schemas/AdCampaignBudget"},"budgetLevel":{"type":"string","enum":["campaign"]},"bidStrategy":{"$ref":"#/components/schemas/BidStrategy"},"bidAmount":{"type":"number"},"roasAverageFloor":{"type":"number"},"portfolioBidStrategyId":{"type":"string"},"targetImpressionShare":{"$ref":"#/components/schemas/GoogleTargetImpressionShare"},"manualCpc":{"$ref":"#/components/schemas/GoogleManualCpc"},"networkSettings":{"$ref":"#/components/schemas/GoogleNetworkSettings"},"trackingUrlTemplate":{"type":"string"},"finalUrlSuffix":{"type":"string"},"sharedBudgetId":{"type":["string","null"]},"platformSpecificData":{"type":"object"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["platform"],"properties":{"platform":{"type":"string","enum":["facebook","instagram","tiktok","linkedin","pinterest","google","twitter","openai","reddit"]},"accountId":{"type":"string"},"bidStrategy":{"allOf":[{"$ref":"#/components/schemas/BidStrategy"}]},"bidAmount":{"type":"number"},"roasAverageFloor":{"type":"number"},"portfolioBidStrategyId":{"type":"string","pattern":"^\\d+$"},"allowSharedBudgetUpdate":{"type":"boolean","default":false},"targetImpressionShare":{"allOf":[{"$ref":"#/components/schemas/GoogleTargetImpressionShare"}]},"manualCpc":{"$ref":"#/components/schemas/GoogleManualCpc"},"networkSettings":{"$ref":"#/components/schemas/GoogleNetworkSettings"},"trackingUrlTemplate":{"type":"string"},"finalUrlSuffix":{"type":"string"},"sharedBudgetId":{"type":["string","null"],"pattern":"^\\d+$"},"budget":{"type":"object","required":["amount","type"],"properties":{"amount":{"type":"number"},"type":{"type":"string","enum":["daily","lifetime"]}}},"name":{"type":"string","maxLength":255},"platformSpecificData":{"type":"object","properties":{"spendCap":{"type":["number","null"]}}}}}}}},"x-pozy-area":"ads"},"delete":{"operationId":"deleteAdCampaign","summary":"Delete a campaign","tags":["Ad Campaigns"],"parameters":[{"name":"campaignId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"deleted":{"type":"boolean"},"adCount":{"type":"integer"}}}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["platform"],"properties":{"platform":{"type":"string","enum":["facebook","instagram","tiktok","linkedin","pinterest","google","twitter","openai","reddit"]},"accountId":{"type":"string"},"adAccountId":{"type":"string","pattern":"^[0-9a-z]{1,32}$"}}}}}},"x-pozy-area":"ads"}},"/v1/ads/campaigns/{campaignId}/negative-keywords":{"get":{"operationId":"listCampaignNegativeKeywords","summary":"List campaign-level negative keywords","tags":["Ad Campaigns"],"parameters":[{"name":"campaignId","in":"path","required":true,"schema":{"type":"string"}},{"name":"platform","in":"query","required":false,"schema":{"type":"string","enum":["facebook","instagram","tiktok","linkedin","pinterest","google","twitter","openai","reddit"]}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"keywords":{"type":"array","items":{"type":"object","properties":{"criterionId":{"type":"string"},"text":{"type":"string"},"matchType":{"type":"string","enum":["exact","phrase","broad"]}}}},"cachedAt":{"type":["string","null"],"format":"date-time"},"stale":{"type":"boolean"}}}}}}},"x-pozy-area":"ads"},"put":{"operationId":"replaceCampaignNegativeKeywords","summary":"Replace campaign-level negative keywords","tags":["Ad Campaigns"],"parameters":[{"name":"campaignId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"created":{"type":"integer"},"removed":{"type":"integer"},"keywords":{"type":"array","items":{"type":"object","properties":{"criterionId":{"type":"string"},"text":{"type":"string"},"matchType":{"type":"string","enum":["exact","phrase","broad"]}}}}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["keywords"],"properties":{"platform":{"type":"string","enum":["facebook","instagram","tiktok","linkedin","pinterest","google","twitter","openai","reddit"]},"keywords":{"type":"array","maxItems":1000,"items":{"$ref":"#/components/schemas/KeywordEntry"}}}}}}},"x-pozy-area":"ads"}},"/v1/ads/campaigns/bulk-status":{"post":{"operationId":"bulkUpdateAdCampaignStatus","summary":"Pause or resume many campaigns","tags":["Ad Campaigns"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["active","paused"]},"totals":{"type":"object","properties":{"updated":{"type":"integer"},"skipped":{"type":"integer"},"failed":{"type":"integer"}}},"results":{"type":"array","items":{"type":"object","properties":{"platformCampaignId":{"type":"string"},"platform":{"type":"string"},"updated":{"type":"integer","enum":[0,1]},"skipped":{"type":"integer","enum":[0,1]},"platformCampaignStatus":{"type":["string","null"]},"error":{"type":"string"}}}}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["status","campaigns"],"properties":{"status":{"type":"string","enum":["active","paused"]},"campaigns":{"type":"array","maxItems":50,"items":{"type":"object","required":["platformCampaignId","platform"],"properties":{"platformCampaignId":{"type":"string"},"platform":{"type":"string","enum":["facebook","instagram","tiktok","linkedin","pinterest","google","twitter","openai","reddit","googleads","tiktokads","linkedinads","pinterestads","xads","openaiads","redditads"]}}}}}}}}},"x-pozy-area":"ads"}},"/v1/ads/campaigns/{campaignId}/duplicate":{"post":{"operationId":"duplicateAdCampaign","summary":"Duplicate a campaign","tags":["Ad Campaigns"],"parameters":[{"name":"Idempotency-Key","in":"header","required":false,"schema":{"type":"string","maxLength":255}},{"name":"campaignId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"copiedCampaignId":{"type":"string"},"adSetIdMap":{"type":"object","additionalProperties":{"type":"string"}},"adIdMap":{"type":"object","additionalProperties":{"type":"string"}},"discovery":{"type":"string","enum":["triggered","skipped","failed"]},"raw":{"type":"object"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["platform"],"properties":{"platform":{"type":"string","enum":["facebook","instagram","tiktok","linkedin"]},"deepCopy":{"type":"boolean","default":true},"statusOption":{"type":"string","enum":["ACTIVE","PAUSED","INHERITED_FROM_SOURCE"],"default":"PAUSED"},"startTime":{"type":"string","format":"date-time"},"endTime":{"type":"string","format":"date-time"},"renameStrategy":{"type":"string","enum":["DEEP_RENAME","ONLY_TOP_LEVEL_RENAME","NO_RENAME"]},"renamePrefix":{"type":"string"},"renameSuffix":{"type":"string"},"syncAfter":{"type":"boolean","default":true}}}}}},"x-pozy-area":"ads"}},"/v1/ads/campaigns/{campaignId}/targeting":{"get":{"operationId":"getCampaignTargeting","summary":"Read a Google campaign's device, location, excluded location, and language targeting","tags":["Ad Campaigns"],"parameters":[{"name":"campaignId","in":"path","required":true,"schema":{"type":"string"}},{"name":"platform","in":"query","required":false,"schema":{"type":"string","enum":["google"]}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"devices":{"type":"array","items":{"type":"object","properties":{"device":{"type":"string","enum":["MOBILE","DESKTOP","TABLET","CONNECTED_TV"]},"included":{"type":"boolean"},"bidModifier":{"type":["number","null"]}}}},"locations":{"type":"array","items":{"type":"object","properties":{"geoTargetId":{"type":"string"},"negative":{"type":"boolean"},"name":{"type":["string","null"]},"canonicalName":{"type":["string","null"]},"type":{"type":["string","null"]},"countryCode":{"type":["string","null"]}}}},"excludedLocations":{"type":"array","items":{"type":"object","properties":{"geoTargetId":{"type":"string"},"negative":{"type":"boolean"},"name":{"type":["string","null"]},"canonicalName":{"type":["string","null"]},"type":{"type":["string","null"]},"countryCode":{"type":["string","null"]}}}},"excludedLocationsEditable":{"type":"boolean"},"languages":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"}}}},"locationTargetingType":{"type":["string","null"],"enum":["presence","presence_or_interest",null]},"cachedAt":{"type":["string","null"],"format":"date-time"},"stale":{"type":"boolean"}}}}}}},"x-pozy-area":"ads"},"put":{"operationId":"updateCampaignTargeting","summary":"Edit a Google campaign's device, location, excluded location, or language targeting","tags":["Ad Campaigns"],"parameters":[{"name":"campaignId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"campaignId":{"type":"string"},"adGroupId":{"type":"string"},"updated":{"type":"array","items":{"type":"string","enum":["devices","locations","excludedLocations","languages","locationTargetingType"]}},"locationTargetingType":{"type":["string","null"],"enum":["presence","presence_or_interest",null]},"devices":{"type":"array","items":{"type":"object","properties":{"device":{"type":"string","enum":["MOBILE","DESKTOP","TABLET","CONNECTED_TV"]},"included":{"type":"boolean"},"bidModifier":{"type":["number","null"]}}}},"locations":{"type":"array","items":{"type":"object","properties":{"geoTargetId":{"type":"string"},"negative":{"type":"boolean"},"name":{"type":["string","null"]},"canonicalName":{"type":["string","null"]},"type":{"type":["string","null"]},"countryCode":{"type":["string","null"]}}}},"excludedLocations":{"type":"array","items":{"type":"object","properties":{"geoTargetId":{"type":"string"},"negative":{"type":"boolean"},"name":{"type":["string","null"]},"canonicalName":{"type":["string","null"]},"type":{"type":["string","null"]},"countryCode":{"type":["string","null"]}}}},"languages":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"}}}}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["platform","targeting"],"properties":{"platform":{"type":"string","enum":["google"]},"targeting":{"type":"object","minProperties":1,"properties":{"devices":{"type":"array","items":{"oneOf":[{"type":"string","enum":["MOBILE","DESKTOP","TABLET","CONNECTED_TV"]},{"type":"object","required":["device","bidModifier"],"properties":{"device":{"type":"string","enum":["MOBILE","DESKTOP","TABLET","CONNECTED_TV"]},"bidModifier":{"type":"number"}}}]}},"locations":{"oneOf":[{"type":"array","items":{"type":"string"}},{"type":"object","properties":{"countries":{"type":"array","items":{"type":"string"}},"regions":{"type":"array","items":{"oneOf":[{"type":"string"},{"type":"object","required":["key"],"properties":{"key":{"type":"string"},"name":{"type":"string"}}}]}},"cities":{"type":"array","items":{"oneOf":[{"type":"string"},{"type":"object","required":["key"],"properties":{"key":{"type":"string"},"name":{"type":"string"}}}]}},"zips":{"type":"array","items":{"oneOf":[{"type":"string"},{"type":"object","required":["key"],"properties":{"key":{"type":"string"},"name":{"type":"string"}}}]}},"metros":{"type":"array","items":{"oneOf":[{"type":"string"},{"type":"object","required":["key"],"properties":{"key":{"type":"string"},"name":{"type":"string"}}}]}}}}]},"languages":{"type":"array","items":{"type":"string"}},"excludedLocations":{"oneOf":[{"type":"array","items":{"type":"string"}},{"type":"object","additionalProperties":false,"properties":{"countries":{"type":"array","items":{"type":"string"}},"regions":{"type":"array","items":{"oneOf":[{"type":"string"},{"type":"object","required":["key"],"properties":{"key":{"type":"string"},"name":{"type":"string"}}}]}},"cities":{"type":"array","items":{"oneOf":[{"type":"string"},{"type":"object","required":["key"],"properties":{"key":{"type":"string"},"name":{"type":"string"}}}]}},"zips":{"type":"array","items":{"oneOf":[{"type":"string"},{"type":"object","required":["key"],"properties":{"key":{"type":"string"},"name":{"type":"string"}}}]}},"metros":{"type":"array","items":{"oneOf":[{"type":"string"},{"type":"object","required":["key"],"properties":{"key":{"type":"string"},"name":{"type":"string"}}}]}}}}]},"locationTargetingType":{"$ref":"#/components/schemas/GoogleLocationTargetingType"}}}}}}}},"x-pozy-area":"ads"}},"/v1/ads/ad-sets":{"get":{"operationId":"listAdSets","summary":"List ad sets","tags":["Ad Campaigns"],"parameters":[{"name":"accountId","in":"query","required":false,"schema":{"type":"string"}},{"name":"adAccountId","in":"query","required":false,"schema":{"type":"string"}},{"name":"campaignId","in":"query","required":false,"schema":{"type":"string"}},{"name":"adSetId","in":"query","required":false,"schema":{"type":"string"}},{"name":"platform","in":"query","required":false,"schema":{"type":"string","enum":["facebook","instagram","tiktok","linkedin","pinterest","google","twitter","openai","reddit"]}},{"name":"status","in":"query","required":false,"schema":{"$ref":"#/components/schemas/AdStatus"}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"default":1}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":500,"default":500}},{"name":"live","in":"query","required":false,"schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"adSets":{"type":"array","items":{"type":"object","properties":{"platformAdSetId":{"type":"string"},"platform":{"type":"string"},"adSetName":{"type":["string","null"]},"status":{"type":["string","null"]},"platformAdSetStatus":{"type":["string","null"]},"platformCampaignId":{"type":["string","null"]},"platformAdAccountId":{"type":"string"},"accountId":{"type":["string","null"]},"profileId":{"type":"string"},"currency":{"type":["string","null"]},"budget":{"type":["object","null"],"properties":{"amount":{"type":"number"},"type":{"type":"string","enum":["daily","lifetime"]},"daily":{"type":"number"},"lifetime":{"type":"number"},"pacing":{"type":"string"}}},"schedule":{"type":["object","null"],"properties":{"startDate":{"type":"string","format":"date-time"},"endDate":{"type":"string","format":"date-time"}}},"targeting":{"type":["object","null"],"additionalProperties":true,"properties":{"include":{"type":"object"},"exclude":{"type":"object"},"audienceExpansionEnabled":{"type":"boolean"},"offsiteDeliveryEnabled":{"type":"boolean"}}},"isExternal":{"type":["boolean","null"]},"platformCreatedAt":{"type":["string","null"],"format":"date-time"},"statusReadAt":{"type":["string","null"],"format":"date-time"},"optimizationGoal":{"type":["string","null"]},"billingEvent":{"type":["string","null"]},"bidStrategy":{"type":["string","null"]},"bidAmount":{"type":["number","null"]},"promotedObject":{"type":["object","null"],"additionalProperties":true},"nativeSettings":{"type":"object","additionalProperties":true},"configReadAt":{"type":["string","null"],"format":"date-time"}}}},"pagination":{"$ref":"#/components/schemas/Pagination"}}}}}}},"x-pozy-area":"ads"},"post":{"operationId":"createAdSet","summary":"Create a standalone ad group","tags":["Ad Campaigns"],"parameters":[{"name":"Idempotency-Key","in":"header","required":false,"schema":{"type":"string","maxLength":255}}],"responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"adSetId":{"type":"string"},"campaignId":{"type":"string"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","platform","campaignId","name"],"properties":{"accountId":{"type":"string"},"platform":{"type":"string","enum":["facebook","instagram","tiktok","linkedin","pinterest","google","twitter","openai","reddit"]},"campaignId":{"type":"string"},"name":{"type":"string","minLength":1,"maxLength":255},"status":{"type":"string","enum":["ACTIVE","PAUSED"],"default":"PAUSED"},"maxCpc":{"type":"number","exclusiveMinimum":0},"adAccountId":{"type":"string"},"customerId":{"type":"string","deprecated":true},"budgetAmount":{"type":"number","exclusiveMinimum":0},"budgetType":{"type":"string","enum":["daily","lifetime"]},"startDate":{"type":"string"},"endDate":{"type":"string"},"targeting":{"$ref":"#/components/schemas/TargetingSpec"},"promotedObject":{"type":"object","properties":{"pixelId":{"type":"string"},"customEventType":{"type":"string"}}},"optimizationGoal":{"type":"string"},"bidStrategy":{"type":"string","enum":["LOWEST_COST_WITHOUT_CAP","LOWEST_COST_WITH_BID_CAP","COST_CAP"]},"bidAmount":{"type":"number","exclusiveMinimum":0}}}}}},"x-pozy-area":"ads"}},"/v1/ads/ad-sets/{adSetId}/duplicate":{"post":{"operationId":"duplicateAdSet","summary":"Duplicate an ad set","tags":["Ad Campaigns"],"parameters":[{"name":"Idempotency-Key","in":"header","required":false,"schema":{"type":"string","maxLength":255}},{"name":"adSetId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"copiedAdSetId":{"type":"string"},"copiedAdIds":{"type":"array","items":{"type":"string"}},"adIdMap":{"type":"object","additionalProperties":{"type":"string"}},"discovery":{"type":"string","enum":["triggered","skipped","failed"]},"raw":{"type":"object"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["platform"],"properties":{"platform":{"type":"string","enum":["facebook","instagram","tiktok"]},"campaignId":{"type":"string"},"deepCopy":{"type":"boolean","default":true},"statusOption":{"type":"string","enum":["ACTIVE","PAUSED","INHERITED_FROM_SOURCE"],"default":"PAUSED"},"startTime":{"type":"string","format":"date-time"},"endTime":{"type":"string","format":"date-time"},"renameStrategy":{"type":"string","enum":["DEEP_RENAME","ONLY_TOP_LEVEL_RENAME","NO_RENAME"]},"renamePrefix":{"type":"string"},"renameSuffix":{"type":"string"},"syncAfter":{"type":"boolean","default":true}}}}}},"x-pozy-area":"ads"}},"/v1/ads/{adId}/duplicate":{"post":{"operationId":"duplicateAd","summary":"Duplicate an ad","tags":["Ad Campaigns"],"parameters":[{"name":"Idempotency-Key","in":"header","required":false,"schema":{"type":"string","maxLength":255}},{"name":"adId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"copiedAdId":{"type":"string"},"discovery":{"type":"string","enum":["triggered","skipped","failed"]},"raw":{"type":"object"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{"adSetId":{"type":"string"},"statusOption":{"type":"string","enum":["ACTIVE","PAUSED","INHERITED_FROM_SOURCE"],"default":"PAUSED"},"renameStrategy":{"type":"string","enum":["DEEP_RENAME","ONLY_TOP_LEVEL_RENAME","NO_RENAME"]},"renamePrefix":{"type":"string"},"renameSuffix":{"type":"string"},"syncAfter":{"type":"boolean","default":true},"reuseSourceCreative":{"type":"boolean","default":false}}}}}},"x-pozy-area":"ads"}},"/v1/ads/ad-sets/{adSetId}":{"get":{"operationId":"getAdSetDetails","summary":"Get live ad-set details","tags":["Ad Campaigns"],"parameters":[{"name":"adSetId","in":"path","required":true,"schema":{"type":"string"}},{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}},{"name":"fields","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"adSet":{"type":"object"}}}}}}},"x-pozy-area":"ads"},"put":{"operationId":"updateAdSet","summary":"Update an ad set","tags":["Ad Campaigns"],"parameters":[{"name":"adSetId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"budget":{"$ref":"#/components/schemas/AdBudget"},"budgetLevel":{"type":"string","enum":["adset"]},"status":{"type":"string","enum":["active","paused"]},"platformAdSetStatus":{"type":["string","null"]},"platformCampaignStatus":{"type":["string","null"]},"statusReadAt":{"type":["string","null"],"format":"date-time"},"statusUpdated":{"type":"integer","enum":[0,1]},"statusSkipped":{"type":"integer","enum":[0,1]},"statusSkippedReasons":{"type":"array","items":{"type":"string"}},"bidStrategy":{"$ref":"#/components/schemas/BidStrategy"},"bidAmount":{"type":["number","null"]},"roasAverageFloor":{"type":["number","null"]},"platformSpecificData":{"type":"object"},"targeting":{"type":"object"},"startDate":{"type":"string"},"endDate":{"type":["string","null"]}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["platform"],"properties":{"platform":{"type":"string","enum":["facebook","instagram","tiktok","linkedin","pinterest","google","twitter","openai","reddit"]},"budget":{"type":"object","properties":{"amount":{"type":"number"},"type":{"type":"string","enum":["daily","lifetime"]}}},"status":{"type":"string","enum":["active","paused"]},"name":{"type":"string","maxLength":255},"bidStrategy":{"allOf":[{"$ref":"#/components/schemas/BidStrategy"}]},"dsaBeneficiary":{"type":"string","minLength":1,"maxLength":100},"dsaPayor":{"type":"string","minLength":1,"maxLength":100},"regionalRegulatedCategories":{"type":"array","items":{"type":"string","minLength":1}},"regionalRegulationIdentities":{"type":"object","additionalProperties":{"type":["string","integer"]}},"smartTargeting":{"type":"object","properties":{"audience":{"type":"boolean"},"interestsBehaviors":{"type":"boolean"}}},"placements":{"type":["object","null"],"properties":{"publisherPlatforms":{"type":"array","items":{"type":"string","enum":["facebook","instagram","threads","messenger","audience_network","whatsapp"]}},"facebookPositions":{"type":"array","items":{"type":"string","enum":["feed","right_hand_column","marketplace","story","search","instream_video","facebook_reels","facebook_reels_overlay","profile_feed","notification"]}},"instagramPositions":{"type":"array","items":{"type":"string","enum":["stream","story","explore","explore_home","reels","profile_feed","ig_search","profile_reels"]}},"messengerPositions":{"type":"array","items":{"type":"string","enum":["messenger_home","sponsored_messages","story"]}},"audienceNetworkPositions":{"type":"array","items":{"type":"string","enum":["classic","rewarded_video"]}},"threadsPositions":{"type":"array","items":{"type":"string","enum":["threads_stream"]}},"whatsappPositions":{"type":"array","items":{"type":"string","enum":["status"]}},"devicePlatforms":{"type":"array","items":{"type":"string","enum":["mobile","desktop"]}}}},"startDate":{"type":"string"},"endDate":{"type":["string","null"]},"targeting":{"allOf":[{"$ref":"#/components/schemas/TargetingSpec"}]},"bidAmount":{"type":"number"},"roasAverageFloor":{"type":"number"},"valueRuleSetId":{"type":"string","pattern":"^\\d+$"},"valueRulesApplied":{"type":"boolean"},"platformSpecificData":{"type":"object","properties":{"optimizationGoal":{"type":"string"},"billingEvent":{"type":"string"},"startDate":{"type":"string"},"endDate":{"type":"string"},"dailyMinSpendTarget":{"type":"number"},"lifetimeMinSpendTarget":{"type":"number"},"customerLifecycle":{"$ref":"#/components/schemas/MetaCustomerLifecycle"},"adSchedule":{"allOf":[{"$ref":"#/components/schemas/MetaAdSchedule"}]},"promotedObject":{"type":"object","properties":{"pixelId":{"type":"string"},"customEventType":{"type":"string"},"customEventStr":{"type":"string"},"pageId":{"type":"string"},"applicationId":{"type":"string"},"objectStoreUrl":{"type":"string"},"customConversionId":{"type":"string"},"productCatalogId":{"type":"string"},"productSetId":{"type":"string"},"offlineConversionDataSetId":{"type":"string"},"whatsappPhoneNumber":{"type":"string"}},"additionalProperties":false}}}}}}}},"x-pozy-area":"ads"},"delete":{"operationId":"deleteAdSet","summary":"Delete an ad set","tags":["Ad Campaigns"],"parameters":[{"name":"adSetId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"deleted":{"type":"boolean"},"adCount":{"type":"integer"}}}}}}},"x-pozy-area":"ads"}},"/v1/ads/ad-sets/{adSetId}/targeting":{"get":{"operationId":"getAdSetTargeting","summary":"Read a Reddit ad group's targeting and schedule","tags":["Ad Campaigns"],"parameters":[{"name":"adSetId","in":"path","required":true,"schema":{"type":"string"}},{"name":"platform","in":"query","required":false,"schema":{"type":"string","enum":["reddit"]}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"adSetId":{"type":"string"},"targeting":{"allOf":[{"$ref":"#/components/schemas/TargetingSpec"}]},"startDate":{"type":["string","null"]},"endDate":{"type":["string","null"]}}}}}}},"x-pozy-area":"ads"}},"/v1/ads/ad-sets/{adSetId}/status":{"put":{"operationId":"updateAdSetStatus","summary":"Pause or resume a single ad set","tags":["Ad Campaigns"],"parameters":[{"name":"adSetId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["active","paused"]},"platformAdSetStatus":{"type":["string","null"]},"platformCampaignStatus":{"type":["string","null"]},"statusReadAt":{"type":["string","null"],"format":"date-time"},"updated":{"type":"integer","enum":[0,1]},"skipped":{"type":"integer","enum":[0,1]},"skippedReasons":{"type":"array","items":{"type":"string"}}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["status","platform"],"properties":{"status":{"type":"string","enum":["active","paused"]},"platform":{"type":"string","enum":["facebook","instagram","tiktok","linkedin","pinterest","google","twitter","openai","reddit"]}}}}}},"x-pozy-area":"ads"}},"/v1/ads/tree":{"get":{"operationId":"getAdTree","summary":"Get campaign tree","tags":["Ad Campaigns"],"parameters":[{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"default":1}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":100,"default":20}},{"name":"source","in":"query","required":false,"schema":{"type":"string","enum":["pozy","all"],"default":"all"}},{"name":"platform","in":"query","required":false,"schema":{"type":"string","enum":["facebook","instagram","tiktok","linkedin","pinterest","google","twitter","openai","reddit"]}},{"name":"status","in":"query","required":false,"schema":{"$ref":"#/components/schemas/AdStatus"}},{"name":"adAccountId","in":"query","required":false,"schema":{"type":"string"}},{"name":"pageId","in":"query","required":false,"schema":{"type":"string"}},{"name":"accountId","in":"query","required":false,"schema":{"type":"string"}},{"name":"profileId","in":"query","required":false,"schema":{"type":"string"}},{"name":"campaignId","in":"query","required":false,"schema":{"type":"string"}},{"name":"updatedSince","in":"query","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"search","in":"query","required":false,"schema":{"type":"string","maxLength":500}},{"name":"fromDate","in":"query","required":false,"schema":{"type":"string","format":"date"}},{"name":"toDate","in":"query","required":false,"schema":{"type":"string","format":"date"}},{"name":"hasDelivery","in":"query","required":false,"schema":{"type":"boolean"}},{"name":"minSpend","in":"query","required":false,"schema":{"type":"number","minimum":0}},{"name":"sort","in":"query","required":false,"schema":{"type":"string","enum":["newest","oldest","spend_desc","spend_asc"],"default":"newest"}},{"name":"timeIncrement","in":"query","required":false,"schema":{"type":"integer","enum":[1]}},{"name":"dailyLevel","in":"query","required":false,"schema":{"type":"string","enum":["campaign","adset","ad"],"default":"campaign"}},{"name":"compare","in":"query","required":false,"schema":{"type":"string","enum":["previous"]}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdTreeResponse"}}}}},"x-pozy-area":"ads"}},"/v1/ads/timeline":{"get":{"operationId":"getAdsTimeline","summary":"Get daily account metrics","tags":["Ad Campaigns"],"parameters":[{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}},{"name":"adAccountId","in":"query","required":false,"schema":{"type":"string"}},{"name":"fromDate","in":"query","required":false,"schema":{"type":"string","format":"date"}},{"name":"toDate","in":"query","required":false,"schema":{"type":"string","format":"date"}},{"name":"platform","in":"query","required":false,"schema":{"type":"string","enum":["facebook","instagram","tiktok","linkedin","pinterest","google","twitter","openai","reddit"]}},{"name":"compare","in":"query","required":false,"schema":{"type":"string","enum":["previous"]}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdsTimelineResponse"}}}}},"x-pozy-area":"ads"}},"/v1/ads/{adId}":{"get":{"operationId":"getAd","summary":"Get ad details","tags":["Ad Campaigns"],"parameters":[{"name":"adId","in":"path","required":true,"schema":{"type":"string"}},{"name":"live","in":"query","required":false,"schema":{"type":"boolean","default":false}},{"name":"accountId","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"ad":{"$ref":"#/components/schemas/Ad"},"cachedAt":{"type":["string","null"],"format":"date-time"},"stale":{"type":"boolean"},"statusReadAt":{"type":["string","null"],"format":"date-time"},"darkPost":{"type":"object","properties":{"platform":{"type":"string","enum":["facebook"]},"platformPostId":{"type":"string"},"pageId":{"type":"string"},"isDarkPost":{"type":"boolean"},"adId":{"type":["string","null"]},"accountId":{"type":["string","null"]},"facebookAccountId":{"type":"string"},"platformAdAccountIds":{"type":"array","items":{"type":"string"}},"firstSeenAt":{"type":"string","format":"date-time"},"lastActivityAt":{"type":"string","format":"date-time"}}}}}}}}},"x-pozy-area":"ads"},"put":{"operationId":"updateAd","summary":"Update ad","tags":["Ad Campaigns"],"parameters":[{"name":"adId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"ad":{"$ref":"#/components/schemas/Ad"},"message":{"type":"string"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"headlines":{"type":"array","minItems":1,"maxItems":15,"items":{"$ref":"#/components/schemas/GoogleRsaHeadline"}},"descriptions":{"type":"array","minItems":1,"maxItems":5,"items":{"$ref":"#/components/schemas/GoogleRsaDescription"}},"finalUrls":{"type":"array","minItems":1,"items":{"type":"string","format":"uri"}},"assetGroup":{"allOf":[{"$ref":"#/components/schemas/GooglePmaxAssetGroupUpdate"}]},"demandGen":{"allOf":[{"$ref":"#/components/schemas/GoogleDemandGenUpdate"}]},"status":{"type":"string","enum":["active","paused"]},"budget":{"type":"object","properties":{"amount":{"type":"number"},"type":{"type":"string","enum":["daily","lifetime"]}}},"targeting":{"type":"object","properties":{"keywords":{"type":"array","items":{"oneOf":[{"type":"string"},{"type":"object","required":["text"],"properties":{"text":{"type":"string","maxLength":80},"matchType":{"type":"string","enum":["exact","phrase","broad"]}}}]}},"negativeKeywords":{"type":"array","items":{"oneOf":[{"type":"string"},{"type":"object","required":["text"],"properties":{"text":{"type":"string","maxLength":80},"matchType":{"type":"string","enum":["exact","phrase","broad"]}}}]}},"devices":{"type":"array","items":{"oneOf":[{"type":"string","enum":["MOBILE","DESKTOP","TABLET","CONNECTED_TV"]},{"type":"object","required":["device"],"properties":{"device":{"type":"string","enum":["MOBILE","DESKTOP","TABLET","CONNECTED_TV"]},"bidModifier":{"type":"number","minimum":0,"maximum":10}}}]}},"ageMin":{"type":"integer","minimum":13,"maximum":65},"ageMax":{"type":"integer","minimum":13,"maximum":65},"countries":{"type":"array","items":{"type":"string"}},"locations":{"oneOf":[{"type":"array","items":{"type":"string"}},{"type":"object","properties":{"countries":{"type":"array","items":{"type":"string"}},"regions":{"type":"array","items":{"type":"object","required":["key"],"properties":{"key":{"type":"string"},"name":{"type":"string"}}}},"cities":{"type":"array","items":{"type":"object","required":["key"],"properties":{"key":{"type":"string"},"name":{"type":"string"}}}},"zips":{"type":"array","items":{"type":"object","required":["key"],"properties":{"key":{"type":"string"},"name":{"type":"string"}}}},"metros":{"type":"array","items":{"type":"object","required":["key"],"properties":{"key":{"type":"string"},"name":{"type":"string"}}}}}}]},"languages":{"type":"array","items":{"type":"string"}},"interests":{"type":"array","items":{"type":"object","required":["id","name"],"properties":{"id":{"type":"string"},"name":{"type":"string"}}}},"advantage_audience":{"type":"integer","enum":[0,1]}}},"creative":{"type":"object","properties":{"promotion":{"$ref":"#/components/schemas/MetaPromotion"},"creativeFeatures":{"$ref":"#/components/schemas/MetaCreativeFeatures"},"headline":{"type":"string"},"longHeadline":{"type":"string","minLength":1,"maxLength":90},"businessName":{"type":"string","minLength":1,"maxLength":25},"squareImageUrl":{"type":"string","format":"uri"},"body":{"type":"string"},"description":{"type":"string","maxLength":255},"callToAction":{"type":"string"},"linkUrl":{"type":"string","format":"uri"},"imageUrl":{"type":"string","format":"uri"},"videoUrl":{"type":"string","format":"uri"},"videoId":{"type":"string"},"existingCreativeId":{"type":"string"}}},"name":{"type":"string","maxLength":255}}}}}},"x-pozy-area":"ads"},"delete":{"operationId":"deleteAd","summary":"Cancel an ad","tags":["Ad Campaigns"],"parameters":[{"name":"adId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}}}}}}},"x-pozy-area":"ads"}},"/v1/ads/{adId}/status":{"put":{"operationId":"updateAdStatus","summary":"Pause or resume a single ad","tags":["Ad Campaigns"],"parameters":[{"name":"adId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"updated":{"type":"integer"},"skipped":{"type":"integer"},"status":{"type":"string"},"configuredStatus":{"type":["string","null"]},"message":{"type":"string"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["status"],"properties":{"status":{"type":"string","enum":["active","paused"]}}}}}},"x-pozy-area":"ads"}},"/v1/ads/campaigns/{campaignId}/assets":{"get":{"operationId":"listCampaignAssets","summary":"List campaign assets","tags":["Ad Campaigns"],"parameters":[{"name":"campaignId","in":"path","required":true,"schema":{"type":"string","pattern":"^\\d+$"}},{"name":"accountId","in":"query","required":true,"schema":{"type":"string","pattern":"^[a-fA-F0-9]{24}$"}},{"name":"adAccountId","in":"query","required":false,"schema":{"type":"string","pattern":"^\\d+$"}},{"name":"customerId","in":"query","required":false,"schema":{"type":"string","pattern":"^\\d+$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"campaignId":{"type":"string"},"sitelinks":{"type":"array","items":{"type":"object","properties":{"assetResourceName":{"type":"string"},"campaignAssetResourceName":{"type":"string"},"text":{"type":"string"},"linkUrl":{"type":"string","format":"uri"},"description1":{"type":"string"},"description2":{"type":"string"}}}},"callouts":{"type":"array","items":{"type":"object","properties":{"assetResourceName":{"type":"string"},"campaignAssetResourceName":{"type":"string"},"calloutText":{"type":"string"}}}},"structuredSnippets":{"type":"array","items":{"type":"object","properties":{"assetResourceName":{"type":"string"},"campaignAssetResourceName":{"type":"string"},"header":{"type":"string"},"values":{"type":"array","items":{"type":"string"}}}}},"images":{"type":"array","items":{"type":"object","properties":{"assetResourceName":{"type":"string"},"campaignAssetResourceName":{"type":"string"},"imageUrl":{"type":"string","format":"uri"},"width":{"type":"integer"},"height":{"type":"integer"}}}},"cachedAt":{"type":["string","null"],"format":"date-time"},"stale":{"type":"boolean"}}}}}}},"x-pozy-area":"ads"},"post":{"operationId":"attachCampaignAssets","summary":"Attach campaign assets","tags":["Ad Campaigns"],"parameters":[{"name":"campaignId","in":"path","required":true,"schema":{"type":"string","pattern":"^\\d+$"}}],"responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"campaignId":{"type":"string"},"sitelinkAssetResourceNames":{"type":"array","items":{"type":"string"}},"calloutAssetResourceNames":{"type":"array","items":{"type":"string"}},"structuredSnippetAssetResourceNames":{"type":"array","items":{"type":"string"}},"imageAssetResourceNames":{"type":"array","items":{"type":"string"}}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId"],"properties":{"accountId":{"type":"string","pattern":"^[a-fA-F0-9]{24}$"},"adAccountId":{"type":"string","pattern":"^\\d+$"},"customerId":{"type":"string","deprecated":true,"pattern":"^\\d+$"},"sitelinks":{"type":"array","items":{"$ref":"#/components/schemas/GoogleSitelink"},"minItems":2,"maxItems":20},"callouts":{"type":"array","items":{"type":"string","minLength":1,"maxLength":25},"minItems":1,"maxItems":20},"structuredSnippets":{"type":"array","items":{"$ref":"#/components/schemas/GoogleStructuredSnippet"},"minItems":1,"maxItems":20},"images":{"type":"array","items":{"type":"string","format":"uri"},"minItems":1,"maxItems":20}}}}}},"x-pozy-area":"ads"},"put":{"operationId":"updateCampaignAssets","summary":"Update campaign assets","tags":["Ad Campaigns"],"parameters":[{"name":"campaignId","in":"path","required":true,"schema":{"type":"string","pattern":"^\\d+$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"updated":{"type":"integer"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","updates"],"properties":{"accountId":{"type":"string","pattern":"^[a-fA-F0-9]{24}$"},"adAccountId":{"type":"string","pattern":"^\\d+$"},"customerId":{"type":"string","deprecated":true,"pattern":"^\\d+$"},"updates":{"type":"array","items":{"$ref":"#/components/schemas/GoogleAssetUpdate"},"minItems":1,"maxItems":20}}}}}},"x-pozy-area":"ads"},"delete":{"operationId":"removeCampaignAssets","summary":"Remove campaign assets","tags":["Ad Campaigns"],"parameters":[{"name":"campaignId","in":"path","required":true,"schema":{"type":"string","pattern":"^\\d+$"}},{"name":"accountId","in":"query","required":true,"schema":{"type":"string","pattern":"^[a-fA-F0-9]{24}$"}},{"name":"adAccountId","in":"query","required":false,"schema":{"type":"string","pattern":"^\\d+$"}},{"name":"customerId","in":"query","required":false,"schema":{"type":"string","pattern":"^\\d+$"}},{"name":"assetResourceNames","in":"query","required":true,"schema":{"type":"array","minItems":1,"items":{"type":"string"}}},{"name":"campaignAssetResourceNames","in":"query","required":true,"schema":{"type":"array","minItems":1,"items":{"type":"string"}}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"removed":{"type":"boolean"}}}}}}},"x-pozy-area":"ads"}},"/v1/ads/ad-sets/{adSetId}/assets":{"get":{"operationId":"listAdGroupAssets","summary":"List ad-group assets","tags":["Ad Campaigns"],"parameters":[{"name":"adSetId","in":"path","required":true,"schema":{"type":"string","pattern":"^\\d+$"}},{"name":"accountId","in":"query","required":true,"schema":{"type":"string","pattern":"^[a-fA-F0-9]{24}$"}},{"name":"adAccountId","in":"query","required":false,"schema":{"type":"string","pattern":"^\\d+$"}},{"name":"customerId","in":"query","required":false,"schema":{"type":"string","pattern":"^\\d+$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"adGroupId":{"type":"string"},"sitelinks":{"type":"array","items":{"type":"object","properties":{"assetResourceName":{"type":"string"},"adGroupAssetResourceName":{"type":"string"},"text":{"type":"string"},"linkUrl":{"type":"string","format":"uri"},"description1":{"type":"string"},"description2":{"type":"string"}}}},"callouts":{"type":"array","items":{"type":"object","properties":{"assetResourceName":{"type":"string"},"adGroupAssetResourceName":{"type":"string"},"calloutText":{"type":"string"}}}},"structuredSnippets":{"type":"array","items":{"type":"object","properties":{"assetResourceName":{"type":"string"},"adGroupAssetResourceName":{"type":"string"},"header":{"type":"string"},"values":{"type":"array","items":{"type":"string"}}}}},"images":{"type":"array","items":{"type":"object","properties":{"assetResourceName":{"type":"string"},"adGroupAssetResourceName":{"type":"string"},"imageUrl":{"type":"string","format":"uri"},"width":{"type":"integer"},"height":{"type":"integer"}}}},"cachedAt":{"type":["string","null"],"format":"date-time"},"stale":{"type":"boolean"}}}}}}},"x-pozy-area":"ads"},"post":{"operationId":"attachAdGroupAssets","summary":"Attach ad-group assets","tags":["Ad Campaigns"],"parameters":[{"name":"adSetId","in":"path","required":true,"schema":{"type":"string","pattern":"^\\d+$"}}],"responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"adGroupId":{"type":"string"},"sitelinkAssetResourceNames":{"type":"array","items":{"type":"string"}},"calloutAssetResourceNames":{"type":"array","items":{"type":"string"}},"structuredSnippetAssetResourceNames":{"type":"array","items":{"type":"string"}},"imageAssetResourceNames":{"type":"array","items":{"type":"string"}}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId"],"properties":{"accountId":{"type":"string","pattern":"^[a-fA-F0-9]{24}$"},"adAccountId":{"type":"string","pattern":"^\\d+$"},"customerId":{"type":"string","deprecated":true,"pattern":"^\\d+$"},"sitelinks":{"type":"array","items":{"$ref":"#/components/schemas/GoogleSitelink"},"minItems":2,"maxItems":20},"callouts":{"type":"array","items":{"type":"string","minLength":1,"maxLength":25},"minItems":1,"maxItems":20},"structuredSnippets":{"type":"array","items":{"$ref":"#/components/schemas/GoogleStructuredSnippet"},"minItems":1,"maxItems":20},"images":{"type":"array","items":{"type":"string","format":"uri"},"minItems":1,"maxItems":20}}}}}},"x-pozy-area":"ads"},"put":{"operationId":"updateAdGroupAssets","summary":"Update ad-group assets","tags":["Ad Campaigns"],"parameters":[{"name":"adSetId","in":"path","required":true,"schema":{"type":"string","pattern":"^\\d+$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"updated":{"type":"integer"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","updates"],"properties":{"accountId":{"type":"string","pattern":"^[a-fA-F0-9]{24}$"},"adAccountId":{"type":"string","pattern":"^\\d+$"},"customerId":{"type":"string","deprecated":true,"pattern":"^\\d+$"},"updates":{"type":"array","items":{"$ref":"#/components/schemas/GoogleAssetUpdate"},"minItems":1,"maxItems":20}}}}}},"x-pozy-area":"ads"},"delete":{"operationId":"removeAdGroupAssets","summary":"Remove ad-group assets","tags":["Ad Campaigns"],"parameters":[{"name":"adSetId","in":"path","required":true,"schema":{"type":"string","pattern":"^\\d+$"}},{"name":"accountId","in":"query","required":true,"schema":{"type":"string","pattern":"^[a-fA-F0-9]{24}$"}},{"name":"adAccountId","in":"query","required":false,"schema":{"type":"string","pattern":"^\\d+$"}},{"name":"customerId","in":"query","required":false,"schema":{"type":"string","pattern":"^\\d+$"}},{"name":"assetResourceNames","in":"query","required":true,"schema":{"type":"array","minItems":1,"items":{"type":"string"}}},{"name":"adGroupAssetResourceNames","in":"query","required":true,"schema":{"type":"array","minItems":1,"items":{"type":"string"}}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"removed":{"type":"boolean"}}}}}}},"x-pozy-area":"ads"}},"/v1/ads/campaigns/{campaignId}/analytics":{"get":{"operationId":"getCampaignAnalytics","summary":"Get campaign analytics","tags":["Ad Insights"],"parameters":[{"name":"campaignId","in":"path","required":true,"schema":{"type":"string"}},{"name":"platform","in":"query","required":false,"schema":{"type":"string"}},{"name":"fromDate","in":"query","required":false,"schema":{"type":"string","format":"date"}},{"name":"toDate","in":"query","required":false,"schema":{"type":"string","format":"date"}},{"name":"breakdowns","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CampaignAnalyticsResponse"}}}}},"x-pozy-area":"ads"}},"/v1/ads/preview":{"post":{"operationId":"generateAdPreviews","summary":"Render pre-create ad previews","tags":["Ad Creatives"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"previews":{"type":"array","items":{"type":"object","properties":{"format":{"type":"string"},"html":{"type":["string","null"]}}}}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","adAccountId"],"properties":{"accountId":{"type":"string"},"adAccountId":{"type":"string"},"formats":{"type":"array","minItems":1,"maxItems":10,"items":{"type":"string"}},"existingCreativeId":{"type":"string"},"creativeSpec":{"type":"object","additionalProperties":true}}}}}},"x-pozy-area":"ads"}},"/v1/ads/{adId}/preview":{"get":{"operationId":"getAdPreviews","summary":"Render previews of an existing ad","tags":["Ad Creatives"],"parameters":[{"name":"adId","in":"path","required":true,"schema":{"type":"string"}},{"name":"accountId","in":"query","required":false,"schema":{"type":"string"}},{"name":"formats","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"adId":{"type":"string"},"synced":{"type":"boolean"},"previews":{"type":"array","items":{"type":"object","properties":{"format":{"type":"string"},"html":{"type":["string","null"]}}}}}}}}}},"x-pozy-area":"ads"}},"/v1/ads/{adId}/review":{"get":{"operationId":"getAdReview","summary":"Read the platform's review verdict for an ad","tags":["Ad Campaigns"],"parameters":[{"name":"adId","in":"path","required":true,"schema":{"type":"string"}},{"name":"accountId","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"adId":{"type":["string","null"]},"platform":{"type":"string"},"platformAdId":{"type":"string"},"synced":{"type":"boolean"},"review":{"type":"object","properties":{"approved":{"type":["boolean","null"]},"reviewStatus":{"type":["string","null"]},"forbiddenPlacements":{"type":"array","items":{"type":"string"}},"forbiddenAges":{"type":"array","items":{"type":"string"}},"forbiddenLocations":{"type":"array","items":{"type":"string"}},"forbiddenOperatingSystems":{"type":"array","items":{"type":"string"}},"rejections":{"type":"array","items":{"type":"object","properties":{"reasons":{"type":"array","items":{"type":"string"}},"suggestion":{"type":["string","null"]},"forbiddenPlacements":{"type":"array","items":{"type":"string"}},"forbiddenAges":{"type":"array","items":{"type":"string"}},"forbiddenLocations":{"type":"array","items":{"type":"string"}},"content":{"type":["object","null"],"properties":{"type":{"type":["string","null"]},"text":{"type":["string","null"]},"imageId":{"type":["string","null"]},"videoId":{"type":["string","null"]},"musicId":{"type":["string","null"]}}}}}},"approvalStatus":{"type":["string","null"]},"policyTopics":{"type":"array","items":{"type":"object","properties":{"topic":{"type":["string","null"]},"type":{"type":["string","null"]},"evidences":{"type":"array","items":{"type":"object"}},"constraints":{"type":"array","items":{"type":"object"}}}}},"reviewFeedback":{"type":"object","properties":{"global":{"type":"object","additionalProperties":{"type":"string"}},"placementSpecific":{"type":"object","additionalProperties":{"type":"object","additionalProperties":{"type":"string"}}}}},"issues":{"type":"array","items":{"type":"object"}},"readAt":{"type":"string","format":"date-time"}}}}}}}}},"x-pozy-area":"ads"}},"/v1/ads/{adId}/tiktok-smart-plus-review":{"get":{"operationId":"getTikTokSmartPlusAdReview","summary":"Review status of each creative in a TikTok Smart+ ad","tags":["Ad Campaigns"],"parameters":[{"name":"adId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"adId":{"type":"string"},"platform":{"type":"string","enum":["tiktok"]},"platformAdId":{"type":"string"},"smartPlusAdId":{"type":"string"},"review":{"$ref":"#/components/schemas/TikTokSmartPlusAdLevelReview"},"materials":{"type":"array","items":{"$ref":"#/components/schemas/TikTokSmartPlusMaterialReview"}},"readAt":{"type":"string","format":"date-time"}}}}}}},"x-pozy-area":"ads"}},"/v1/ads/{adId}/media":{"get":{"operationId":"getAdMedia","summary":"Direct video and image URLs for an ad","tags":["Ad Creatives"],"parameters":[{"name":"adId","in":"path","required":true,"schema":{"type":"string"}},{"name":"accountId","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"adId":{"type":"string"},"platform":{"type":"string"},"synced":{"type":"boolean"},"media":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["image","video"]},"url":{"type":"string"},"thumbnailUrl":{"type":"string"},"videoId":{"type":"string"},"length":{"type":"number"},"index":{"type":"integer"}}}}}}}}}},"x-pozy-area":"ads"}},"/v1/ads/keywords/ideas":{"post":{"operationId":"generateKeywordIdeas","summary":"Generate keyword ideas","tags":["Ad Insights"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"customerId":{"type":"string"},"data":{"type":"array","items":{"type":"object"}},"aggregateMetricResults":{"type":["object","null"]},"paging":{"type":"object","properties":{"nextPageToken":{"type":["string","null"]}}}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId"],"properties":{"accountId":{"type":"string"},"adAccountId":{"type":"string"},"customerId":{"type":"string","deprecated":true},"seedKeywords":{"type":"array","items":{"type":"string","maxLength":80},"minItems":1,"maxItems":20},"seedUrl":{"type":"string","format":"uri"},"countries":{"type":"array","items":{"type":"string","minLength":2,"maxLength":2},"minItems":1,"maxItems":10},"languageConstantId":{"type":"string","default":"1000"},"network":{"type":"string","enum":["GOOGLE_SEARCH","GOOGLE_SEARCH_AND_PARTNERS"],"default":"GOOGLE_SEARCH"},"includeAdultKeywords":{"type":"boolean"},"pageSize":{"type":"integer","minimum":1,"maximum":10000},"pageToken":{"type":"string"}}}}}},"x-pozy-area":"ads"}},"/v1/ads/keywords/historical-metrics":{"post":{"operationId":"generateKeywordHistoricalMetrics","summary":"Get historical keyword metrics","tags":["Ad Insights"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"customerId":{"type":"string"},"data":{"type":"array","items":{"type":"object"}},"aggregateMetricResults":{"type":["object","null"]}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","keywords"],"properties":{"accountId":{"type":"string"},"adAccountId":{"type":"string"},"customerId":{"type":"string","deprecated":true},"keywords":{"type":"array","items":{"type":"string","maxLength":80},"minItems":1,"maxItems":1000},"countries":{"type":"array","items":{"type":"string","minLength":2,"maxLength":2},"minItems":1,"maxItems":10},"languageConstantId":{"type":"string","default":"1000"},"network":{"type":"string","enum":["GOOGLE_SEARCH","GOOGLE_SEARCH_AND_PARTNERS"],"default":"GOOGLE_SEARCH"},"includeAdultKeywords":{"type":"boolean"},"includeAverageCpc":{"type":"boolean"}}}}}},"x-pozy-area":"ads"}},"/v1/ads/insights":{"get":{"operationId":"queryAdInsights","summary":"Flexible live insights query","tags":["Ad Insights"],"parameters":[{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}},{"name":"objectId","in":"query","required":false,"schema":{"type":"string"}},{"name":"query","in":"query","required":false,"schema":{"type":"string","maxLength":10000}},{"name":"adAccountId","in":"query","required":false,"schema":{"type":"string"}},{"name":"reportType","in":"query","required":false,"schema":{"type":"string","enum":["BASIC","AUDIENCE"],"default":"BASIC"}},{"name":"dataLevel","in":"query","required":false,"schema":{"type":"string","enum":["AUCTION_ADVERTISER","AUCTION_CAMPAIGN","AUCTION_ADGROUP","AUCTION_AD"]}},{"name":"dimensions","in":"query","required":false,"schema":{"type":"string"}},{"name":"metrics","in":"query","required":false,"schema":{"type":"string"}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"default":1}},{"name":"pageSize","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":1000,"default":100}},{"name":"customerId","in":"query","required":false,"schema":{"type":"string"}},{"name":"pageToken","in":"query","required":false,"schema":{"type":"string"}},{"name":"level","in":"query","required":false,"schema":{"type":"string","enum":["ad","adset","campaign","account"]}},{"name":"fields","in":"query","required":false,"schema":{"type":"string"}},{"name":"breakdowns","in":"query","required":false,"schema":{"type":"string"}},{"name":"actionBreakdowns","in":"query","required":false,"schema":{"type":"string"}},{"name":"actionAttributionWindows","in":"query","required":false,"schema":{"type":"string"}},{"name":"actionReportTime","in":"query","required":false,"schema":{"type":"string"}},{"name":"useUnifiedAttributionSetting","in":"query","required":false,"schema":{"type":"boolean"}},{"name":"filtering","in":"query","required":false,"schema":{"type":"string"}},{"name":"datePreset","in":"query","required":false,"schema":{"type":"string"}},{"name":"fromDate","in":"query","required":false,"schema":{"type":"string","format":"date"}},{"name":"toDate","in":"query","required":false,"schema":{"type":"string","format":"date"}},{"name":"timeIncrement","in":"query","required":false,"schema":{"type":"string"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":500,"default":25}},{"name":"after","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"objectId":{"type":"string"},"adAccountId":{"type":"string"},"customerId":{"type":"string"},"fieldMask":{"type":["string","null"]},"data":{"type":"array","items":{"type":"object"}},"paging":{"type":"object","properties":{"after":{"type":["string","null"]},"nextPageToken":{"type":["string","null"]},"page":{"type":"integer"},"pageSize":{"type":"integer"},"totalRows":{"type":"integer"},"totalPages":{"type":"integer"}}}}}}}}},"x-pozy-area":"ads"}},"/v1/ads/insights/reports":{"post":{"operationId":"createAdInsightsReport","summary":"Submit async insights report","tags":["Ad Insights"],"responses":{"202":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"reportRunId":{"type":"string"},"status":{"type":"string"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","objectId"],"properties":{"accountId":{"type":"string"},"objectId":{"type":"string"},"level":{"type":"string","enum":["ad","adset","campaign","account"]},"fields":{"type":"string"},"breakdowns":{"type":"string"},"actionBreakdowns":{"type":"string"},"actionAttributionWindows":{"type":"array","items":{"type":"string"}},"actionReportTime":{"type":"string"},"useUnifiedAttributionSetting":{"type":"boolean"},"filtering":{"type":"array","items":{"type":"object","required":["field","operator"],"properties":{"field":{"type":"string"},"operator":{"type":"string"},"value":{}}}},"datePreset":{"type":"string"},"fromDate":{"type":"string","format":"date"},"toDate":{"type":"string","format":"date"},"timeIncrement":{"oneOf":[{"type":"integer","minimum":1,"maximum":90},{"type":"string","enum":["monthly","all_days"]}]}}}}}},"x-pozy-area":"ads"}},"/v1/ads/insights/reports/{reportRunId}":{"get":{"operationId":"getAdInsightsReport","summary":"Poll an async insights report run","tags":["Ad Insights"],"parameters":[{"name":"reportRunId","in":"path","required":true,"schema":{"type":"string"}},{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":500,"default":25}},{"name":"after","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"reportRunId":{"type":"string"},"status":{"type":"string"},"percentCompletion":{"type":"integer"},"dateStart":{"type":"string"},"dateStop":{"type":"string"},"data":{"type":"array","items":{"type":"object"}},"paging":{"type":"object","properties":{"after":{"type":["string","null"]}}}}}}}}},"x-pozy-area":"ads"}},"/v1/ads/{adId}/analytics":{"get":{"operationId":"getAdAnalytics","summary":"Get ad analytics","tags":["Ad Insights"],"parameters":[{"name":"adId","in":"path","required":true,"schema":{"type":"string"}},{"name":"fromDate","in":"query","required":false,"schema":{"type":"string","format":"date"}},{"name":"toDate","in":"query","required":false,"schema":{"type":"string","format":"date"}},{"name":"breakdowns","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdAnalyticsResponse"}}}}},"x-pozy-area":"ads"}},"/v1/ads/{adId}/tracking-tags":{"get":{"operationId":"getAdTrackingTags","summary":"Get ad tracking tags","tags":["Tracking Tags"],"parameters":[{"name":"adId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"platform":{"type":"string"},"level":{"type":"string","enum":["creative","campaign"]},"urlTags":{"type":["string","null"]},"templateUrlSpec":{"type":["object","null"]},"trackingUrlTemplate":{"type":["string","null"]},"finalUrlSuffix":{"type":["string","null"]},"dynamicValueParameters":{"type":["object","null"]},"customValueParameters":{"type":["object","null"]}}}}}}},"x-pozy-area":"ads"},"patch":{"operationId":"updateAdTrackingTags","summary":"Set ad tracking tags","tags":["Tracking Tags"],"parameters":[{"name":"adId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"platform":{"type":"string"}},"additionalProperties":true}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"urlTags":{"type":"array","items":{"type":"object","required":["key","value"],"properties":{"key":{"type":"string"},"value":{"type":"string"}}}},"creative":{"type":"object","required":["headline","body","callToAction","linkUrl","imageUrl"],"properties":{"headline":{"type":"string"},"body":{"type":"string"},"callToAction":{"type":"string"},"linkUrl":{"type":"string","format":"uri"},"imageUrl":{"type":"string","format":"uri"},"videoUrl":{"type":"string","format":"uri"}}},"trackingUrlTemplate":{"type":"string"},"finalUrlSuffix":{"type":"string"},"dynamicValueParameters":{"type":"object","additionalProperties":{"type":"string"}},"customValueParameters":{"type":"object","additionalProperties":{"type":"string"}}}}}}},"x-pozy-area":"ads"}},"/v1/ads/{adId}/comments":{"get":{"operationId":"getAdComments","summary":"List comments on an ad","tags":["Ad Accounts"],"parameters":[{"name":"adId","in":"path","required":true,"schema":{"type":"string"}},{"name":"placement","in":"query","required":false,"schema":{"type":"string","enum":["facebook","instagram"]}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":100,"default":25}},{"name":"since","in":"query","required":false,"schema":{"type":"string","format":"date"}},{"name":"until","in":"query","required":false,"schema":{"type":"string","format":"date"}},{"name":"cursor","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","required":["status","comments","pagination","meta"],"properties":{"status":{"type":"string","enum":["success"]},"comments":{"type":"array","items":{"type":"object"}},"pagination":{"type":"object","properties":{"hasMore":{"type":"boolean"},"cursor":{"type":"string"}}},"meta":{"type":"object","required":["platform","adId","accountId","lastUpdated"],"properties":{"platform":{"type":"string","enum":["facebook","instagram","tiktok"]},"placement":{"type":"string","enum":["facebook","instagram"]},"adId":{"type":"string"},"platformAdId":{"type":"string"},"effectiveStoryId":{"type":"string"},"tiktokItemId":{"type":["string","null"]},"since":{"type":"string","format":"date"},"until":{"type":"string","format":"date"},"facebookAccountId":{"type":["string","null"]},"instagramUserId":{"type":"string"},"instagramPermalink":{"type":"string"},"instagramAccountId":{"type":"string"},"accountId":{"type":"string"},"lastUpdated":{"type":"string","format":"date-time"}}}}}}}}},"x-pozy-area":"ads"}},"/v1/ads/{adId}/comments/{commentId}/reply":{"post":{"operationId":"replyToAdComment","summary":"Reply to an ad comment","tags":["Ad Accounts"],"parameters":[{"name":"adId","in":"path","required":true,"schema":{"type":"string"}},{"name":"commentId","in":"path","required":true,"schema":{"type":"string","pattern":"^\\d+$"}},{"name":"since","in":"query","required":false,"schema":{"type":"string","format":"date"}},{"name":"until","in":"query","required":false,"schema":{"type":"string","format":"date"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","required":["status","commentId"],"properties":{"status":{"type":"string","enum":["success"]},"commentId":{"type":"string"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["text"],"properties":{"text":{"type":"string","minLength":1}}}}}},"x-pozy-area":"ads"}},"/v1/ads/{adId}/comments/{commentId}/hide":{"post":{"operationId":"hideAdComment","summary":"Hide or unhide an ad comment","tags":["Ad Accounts"],"parameters":[{"name":"adId","in":"path","required":true,"schema":{"type":"string"}},{"name":"commentId","in":"path","required":true,"schema":{"type":"string","pattern":"^\\d+$"}},{"name":"since","in":"query","required":false,"schema":{"type":"string","format":"date"}},{"name":"until","in":"query","required":false,"schema":{"type":"string","format":"date"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","required":["status","commentId"],"properties":{"status":{"type":"string","enum":["success"]},"commentId":{"type":"string"},"hidden":{"type":"boolean"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["hidden"],"properties":{"hidden":{"type":"boolean"}}}}}},"x-pozy-area":"ads"}},"/v1/ads/{adId}/comments/{commentId}":{"delete":{"operationId":"deleteAdComment","summary":"Delete an ad comment","tags":["Ad Accounts"],"parameters":[{"name":"adId","in":"path","required":true,"schema":{"type":"string"}},{"name":"commentId","in":"path","required":true,"schema":{"type":"string","pattern":"^\\d+$"}},{"name":"since","in":"query","required":false,"schema":{"type":"string","format":"date"}},{"name":"until","in":"query","required":false,"schema":{"type":"string","format":"date"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","required":["status","commentId"],"properties":{"status":{"type":"string","enum":["success"]},"commentId":{"type":"string"}}}}}}},"x-pozy-area":"ads"}},"/v1/ads/business-centers":{"get":{"operationId":"listAdsBusinessCenters","summary":"List TikTok Business Centers","tags":["Ad Accounts"],"parameters":[{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"businessCenters":{"type":"array","items":{"$ref":"#/components/schemas/BusinessCenter"}}}}}}}},"x-pozy-area":"ads"}},"/v1/ads/alerts":{"get":{"operationId":"listAdsAlerts","summary":"List ads that need attention","tags":["Ad Campaigns"],"parameters":[{"name":"accountId","in":"query","required":false,"schema":{"type":"string"}},{"name":"profileId","in":"query","required":false,"schema":{"type":"string"}},{"name":"includeDismissed","in":"query","required":false,"schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"alerts":{"type":"array","items":{"$ref":"#/components/schemas/AdsAlert"}},"counts":{"type":"object","properties":{"error":{"type":"integer"},"warning":{"type":"integer"},"info":{"type":"integer"}}}}}}}}},"x-pozy-area":"ads"}},"/v1/ads/alerts/{alertId}/dismiss":{"post":{"operationId":"dismissAdsAlert","summary":"Dismiss an ads alert","tags":["Ad Campaigns"],"parameters":[{"name":"alertId","in":"path","required":true,"schema":{"type":"string","maxLength":200}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"dismissed":{"type":"boolean"},"dismissedUntil":{"type":"string","format":"date-time"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"x-pozy-area":"ads"}},"/v1/ads/activity":{"get":{"operationId":"getAdsActivityLog","summary":"Ad account change / audit log","tags":["Ad Accounts"],"parameters":[{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}},{"name":"adAccountId","in":"query","required":true,"schema":{"type":"string"}},{"name":"since","in":"query","required":false,"schema":{"type":"string","format":"date"}},{"name":"until","in":"query","required":false,"schema":{"type":"string","format":"date"}},{"name":"objectId","in":"query","required":false,"schema":{"type":"string"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":200,"default":50}},{"name":"after","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"adAccountId":{"type":"string"},"data":{"type":"array","items":{"type":"object"}},"paging":{"type":"object","properties":{"after":{"type":["string","null"]}}}}}}}}},"x-pozy-area":"ads"}},"/v1/ads/rf-predictions":{"post":{"operationId":"createRfPrediction","summary":"Create reach-frequency prediction","tags":["Reach and Frequency"],"responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"adAccountId":{"type":"string"},"currency":{"type":"string"},"prediction":{"$ref":"#/components/schemas/RfPrediction"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","adAccountId","startDate","endDate"],"properties":{"accountId":{"type":"string"},"adAccountId":{"type":"string"},"budgetAmount":{"type":"number"},"reach":{"type":"integer"},"startDate":{"type":"string","format":"date-time"},"endDate":{"type":"string","format":"date-time"},"frequencyCap":{"type":"integer","minimum":1,"maximum":90},"targeting":{"type":"object"},"placements":{"type":"object"}}}}}},"x-pozy-area":"ads"}},"/v1/ads/rf-predictions/{predictionId}":{"get":{"operationId":"getRfPrediction","summary":"Get reach-frequency prediction","tags":["Reach and Frequency"],"parameters":[{"name":"predictionId","in":"path","required":true,"schema":{"type":"string"}},{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}},{"name":"adAccountId","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"adAccountId":{"type":"string"},"currency":{"type":"string"},"prediction":{"$ref":"#/components/schemas/RfPrediction"}}}}}}},"x-pozy-area":"ads"},"delete":{"operationId":"cancelRfReservation","summary":"Cancel reach-frequency booking","tags":["Reach and Frequency"],"parameters":[{"name":"predictionId","in":"path","required":true,"schema":{"type":"string"}},{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}},{"name":"adAccountId","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"}},"x-pozy-area":"ads"}},"/v1/ads/rf-predictions/{predictionId}/reserve":{"post":{"operationId":"reserveRfPrediction","summary":"Reserve reach-frequency inventory","tags":["Reach and Frequency"],"parameters":[{"name":"predictionId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"adAccountId":{"type":"string"},"prediction":{"$ref":"#/components/schemas/RfPrediction"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","adAccountId"],"properties":{"accountId":{"type":"string"},"adAccountId":{"type":"string"}}}}}},"x-pozy-area":"ads"}},"/v1/ads/studies":{"get":{"operationId":"listAdStudies","summary":"A/B tests and lift studies","tags":["Ad Accounts"],"parameters":[{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}},{"name":"adAccountId","in":"query","required":true,"schema":{"type":"string"}},{"name":"fields","in":"query","required":false,"schema":{"type":"string"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":100,"default":25}},{"name":"after","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"adAccountId":{"type":"string"},"data":{"type":"array","items":{"type":"object"}},"paging":{"type":"object","properties":{"after":{"type":["string","null"]}}}}}}}}},"x-pozy-area":"ads"}},"/v1/ads/tiktok-identities":{"get":{"operationId":"listAdsTikTokIdentities","summary":"List TikTok ad identities","tags":["Ad Creatives"],"parameters":[{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}},{"name":"adAccountId","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"adAccountId":{"type":"string"},"identities":{"type":"array","items":{"type":"object","properties":{"identityId":{"type":"string"},"identityType":{"type":"string","enum":["TT_USER","BC_AUTH_TT","CUSTOMIZED_USER"]},"displayName":{"type":["string","null"]},"username":{"type":["string","null"]},"profileImage":{"type":["string","null"]},"identityAuthorizedBcId":{"type":["string","null"]}}}}}}}}}},"x-pozy-area":"ads"}},"/v1/ads/tiktok-smart-plus-materials":{"get":{"operationId":"getTikTokSmartPlusMaterialReport","summary":"Per-creative performance inside TikTok Smart+ ads","tags":["Ad Insights"],"parameters":[{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}},{"name":"adAccountId","in":"query","required":true,"schema":{"type":"string"}},{"name":"startDate","in":"query","required":true,"schema":{"type":"string","format":"date"}},{"name":"endDate","in":"query","required":true,"schema":{"type":"string","format":"date"}},{"name":"level","in":"query","required":false,"schema":{"type":"string","enum":["ad","adGroup"],"default":"ad"}},{"name":"smartPlusAdIds","in":"query","required":false,"schema":{"type":"string"}},{"name":"adGroupIds","in":"query","required":false,"schema":{"type":"string"}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"default":1}},{"name":"pageSize","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":1000,"default":100}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"adAccountId":{"type":"string"},"level":{"type":"string","enum":["ad","adGroup"]},"startDate":{"type":"string"},"endDate":{"type":"string"},"page":{"type":"integer"},"pageSize":{"type":"integer"},"totalRows":{"type":"integer"},"totalPages":{"type":"integer"},"missingRows":{"type":"integer"},"rows":{"type":"array","items":{"type":"object","properties":{"materialId":{"type":"string"},"materialType":{"type":["string","null"]},"tiktokItemId":{"type":["string","null"]},"name":{"type":["string","null"]},"smartPlusAdId":{"type":["string","null"]},"adGroupId":{"type":["string","null"]},"metrics":{"type":"object","properties":{"spend":{"type":["number","null"]},"impressions":{"type":["number","null"]},"clicks":{"type":["number","null"]},"cpc":{"type":["number","null"]},"addToCart":{"type":["number","null"]},"initiateCheckout":{"type":["number","null"]},"addPaymentInfo":{"type":["number","null"]},"purchases":{"type":["number","null"]},"purchaseValue":{"type":["number","null"]},"roas":{"type":["number","null"]}}}}}}}}}}}},"x-pozy-area":"ads"}},"/v1/ads/tiktok-smart-plus-reviews":{"get":{"operationId":"listTikTokSmartPlusReviews","summary":"Review status of every TikTok Smart+ ad of an advertiser","tags":["Ad Campaigns"],"parameters":[{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}},{"name":"adAccountId","in":"query","required":true,"schema":{"type":"string"}},{"name":"includeDeleted","in":"query","required":false,"schema":{"type":"boolean","default":false}},{"name":"maxAgeSeconds","in":"query","required":false,"schema":{"type":"integer","minimum":600,"maximum":86400,"default":3600}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"default":1}},{"name":"pageSize","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":1000,"default":500}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"adAccountId":{"type":"string"},"includeDeleted":{"type":"boolean"},"maxAgeSeconds":{"type":"integer"},"page":{"type":"integer"},"pageSize":{"type":"integer"},"totalPages":{"type":"integer"},"totalSmartPlusAds":{"type":"integer"},"listing":{"type":"object","properties":{"readAt":{"type":"string","format":"date-time"},"source":{"type":"string","enum":["fresh","fallback"]},"error":{"type":["object","null"],"properties":{"tiktokCode":{"type":["integer","null"]},"message":{"type":"string"}}}}},"reviewError":{"type":["object","null"],"properties":{"tiktokCode":{"type":["integer","null"]},"message":{"type":"string"}}},"counts":{"type":"object","properties":{"fresh":{"type":"integer"},"stale":{"type":"integer"},"pending":{"type":"integer"},"failed":{"type":"integer"}}},"oldestReadAt":{"type":["string","null"],"format":"date-time"},"items":{"type":"array","items":{"type":"object","properties":{"smartPlusAdId":{"type":"string"},"adGroupId":{"type":["string","null"]},"campaignId":{"type":["string","null"]},"review":{"$ref":"#/components/schemas/TikTokSmartPlusAdLevelReview"},"materials":{"type":"array","items":{"$ref":"#/components/schemas/TikTokSmartPlusMaterialReview"}},"readAt":{"type":"string","format":"date-time"}}}},"failedSmartPlusAds":{"type":"array","items":{"type":"object","properties":{"smartPlusAdId":{"type":"string"},"adGroupId":{"type":["string","null"]},"campaignId":{"type":["string","null"]},"error":{"type":"object","properties":{"tiktokCode":{"type":["integer","null"]},"message":{"type":"string"}}},"refusedAt":{"type":["string","null"],"format":"date-time"}}}},"incomplete":{"type":"boolean"},"allFresh":{"type":"boolean"},"pendingSmartPlusAdIds":{"type":"array","items":{"type":"string"}},"retryAfterSeconds":{"type":["integer","null"]},"refreshState":{"type":"string","enum":["ok","paused","refused","error"]}}}}}}},"x-pozy-area":"ads"}},"/v1/ads/instagram-accounts":{"get":{"operationId":"listAdsInstagramAccounts","summary":"List Instagram ad identities","tags":["Ad Accounts"],"parameters":[{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}},{"name":"adAccountId","in":"query","required":true,"schema":{"type":"string","pattern":"^act_[0-9]+$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","required":["accounts","pages","resolved"],"properties":{"accounts":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/MetaInstagramIdentityRef"},{"type":"object","required":["isPageBacked","source"],"properties":{"isPageBacked":{"type":"boolean"},"source":{"type":"string","enum":["ad_account","page_backed","business"]}}}]}},"pages":{"type":"array","items":{"type":"object","required":["pageId","name"],"properties":{"pageId":{"type":"string"},"name":{"type":"string"},"instagramBusinessAccount":{"$ref":"#/components/schemas/MetaInstagramIdentityRef"},"connectedInstagramAccount":{"$ref":"#/components/schemas/MetaInstagramIdentityRef"}}}},"resolved":{"type":"object","required":["pageId","igUserId","source"],"properties":{"pageId":{"type":["string","null"]},"igUserId":{"type":["string","null"]},"source":{"type":["string","null"],"enum":["ad_account","page_backed","business",null]}}}}}}}}},"x-pozy-area":"ads"}},"/v1/ads/instagram-posts":{"get":{"operationId":"listAdsInstagramPosts","summary":"List Instagram posts to boost","tags":["Ad Accounts"],"parameters":[{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}},{"name":"adAccountId","in":"query","required":false,"schema":{"type":"string","pattern":"^act_[0-9]+$"}},{"name":"igUserId","in":"query","required":false,"schema":{"type":"string"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":100,"default":25}},{"name":"after","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","required":["igUserId","username","posts","paging"],"properties":{"igUserId":{"type":"string"},"username":{"type":"string"},"posts":{"type":"array","items":{"type":"object","required":["id","mediaType","timestamp"],"properties":{"id":{"type":"string"},"caption":{"type":"string"},"mediaType":{"type":"string"},"mediaUrl":{"type":"string"},"thumbnailUrl":{"type":"string"},"permalink":{"type":"string"},"timestamp":{"type":"string"}}}},"paging":{"type":"object","required":["after"],"properties":{"after":{"type":["string","null"]}}}}}}}}},"x-pozy-area":"ads"}},"/v1/ads/advertisable-applications":{"get":{"operationId":"listAdvertisableApplications","summary":"List advertisable apps","tags":["Ad Accounts"],"parameters":[{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}},{"name":"adAccountId","in":"query","required":true,"schema":{"type":"string","pattern":"^act_[0-9]+$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","required":["applications"],"properties":{"applications":{"type":"array","items":{"type":"object","required":["id","name","supportedPlatforms","storeUrls"],"properties":{"id":{"type":"string"},"name":{"type":"string"},"supportedPlatforms":{"type":"array","items":{"type":"string"}},"storeUrls":{"type":"object","additionalProperties":{"type":"string"}}}}}}}}}}},"x-pozy-area":"ads"}},"/v1/ads/ios-fourteen-campaign-limits":{"get":{"operationId":"getIosFourteenCampaignLimits","summary":"Get iOS 14 campaign limits","tags":["Ad Accounts"],"parameters":[{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}},{"name":"adAccountId","in":"query","required":true,"schema":{"type":"string","pattern":"^act_[0-9]+$"}},{"name":"applicationId","in":"query","required":true,"schema":{"type":"string","pattern":"^[0-9]+$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","required":["limits"],"properties":{"limits":{"type":["object","null"],"properties":{"campaignGroupLimit":{"type":["number","null"]},"campaignLimit":{"type":["number","null"]},"campaignGroupLimitsDetails":{"type":"array","items":{}}}}}}}}}},"x-pozy-area":"ads"}},"/v1/ads/businesses":{"get":{"operationId":"listMetaBusinesses","summary":"Businesses list","tags":["Ad Accounts"],"parameters":[{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":100,"default":25}},{"name":"after","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object"}},"paging":{"type":"object","properties":{"after":{"type":["string","null"]}}}}}}}}},"x-pozy-area":"ads"}},"/v1/ads/businesses/users":{"get":{"operationId":"listMetaBusinessUsers","summary":"Business users","tags":["Ad Accounts"],"parameters":[{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}},{"name":"businessId","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"businessId":{"type":"string"},"users":{"type":"array","items":{"$ref":"#/components/schemas/MetaBusinessUser"}},"systemUsers":{"type":"array","items":{"$ref":"#/components/schemas/MetaBusinessUser"}}}}}}}},"x-pozy-area":"ads"}},"/v1/ads/page-users":{"get":{"operationId":"listPageUsers","summary":"Page users of a business","tags":["Ad Accounts"],"parameters":[{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}},{"name":"pageId","in":"query","required":true,"schema":{"type":"string"}},{"name":"businessId","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"pageId":{"type":"string"},"businessId":{"type":"string"},"users":{"type":"array","items":{"$ref":"#/components/schemas/MetaAssignedUser"}}}}}}}},"x-pozy-area":"ads"},"post":{"operationId":"assignPageUser","summary":"Assign a user to a Page","tags":["Ad Accounts"],"responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"pageId":{"type":"string"},"businessId":{"type":"string"},"user":{"type":"object","properties":{"id":{"type":"string"},"tasks":{"type":"array","items":{"type":"string"}}}}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","pageId","businessId","userId","tasks"],"properties":{"accountId":{"type":"string"},"pageId":{"type":"string"},"businessId":{"type":"string"},"userId":{"type":"string"},"tasks":{"type":"array","minItems":1,"items":{"type":"string","enum":["MANAGE","CREATE_CONTENT","MODERATE","MESSAGING","ADVERTISE","ANALYZE"]}}}}}}},"x-pozy-area":"ads"},"delete":{"operationId":"removePageUser","summary":"Remove a user from a Page","tags":["Ad Accounts"],"parameters":[{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}},{"name":"pageId","in":"query","required":true,"schema":{"type":"string"}},{"name":"userId","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"pageId":{"type":"string"},"userId":{"type":"string"},"removed":{"type":"boolean"}}}}}}},"x-pozy-area":"ads"}},"/v1/ads/labels":{"get":{"operationId":"listAdLabels","summary":"List ad labels","tags":["Ad Accounts"],"parameters":[{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}},{"name":"adAccountId","in":"query","required":false,"schema":{"type":"string","pattern":"^(act_)?\\d+$"}},{"name":"customerId","in":"query","required":false,"schema":{"type":"string","pattern":"^\\d+$"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":100,"default":25}},{"name":"after","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"adAccountId":{"type":"string"},"data":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/GoogleAdLabel"},{"type":"object"}]}},"paging":{"type":"object","properties":{"after":{"type":["string","null"]}}},"cachedAt":{"type":["string","null"],"format":"date-time"},"stale":{"type":"boolean"}}}}}}},"x-pozy-area":"ads"},"post":{"operationId":"createAdLabel","summary":"Create a Google Ads label","tags":["Ad Accounts"],"responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"customerId":{"type":"string"},"id":{"type":"string"},"resourceName":{"type":"string"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["accountId","name"],"properties":{"accountId":{"type":"string"},"adAccountId":{"type":"string","pattern":"^\\d+$"},"customerId":{"type":"string","pattern":"^\\d+$","deprecated":true},"name":{"type":"string","minLength":1,"maxLength":80},"backgroundColor":{"type":"string","pattern":"^#[0-9a-fA-F]{6}$"},"description":{"type":"string","maxLength":200}}}}}},"x-pozy-area":"ads"}},"/v1/ads/labels/{labelId}":{"patch":{"operationId":"updateAdLabel","summary":"Update a Google Ads label","tags":["Ad Accounts"],"parameters":[{"name":"labelId","in":"path","required":true,"schema":{"type":"string","pattern":"^\\d+$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"customerId":{"type":"string"},"label":{"$ref":"#/components/schemas/GoogleAdLabel"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["accountId"],"minProperties":2,"properties":{"accountId":{"type":"string"},"adAccountId":{"type":"string","pattern":"^\\d+$"},"customerId":{"type":"string","pattern":"^\\d+$","deprecated":true},"name":{"type":"string","minLength":1,"maxLength":80},"backgroundColor":{"type":"string","pattern":"^#[0-9a-fA-F]{6}$"},"description":{"type":"string","maxLength":200}}}}}},"x-pozy-area":"ads"},"delete":{"operationId":"removeAdLabel","summary":"Remove a Google Ads label","tags":["Ad Accounts"],"parameters":[{"name":"labelId","in":"path","required":true,"schema":{"type":"string","pattern":"^\\d+$"}},{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}},{"name":"adAccountId","in":"query","required":false,"schema":{"type":"string","pattern":"^\\d+$"}},{"name":"customerId","in":"query","required":false,"schema":{"type":"string","pattern":"^\\d+$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"customerId":{"type":"string"},"labelId":{"type":"string"},"removed":{"type":"boolean"}}}}}}},"x-pozy-area":"ads"}},"/v1/ads/labels/{labelId}/assignments":{"post":{"operationId":"attachAdLabel","summary":"Attach a Google Ads label","tags":["Ad Accounts"],"parameters":[{"name":"labelId","in":"path","required":true,"schema":{"type":"string","pattern":"^\\d+$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"customerId":{"type":"string"},"labelId":{"type":"string"},"attached":{"type":"integer"},"unchanged":{"type":"integer"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleAdLabelAssignments"}}}},"x-pozy-area":"ads"},"delete":{"operationId":"detachAdLabel","summary":"Detach a Google Ads label","tags":["Ad Accounts"],"parameters":[{"name":"labelId","in":"path","required":true,"schema":{"type":"string","pattern":"^\\d+$"}},{"name":"accountId","in":"query","required":true,"schema":{"type":"string","pattern":"^[a-fA-F0-9]{24}$"}},{"name":"adAccountId","in":"query","required":false,"schema":{"type":"string","pattern":"^\\d+$"}},{"name":"customerId","in":"query","required":false,"schema":{"type":"string","pattern":"^\\d+$"}},{"name":"campaignIds","in":"query","required":false,"schema":{"type":"array","minItems":1,"maxItems":1000,"items":{"type":"string","pattern":"^\\d+$"}}},{"name":"adSetIds","in":"query","required":false,"schema":{"type":"array","minItems":1,"maxItems":1000,"items":{"type":"string","pattern":"^\\d+$"}}},{"name":"adIds","in":"query","required":false,"schema":{"type":"array","minItems":1,"maxItems":1000,"items":{"type":"string","pattern":"^\\d+~\\d+$"}}},{"name":"keywordIds","in":"query","required":false,"schema":{"type":"array","minItems":1,"maxItems":1000,"items":{"type":"string","pattern":"^\\d+~\\d+$"}}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"customerId":{"type":"string"},"labelId":{"type":"string"},"detached":{"type":"integer"},"unchanged":{"type":"integer"}}}}}}},"x-pozy-area":"ads"}},"/v1/ads/high-demand-periods":{"get":{"operationId":"listHighDemandPeriods","summary":"List high-demand periods","tags":["Ad Accounts"],"parameters":[{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}},{"name":"campaignId","in":"query","required":false,"schema":{"type":"string"}},{"name":"adSetId","in":"query","required":false,"schema":{"type":"string"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":100,"default":25}},{"name":"after","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"objectId":{"type":"string"},"data":{"type":"array","items":{"type":"object"}},"paging":{"type":"object","properties":{"after":{"type":["string","null"]}}}}}}}}},"x-pozy-area":"ads"},"post":{"operationId":"createHighDemandPeriod","summary":"Schedule a budget increase","tags":["Ad Accounts"],"responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"objectId":{"type":"string"},"id":{"type":"string"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","budgetValue","budgetValueType","timeStart","timeEnd"],"properties":{"accountId":{"type":"string"},"campaignId":{"type":"string"},"adSetId":{"type":"string"},"budgetValue":{"type":"number"},"budgetValueType":{"type":"string","enum":["ABSOLUTE","MULTIPLIER"]},"timeStart":{"type":"integer"},"timeEnd":{"type":"integer"},"recurrenceType":{"type":"string","enum":["ONE_TIME","WEEKLY","MONTHLY"]},"currency":{"type":"string"}}}}}},"x-pozy-area":"ads"}},"/v1/ads/creatives":{"get":{"operationId":"listAdCreatives","summary":"Creative library","tags":["Ad Creatives"],"parameters":[{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}},{"name":"adAccountId","in":"query","required":true,"schema":{"type":"string"}},{"name":"fields","in":"query","required":false,"schema":{"type":"string"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":100,"default":25}},{"name":"after","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"adAccountId":{"type":"string"},"data":{"type":"array","items":{"type":"object"}},"paging":{"type":"object","properties":{"after":{"type":["string","null"]}}}}}}}}},"x-pozy-area":"ads"},"post":{"operationId":"createAdCreative","summary":"Create a standalone creative","tags":["Ad Creatives"],"responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"adAccountId":{"type":"string"},"creativeId":{"type":"string"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","adAccountId","headline","body","linkUrl"],"properties":{"accountId":{"type":"string"},"adAccountId":{"type":"string"},"headline":{"type":"string","maxLength":255},"body":{"type":"string"},"description":{"type":"string","maxLength":255},"callToAction":{"type":"string","default":"LEARN_MORE"},"linkUrl":{"type":"string","format":"uri"},"imageUrl":{"type":"string","format":"uri"},"imageHash":{"type":"string"},"carouselCards":{"type":"array","minItems":2,"maxItems":10,"items":{"type":"object","required":["imageUrl","linkUrl"],"properties":{"imageUrl":{"type":"string","format":"uri"},"linkUrl":{"type":"string","format":"uri"},"headline":{"type":"string","maxLength":255},"description":{"type":"string","maxLength":255},"callToAction":{"type":"string"}}}},"optimizeCardOrder":{"type":"boolean"},"urlTags":{"type":"string"},"promotion":{"$ref":"#/components/schemas/MetaPromotion"},"creativeFeatures":{"$ref":"#/components/schemas/MetaCreativeFeatures"},"multiAdvertiser":{"type":"string","enum":["OPT_IN","OPT_OUT"]},"aiDisclosure":{"type":"string","enum":["OPT_IN","OPT_OUT"]}}}}}},"x-pozy-area":"ads"}},"/v1/ads/creatives/{creativeId}":{"get":{"operationId":"getAdCreative","summary":"Creative details","tags":["Ad Creatives"],"parameters":[{"name":"creativeId","in":"path","required":true,"schema":{"type":"string"}},{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}},{"name":"fields","in":"query","required":false,"schema":{"type":"string"}},{"name":"thumbnailWidth","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":4096}},{"name":"thumbnailHeight","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":4096}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"creative":{"type":"object"}}}}}}},"x-pozy-area":"ads"},"put":{"operationId":"updateAdCreative","summary":"Rename a creative","tags":["Ad Creatives"],"parameters":[{"name":"creativeId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"creativeId":{"type":"string"},"name":{"type":"string"},"message":{"type":"string"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","name"],"properties":{"accountId":{"type":"string"},"name":{"type":"string","maxLength":255}}}}}},"x-pozy-area":"ads"},"delete":{"operationId":"deleteAdCreative","summary":"Delete a creative","tags":["Ad Creatives"],"parameters":[{"name":"creativeId","in":"path","required":true,"schema":{"type":"string"}},{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"creativeId":{"type":"string"},"message":{"type":"string"}}}}}}},"x-pozy-area":"ads"}},"/v1/ads/value-rule-sets":{"get":{"operationId":"listValueRuleSets","summary":"List value rule sets","tags":["Ad Accounts"],"parameters":[{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}},{"name":"adAccountId","in":"query","required":true,"schema":{"type":"string"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":100,"default":25}},{"name":"after","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"adAccountId":{"type":"string"},"data":{"type":"array","items":{"$ref":"#/components/schemas/ValueRuleSet"}},"paging":{"type":"object","properties":{"after":{"type":["string","null"]}}}}}}}}},"x-pozy-area":"ads"},"post":{"operationId":"createValueRuleSet","summary":"Create a value rule set","tags":["Ad Accounts"],"responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"adAccountId":{"type":"string"},"valueRuleSetId":{"type":["string","null"]}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","adAccountId","name","rules"],"properties":{"accountId":{"type":"string"},"adAccountId":{"type":"string"},"name":{"type":"string","minLength":1,"maxLength":255},"rules":{"type":"array","minItems":1,"maxItems":10,"items":{"$ref":"#/components/schemas/ValueRule"}}}}}}},"x-pozy-area":"ads"}},"/v1/ads/value-rule-sets/{valueRuleSetId}":{"get":{"operationId":"getValueRuleSet","summary":"Read a value rule set","tags":["Ad Accounts"],"parameters":[{"name":"valueRuleSetId","in":"path","required":true,"schema":{"type":"string"}},{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"valueRuleSet":{"$ref":"#/components/schemas/ValueRuleSet"}}}}}}},"x-pozy-area":"ads"},"put":{"operationId":"updateValueRuleSet","summary":"Replace a value rule set","tags":["Ad Accounts"],"parameters":[{"name":"valueRuleSetId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"valueRuleSetId":{"type":"string"},"name":{"type":"string"},"rules":{"type":"array","items":{"$ref":"#/components/schemas/ValueRule"}},"message":{"type":"string"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","name","rules"],"properties":{"accountId":{"type":"string"},"name":{"type":"string","minLength":1,"maxLength":255},"rules":{"type":"array","minItems":1,"maxItems":10,"items":{"$ref":"#/components/schemas/ValueRule"}}}}}}},"x-pozy-area":"ads"},"delete":{"operationId":"deleteValueRuleSet","summary":"Delete a value rule set","tags":["Ad Accounts"],"parameters":[{"name":"valueRuleSetId","in":"path","required":true,"schema":{"type":"string"}},{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"valueRuleSetId":{"type":"string"},"message":{"type":"string"}}}}}}},"x-pozy-area":"ads"}},"/v1/ads/accounts/negative-keyword-lists":{"get":{"operationId":"listAdNegativeKeywordLists","summary":"List negative keyword lists","tags":["Ad Accounts"],"parameters":[{"name":"accountId","in":"query","required":true,"schema":{"type":"string","pattern":"^[a-fA-F0-9]{24}$"}},{"name":"adAccountId","in":"query","required":false,"schema":{"type":"string","pattern":"^\\d+$"}},{"name":"customerId","in":"query","required":false,"schema":{"type":"string","pattern":"^\\d+$"}},{"name":"platform","in":"query","required":false,"schema":{"type":"string","enum":["facebook","instagram","tiktok","linkedin","pinterest","google","twitter","openai","reddit"]}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"lists":{"type":"array","items":{"$ref":"#/components/schemas/AdNegativeKeywordList"}},"customerId":{"type":"string","pattern":"^\\d+$"},"cachedAt":{"type":["string","null"],"format":"date-time"},"stale":{"type":"boolean"}}}}}}},"x-pozy-area":"ads"},"post":{"operationId":"createAdNegativeKeywordList","summary":"Create a negative keyword list","tags":["Ad Accounts"],"responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","pattern":"^\\d+$"},"resourceName":{"type":"string"},"created":{"type":"integer"},"customerId":{"type":"string","pattern":"^\\d+$"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["accountId","name"],"properties":{"accountId":{"type":"string","pattern":"^[a-fA-F0-9]{24}$"},"adAccountId":{"type":"string","pattern":"^\\d+$"},"customerId":{"type":"string","deprecated":true,"pattern":"^\\d+$"},"platform":{"type":"string","enum":["facebook","instagram","tiktok","linkedin","pinterest","google","twitter","openai","reddit"]},"name":{"type":"string","minLength":1,"maxLength":255},"keywords":{"type":"array","maxItems":5000,"items":{"$ref":"#/components/schemas/KeywordEntry"}}}}}}},"x-pozy-area":"ads"}},"/v1/ads/accounts/negative-keyword-lists/{listId}":{"get":{"operationId":"getAdNegativeKeywordList","summary":"Get a negative keyword list","tags":["Ad Accounts"],"parameters":[{"name":"listId","in":"path","required":true,"schema":{"type":"string","pattern":"^\\d+$"}},{"name":"accountId","in":"query","required":true,"schema":{"type":"string","pattern":"^[a-fA-F0-9]{24}$"}},{"name":"adAccountId","in":"query","required":false,"schema":{"type":"string","pattern":"^\\d+$"}},{"name":"customerId","in":"query","required":false,"schema":{"type":"string","pattern":"^\\d+$"}},{"name":"platform","in":"query","required":false,"schema":{"type":"string","enum":["facebook","instagram","tiktok","linkedin","pinterest","google","twitter","openai","reddit"]}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"list":{"allOf":[{"$ref":"#/components/schemas/AdNegativeKeywordList"},{"type":"object","properties":{"keywords":{"type":"array","items":{"$ref":"#/components/schemas/AdNegativeKeywordListKeyword"}}}}]},"customerId":{"type":"string","pattern":"^\\d+$"},"cachedAt":{"type":["string","null"],"format":"date-time"},"stale":{"type":"boolean"}}}}}}},"x-pozy-area":"ads"},"put":{"operationId":"updateAdNegativeKeywordList","summary":"Rename a negative keyword list","tags":["Ad Accounts"],"parameters":[{"name":"listId","in":"path","required":true,"schema":{"type":"string","pattern":"^\\d+$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"updated":{"type":"boolean"},"customerId":{"type":"string","pattern":"^\\d+$"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["accountId","name"],"properties":{"accountId":{"type":"string","pattern":"^[a-fA-F0-9]{24}$"},"adAccountId":{"type":"string","pattern":"^\\d+$"},"customerId":{"type":"string","deprecated":true,"pattern":"^\\d+$"},"platform":{"type":"string","enum":["facebook","instagram","tiktok","linkedin","pinterest","google","twitter","openai","reddit"]},"name":{"type":"string","minLength":1,"maxLength":255}}}}}},"x-pozy-area":"ads"},"delete":{"operationId":"deleteAdNegativeKeywordList","summary":"Delete a negative keyword list","tags":["Ad Accounts"],"parameters":[{"name":"listId","in":"path","required":true,"schema":{"type":"string","pattern":"^\\d+$"}},{"name":"accountId","in":"query","required":true,"schema":{"type":"string","pattern":"^[a-fA-F0-9]{24}$"}},{"name":"adAccountId","in":"query","required":false,"schema":{"type":"string","pattern":"^\\d+$"}},{"name":"customerId","in":"query","required":false,"schema":{"type":"string","pattern":"^\\d+$"}},{"name":"platform","in":"query","required":false,"schema":{"type":"string","enum":["facebook","instagram","tiktok","linkedin","pinterest","google","twitter","openai","reddit"]}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"removed":{"type":"boolean"},"customerId":{"type":"string","pattern":"^\\d+$"}}}}}}},"x-pozy-area":"ads"}},"/v1/ads/accounts/negative-keyword-lists/{listId}/keywords":{"put":{"operationId":"replaceAdNegativeKeywordListKeywords","summary":"Replace negative list keywords","tags":["Ad Accounts"],"parameters":[{"name":"listId","in":"path","required":true,"schema":{"type":"string","pattern":"^\\d+$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"created":{"type":"integer"},"removed":{"type":"integer"},"customerId":{"type":"string","pattern":"^\\d+$"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["accountId","keywords"],"properties":{"accountId":{"type":"string","pattern":"^[a-fA-F0-9]{24}$"},"adAccountId":{"type":"string","pattern":"^\\d+$"},"customerId":{"type":"string","deprecated":true,"pattern":"^\\d+$"},"platform":{"type":"string","enum":["facebook","instagram","tiktok","linkedin","pinterest","google","twitter","openai","reddit"]},"keywords":{"type":"array","maxItems":5000,"items":{"$ref":"#/components/schemas/KeywordEntry"}}}}}}},"x-pozy-area":"ads"}},"/v1/ads/campaigns/{campaignId}/negative-keyword-lists":{"get":{"operationId":"listCampaignNegativeKeywordLists","summary":"List campaign negative lists","tags":["Ad Campaigns"],"parameters":[{"name":"campaignId","in":"path","required":true,"schema":{"type":"string","pattern":"^\\d+$"}},{"name":"platform","in":"query","required":false,"schema":{"type":"string","enum":["facebook","instagram","tiktok","linkedin","pinterest","google","twitter","openai","reddit"]}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"lists":{"type":"array","items":{"$ref":"#/components/schemas/AdNegativeKeywordList"}},"customerId":{"type":"string","pattern":"^\\d+$"},"cachedAt":{"type":["string","null"],"format":"date-time"},"stale":{"type":"boolean"}}}}}}},"x-pozy-area":"ads"},"put":{"operationId":"replaceCampaignNegativeKeywordLists","summary":"Replace campaign negative lists","tags":["Ad Campaigns"],"parameters":[{"name":"campaignId","in":"path","required":true,"schema":{"type":"string","pattern":"^\\d+$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"created":{"type":"integer"},"removed":{"type":"integer"},"customerId":{"type":"string","pattern":"^\\d+$"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["listIds"],"properties":{"platform":{"type":"string","enum":["facebook","instagram","tiktok","linkedin","pinterest","google","twitter","openai","reddit"]},"listIds":{"type":"array","maxItems":20,"items":{"type":"string","pattern":"^\\d+$"}}}}}}},"x-pozy-area":"ads"}},"/v1/ads/accounts/callouts":{"get":{"operationId":"listAccountCallouts","summary":"List account callouts","tags":["Ad Accounts"],"parameters":[{"name":"accountId","in":"query","required":true,"schema":{"type":"string","pattern":"^[a-fA-F0-9]{24}$"}},{"name":"adAccountId","in":"query","required":false,"schema":{"type":"string","pattern":"^\\d+$"}},{"name":"customerId","in":"query","required":false,"schema":{"type":"string","pattern":"^\\d+$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"customerId":{"type":"string"},"callouts":{"type":"array","items":{"type":"object","properties":{"assetId":{"type":"string"},"status":{"type":"string"},"text":{"type":"string"}}}},"cachedAt":{"type":["string","null"],"format":"date-time"},"stale":{"type":"boolean"}}}}}}},"x-pozy-area":"ads"},"post":{"operationId":"addAccountCallouts","summary":"Add account callouts","tags":["Ad Accounts"],"responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"customerId":{"type":"string"},"callouts":{"type":"array","items":{"type":"object","properties":{"assetId":{"type":"string"},"text":{"type":"string"}}}}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","callouts"],"properties":{"accountId":{"type":"string","pattern":"^[a-fA-F0-9]{24}$"},"adAccountId":{"type":"string","pattern":"^\\d+$"},"customerId":{"type":"string","deprecated":true,"pattern":"^\\d+$"},"callouts":{"type":"array","items":{"type":"string","minLength":1,"maxLength":25},"minItems":1,"maxItems":20}}}}}},"x-pozy-area":"ads"},"put":{"operationId":"updateAccountCallouts","summary":"Update account callouts","tags":["Ad Accounts"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"updated":{"type":"integer"},"customerId":{"type":"string"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","updates"],"properties":{"accountId":{"type":"string","pattern":"^[a-fA-F0-9]{24}$"},"adAccountId":{"type":"string","pattern":"^\\d+$"},"customerId":{"type":"string","deprecated":true,"pattern":"^\\d+$"},"updates":{"type":"array","items":{"type":"object","required":["assetResourceName"],"properties":{"assetResourceName":{"type":"string","pattern":"^customers/\\d+/assets/\\d+$"},"calloutAsset":{"type":"object","required":["calloutText"],"properties":{"calloutText":{"type":"string","minLength":1,"maxLength":25}}}}},"minItems":1,"maxItems":20}}}}}},"x-pozy-area":"ads"},"delete":{"operationId":"removeAccountCallout","summary":"Remove account callout","tags":["Ad Accounts"],"parameters":[{"name":"accountId","in":"query","required":true,"schema":{"type":"string","pattern":"^[a-fA-F0-9]{24}$"}},{"name":"adAccountId","in":"query","required":false,"schema":{"type":"string","pattern":"^\\d+$"}},{"name":"customerId","in":"query","required":false,"schema":{"type":"string","pattern":"^\\d+$"}},{"name":"assetId","in":"query","required":true,"schema":{"type":"string","pattern":"^\\d+$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"removed":{"type":"boolean"},"customerId":{"type":"string"}}}}}}},"x-pozy-area":"ads"}},"/v1/ads/accounts/sitelinks":{"get":{"operationId":"listAccountSitelinks","summary":"List account sitelinks","tags":["Ad Accounts"],"parameters":[{"name":"accountId","in":"query","required":true,"schema":{"type":"string","pattern":"^[a-fA-F0-9]{24}$"}},{"name":"adAccountId","in":"query","required":false,"schema":{"type":"string","pattern":"^\\d+$"}},{"name":"customerId","in":"query","required":false,"schema":{"type":"string","pattern":"^\\d+$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"customerId":{"type":"string"},"sitelinks":{"type":"array","items":{"type":"object","properties":{"assetId":{"type":"string"},"status":{"type":"string"},"assetResourceName":{"type":"string"},"customerAssetResourceName":{"type":"string"},"text":{"type":"string"},"linkUrl":{"type":"string","format":"uri"},"description1":{"type":"string"},"description2":{"type":"string"}}}},"cachedAt":{"type":["string","null"],"format":"date-time"},"stale":{"type":"boolean"}}}}}}},"x-pozy-area":"ads"},"post":{"operationId":"addAccountSitelinks","summary":"Add account sitelinks","tags":["Ad Accounts"],"responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"customerId":{"type":"string"},"sitelinks":{"type":"array","items":{"type":"object","properties":{"assetId":{"type":"string"},"text":{"type":"string","minLength":1,"maxLength":25},"linkUrl":{"type":"string","format":"uri"},"description1":{"type":"string","minLength":1,"maxLength":35},"description2":{"type":"string","minLength":1,"maxLength":35}}}}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","sitelinks"],"properties":{"accountId":{"type":"string","pattern":"^[a-fA-F0-9]{24}$"},"adAccountId":{"type":"string","pattern":"^\\d+$"},"customerId":{"type":"string","deprecated":true,"pattern":"^\\d+$"},"sitelinks":{"type":"array","items":{"$ref":"#/components/schemas/GoogleSitelink"},"minItems":1,"maxItems":20}}}}}},"x-pozy-area":"ads"},"put":{"operationId":"updateAccountSitelinks","summary":"Update account sitelinks","tags":["Ad Accounts"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"updated":{"type":"integer"},"customerId":{"type":"string"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","updates"],"properties":{"accountId":{"type":"string","pattern":"^[a-fA-F0-9]{24}$"},"adAccountId":{"type":"string","pattern":"^\\d+$"},"customerId":{"type":"string","deprecated":true,"pattern":"^\\d+$"},"updates":{"type":"array","items":{"type":"object","required":["assetResourceName"],"properties":{"assetResourceName":{"type":"string","pattern":"^customers/\\d+/assets/\\d+$"},"sitelinkAsset":{"type":"object","properties":{"linkText":{"type":"string","minLength":1,"maxLength":25},"description1":{"type":"string","maxLength":35},"description2":{"type":"string","maxLength":35},"linkUrl":{"type":"string","format":"uri"}},"minProperties":1},"finalUrls":{"type":"array","items":{"type":"string","format":"uri"},"minItems":1}}},"minItems":1,"maxItems":20}}}}}},"x-pozy-area":"ads"},"delete":{"operationId":"removeAccountSitelink","summary":"Remove account sitelink","tags":["Ad Accounts"],"parameters":[{"name":"accountId","in":"query","required":true,"schema":{"type":"string","pattern":"^[a-fA-F0-9]{24}$"}},{"name":"adAccountId","in":"query","required":false,"schema":{"type":"string","pattern":"^\\d+$"}},{"name":"customerId","in":"query","required":false,"schema":{"type":"string","pattern":"^\\d+$"}},{"name":"assetId","in":"query","required":true,"schema":{"type":"string","pattern":"^\\d+$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"removed":{"type":"boolean"},"customerId":{"type":"string"}}}}}}},"x-pozy-area":"ads"}},"/v1/ads/accounts/structured-snippets":{"get":{"operationId":"listAccountStructuredSnippets","summary":"List account snippets","tags":["Ad Accounts"],"parameters":[{"name":"accountId","in":"query","required":true,"schema":{"type":"string","pattern":"^[a-fA-F0-9]{24}$"}},{"name":"adAccountId","in":"query","required":false,"schema":{"type":"string","pattern":"^\\d+$"}},{"name":"customerId","in":"query","required":false,"schema":{"type":"string","pattern":"^\\d+$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"customerId":{"type":"string"},"structuredSnippets":{"type":"array","items":{"type":"object","properties":{"assetId":{"type":"string"},"status":{"type":"string"},"assetResourceName":{"type":"string"},"customerAssetResourceName":{"type":"string"},"header":{"type":"string"},"values":{"type":"array","items":{"type":"string"}}}}},"cachedAt":{"type":["string","null"],"format":"date-time"},"stale":{"type":"boolean"}}}}}}},"x-pozy-area":"ads"},"post":{"operationId":"addAccountStructuredSnippets","summary":"Add account snippets","tags":["Ad Accounts"],"responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"customerId":{"type":"string"},"structuredSnippets":{"type":"array","items":{"type":"object","properties":{"assetId":{"type":"string"},"header":{"type":"string","enum":["Amenities","Brands","Courses","Degree programs","Destinations","Featured hotels","Insurance coverage","Models","Neighborhoods","Service catalog","Shows","Styles","Types"]},"values":{"type":"array","minItems":3,"maxItems":10,"items":{"type":"string","minLength":1,"maxLength":25}}}}}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","structuredSnippets"],"properties":{"accountId":{"type":"string","pattern":"^[a-fA-F0-9]{24}$"},"adAccountId":{"type":"string","pattern":"^\\d+$"},"customerId":{"type":"string","deprecated":true,"pattern":"^\\d+$"},"structuredSnippets":{"type":"array","items":{"$ref":"#/components/schemas/GoogleStructuredSnippet"},"minItems":1,"maxItems":20}}}}}},"x-pozy-area":"ads"},"put":{"operationId":"updateAccountStructuredSnippets","summary":"Update account snippets","tags":["Ad Accounts"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"updated":{"type":"integer"},"customerId":{"type":"string"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","updates"],"properties":{"accountId":{"type":"string","pattern":"^[a-fA-F0-9]{24}$"},"adAccountId":{"type":"string","pattern":"^\\d+$"},"customerId":{"type":"string","deprecated":true,"pattern":"^\\d+$"},"updates":{"type":"array","items":{"type":"object","required":["assetResourceName"],"properties":{"assetResourceName":{"type":"string","pattern":"^customers/\\d+/assets/\\d+$"},"structuredSnippetAsset":{"$ref":"#/components/schemas/GoogleStructuredSnippet"}}},"minItems":1,"maxItems":20}}}}}},"x-pozy-area":"ads"},"delete":{"operationId":"removeAccountStructuredSnippet","summary":"Remove account snippet","tags":["Ad Accounts"],"parameters":[{"name":"accountId","in":"query","required":true,"schema":{"type":"string","pattern":"^[a-fA-F0-9]{24}$"}},{"name":"adAccountId","in":"query","required":false,"schema":{"type":"string","pattern":"^\\d+$"}},{"name":"customerId","in":"query","required":false,"schema":{"type":"string","pattern":"^\\d+$"}},{"name":"assetId","in":"query","required":true,"schema":{"type":"string","pattern":"^\\d+$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"removed":{"type":"boolean"},"customerId":{"type":"string"}}}}}}},"x-pozy-area":"ads"}},"/v1/ads/accounts/hierarchy":{"get":{"operationId":"getAdAccountHierarchy","summary":"Get manager account hierarchy","tags":["Ad Accounts"],"parameters":[{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}},{"name":"adAccountId","in":"query","required":false,"schema":{"type":"string"}},{"name":"customerId","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"accountId":{"type":"string"},"roots":{"type":"array","items":{"type":"object","properties":{"customerId":{"type":"string"},"name":{"type":["string","null"]},"currency":{"type":["string","null"]},"timeZone":{"type":["string","null"]},"manager":{"type":"boolean"},"testAccount":{"type":"boolean"},"status":{"type":["string","null"]},"managerLinks":{"type":"array","items":{"type":"object","properties":{"managerCustomerId":{"type":"string"},"managerLinkId":{"type":"string"},"status":{"type":"string","enum":["ACTIVE","PENDING"]}}}},"clients":{"type":"array","items":{"$ref":"#/components/schemas/GoogleAdsHierarchyClient"}}}}},"directCustomers":{"type":"array","items":{"type":"object","properties":{"customerId":{"type":"string"},"manager":{"type":"boolean"},"pendingInvitations":{"type":"array","items":{"type":"object","properties":{"managerCustomerId":{"type":"string"},"managerLinkId":{"type":"string"}}}}}}},"unavailable":{"type":"array","items":{"type":"object","properties":{"customerId":{"type":"string"},"reason":{"type":"string"}}}},"truncated":{"type":"boolean"},"cachedAt":{"type":["string","null"],"format":"date-time"},"stale":{"type":"boolean"}}}}}}},"x-pozy-area":"ads"}},"/v1/ads/accounts/manager-links":{"post":{"operationId":"inviteAdAccountToManager","summary":"Invite a client account to a manager","tags":["Ad Accounts"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleAdsManagerLink"}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["accountId","managerCustomerId","clientCustomerId"],"properties":{"accountId":{"type":"string"},"managerCustomerId":{"type":"string"},"clientCustomerId":{"type":"string"},"validateOnly":{"type":"boolean","default":false}}}}}},"x-pozy-area":"ads"},"patch":{"operationId":"updateAdAccountManagerLink","summary":"Accept, decline, cancel or end a manager link","tags":["Ad Accounts"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleAdsManagerLink"}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["accountId","managerCustomerId","clientCustomerId","managerLinkId","action"],"properties":{"accountId":{"type":"string"},"managerCustomerId":{"type":"string"},"clientCustomerId":{"type":"string"},"managerLinkId":{"type":"string"},"action":{"type":"string","enum":["accept","decline","cancel","unlink"]},"validateOnly":{"type":"boolean","default":false}}}}}},"x-pozy-area":"ads"}},"/v1/ads/accounts/billing":{"get":{"operationId":"getAdAccountBilling","summary":"Get ad account billing","tags":["Ad Accounts"],"parameters":[{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}},{"name":"adAccountId","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"customerId":{"type":"string"},"paymentsAccounts":{"type":"array","items":{"type":"object","properties":{"paymentsAccountId":{"type":"string"},"name":{"type":["string","null"]},"currency":{"type":["string","null"]},"paymentsProfileId":{"type":["string","null"]},"payingManagerCustomerId":{"type":["string","null"]}}}},"billingSetups":{"type":"array","items":{"type":"object","properties":{"billingSetupId":{"type":"string"},"status":{"type":"string","enum":["PENDING","APPROVED_HELD","APPROVED","CANCELLED","UNKNOWN"]},"paymentsAccountId":{"type":["string","null"]},"startDateTime":{"type":["string","null"]},"endDateTime":{"type":["string","null"]}}}},"accountBudgets":{"type":"array","items":{"type":"object","properties":{"accountBudgetId":{"type":"string"},"status":{"type":"string","enum":["PENDING","APPROVED","CANCELLED","UNKNOWN"]},"billingSetupId":{"type":["string","null"]},"approvedSpendingLimitMicros":{"type":["string","null"]},"approvedSpendingLimitType":{"type":["string","null"]},"pendingProposalId":{"type":["string","null"]}}}},"pendingBudgetProposals":{"type":"array","items":{"type":"object","properties":{"accountBudgetProposalId":{"type":"string"},"billingSetupId":{"type":["string","null"]}}}},"cachedAt":{"type":["string","null"],"format":"date-time"},"stale":{"type":"boolean"}}}}}}},"x-pozy-area":"ads"},"post":{"operationId":"setUpAdAccountBilling","summary":"Set up ad account billing (monthly invoicing)","tags":["Ad Accounts"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"customerId":{"type":"string"},"paymentsAccountId":{"type":"string"},"paymentsAccountName":{"type":["string","null"]},"billingSetupId":{"type":["string","null"]},"reusedBillingSetup":{"type":"boolean"},"accountBudgetProposalId":{"type":["string","null"]},"validateOnly":{"type":"boolean"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["accountId","adAccountId","paymentsAccountId"],"properties":{"accountId":{"type":"string","pattern":"^[a-fA-F0-9]{24}$"},"adAccountId":{"type":"string","pattern":"^[0-9]+$"},"paymentsAccountId":{"type":"string","pattern":"^\\d{4}-\\d{4}-\\d{4}-\\d{4}$"},"spendingLimit":{"type":"number","exclusiveMinimum":0},"budgetName":{"type":"string","minLength":1,"maxLength":255,"default":"Pozy account budget"},"purchaseOrderNumber":{"type":"string","minLength":1,"maxLength":64},"validateOnly":{"type":"boolean","default":false}}}}}},"x-pozy-area":"ads"}},"/v1/ads/accounts/user-invitations":{"get":{"operationId":"listAdAccountUserInvitations","summary":"List user access invitations","tags":["Ad Accounts"],"parameters":[{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}},{"name":"adAccountId","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"customerId":{"type":"string"},"invitations":{"type":"array","items":{"$ref":"#/components/schemas/GoogleAdsUserAccessInvitation"}},"cachedAt":{"type":["string","null"],"format":"date-time"},"stale":{"type":"boolean"}}}}}}},"x-pozy-area":"ads"},"post":{"operationId":"inviteAdAccountUser","summary":"Invite a user to an ad account by email","tags":["Ad Accounts"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleAdsUserAccessInvitationResult"}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["accountId","adAccountId","emailAddress","accessRole"],"properties":{"accountId":{"type":"string"},"adAccountId":{"type":"string"},"emailAddress":{"type":"string","format":"email"},"accessRole":{"$ref":"#/components/schemas/GoogleAdsAccessRole"},"validateOnly":{"type":"boolean","default":false}}}}}},"x-pozy-area":"ads"},"delete":{"operationId":"revokeAdAccountUserInvitation","summary":"Revoke a user access invitation","tags":["Ad Accounts"],"parameters":[{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}},{"name":"adAccountId","in":"query","required":true,"schema":{"type":"string"}},{"name":"invitationId","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"customerId":{"type":"string"},"invitationId":{"type":"string"},"revoked":{"type":"boolean"}}}}}}},"x-pozy-area":"ads"}},"/v1/ads/accounts/user-invitations/pending-approvals":{"get":{"operationId":"listAdAccountUserInvitationApprovals","summary":"List invitations awaiting multi-party approval","tags":["Ad Accounts"],"parameters":[{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}},{"name":"adAccountId","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"customerId":{"type":"string"},"approvals":{"type":"array","items":{"$ref":"#/components/schemas/GoogleAdsUserInvitationApproval"}},"cachedAt":{"type":["string","null"],"format":"date-time"},"stale":{"type":"boolean"}}}}}}},"x-pozy-area":"ads"},"delete":{"operationId":"withdrawAdAccountUserInvitationApproval","summary":"Withdraw an invitation awaiting multi-party approval","tags":["Ad Accounts"],"parameters":[{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}},{"name":"adAccountId","in":"query","required":true,"schema":{"type":"string"}},{"name":"multiPartyAuthReviewId","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"customerId":{"type":"string"},"multiPartyAuthReviewId":{"type":"string"},"status":{"type":"string","enum":["REVOKED"]}}}}}}},"x-pozy-area":"ads"}},"/v1/ads/accounts/users":{"get":{"operationId":"listAdAccountUsers","summary":"Ad account users","tags":["Ad Accounts"],"parameters":[{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}},{"name":"adAccountId","in":"query","required":true,"schema":{"type":"string"}},{"name":"businessId","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"adAccountId":{"type":"string"},"businessId":{"type":"string"},"users":{"type":"array","items":{"$ref":"#/components/schemas/MetaAssignedUser"}}}}}}}},"x-pozy-area":"ads"},"post":{"operationId":"assignAdAccountUser","summary":"Assign a user to an ad account","tags":["Ad Accounts"],"responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"adAccountId":{"type":"string"},"user":{"type":"object","properties":{"id":{"type":"string"},"tasks":{"type":"array","items":{"type":"string"}}}}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","adAccountId","userId","tasks"],"properties":{"accountId":{"type":"string"},"adAccountId":{"type":"string"},"userId":{"type":"string"},"tasks":{"type":"array","minItems":1,"items":{"type":"string","enum":["MANAGE","ADVERTISE","ANALYZE","DRAFT"]}}}}}}},"x-pozy-area":"ads"},"delete":{"operationId":"removeAdAccountUser","summary":"Remove a user from an ad account","tags":["Ad Accounts"],"parameters":[{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}},{"name":"adAccountId","in":"query","required":true,"schema":{"type":"string"}},{"name":"userId","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"adAccountId":{"type":"string"},"userId":{"type":"string"},"removed":{"type":"boolean"}}}}}}},"x-pozy-area":"ads"}},"/v1/ads/accounts/finance":{"get":{"operationId":"getAdAccountFinance","summary":"Ad account finances","tags":["Ad Accounts"],"parameters":[{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}},{"name":"adAccountId","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"adAccountId":{"type":"string"},"currency":{"type":"string"},"balance":{"type":"number"},"amountSpent":{"type":"number"},"spendCap":{"type":["number","null"]},"fundingSource":{"type":["object","null"],"properties":{"displayString":{"type":"string"},"type":{"type":"integer"}}}}}}}}},"x-pozy-area":"ads"}},"/v1/ads/accounts/health":{"get":{"operationId":"getAdAccountHealth","summary":"Check an ad account before creating ads","tags":["Ad Accounts"],"parameters":[{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}},{"name":"adAccountId","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"adAccountId":{"type":"string"},"status":{"type":"string","enum":["ok","attention","blocked"]},"checkedAt":{"type":"string","format":"date-time"},"checks":{"type":"array","items":{"type":"object","required":["id","status","title","message"],"properties":{"id":{"type":"string","enum":["account_status","payment","spend_cap","page","instagram","lead_terms","pixel","whatsapp"]},"status":{"type":"string","enum":["ok","warning","error","missing","unknown"]},"title":{"type":"string"},"message":{"type":"string"},"fix":{"type":"object","properties":{"label":{"type":"string"},"url":{"type":"string"}}}}}}}}}}}},"x-pozy-area":"ads"}},"/v1/ads/accounts/live":{"get":{"operationId":"getAdAccountLiveEntities","summary":"Read an ad account's campaigns and ad sets live","tags":["Ad Accounts"],"parameters":[{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}},{"name":"adAccountId","in":"query","required":true,"schema":{"type":"string"}},{"name":"status","in":"query","required":false,"schema":{"type":"string"}},{"name":"level","in":"query","required":false,"schema":{"type":"string","enum":["campaign","adSet"]}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":500,"default":200}},{"name":"after","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"accountId":{"type":"string"},"adAccountId":{"type":"string"},"platform":{"type":"string","enum":["facebook","tiktok"]},"currency":{"type":"string"},"readAt":{"type":"string","format":"date-time"},"campaigns":{"type":"array","items":{"type":"object","properties":{"platformCampaignId":{"type":"string"},"campaignName":{"type":["string","null"]},"platformCampaignStatus":{"type":["string","null"]},"configuredStatus":{"type":["string","null"]},"status":{"type":"string"},"budget":{"type":["object","null"],"properties":{"amount":{"type":"number"},"type":{"type":"string","enum":["daily","lifetime"]}}},"dailyBudget":{"type":["number","null"]},"lifetimeBudget":{"type":["number","null"]},"budgetMode":{"type":["string","null"]},"budgetRemaining":{"type":["number","null"]},"spendCap":{"type":["number","null"]},"bidStrategy":{"type":["string","null"]}}}},"adSets":{"type":"array","items":{"type":"object","properties":{"platformAdSetId":{"type":"string"},"adSetName":{"type":["string","null"]},"platformCampaignId":{"type":["string","null"]},"platformAdSetStatus":{"type":["string","null"]},"configuredStatus":{"type":["string","null"]},"status":{"type":"string"},"budget":{"type":["object","null"],"properties":{"amount":{"type":"number"},"type":{"type":"string","enum":["daily","lifetime"]}}},"dailyBudget":{"type":["number","null"]},"lifetimeBudget":{"type":["number","null"]},"budgetMode":{"type":["string","null"]},"budgetRemaining":{"type":["number","null"]},"bidStrategy":{"type":["string","null"]},"bidAmount":{"type":["number","null"]},"optimizationGoal":{"type":["string","null"]},"billingEvent":{"type":["string","null"]},"promotedObject":{"type":["object","null"],"additionalProperties":true},"targeting":{"type":["object","null"],"additionalProperties":true},"schedule":{"type":["object","null"],"properties":{"startDate":{"type":"string","format":"date-time"},"endDate":{"type":"string","format":"date-time"}}},"adSchedule":{"oneOf":[{"$ref":"#/components/schemas/MetaAdSchedule"},{"type":"null"}]}}}},"paging":{"type":"object","properties":{"campaigns":{"type":"object","properties":{"after":{"type":["string","null"]}}},"adSets":{"type":"object","properties":{"after":{"type":["string","null"]}}}}}}}}}}},"x-pozy-area":"ads"}},"/v1/ads/accounts":{"get":{"operationId":"listAdAccounts","summary":"List ad accounts","tags":["Ad Accounts"],"parameters":[{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}},{"name":"adAccountId","in":"query","required":false,"schema":{"type":"string"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":1000}},{"name":"inScopeOnly","in":"query","required":false,"schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"accounts":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"currency":{"type":"string"},"businessId":{"type":"string"},"businessName":{"type":"string"},"status":{"type":"string"},"accountStatus":{},"approvalStatus":{"type":"string"},"timezone":{"type":"string"},"type":{"type":"string"},"disableReason":{"type":"integer"},"balance":{"type":"number"},"cashBalance":{"type":"number"},"grantBalance":{"type":"number"},"timezoneName":{"type":"string"},"timezoneOffsetHoursUtc":{"type":"number"},"minimumDailyBudget":{"type":"number"},"fundingSource":{"type":"string"},"fundingSourceDetails":{"type":"object","properties":{"id":{"type":"string"},"displayString":{"type":"string"},"type":{"type":"integer"}}},"billingStatus":{"type":"string","enum":["ok","missing","unknown"]},"selectable":{"type":"boolean"},"unusableReason":{"type":["string","null"]},"selected":{"type":"boolean"}}}},"cachedAt":{"type":["string","null"],"format":"date-time"},"stale":{"type":"boolean"}}}}}}},"x-pozy-area":"ads"},"post":{"operationId":"createAdAccount","summary":"Create ad account","tags":["Ad Accounts"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","required":["platform","managerCustomerId","validateOnly"],"properties":{"platform":{"type":"string","enum":["google"]},"managerCustomerId":{"type":"string"},"validateOnly":{"type":"boolean"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/CreateMetaAdAccountRequest"},{"$ref":"#/components/schemas/CreateGoogleAdAccountRequest"}]}}}},"x-pozy-area":"ads"},"patch":{"operationId":"updateAdAccount","summary":"Update ad account settings","tags":["Ad Accounts"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"adAccountId":{"type":"string"},"urlTracking":{"type":"object","properties":{"trackingUrlTemplate":{"type":"string"},"finalUrlSuffix":{"type":"string"}}},"dsaDefaults":{"type":"object","properties":{"beneficiary":{"type":"string"},"payor":{"type":"string"}}},"settings":{"type":"object","properties":{"name":{"type":"string"},"currency":{"type":"string"},"balance":{"type":"number"},"amountSpent":{"type":"number"},"spendCap":{"type":["number","null"]},"fundingSource":{"type":["object","null"],"properties":{"displayString":{"type":"string"},"type":{"type":"integer"}}}}}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","adAccountId"],"properties":{"accountId":{"type":"string"},"adAccountId":{"type":"string"},"name":{"type":"string","maxLength":255},"spendCap":{"type":["number","null"]},"resetAmountSpent":{"type":"boolean"},"defaultDsaBeneficiary":{"type":"string","maxLength":100},"defaultDsaPayor":{"type":"string","maxLength":100},"trackingUrlTemplate":{"type":"string"},"finalUrlSuffix":{"type":"string"}}}}}},"x-pozy-area":"ads"}},"/v1/ads/dsa-defaults":{"get":{"operationId":"getDsaDefaults","summary":"Get ad account DSA defaults","tags":["Ad Accounts"],"parameters":[{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}},{"name":"adAccountId","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"adAccountId":{"type":"string"},"dsaDefaults":{"type":"object","properties":{"beneficiary":{"type":"string"},"payor":{"type":"string"}}}}}}}}},"x-pozy-area":"ads"}},"/v1/ads/dsa-recommendations":{"get":{"operationId":"getDsaRecommendations","summary":"Get DSA recommendations","tags":["Ad Accounts"],"parameters":[{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}},{"name":"adAccountId","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"adAccountId":{"type":"string"},"recommendations":{"type":"array","items":{"type":"string"}}}}}}}},"x-pozy-area":"ads"}},"/v1/ads/boost":{"post":{"operationId":"boostPost","summary":"Boost post as ad","tags":["Ad Campaigns"],"parameters":[{"name":"Idempotency-Key","in":"header","required":false,"schema":{"type":"string","maxLength":255}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"validateOnly":{"type":"boolean"},"results":{"type":"array","items":{"type":"object","properties":{"node":{"type":"string","enum":["campaign","adSet","creative","ad"]},"status":{"type":"string","enum":["validated","skipped","unverified"]},"reason":{"type":"string"}}}},"message":{"type":"string"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","adAccountId","name","goal"],"properties":{"creativeFeatures":{"$ref":"#/components/schemas/MetaCreativeFeatures"},"postId":{"type":"string"},"platformPostId":{"type":"string"},"accountId":{"type":"string"},"adAccountId":{"type":"string"},"name":{"type":"string","maxLength":255},"campaignName":{"type":"string","maxLength":255},"adSetName":{"type":"string","maxLength":255},"goal":{"type":"string","enum":["engagement","traffic","awareness","video_views","lead_generation","conversions","app_promotion"]},"adSetId":{"type":"string"},"existingCampaignId":{"type":"string"},"identityId":{"type":"string"},"identityType":{"type":"string","enum":["TT_USER","CUSTOMIZED_USER","BC_AUTH_TT"]},"budgetAmount":{"type":"number"},"budgetType":{"type":"string","enum":["daily","lifetime"]},"lifetimeBudgetCap":{"type":"number","exclusiveMinimum":0},"budget":{"type":"object","deprecated":true,"required":["amount","type"],"properties":{"amount":{"type":"number"},"type":{"type":"string","enum":["daily","lifetime"]}}},"instagramAccountId":{"type":"string"},"destinationType":{"type":"string","enum":["INSTAGRAM_PROFILE","WEBSITE","ON_AD","MESSENGER","WHATSAPP","INSTAGRAM_DIRECT"]},"whatsappPhoneNumber":{"type":"string","pattern":"^\\+[1-9]\\d{6,14}$"},"workflowId":{"type":"string","pattern":"^[a-fA-F0-9]{24}$"},"currency":{"type":"string","minLength":3,"maxLength":3},"startDate":{"type":"string","format":"date-time"},"endDate":{"type":"string","format":"date-time"},"schedule":{"type":"object","deprecated":true,"properties":{"startDate":{"type":"string","format":"date-time","deprecated":true},"endDate":{"type":"string","format":"date-time","deprecated":true}}},"targeting":{"type":"object","properties":{"ageMin":{"type":"integer","minimum":13,"maximum":65},"ageMax":{"type":"integer","minimum":13,"maximum":65},"gender":{"type":"string","enum":["all","male","female"]},"languages":{"type":"array","items":{"type":"string"}},"countries":{"type":"array","items":{"type":"string"}},"regions":{"type":"array","items":{"type":"object","required":["key"],"properties":{"key":{"type":"string"},"name":{"type":"string"}}}},"cities":{"type":"array","items":{"type":"object","required":["key"],"properties":{"key":{"type":"string"},"name":{"type":"string"},"radius":{"type":"number"},"distanceUnit":{"type":"string","enum":["mile","kilometer"]}}}},"zips":{"type":"array","items":{"type":"object","required":["key"],"properties":{"key":{"type":"string"},"name":{"type":"string"}}}},"metros":{"type":"array","items":{"type":"object","required":["key"],"properties":{"key":{"type":"string"},"name":{"type":"string"}}}},"customLocations":{"type":"array","items":{"type":"object","required":["latitude","longitude","radius","distanceUnit"],"properties":{"latitude":{"type":"number","minimum":-90,"maximum":90},"longitude":{"type":"number","minimum":-180,"maximum":180},"radius":{"type":"number"},"distanceUnit":{"type":"string","enum":["mile","kilometer"]},"name":{"type":"string"},"address":{"type":"string"}}}},"interests":{"type":"array","items":{"type":"object","required":["id","name"],"properties":{"id":{"type":"string"},"name":{"type":"string"}}}},"advantage_audience":{"type":"integer","enum":[0,1]}}},"locationTargetingType":{"allOf":[{"$ref":"#/components/schemas/GoogleLocationTargetingType"}]},"rawTargeting":{"type":"object","additionalProperties":true},"bidStrategy":{"allOf":[{"$ref":"#/components/schemas/BidStrategy"}],"deprecated":true},"bidAmount":{"type":"number","deprecated":true},"roasAverageFloor":{"type":"number","deprecated":true},"platformSpecificData":{"oneOf":[{"$ref":"#/components/schemas/LinkedInAdsPlatformData"},{"$ref":"#/components/schemas/MetaAdsPlatformData"}]},"tracking":{"type":"object","properties":{"pixelId":{"type":"string"},"urlTags":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}}}}}},"specialAdCategories":{"type":"array","items":{"type":"string","enum":["HOUSING","EMPLOYMENT","CREDIT","FINANCIAL_PRODUCTS_SERVICES","ISSUES_ELECTIONS_POLITICS","ONLINE_GAMBLING_AND_GAMING"]}},"specialAdCategoryCountry":{"type":"array","items":{"type":"string"}},"regionalRegulatedCategories":{"type":"array","items":{"type":"string"}},"regionalRegulationIdentities":{"type":"object","additionalProperties":{"type":["string","integer"]}},"linkUrl":{"type":"string","format":"uri"},"callToAction":{"type":"string"},"sparkAuthCode":{"type":"string"},"smartPlus":{"type":"boolean"},"sparkPosts":{"type":"array","minItems":1,"maxItems":50,"items":{"type":"object","required":["platformPostId","sparkAuthCode"],"properties":{"platformPostId":{"type":"string"},"sparkAuthCode":{"type":"string"}}}},"promoCodes":{"type":"array","minItems":1,"maxItems":10,"items":{"type":"object","required":["discountType","discountValue"],"properties":{"discountType":{"type":"string","enum":["PERCENTAGE","CASH"]},"discountValue":{"type":"number"},"discountCurrency":{"type":"string"},"promoCode":{"type":"string","maxLength":30},"minimumPurchaseType":{"type":"string","enum":["QUANTITY","SUBTOTAL"]},"minimumPurchaseValue":{"type":"number"},"minimumPurchaseCurrency":{"type":"string"}}}},"promotedObject":{"type":"object","properties":{"pixelId":{"type":"string"},"customEventType":{"type":"string"},"customEventStr":{"type":"string"},"customConversionId":{"type":"string"}}},"dsaBeneficiary":{"type":"string","maxLength":100},"dsaPayor":{"type":"string","maxLength":100},"leadGenFormId":{"type":"string"},"status":{"type":"string","enum":["ACTIVE","PAUSED"]},"campaignStatus":{"type":"string","enum":["ACTIVE","PAUSED"]},"adSetStatus":{"type":"string","enum":["ACTIVE","PAUSED"]},"adStatus":{"$ref":"#/components/schemas/AdActivationStatus"},"budgetLevel":{"type":"string","enum":["adset","campaign"]},"attributionSpec":{"type":"array","minItems":1,"maxItems":3,"items":{"type":"object","required":["eventType","windowDays"],"properties":{"eventType":{"type":"string","enum":["CLICK_THROUGH","VIEW_THROUGH","ENGAGED_VIDEO_VIEW"]},"windowDays":{"type":"integer","enum":[1,7,28]}}}},"bodies":{"type":"array","minItems":1,"maxItems":5,"items":{"type":"string"}},"rehostOnInstagramVideoRejection":{"type":"boolean","default":true},"smartTargeting":{"type":"object","properties":{"audience":{"type":"boolean"},"interestsBehaviors":{"type":"boolean"}}},"optimizationGoal":{"type":"string"},"metaObjective":{"type":"string","enum":["OUTCOME_ENGAGEMENT"]},"validateOnly":{"type":"boolean","default":false}}}}}},"x-pozy-area":"ads"}},"/v1/ads/campaigns/{campaignId}/asset-groups":{"get":{"operationId":"listGoogleAssetGroups","summary":"List Performance Max asset groups","tags":["Ad Campaigns"],"parameters":[{"name":"campaignId","in":"path","required":true,"schema":{"type":"string","pattern":"^\\d+$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","required":["assetGroups","cachedAt","stale"],"properties":{"assetGroups":{"type":"array","items":{"$ref":"#/components/schemas/GooglePmaxAssetGroup"}},"cachedAt":{"type":["string","null"],"format":"date-time"},"stale":{"type":"boolean"}}}}}}},"x-pozy-area":"ads"},"post":{"operationId":"createGoogleAssetGroup","summary":"Create a Performance Max asset group","tags":["Ad Campaigns"],"parameters":[{"name":"campaignId","in":"path","required":true,"schema":{"type":"string","pattern":"^\\d+$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"validateOnly":{"type":"boolean"},"message":{"type":"string"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["name","finalUrls"],"properties":{"name":{"type":"string","minLength":1,"maxLength":128},"finalUrls":{"type":"array","minItems":1,"maxItems":10,"items":{"type":"string","format":"uri"}},"finalMobileUrls":{"type":"array","minItems":1,"maxItems":10,"items":{"type":"string","format":"uri"}},"path1":{"type":"string","maxLength":15},"path2":{"type":"string","maxLength":15},"status":{"type":"string","enum":["ENABLED","PAUSED"],"default":"PAUSED"},"assets":{"type":"array","maxItems":100,"items":{"$ref":"#/components/schemas/GoogleAssetGroupAssetLink"}},"listingGroupFilter":{"$ref":"#/components/schemas/GoogleListingGroupTree"},"validateOnly":{"type":"boolean","default":false}}}}}},"x-pozy-area":"ads"}},"/v1/ads/campaigns/{campaignId}/asset-groups/{assetGroupId}":{"get":{"operationId":"getGoogleAssetGroup","summary":"Get a Performance Max asset group","tags":["Ad Campaigns"],"parameters":[{"name":"campaignId","in":"path","required":true,"schema":{"type":"string","pattern":"^\\d+$"}},{"name":"assetGroupId","in":"path","required":true,"schema":{"type":"string","pattern":"^\\d+$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","required":["assetGroup","cachedAt","stale"],"properties":{"assetGroup":{"$ref":"#/components/schemas/GooglePmaxAssetGroupDetail"},"cachedAt":{"type":["string","null"],"format":"date-time"},"stale":{"type":"boolean"}}}}}}},"x-pozy-area":"ads"},"patch":{"operationId":"updateGoogleAssetGroup","summary":"Update a Performance Max asset group","tags":["Ad Campaigns"],"parameters":[{"name":"campaignId","in":"path","required":true,"schema":{"type":"string","pattern":"^\\d+$"}},{"name":"assetGroupId","in":"path","required":true,"schema":{"type":"string","pattern":"^\\d+$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"assetGroupId":{"type":"string"},"updated":{"type":"array","items":{"type":"string"}},"validateOnly":{"type":"boolean"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":128},"status":{"type":"string","enum":["ENABLED","PAUSED"]},"finalUrls":{"type":"array","minItems":1,"maxItems":10,"items":{"type":"string","format":"uri"}},"finalMobileUrls":{"type":"array","minItems":1,"maxItems":10,"items":{"type":"string","format":"uri"}},"path1":{"type":["string","null"],"maxLength":15},"path2":{"type":["string","null"],"maxLength":15},"validateOnly":{"type":"boolean","default":false}}}}}},"x-pozy-area":"ads"},"delete":{"operationId":"removeGoogleAssetGroup","summary":"Remove a Performance Max asset group","tags":["Ad Campaigns"],"parameters":[{"name":"campaignId","in":"path","required":true,"schema":{"type":"string","pattern":"^\\d+$"}},{"name":"assetGroupId","in":"path","required":true,"schema":{"type":"string","pattern":"^\\d+$"}},{"name":"validateOnly","in":"query","required":false,"schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"assetGroupId":{"type":"string"},"removed":{"type":"boolean"},"validateOnly":{"type":"boolean"}}}}}}},"x-pozy-area":"ads"}},"/v1/ads/campaigns/{campaignId}/asset-groups/{assetGroupId}/assets":{"post":{"operationId":"editGoogleAssetGroupAssets","summary":"Link or unlink asset group assets","tags":["Ad Campaigns"],"parameters":[{"name":"campaignId","in":"path","required":true,"schema":{"type":"string","pattern":"^\\d+$"}},{"name":"assetGroupId","in":"path","required":true,"schema":{"type":"string","pattern":"^\\d+$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"assetGroupId":{"type":"string"},"linked":{"type":"integer"},"unlinked":{"type":"integer"},"validateOnly":{"type":"boolean"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"link":{"type":"array","maxItems":100,"items":{"$ref":"#/components/schemas/GoogleAssetGroupAssetLink"}},"unlink":{"type":"array","maxItems":100,"items":{"$ref":"#/components/schemas/GoogleAssetGroupAssetUnlink"}},"validateOnly":{"type":"boolean","default":false}}}}}},"x-pozy-area":"ads"}},"/v1/ads/campaigns/{campaignId}/asset-groups/{assetGroupId}/listing-group-filters":{"put":{"operationId":"replaceGoogleListingGroupFilters","summary":"Replace an asset group's listing-group tree","tags":["Ad Campaigns"],"parameters":[{"name":"campaignId","in":"path","required":true,"schema":{"type":"string","pattern":"^\\d+$"}},{"name":"assetGroupId","in":"path","required":true,"schema":{"type":"string","pattern":"^\\d+$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"assetGroupId":{"type":"string"},"removed":{"type":"integer"},"created":{"type":"integer"},"validateOnly":{"type":"boolean"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["tree"],"properties":{"tree":{"$ref":"#/components/schemas/GoogleListingGroupTree"},"validateOnly":{"type":"boolean","default":false}}}}}},"x-pozy-area":"ads"}},"/v1/ads/create":{"post":{"operationId":"createStandaloneAd","summary":"Create standalone ad","tags":["Ad Campaigns"],"parameters":[{"name":"Idempotency-Key","in":"header","required":false,"schema":{"type":"string","maxLength":255}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"validateOnly":{"type":"boolean"},"appliedDefaults":{"$ref":"#/components/schemas/AdAppliedDefaults"},"results":{"type":"array","items":{"type":"object","properties":{"node":{"type":"string","enum":["campaign","adSet","creative","ad","performanceMaxCampaign"]},"status":{"type":"string","enum":["validated","skipped","unverified"]},"reason":{"type":"string"}}}},"message":{"type":"string"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","adAccountId"],"properties":{"accountId":{"type":"string"},"adAccountId":{"type":"string"},"name":{"type":"string","maxLength":255},"campaignName":{"type":"string","maxLength":255},"adSetName":{"type":"string","maxLength":255},"adName":{"type":"string","maxLength":255},"tracking":{"$ref":"#/components/schemas/AdTracking"},"goal":{"type":"string","enum":["engagement","traffic","awareness","video_views","lead_generation","lead_conversion","conversions","app_promotion","catalog_sales","page_likes","page_visits","job_applicants"]},"smartTargeting":{"type":"object","properties":{"audience":{"type":"boolean"},"interestsBehaviors":{"type":"boolean"}}},"optimizationGoal":{"type":"string"},"billingEvent":{"type":"string"},"buyingType":{"type":"string","enum":["AUCTION","RESERVED"],"default":"AUCTION"},"rfPredictionId":{"type":"string"},"promotion":{"$ref":"#/components/schemas/MetaPromotion"},"creativeFeatures":{"$ref":"#/components/schemas/MetaCreativeFeatures"},"catalogFormat":{"type":"string","enum":["single_image","carousel_images_multi_items","carousel_images_single_item","carousel_slideshows"]},"multiAdvertiser":{"type":"string","enum":["OPT_IN","OPT_OUT"]},"aiDisclosure":{"type":"string","enum":["OPT_IN","OPT_OUT"]},"validateOnly":{"type":"boolean"},"budgetAmount":{"type":"number"},"budgetType":{"type":"string","enum":["daily","lifetime"]},"status":{"type":"string","enum":["ACTIVE","PAUSED"]},"campaignStatus":{"type":"string","enum":["ACTIVE","PAUSED"]},"adSetStatus":{"type":"string","enum":["ACTIVE","PAUSED"]},"adStatus":{"$ref":"#/components/schemas/AdActivationStatus"},"budgetLevel":{"type":"string","enum":["adset","campaign"],"default":"adset"},"currency":{"type":"string","minLength":3,"maxLength":3},"headline":{"type":"string"},"longHeadline":{"type":"string","maxLength":90},"body":{"type":"string"},"description":{"type":"string","maxLength":255},"bodies":{"type":"array","minItems":1,"maxItems":5,"items":{"type":"string"}},"headlines":{"type":"array","minItems":1,"maxItems":5,"items":{"type":"string","maxLength":255}},"descriptions":{"type":"array","minItems":1,"maxItems":5,"items":{"type":"string","maxLength":255}},"callToAction":{"type":"string","enum":["BOOK_TRAVEL","CONTACT_US","DONATE","DONATE_NOW","DOWNLOAD","GET_DIRECTIONS","GO_LIVE","INTERESTED","LEARN_MORE","SEE_DETAILS","LIKE_PAGE","MESSAGE_PAGE","RAISE_MONEY","SAVE","SEND_TIP","SHOP_NOW","SIGN_UP","VIEW_INSTAGRAM_PROFILE","INSTAGRAM_MESSAGE","LOYALTY_LEARN_MORE","PURCHASE_GIFT_CARDS","PAY_TO_ACCESS","SEE_MORE","TRY_IN_CAMERA","WHATSAPP_LINK","GET_IN_TOUCH","TRY_NOW","ASK_A_QUESTION","START_A_CHAT","CHAT_NOW","ASK_US","CHAT_WITH_US","SHOP_ON_RETAILER","BOOK_NOW","CHECK_AVAILABILITY","ORDER_NOW","WHATSAPP_MESSAGE","GET_MOBILE_APP","INSTALL_MOBILE_APP","USE_MOBILE_APP","INSTALL_APP","USE_APP","PLAY_GAME","TRY_DEMO","WATCH_VIDEO","WATCH_MORE","OPEN_LINK","NO_BUTTON","LISTEN_MUSIC","MOBILE_DOWNLOAD","GET_OFFER","GET_OFFER_VIEW","BUY_NOW","BUY_TICKETS","UPDATE_APP","BET_NOW","ADD_TO_CART","SELL_NOW","GET_SHOWTIMES","LISTEN_NOW","GET_EVENT_TICKETS","REMIND_ME","SEARCH_MORE","PRE_REGISTER","SWIPE_UP_PRODUCT","SWIPE_UP_SHOP","PLAY_GAME_ON_FACEBOOK","VISIT_WORLD","OPEN_INSTANT_APP","JOIN_GROUP","GET_PROMOTIONS","SEND_UPDATES","INQUIRE_NOW","VISIT_PROFILE","CHAT_ON_WHATSAPP","EXPLORE_MORE","CONFIRM","JOIN_CHANNEL","MAKE_AN_APPOINTMENT","ASK_ABOUT_SERVICES","BOOK_A_CONSULTATION","GET_A_QUOTE","BUY_VIA_MESSAGE","ASK_FOR_MORE_INFO","VIEW_PRODUCT","VIEW_CHANNEL","WATCH_LIVE_VIDEO","JOIN_LIVE_VIDEO","IMAGINE","WATCH_NOW","STREAM_NOW","BUY_ACTIVITY_TICKETS","CALL","MISSED_CALL","CALL_NOW","CALL_ME","APPLY_NOW","BUY","GET_QUOTE","SUBSCRIBE","RECORD_NOW","VOTE_NOW","GIVE_FREE_RIDES","REGISTER_NOW","OPEN_MESSENGER_EXT","EVENT_RSVP","CIVIC_ACTION","SEND_INVITES","REFER_FRIENDS","REQUEST_TIME","SEE_MENU","SEARCH","TRY_IT","TRY_ON","LINK_CARD","DIAL_CODE","FIND_YOUR_GROUPS","START_ORDER","REGISTER","JOIN","ATTEND","REQUEST_DEMO","VIEW_QUOTE","APPLY"]},"linkUrl":{"type":"string","format":"uri"},"leadGenFormId":{"type":"string"},"imageUrl":{"type":"string","format":"uri"},"images":{"type":"object","properties":{"landscape":{"type":"string","format":"uri"},"square":{"type":"string","format":"uri"}}},"video":{"type":"object","properties":{"url":{"type":"string","format":"uri"},"id":{"type":"string"},"thumbnailUrl":{"type":"string","format":"uri"}}},"creatives":{"type":"array","minItems":1,"items":{"type":"object","required":["headline","body","linkUrl","callToAction"],"properties":{"creativeFeatures":{"$ref":"#/components/schemas/MetaCreativeFeatures"},"name":{"type":"string","maxLength":255},"headline":{"type":"string","maxLength":255},"body":{"type":"string"},"description":{"type":"string","maxLength":255},"imageUrl":{"type":"string","format":"uri"},"video":{"type":"object","required":["url"],"properties":{"url":{"type":"string","format":"uri"},"thumbnailUrl":{"type":"string","format":"uri"}}},"linkUrl":{"type":"string","format":"uri"},"callToAction":{"type":"string","enum":["BOOK_TRAVEL","CONTACT_US","DONATE","DONATE_NOW","DOWNLOAD","GET_DIRECTIONS","GO_LIVE","INTERESTED","LEARN_MORE","SEE_DETAILS","LIKE_PAGE","MESSAGE_PAGE","RAISE_MONEY","SAVE","SEND_TIP","SHOP_NOW","SIGN_UP","VIEW_INSTAGRAM_PROFILE","INSTAGRAM_MESSAGE","LOYALTY_LEARN_MORE","PURCHASE_GIFT_CARDS","PAY_TO_ACCESS","SEE_MORE","TRY_IN_CAMERA","WHATSAPP_LINK","GET_IN_TOUCH","TRY_NOW","ASK_A_QUESTION","START_A_CHAT","CHAT_NOW","ASK_US","CHAT_WITH_US","SHOP_ON_RETAILER","BOOK_NOW","CHECK_AVAILABILITY","ORDER_NOW","WHATSAPP_MESSAGE","GET_MOBILE_APP","INSTALL_MOBILE_APP","USE_MOBILE_APP","INSTALL_APP","USE_APP","PLAY_GAME","TRY_DEMO","WATCH_VIDEO","WATCH_MORE","OPEN_LINK","NO_BUTTON","LISTEN_MUSIC","MOBILE_DOWNLOAD","GET_OFFER","GET_OFFER_VIEW","BUY_NOW","BUY_TICKETS","UPDATE_APP","BET_NOW","ADD_TO_CART","SELL_NOW","GET_SHOWTIMES","LISTEN_NOW","GET_EVENT_TICKETS","REMIND_ME","SEARCH_MORE","PRE_REGISTER","SWIPE_UP_PRODUCT","SWIPE_UP_SHOP","PLAY_GAME_ON_FACEBOOK","VISIT_WORLD","OPEN_INSTANT_APP","JOIN_GROUP","GET_PROMOTIONS","SEND_UPDATES","INQUIRE_NOW","VISIT_PROFILE","CHAT_ON_WHATSAPP","EXPLORE_MORE","CONFIRM","JOIN_CHANNEL","MAKE_AN_APPOINTMENT","ASK_ABOUT_SERVICES","BOOK_A_CONSULTATION","GET_A_QUOTE","BUY_VIA_MESSAGE","ASK_FOR_MORE_INFO","VIEW_PRODUCT","VIEW_CHANNEL","WATCH_LIVE_VIDEO","JOIN_LIVE_VIDEO","IMAGINE","WATCH_NOW","STREAM_NOW","BUY_ACTIVITY_TICKETS","CALL","MISSED_CALL","CALL_NOW","CALL_ME","APPLY_NOW","BUY","GET_QUOTE","SUBSCRIBE","RECORD_NOW","VOTE_NOW","GIVE_FREE_RIDES","REGISTER_NOW","OPEN_MESSENGER_EXT","EVENT_RSVP","CIVIC_ACTION","SEND_INVITES","REFER_FRIENDS","REQUEST_TIME","SEE_MENU","SEARCH","TRY_IT","TRY_ON","LINK_CARD","DIAL_CODE","FIND_YOUR_GROUPS","START_ORDER"]}}}},"adSetId":{"type":"string"},"existingCampaignId":{"type":"string"},"phoneNumber":{"type":"string","pattern":"^\\+[1-9]\\d{6,14}$"},"existingCreativeId":{"type":"string"},"businessName":{"type":"string","maxLength":25},"boardId":{"type":"string"},"organizationId":{"type":"string"},"targeting":{"allOf":[{"$ref":"#/components/schemas/TargetingSpec"}]},"countries":{"type":"array","items":{"type":"string"}},"countryGroups":{"type":"array","items":{"type":"string","enum":["africa","asia","europe","north_america","south_america","oceania","central_america","caribbean","eea","euro_area","nafta","mercosur","afta","apec","gcc","cisfta","emerging_markets","itunes_app_store","android_free_store","android_paid_store"]}},"cities":{"type":"array","items":{"oneOf":[{"type":"string"},{"type":"object","required":["key"],"properties":{"key":{"type":"string"},"radius":{"type":"number"},"distance_unit":{"type":"string","enum":["mile","kilometer"]}}}]}},"regions":{"type":"array","items":{"oneOf":[{"type":"string"},{"type":"object","required":["key"],"properties":{"key":{"type":"string"}}}]}},"ageMin":{"type":"integer","minimum":13,"maximum":65},"ageMax":{"type":"integer","minimum":13,"maximum":65},"interests":{"type":"array","items":{"type":"object","required":["id","name"],"properties":{"id":{"type":"string"},"name":{"type":"string"}}}},"zips":{"type":"array","items":{"oneOf":[{"type":"string"},{"type":"object","required":["key"],"properties":{"key":{"type":"string"},"name":{"type":"string"}}}]}},"metros":{"type":"array","items":{"oneOf":[{"type":"string"},{"type":"object","required":["key"],"properties":{"key":{"type":"string"},"name":{"type":"string"}}}]}},"customLocations":{"type":"array","items":{"type":"object","required":["latitude","longitude","radius","distanceUnit"],"properties":{"latitude":{"type":"number","minimum":-90,"maximum":90},"longitude":{"type":"number","minimum":-180,"maximum":180},"radius":{"type":"number"},"distanceUnit":{"type":"string","enum":["mile","kilometer"]},"name":{"type":"string"},"address":{"type":"string"}}}},"behaviors":{"type":"array","items":{"type":"object","required":["id"],"properties":{"id":{"type":"string"},"name":{"type":"string"}}}},"workPositions":{"type":"array","items":{"type":"object","required":["id"],"properties":{"id":{"type":"string"},"name":{"type":"string"}}}},"workEmployers":{"type":"array","items":{"type":"object","required":["id"],"properties":{"id":{"type":"string"},"name":{"type":"string"}}}},"workIndustries":{"type":"array","items":{"type":"object","required":["id"],"properties":{"id":{"type":"string"},"name":{"type":"string"}}}},"incomeTier":{"type":"string","enum":["top_5","top_10","top_10_25","top_25_50"]},"languages":{"type":"array","items":{"type":"string"}},"placements":{"type":"object","properties":{"publisherPlatforms":{"type":"array","items":{"type":"string","enum":["facebook","instagram","threads","messenger","audience_network","whatsapp"]}},"facebookPositions":{"type":"array","items":{"type":"string","enum":["feed","right_hand_column","marketplace","story","search","instream_video","facebook_reels","facebook_reels_overlay","profile_feed","notification"]}},"instagramPositions":{"type":"array","items":{"type":"string","enum":["stream","story","explore","explore_home","reels","profile_feed","ig_search","profile_reels"]}},"messengerPositions":{"type":"array","items":{"type":"string","enum":["messenger_home","sponsored_messages","story"]}},"audienceNetworkPositions":{"type":"array","items":{"type":"string","enum":["classic","rewarded_video"]}},"threadsPositions":{"type":"array","items":{"type":"string","enum":["threads_stream"]}},"whatsappPositions":{"type":"array","items":{"type":"string","enum":["status"]}},"devicePlatforms":{"type":"array","items":{"type":"string","enum":["mobile","desktop"]}}}},"savedTargetingId":{"type":"string"},"rawTargeting":{"type":"object","additionalProperties":true},"specialAdCategories":{"type":"array","items":{"type":"string","enum":["HOUSING","EMPLOYMENT","CREDIT","FINANCIAL_PRODUCTS_SERVICES","ISSUES_ELECTIONS_POLITICS","ONLINE_GAMBLING_AND_GAMING"]}},"specialAdCategoryCountry":{"type":"array","items":{"type":"string"}},"regionalRegulatedCategories":{"type":"array","items":{"type":"string"}},"regionalRegulationIdentities":{"type":"object","additionalProperties":{"type":["string","integer"]}},"endDate":{"type":"string","format":"date-time"},"startDate":{"type":"string","format":"date-time"},"pageId":{"type":"string"},"instagramAccountId":{"type":"string"},"dynamicCreative":{"type":"object","properties":{"imageUrls":{"type":"array","minItems":1,"maxItems":10,"items":{"type":"string","format":"uri"}},"videoUrls":{"type":"array","minItems":1,"maxItems":10,"items":{"type":"string","format":"uri"}},"bodies":{"type":"array","maxItems":5,"items":{"type":"string"}},"titles":{"type":"array","maxItems":5,"items":{"type":"string"}},"descriptions":{"type":"array","maxItems":5,"items":{"type":"string"}},"linkUrls":{"type":"array","items":{"type":"string","format":"uri"}},"callToActionTypes":{"type":"array","items":{"type":"string","enum":["BOOK_TRAVEL","CONTACT_US","DONATE","DONATE_NOW","DOWNLOAD","GET_DIRECTIONS","GO_LIVE","INTERESTED","LEARN_MORE","SEE_DETAILS","LIKE_PAGE","MESSAGE_PAGE","RAISE_MONEY","SAVE","SEND_TIP","SHOP_NOW","SIGN_UP","VIEW_INSTAGRAM_PROFILE","INSTAGRAM_MESSAGE","LOYALTY_LEARN_MORE","PURCHASE_GIFT_CARDS","PAY_TO_ACCESS","SEE_MORE","TRY_IN_CAMERA","WHATSAPP_LINK","GET_IN_TOUCH","TRY_NOW","ASK_A_QUESTION","START_A_CHAT","CHAT_NOW","ASK_US","CHAT_WITH_US","SHOP_ON_RETAILER","BOOK_NOW","CHECK_AVAILABILITY","ORDER_NOW","WHATSAPP_MESSAGE","GET_MOBILE_APP","INSTALL_MOBILE_APP","USE_MOBILE_APP","INSTALL_APP","USE_APP","PLAY_GAME","TRY_DEMO","WATCH_VIDEO","WATCH_MORE","OPEN_LINK","NO_BUTTON","LISTEN_MUSIC","MOBILE_DOWNLOAD","GET_OFFER","GET_OFFER_VIEW","BUY_NOW","BUY_TICKETS","UPDATE_APP","BET_NOW","ADD_TO_CART","SELL_NOW","GET_SHOWTIMES","LISTEN_NOW","GET_EVENT_TICKETS","REMIND_ME","SEARCH_MORE","PRE_REGISTER","SWIPE_UP_PRODUCT","SWIPE_UP_SHOP","PLAY_GAME_ON_FACEBOOK","VISIT_WORLD","OPEN_INSTANT_APP","JOIN_GROUP","GET_PROMOTIONS","SEND_UPDATES","INQUIRE_NOW","VISIT_PROFILE","CHAT_ON_WHATSAPP","EXPLORE_MORE","CONFIRM","JOIN_CHANNEL","MAKE_AN_APPOINTMENT","ASK_ABOUT_SERVICES","BOOK_A_CONSULTATION","GET_A_QUOTE","BUY_VIA_MESSAGE","ASK_FOR_MORE_INFO","VIEW_PRODUCT","VIEW_CHANNEL","WATCH_LIVE_VIDEO","JOIN_LIVE_VIDEO","IMAGINE","WATCH_NOW","STREAM_NOW","BUY_ACTIVITY_TICKETS","CALL","MISSED_CALL","CALL_NOW","CALL_ME","APPLY_NOW","BUY","GET_QUOTE","SUBSCRIBE","RECORD_NOW","VOTE_NOW","GIVE_FREE_RIDES","REGISTER_NOW","OPEN_MESSENGER_EXT","EVENT_RSVP","CIVIC_ACTION","SEND_INVITES","REFER_FRIENDS","REQUEST_TIME","SEE_MENU","SEARCH","TRY_IT","TRY_ON","LINK_CARD","DIAL_CODE","FIND_YOUR_GROUPS","START_ORDER"]}},"adFormat":{"type":"string","enum":["SINGLE_IMAGE","CAROUSEL_IMAGE","SINGLE_VIDEO"]}}},"carouselCards":{"type":"array","minItems":2,"maxItems":10,"items":{"type":"object","required":["imageUrl"],"properties":{"imageUrl":{"type":"string","format":"uri"},"linkUrl":{"type":"string","format":"uri"},"headline":{"type":"string","maxLength":255},"description":{"type":"string","maxLength":255},"callToAction":{"type":"string"}}}},"optimizeCardOrder":{"type":"boolean"},"defaultLocale":{"type":"string"},"translations":{"type":"array","minItems":1,"maxItems":10,"items":{"type":"object","required":["locale","headline","body","description"],"properties":{"locale":{"type":"string"},"headline":{"type":"string","maxLength":255},"body":{"type":"string"},"description":{"type":"string","maxLength":255},"linkUrl":{"type":"string","format":"uri"},"imageUrl":{"type":"string","format":"uri"},"videoUrl":{"type":"string","format":"uri"},"thumbnailUrl":{"type":"string","format":"uri"}}}},"placementAssets":{"allOf":[{"$ref":"#/components/schemas/MetaPlacementAssets"}]},"audienceId":{"type":"string"},"campaignType":{"type":"string","enum":["display","search","pmax","demand_gen"],"default":"display"},"locationTargetingType":{"allOf":[{"$ref":"#/components/schemas/GoogleLocationTargetingType"}]},"assetGroup":{"$ref":"#/components/schemas/GooglePmaxAssetGroupInput"},"demandGen":{"$ref":"#/components/schemas/GoogleDemandGenInput"},"keywords":{"type":"array","maxItems":1000,"items":{"$ref":"#/components/schemas/KeywordEntry"}},"negativeKeywords":{"type":"array","maxItems":1000,"items":{"$ref":"#/components/schemas/KeywordEntry"}},"campaignNegativeKeywords":{"type":"array","maxItems":1000,"items":{"$ref":"#/components/schemas/KeywordEntry"}},"additionalHeadlines":{"type":"array","items":{"oneOf":[{"type":"string","minLength":1,"maxLength":30},{"$ref":"#/components/schemas/GoogleRsaHeadline"}]}},"additionalDescriptions":{"type":"array","items":{"oneOf":[{"type":"string","minLength":1,"maxLength":90},{"$ref":"#/components/schemas/GoogleRsaDescription"}]}},"sitelinks":{"type":"array","minItems":2,"maxItems":20,"items":{"type":"object","required":["text","linkUrl"],"properties":{"text":{"type":"string","minLength":1,"maxLength":25},"linkUrl":{"type":"string","format":"uri"},"description1":{"type":"string","minLength":1,"maxLength":35},"description2":{"type":"string","minLength":1,"maxLength":35}}}},"callouts":{"type":"array","minItems":1,"maxItems":20,"items":{"type":"string","minLength":1,"maxLength":25}},"structuredSnippets":{"type":"array","minItems":1,"maxItems":20,"items":{"type":"object","required":["header","values"],"properties":{"header":{"type":"string","enum":["Amenities","Brands","Courses","Degree programs","Destinations","Featured hotels","Insurance coverage","Models","Neighborhoods","Service catalog","Shows","Styles","Types"]},"values":{"type":"array","minItems":3,"maxItems":10,"items":{"type":"string","minLength":1,"maxLength":25}}}}},"advantageAudience":{"type":"integer","enum":[0,1]},"attributionSpec":{"type":"array","minItems":1,"maxItems":3,"items":{"type":"object","required":["eventType","windowDays"],"properties":{"eventType":{"type":"string","enum":["CLICK_THROUGH","VIEW_THROUGH","ENGAGED_VIDEO_VIEW"]},"windowDays":{"type":"integer","enum":[1,7,28]}}}},"gender":{"type":"string","enum":["all","male","female"],"default":"all"},"bidStrategy":{"allOf":[{"$ref":"#/components/schemas/BidStrategy"}],"deprecated":true},"bidAmount":{"type":"number","deprecated":true},"roasAverageFloor":{"type":"number","deprecated":true},"portfolioBidStrategyId":{"type":"string","pattern":"^\\d+$"},"targetImpressionShare":{"allOf":[{"$ref":"#/components/schemas/GoogleTargetImpressionShare"}]},"manualCpc":{"$ref":"#/components/schemas/GoogleManualCpc"},"networkSettings":{"allOf":[{"$ref":"#/components/schemas/GoogleNetworkSettings"}]},"valueRuleSetId":{"type":"string","pattern":"^\\d+$"},"valueRulesApplied":{"type":"boolean"},"platformSpecificData":{"oneOf":[{"$ref":"#/components/schemas/LinkedInAdsPlatformData"},{"$ref":"#/components/schemas/MetaAdsPlatformData"}]},"dsaBeneficiary":{"type":"string","maxLength":100},"dsaPayor":{"type":"string","maxLength":100},"brandIdentity":{"type":"object","required":["displayName","imageUrl"],"properties":{"displayName":{"type":"string","minLength":1,"maxLength":40},"imageUrl":{"type":"string","format":"uri"}}},"identityId":{"type":"string"},"identityType":{"type":"string","enum":["TT_USER","CUSTOMIZED_USER","BC_AUTH_TT"]},"smartPlus":{"type":"boolean"},"userOs":{"type":"array","minItems":1,"items":{"type":"string","minLength":1}},"userDevice":{"type":"array","minItems":1,"items":{"type":"string","minLength":1}},"isSkadnetworkAttribution":{"type":"boolean"},"campaignAttribution":{"type":"string","enum":["AEM","SKADNETWORK"]},"promotedObject":{"$ref":"#/components/schemas/AdPromotedObject"}}}}}},"x-pozy-area":"ads"}},"/v1/ads/leads":{"get":{"operationId":"listLeads","summary":"List submitted leads","tags":["Lead Gen"],"parameters":[{"name":"formId","in":"query","required":false,"schema":{"type":"string"}},{"name":"accountId","in":"query","required":false,"schema":{"type":"string"}},{"name":"accountIds","in":"query","required":false,"schema":{"type":"string"}},{"name":"status","in":"query","required":false,"schema":{"type":"string"}},{"name":"campaignId","in":"query","required":false,"schema":{"type":"string"}},{"name":"platform","in":"query","required":false,"schema":{"type":"string","enum":["meta","linkedin"]}},{"name":"q","in":"query","required":false,"schema":{"type":"string","maxLength":200}},{"name":"adAccountId","in":"query","required":false,"schema":{"type":"string"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":100,"default":25}},{"name":"since","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":253402300799}},{"name":"cursor","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string"},"leads":{"type":"array","items":{"$ref":"#/components/schemas/AdLead"}},"pagination":{"type":"object","properties":{"hasMore":{"type":"boolean"},"cursor":{"type":["string","null"]}}},"meta":{"type":"object","properties":{"lastCheckedAt":{"type":["string","null"],"format":"date-time"},"lastUpdated":{"type":"string","format":"date-time"}}}}}}}}},"x-pozy-area":"ads"}},"/v1/ads/leads/counts":{"get":{"operationId":"countLeads","summary":"Count leads by status","tags":["Lead Gen"],"parameters":[{"name":"accountId","in":"query","required":false,"schema":{"type":"string"}},{"name":"campaignId","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string"},"counts":{"type":"object","properties":{"new":{"type":"integer"},"contacted":{"type":"integer"},"unreachable":{"type":"integer"},"qualified":{"type":"integer"},"converted":{"type":"integer"},"disqualified":{"type":"integer"}}},"total":{"type":"integer"}}}}}}},"x-pozy-area":"ads"}},"/v1/ads/leads/{id}":{"patch":{"operationId":"updateLead","summary":"Update a lead's status","tags":["Lead Gen"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string"},"lead":{"$ref":"#/components/schemas/AdLead"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["status"],"properties":{"status":{"type":"string","enum":["new","contacted","unreachable","qualified","converted","disqualified"]},"value":{"type":"number","minimum":0},"currency":{"type":"string"},"accountId":{"type":"string"}}}}}},"x-pozy-area":"ads"}},"/v1/ads/lead-forms":{"get":{"operationId":"listLeadForms","summary":"List lead forms","tags":["Lead Gen"],"parameters":[{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}},{"name":"adAccountId","in":"query","required":false,"schema":{"type":"string"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":100,"default":25}},{"name":"cursor","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string"},"forms":{"type":"array","items":{"type":"object"}},"pagination":{"type":"object","properties":{"hasMore":{"type":"boolean"},"cursor":{"type":["string","null"]}}}}}}}}},"x-pozy-area":"ads"},"post":{"operationId":"createLeadForm","summary":"Create a lead form","tags":["Lead Gen"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string"},"form":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}}}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","name","privacyPolicyUrl"],"properties":{"accountId":{"type":"string"},"name":{"type":"string","maxLength":200},"questions":{"type":"array","minItems":1,"deprecated":true,"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string"},"key":{"type":"string"},"label":{"type":"string"},"options":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}}}},"inline_context":{"type":"string"}}}},"privacyPolicyUrl":{"type":"string","format":"uri"},"privacyPolicyLinkText":{"type":"string","maxLength":70,"deprecated":true},"followUpActionUrl":{"type":"string","format":"uri","deprecated":true},"locale":{"type":"string","deprecated":true},"thankYouTitle":{"type":"string","deprecated":true},"thankYouBody":{"type":"string","deprecated":true},"thankYouButtonText":{"type":"string","deprecated":true},"thankYouButtonType":{"type":"string","deprecated":true},"thankYouWebsiteUrl":{"type":"string","format":"uri","deprecated":true},"isOptimizedForQuality":{"type":"boolean","deprecated":true},"platformSpecificData":{"oneOf":[{"type":"object","title":"MetaLeadFormPlatformData","required":["questions"],"properties":{"questions":{"type":"array","minItems":1,"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string"},"key":{"type":"string"},"label":{"type":"string"},"options":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}}}},"inline_context":{"type":"string"}}}},"privacyPolicyLinkText":{"type":"string","maxLength":70},"followUpActionUrl":{"type":"string","format":"uri"},"locale":{"type":"string"},"thankYouTitle":{"type":"string"},"thankYouBody":{"type":"string"},"thankYouButtonText":{"type":"string"},"thankYouButtonType":{"type":"string"},"businessPhoneNumber":{"type":"string"},"countryCode":{"type":"string","pattern":"^[A-Za-z]{2}$"},"thankYouWebsiteUrl":{"type":"string","format":"uri"},"thankYouEnableMessenger":{"type":"boolean","default":false},"isOptimizedForQuality":{"type":"boolean"},"isPhoneSmsVerifyEnabled":{"type":"boolean","default":false},"blockDisplayForNonTargetedViewer":{"type":"boolean"},"questionPageCustomHeadline":{"type":"string"},"contextCard":{"type":"object","properties":{"title":{"type":"string"},"content":{"type":"array","items":{"type":"string"}},"style":{"type":"string","enum":["LIST_STYLE","PARAGRAPH_STYLE"]},"buttonText":{"type":"string"},"coverPhoto":{"type":"string","format":"uri"}}},"customDisclaimer":{"type":"object","required":["title","body","checkboxes"],"properties":{"title":{"type":"string"},"body":{"type":"string"},"checkboxes":{"type":"array","minItems":1,"items":{"type":"object","required":["key","text"],"properties":{"key":{"type":"string"},"text":{"type":"string"},"isRequired":{"type":"boolean","default":false},"isCheckedByDefault":{"type":"boolean","default":false}}}}}}}},{"type":"object","title":"LinkedInLeadFormPlatformData","required":["adAccountId","headline","description","questions"],"properties":{"adAccountId":{"type":"string"},"headline":{"type":"string","maxLength":255},"description":{"type":"string","maxLength":1500},"state":{"type":"string","enum":["DRAFT","PUBLISHED"]},"locale":{"type":"object","properties":{"country":{"type":"string"},"language":{"type":"string"}}},"consents":{"type":"array","items":{"type":"object","required":["description"],"properties":{"description":{"type":"string"},"required":{"type":"boolean","default":false}}}},"questions":{"type":"array","minItems":1,"items":{"oneOf":[{"type":"object","required":["kind","name","question"],"properties":{"kind":{"type":"string","enum":["text"]},"name":{"type":"string"},"question":{"type":"string"},"required":{"type":"boolean"},"responseEditable":{"type":"boolean"},"maxResponseLength":{"type":"integer"}}},{"type":"object","required":["kind","name","question","choices"],"properties":{"kind":{"type":"string","enum":["multipleChoice"]},"name":{"type":"string"},"question":{"type":"string"},"required":{"type":"boolean"},"responseEditable":{"type":"boolean"},"choices":{"type":"array","minItems":1,"items":{"type":"object","required":["id","text"],"properties":{"id":{"type":"integer"},"text":{"type":"string"}}}}}}]}}}}]}}}}}},"x-pozy-area":"ads"}},"/v1/ads/lead-forms/{formId}":{"get":{"operationId":"getLeadForm","summary":"Get a lead form","tags":["Lead Gen"],"parameters":[{"name":"formId","in":"path","required":true,"schema":{"type":"string"}},{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}},{"name":"fields","in":"query","required":false,"schema":{"type":"string","maxLength":2000}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string"},"form":{"oneOf":[{"$ref":"#/components/schemas/MetaLeadForm"},{"type":"object"}]}}}}}}},"x-pozy-area":"ads"},"delete":{"operationId":"archiveLeadForm","summary":"Archive a lead form","tags":["Lead Gen"],"parameters":[{"name":"formId","in":"path","required":true,"schema":{"type":"string"}},{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string"},"formId":{"type":"string"},"archived":{"type":"boolean"}}}}}}},"x-pozy-area":"ads"}},"/v1/ads/lead-forms/{formId}/leads":{"get":{"operationId":"listFormLeads","summary":"List leads for a single form","tags":["Lead Gen"],"parameters":[{"name":"formId","in":"path","required":true,"schema":{"type":"string"}},{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":100,"default":25}},{"name":"cursor","in":"query","required":false,"schema":{"type":"string"}},{"name":"since","in":"query","required":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string"},"leads":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"leadId":{"type":"string"},"status":{"type":"string"},"createdTime":{"type":["string","null"]},"adId":{"type":["string","null"]},"formId":{"type":"string"},"fields":{"type":"object","additionalProperties":{"type":"string"}},"fieldData":{"type":"array","items":{"type":"object"}},"consents":{"$ref":"#/components/schemas/AdLeadConsents"}}}},"pagination":{"type":"object","properties":{"hasMore":{"type":"boolean"},"cursor":{"type":["string","null"]}}},"meta":{"type":"object","properties":{"platform":{"type":"string"},"accountId":{"type":"string"},"formId":{"type":"string"},"source":{"type":"string","enum":["persisted","live"]},"lastCheckedAt":{"type":["string","null"],"format":"date-time"},"lastUpdated":{"type":"string","format":"date-time"}}}}}}}}},"x-pozy-area":"ads"}},"/v1/ads/lead-forms/{formId}/test-leads":{"post":{"operationId":"createTestLead","summary":"Create a test lead","tags":["Lead Gen"],"parameters":[{"name":"formId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string"},"testLead":{"type":"object","properties":{"id":{"type":"string"}}}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","fieldData"],"properties":{"accountId":{"type":"string"},"fieldData":{"type":"array","minItems":1,"items":{"type":"object","required":["name","values"],"properties":{"name":{"type":"string"},"values":{"type":"array","items":{"type":"string"},"minItems":1}}}}}}}}},"x-pozy-area":"ads"},"delete":{"operationId":"deleteTestLead","summary":"Delete a test lead","tags":["Lead Gen"],"parameters":[{"name":"formId","in":"path","required":true,"schema":{"type":"string"}},{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}},{"name":"leadId","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string"},"deleted":{"type":"array","items":{"type":"string"}}}}}}}},"x-pozy-area":"ads"}},"/v1/ads/images":{"get":{"operationId":"listAdImages","summary":"Ad image library","tags":["Ad Creatives"],"parameters":[{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}},{"name":"adAccountId","in":"query","required":true,"schema":{"type":"string"}},{"name":"fields","in":"query","required":false,"schema":{"type":"string"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":100,"default":25}},{"name":"after","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"adAccountId":{"type":"string"},"data":{"type":"array","items":{"type":"object"}},"paging":{"type":"object","properties":{"after":{"type":["string","null"]}}}}}}}}},"x-pozy-area":"ads"},"post":{"operationId":"uploadAdImage","summary":"Upload an ad image from base64","tags":["Ad Creatives"],"responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"adAccountId":{"type":"string"},"image":{"type":"object","properties":{"hash":{"type":"string"},"url":{"type":"string"}}}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","adAccountId","imageBase64"],"properties":{"accountId":{"type":"string"},"adAccountId":{"type":"string"},"imageBase64":{"type":"string"},"filename":{"type":"string"}}}}}},"x-pozy-area":"ads"}},"/v1/ads/videos":{"get":{"operationId":"listAdVideos","summary":"Ad video library","tags":["Ad Creatives"],"parameters":[{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}},{"name":"adAccountId","in":"query","required":true,"schema":{"type":"string"}},{"name":"fields","in":"query","required":false,"schema":{"type":"string"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":100,"default":25}},{"name":"after","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"adAccountId":{"type":"string"},"data":{"type":"array","items":{"type":"object"}},"paging":{"type":"object","properties":{"after":{"type":["string","null"]}}}}}}}}},"x-pozy-area":"ads"},"post":{"operationId":"uploadAdVideo","summary":"Upload an ad video","tags":["Ad Creatives"],"responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"adAccountId":{"type":"string"},"video":{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string","enum":["ready"]},"thumbnailUrl":{"type":["string","null"]}}}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","adAccountId"],"properties":{"accountId":{"type":"string"},"adAccountId":{"type":"string"},"videoUrl":{"type":"string"},"videoBase64":{"type":"string"},"filename":{"type":"string","maxLength":255},"name":{"type":"string","maxLength":255},"async":{"type":"boolean","default":false}}}}}},"x-pozy-area":"ads"}},"/v1/ads/videos/{videoId}":{"get":{"operationId":"getAdVideoStatus","summary":"Get ad video processing status","tags":["Ad Creatives"],"parameters":[{"name":"videoId","in":"path","required":true,"schema":{"type":"string"}},{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}},{"name":"adAccountId","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"adAccountId":{"type":"string"},"video":{"type":"object","required":["id","status","platformStatus","processingProgress","error","thumbnailUrl"],"properties":{"id":{"type":"string"},"status":{"type":"string","enum":["processing","ready","error"]},"platformStatus":{"type":["string","null"]},"processingProgress":{"type":["integer","null"],"minimum":0,"maximum":100},"error":{"type":["string","null"]},"thumbnailUrl":{"type":["string","null"]}}}}}}}}},"x-pozy-area":"ads"},"delete":{"operationId":"deleteAdVideo","summary":"Delete an ad video","tags":["Ad Creatives"],"parameters":[{"name":"videoId","in":"path","required":true,"schema":{"type":"string"}},{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}},{"name":"adAccountId","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"adAccountId":{"type":"string"},"videoId":{"type":"string"},"success":{"type":"boolean"}}}}}}},"x-pozy-area":"ads"}},"/v1/ads/interests":{"get":{"operationId":"searchAdInterests","summary":"Search targeting interests","tags":["Ad Targeting"],"deprecated":true,"parameters":[{"name":"q","in":"query","required":true,"schema":{"type":"string"}},{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"interests":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"category":{"type":"string"}}}}}}}}}},"x-pozy-area":"ads"}},"/v1/ads/targeting/search":{"get":{"operationId":"searchAdTargeting","summary":"Search targeting options","tags":["Ad Targeting"],"parameters":[{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}},{"name":"q","in":"query","required":true,"schema":{"type":"string"}},{"name":"dimension","in":"query","required":false,"schema":{"type":"string","enum":["geo","interest","interestSuggestion","interestKeyword","behavior","hashtag","income","language","workPosition","workEmployer","workIndustry","industry","jobFunction","seniority","companySize","skill","community","conversationKeyword"],"default":"interest"}},{"name":"geoType","in":"query","required":false,"schema":{"type":"string","enum":["all","country","country_group","region","city","subcity","neighborhood","place","zip","metro_area","geo_market"],"default":"city"}},{"name":"countryCode","in":"query","required":false,"schema":{"type":"string","minLength":2,"maxLength":2}},{"name":"adAccountId","in":"query","required":false,"schema":{"type":"string"}},{"name":"locale","in":"query","required":false,"schema":{"type":"string","pattern":"^[a-z]{2,3}_[A-Z]{2}$"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":100,"default":25}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","required":["id","name","type"],"properties":{"id":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"},"path":{"type":"array","items":{"type":"string"}},"audienceSize":{"type":["integer","null"]},"status":{"type":"string"},"countryCode":{"type":"string"},"platformId":{"type":"string"}}}}}}}}}},"x-pozy-area":"ads"}},"/v1/ads/targeting/browse":{"get":{"operationId":"browseAdTargeting","summary":"Browse targeting categories","tags":["Ad Targeting"],"parameters":[{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}},{"name":"adAccountId","in":"query","required":true,"schema":{"type":"string","pattern":"^act_\\d+$"}},{"name":"type","in":"query","required":false,"schema":{"type":"string"}},{"name":"parentNodeId","in":"query","required":false,"schema":{"type":"string"}},{"name":"selectable","in":"query","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","required":["adAccountId","nodes"],"properties":{"adAccountId":{"type":"string"},"nodes":{"type":"array","items":{"type":"object","required":["nodeId","parentNodeId","id","name","type","path","selectable"],"properties":{"nodeId":{"type":"string"},"parentNodeId":{"type":["string","null"]},"id":{"type":["string","null"]},"name":{"type":"string"},"type":{"type":["string","null"]},"path":{"type":"array","items":{"type":"string"}},"selectable":{"type":"boolean"},"description":{"type":"string"},"audienceSizeLowerBound":{"type":"integer"},"audienceSizeUpperBound":{"type":"integer"}}}}}}}}}},"x-pozy-area":"ads"}},"/v1/ads/library":{"get":{"operationId":"searchAdLibrary","summary":"Search the public Ad Library","tags":["Ad Library"],"parameters":[{"name":"platform","in":"query","required":false,"schema":{"type":"string","enum":["meta","linkedin"]}},{"name":"accountId","in":"query","required":false,"schema":{"type":"string"}},{"name":"q","in":"query","required":false,"schema":{"type":"string","maxLength":100}},{"name":"pageIds","in":"query","required":false,"schema":{"type":"string"}},{"name":"advertiser","in":"query","required":false,"schema":{"type":"string","maxLength":100}},{"name":"countries","in":"query","required":false,"schema":{"type":"string"}},{"name":"adType","in":"query","required":false,"schema":{"type":"string","enum":["ALL","POLITICAL_AND_ISSUE_ADS","HOUSING_ADS","EMPLOYMENT_ADS","FINANCIAL_PRODUCTS_AND_SERVICES_ADS"],"default":"ALL"}},{"name":"status","in":"query","required":false,"schema":{"type":"string","enum":["ACTIVE","INACTIVE","ALL"],"default":"ACTIVE"}},{"name":"platforms","in":"query","required":false,"schema":{"type":"string"}},{"name":"mediaType","in":"query","required":false,"schema":{"type":"string","enum":["ALL","IMAGE","MEME","VIDEO","NONE"]}},{"name":"languages","in":"query","required":false,"schema":{"type":"string"}},{"name":"since","in":"query","required":false,"schema":{"type":"string","format":"date"}},{"name":"until","in":"query","required":false,"schema":{"type":"string","format":"date"}},{"name":"searchType","in":"query","required":false,"schema":{"type":"string","enum":["KEYWORD_UNORDERED","KEYWORD_EXACT_PHRASE"],"default":"KEYWORD_UNORDERED"}},{"name":"fields","in":"query","required":false,"schema":{"type":"string"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":100,"default":25}},{"name":"after","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","required":["platform","data","paging"],"properties":{"platform":{"type":"string","enum":["meta","linkedin"]},"data":{"type":"array","items":{"type":"object"}},"paging":{"type":"object","properties":{"after":{"type":["string","null"]},"total":{"type":"integer"}}}}}}}}},"x-pozy-area":"ads"}},"/v1/ads/targeting/reach-estimate":{"post":{"operationId":"estimateAdReach","summary":"Estimate audience reach","tags":["Ad Targeting"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","required":["available"],"properties":{"available":{"type":"boolean"},"lower":{"type":["integer","null"]},"upper":{"type":["integer","null"]},"daily":{"type":["integer","null"]},"active":{"type":["integer","null"]},"currency":{"type":["string","null"]},"estimateReady":{"type":["boolean","null"]}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","adAccountId"],"properties":{"accountId":{"type":"string"},"adAccountId":{"type":"string"},"spec":{"allOf":[{"$ref":"#/components/schemas/TargetingSpec"}]},"rawTargeting":{"type":"object","additionalProperties":true},"optimizationGoal":{"type":"string"}}}}}},"x-pozy-area":"ads"}},"/v1/ads/targeting/bid-pricing":{"post":{"operationId":"getLinkedInBidPricing","summary":"Suggested bid and budget bounds","tags":["Ad Targeting"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","required":["available"],"properties":{"available":{"type":"boolean"},"pricing":{"type":["object","null"],"properties":{"bidLimits":{"type":"object","properties":{"min":{"$ref":"#/components/schemas/MoneyAmount"},"max":{"$ref":"#/components/schemas/MoneyAmount"}}},"suggestedBid":{"type":"object","properties":{"min":{"$ref":"#/components/schemas/MoneyAmount"},"default":{"$ref":"#/components/schemas/MoneyAmount"},"max":{"$ref":"#/components/schemas/MoneyAmount"}}},"dailyBudgetLimits":{"type":"object","properties":{"min":{"$ref":"#/components/schemas/MoneyAmount"},"default":{"$ref":"#/components/schemas/MoneyAmount"},"max":{"$ref":"#/components/schemas/MoneyAmount"}}}}}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","adAccountId","spec"],"properties":{"accountId":{"type":"string"},"adAccountId":{"type":"string"},"spec":{"allOf":[{"$ref":"#/components/schemas/TargetingSpec"}]},"campaignType":{"type":"string","enum":["TEXT_AD","SPONSORED_UPDATES","SPONSORED_INMAILS"]},"bidType":{"type":"string","enum":["CPM","CPC","CPV"]},"matchType":{"type":"string","enum":["EXACT","AUDIENCE_EXPANDED"]},"currency":{"type":"string","minLength":3,"maxLength":3},"objectiveType":{"type":"string"},"optimizationTargetType":{"type":"string"},"dailyBudget":{"type":"number"}}}}}},"x-pozy-area":"ads"}},"/v1/ads/targeting/supply-forecast":{"post":{"operationId":"getLinkedInSupplyForecast","summary":"Forecast ad delivery","tags":["Ad Targeting"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","required":["available"],"properties":{"available":{"type":"boolean"},"forecast":{"type":"array","items":{"type":"object","properties":{"metricType":{"type":"string"},"granularity":{"type":"string","enum":["DAILY","SEVEN_DAY","THIRTY_DAY","CUSTOM"]},"timeSeries":{"type":"array","items":{"type":"object","properties":{"timestamp":{"type":"integer"},"value":{"type":"number"},"adForecastRange":{"type":"object","properties":{"lowEnd":{"type":"number"},"highEnd":{"type":"number"}}}}}}}}}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","adAccountId","spec","timeRangeStart","timeRangeEnd"],"properties":{"accountId":{"type":"string"},"adAccountId":{"type":"string"},"spec":{"allOf":[{"$ref":"#/components/schemas/TargetingSpec"}]},"campaignType":{"type":"string","enum":["SPONSORED_UPDATES","SPONSORED_INMAILS","DYNAMIC"]},"timeRangeStart":{"type":"integer"},"timeRangeEnd":{"type":"integer"},"objectiveType":{"type":"string"},"optimizationTarget":{"type":"string"},"dailyBudget":{"type":"number"},"totalBudget":{"type":"number"},"currency":{"type":"string","minLength":3,"maxLength":3},"competingBid":{"type":"object","required":["bidType","amount"],"properties":{"bidType":{"type":"string","enum":["CPM","CPC","CPV"]},"amount":{"type":"number"}}},"enableAudienceNetwork":{"type":"boolean"},"enableAudienceExpansion":{"type":"boolean"},"connectedTelevisionOnly":{"type":"boolean"}}}}}},"x-pozy-area":"ads"}},"/v1/ads/catalogs":{"get":{"operationId":"listAdCatalogs","summary":"List Meta product catalogs","tags":["Product Catalogs"],"parameters":[{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}},{"name":"catalogAccountId","in":"query","required":false,"schema":{"type":"string"}},{"name":"adAccountId","in":"query","required":false,"schema":{"type":"string"}},{"name":"businessId","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"businessId":{"type":"string"},"catalogs":{"type":"array","items":{"$ref":"#/components/schemas/MetaProductCatalog"}}}}}}}},"x-pozy-area":"ads"},"post":{"operationId":"createAdCatalog","summary":"Create a Meta product catalog","tags":["Product Catalogs"],"responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"catalog":{"$ref":"#/components/schemas/MetaProductCatalog"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","name"],"properties":{"accountId":{"type":"string"},"catalogAccountId":{"type":"string"},"adAccountId":{"type":"string"},"businessId":{"type":"string"},"name":{"type":"string","maxLength":100},"vertical":{"type":"string","enum":["commerce","adoptable_pets","apps_and_software","articles_and_publications","destinations","flights","generic","home_listings","hotels","local_service_businesses","media_titles","offer_items","offline_commerce","services","transactable_items","vehicles","local_service_business"],"default":"commerce"}}}}}},"x-pozy-area":"ads"}},"/v1/ads/catalogs/{catalogId}":{"get":{"operationId":"getAdCatalog","summary":"Get a product catalog","tags":["Product Catalogs"],"parameters":[{"name":"catalogId","in":"path","required":true,"schema":{"type":"string"}},{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}},{"name":"catalogAccountId","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"catalog":{"$ref":"#/components/schemas/MetaProductCatalog"}}}}}}},"x-pozy-area":"ads"},"delete":{"operationId":"deleteAdCatalog","summary":"Delete a product catalog","tags":["Product Catalogs"],"parameters":[{"name":"catalogId","in":"path","required":true,"schema":{"type":"string"}},{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}},{"name":"catalogAccountId","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"catalogId":{"type":"string"}}}}}}},"x-pozy-area":"ads"}},"/v1/ads/catalogs/{catalogId}/products":{"get":{"operationId":"listAdCatalogProducts","summary":"List a catalog's products","tags":["Product Catalogs"],"parameters":[{"name":"catalogId","in":"path","required":true,"schema":{"type":"string"}},{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}},{"name":"catalogAccountId","in":"query","required":false,"schema":{"type":"string"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":100,"default":25}},{"name":"after","in":"query","required":false,"schema":{"type":"string"}},{"name":"retailerId","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"products":{"type":"array","items":{"$ref":"#/components/schemas/MetaCatalogProduct"}},"nextCursor":{"type":["string","null"]}}}}}}},"x-pozy-area":"ads"},"post":{"operationId":"createAdCatalogProduct","summary":"Add a product to a catalog","tags":["Product Catalogs"],"parameters":[{"name":"catalogId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"product":{"$ref":"#/components/schemas/MetaCatalogProduct"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","product"],"properties":{"accountId":{"type":"string"},"catalogAccountId":{"type":"string"},"product":{"type":"object","properties":{"retailerId":{"type":"string","maxLength":100},"name":{"type":"string","maxLength":200},"description":{"type":"string","maxLength":9999},"url":{"type":"string","format":"uri"},"imageUrl":{"type":"string","format":"uri"},"additionalImageUrls":{"type":"array","maxItems":20,"items":{"type":"string","format":"uri"}},"price":{"type":"number"},"currency":{"type":"string"},"salePrice":{"type":"number"},"salePriceStartDate":{"type":"string"},"salePriceEndDate":{"type":"string"},"availability":{"type":"string","enum":["in stock","out of stock","preorder","available for order","discontinued","pending"]},"condition":{"type":"string","enum":["new","refurbished","used"]},"brand":{"type":"string","maxLength":100},"category":{"type":"string","maxLength":250},"googleProductCategory":{"type":"string","maxLength":250},"productType":{"type":"string","maxLength":750},"gtin":{"type":"string","maxLength":50},"mpn":{"type":"string","maxLength":100},"inventory":{"type":"integer","minimum":0},"visibility":{"type":"string","enum":["published","staging"]},"color":{"type":"string","maxLength":200},"size":{"type":"string","maxLength":200},"gender":{"type":"string","enum":["female","male","unisex"]},"material":{"type":"string","maxLength":200},"pattern":{"type":"string","maxLength":100},"customLabel0":{"type":"string","maxLength":100},"customLabel1":{"type":"string","maxLength":100},"customLabel2":{"type":"string","maxLength":100},"customLabel3":{"type":"string","maxLength":100},"customLabel4":{"type":"string","maxLength":100}},"required":["retailerId","name","url","imageUrl","price","currency"]}}}}}},"x-pozy-area":"ads"}},"/v1/ads/catalogs/{catalogId}/products/batch":{"post":{"operationId":"batchAdCatalogProducts","summary":"Create, update or delete products in bulk","tags":["Product Catalogs"],"parameters":[{"name":"catalogId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"202":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"handles":{"type":"array","items":{"type":"string"}},"statusUrl":{"type":"string"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","requests"],"properties":{"accountId":{"type":"string"},"catalogAccountId":{"type":"string"},"requests":{"type":"array","minItems":1,"maxItems":5000,"items":{"type":"object","required":["method","product"],"properties":{"method":{"type":"string","enum":["CREATE","UPDATE","DELETE"]},"product":{"type":"object","properties":{"retailerId":{"type":"string","maxLength":100},"name":{"type":"string","maxLength":200},"description":{"type":"string","maxLength":9999},"url":{"type":"string","format":"uri"},"imageUrl":{"type":"string","format":"uri"},"additionalImageUrls":{"type":"array","maxItems":20,"items":{"type":"string","format":"uri"}},"price":{"type":"number"},"currency":{"type":"string"},"salePrice":{"type":"number"},"salePriceStartDate":{"type":"string"},"salePriceEndDate":{"type":"string"},"availability":{"type":"string","enum":["in stock","out of stock","preorder","available for order","discontinued","pending"]},"condition":{"type":"string","enum":["new","refurbished","used"]},"brand":{"type":"string","maxLength":100},"category":{"type":"string","maxLength":250},"googleProductCategory":{"type":"string","maxLength":250},"productType":{"type":"string","maxLength":750},"gtin":{"type":"string","maxLength":50},"mpn":{"type":"string","maxLength":100},"inventory":{"type":"integer","minimum":0},"visibility":{"type":"string","enum":["published","staging"]},"color":{"type":"string","maxLength":200},"size":{"type":"string","maxLength":200},"gender":{"type":"string","enum":["female","male","unisex"]},"material":{"type":"string","maxLength":200},"pattern":{"type":"string","maxLength":100},"customLabel0":{"type":"string","maxLength":100},"customLabel1":{"type":"string","maxLength":100},"customLabel2":{"type":"string","maxLength":100},"customLabel3":{"type":"string","maxLength":100},"customLabel4":{"type":"string","maxLength":100}},"required":["retailerId"]}}}}}}}}},"x-pozy-area":"ads"}},"/v1/ads/catalogs/{catalogId}/batches/{handle}":{"get":{"operationId":"getAdCatalogBatch","summary":"Get a bulk request's status","tags":["Product Catalogs"],"parameters":[{"name":"catalogId","in":"path","required":true,"schema":{"type":"string"}},{"name":"handle","in":"path","required":true,"schema":{"type":"string"}},{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}},{"name":"catalogAccountId","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"batch":{"type":"object","properties":{"handle":{"type":"string"},"status":{"type":"string"},"errorsTotalCount":{"type":"integer"},"errors":{"type":"array","items":{"type":"object","properties":{"retailerId":{"type":["string","null"]},"message":{"type":"string"}}}}}}}}}}}},"x-pozy-area":"ads"}},"/v1/ads/catalogs/{catalogId}/products/{productId}":{"get":{"operationId":"getAdCatalogProduct","summary":"Get a product","tags":["Product Catalogs"],"parameters":[{"name":"catalogId","in":"path","required":true,"schema":{"type":"string"}},{"name":"productId","in":"path","required":true,"schema":{"type":"string"}},{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}},{"name":"catalogAccountId","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"product":{"$ref":"#/components/schemas/MetaCatalogProduct"}}}}}}},"x-pozy-area":"ads"},"put":{"operationId":"updateAdCatalogProduct","summary":"Update a product","tags":["Product Catalogs"],"parameters":[{"name":"catalogId","in":"path","required":true,"schema":{"type":"string"}},{"name":"productId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"product":{"$ref":"#/components/schemas/MetaCatalogProduct"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","product"],"properties":{"accountId":{"type":"string"},"catalogAccountId":{"type":"string"},"product":{"$ref":"#/components/schemas/MetaCatalogProductInput"}}}}}},"x-pozy-area":"ads"},"delete":{"operationId":"deleteAdCatalogProduct","summary":"Delete a product","tags":["Product Catalogs"],"parameters":[{"name":"catalogId","in":"path","required":true,"schema":{"type":"string"}},{"name":"productId","in":"path","required":true,"schema":{"type":"string"}},{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}},{"name":"catalogAccountId","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"productId":{"type":"string"}}}}}}},"x-pozy-area":"ads"}},"/v1/ads/catalogs/{catalogId}/feeds":{"get":{"operationId":"listAdCatalogFeeds","summary":"List a catalog's product feeds","tags":["Product Catalogs"],"parameters":[{"name":"catalogId","in":"path","required":true,"schema":{"type":"string"}},{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}},{"name":"catalogAccountId","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"feeds":{"type":"array","items":{"$ref":"#/components/schemas/MetaProductFeed"}}}}}}}},"x-pozy-area":"ads"},"post":{"operationId":"createAdCatalogFeed","summary":"Create a product feed","tags":["Product Catalogs"],"parameters":[{"name":"catalogId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"feed":{"$ref":"#/components/schemas/MetaProductFeed"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","name"],"properties":{"accountId":{"type":"string"},"catalogAccountId":{"type":"string"},"name":{"type":"string","maxLength":100},"schedule":{"type":"object","required":["interval","url"],"properties":{"interval":{"type":"string","enum":["HOURLY","DAILY","WEEKLY"]},"url":{"type":"string","format":"uri"},"hour":{"type":"integer","minimum":0,"maximum":23},"dayOfWeek":{"type":"string","enum":["SUNDAY","MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY"]}}}}}}}},"x-pozy-area":"ads"}},"/v1/ads/catalogs/{catalogId}/feeds/{feedId}/uploads":{"get":{"operationId":"listAdCatalogFeedUploads","summary":"List a feed's uploads","tags":["Product Catalogs"],"parameters":[{"name":"catalogId","in":"path","required":true,"schema":{"type":"string"}},{"name":"feedId","in":"path","required":true,"schema":{"type":"string"}},{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}},{"name":"catalogAccountId","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"uploads":{"type":"array","items":{"$ref":"#/components/schemas/MetaFeedUpload"}}}}}}}},"x-pozy-area":"ads"},"post":{"operationId":"createAdCatalogFeedUpload","summary":"Fetch a feed file now","tags":["Product Catalogs"],"parameters":[{"name":"catalogId","in":"path","required":true,"schema":{"type":"string"}},{"name":"feedId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"202":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"upload":{"type":"object","properties":{"id":{"type":"string"}}}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","url"],"properties":{"accountId":{"type":"string"},"catalogAccountId":{"type":"string"},"url":{"type":"string","format":"uri"}}}}}},"x-pozy-area":"ads"}},"/v1/ads/catalogs/{catalogId}/product-sets":{"get":{"operationId":"listAdCatalogProductSets","summary":"List a catalog's product sets","tags":["Product Catalogs"],"parameters":[{"name":"catalogId","in":"path","required":true,"schema":{"type":"string"}},{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}},{"name":"catalogAccountId","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"productSets":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"productCount":{"type":"integer"}}}}}}}}}},"x-pozy-area":"ads"},"post":{"operationId":"createAdCatalogProductSet","summary":"Create a product set","tags":["Product Catalogs"],"parameters":[{"name":"catalogId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"productSet":{"$ref":"#/components/schemas/MetaProductSet"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","name","filter"],"properties":{"accountId":{"type":"string"},"catalogAccountId":{"type":"string"},"name":{"type":"string","maxLength":100},"filter":{"type":"object","additionalProperties":true}}}}}},"x-pozy-area":"ads"}},"/v1/ads/catalogs/{catalogId}/product-sets/{productSetId}":{"put":{"operationId":"updateAdCatalogProductSet","summary":"Update a product set","tags":["Product Catalogs"],"parameters":[{"name":"catalogId","in":"path","required":true,"schema":{"type":"string"}},{"name":"productSetId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"productSet":{"$ref":"#/components/schemas/MetaProductSet"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId"],"properties":{"accountId":{"type":"string"},"catalogAccountId":{"type":"string"},"name":{"type":"string","maxLength":100},"filter":{"type":"object","additionalProperties":true}}}}}},"x-pozy-area":"ads"},"delete":{"operationId":"deleteAdCatalogProductSet","summary":"Delete a product set","tags":["Product Catalogs"],"parameters":[{"name":"catalogId","in":"path","required":true,"schema":{"type":"string"}},{"name":"productSetId","in":"path","required":true,"schema":{"type":"string"}},{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}},{"name":"catalogAccountId","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"productSetId":{"type":"string"}}}}}}},"x-pozy-area":"ads"}},"/v1/ads/audiences":{"get":{"operationId":"listAdAudiences","summary":"List custom audiences","tags":["Ad Audiences"],"parameters":[{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}},{"name":"adAccountId","in":"query","required":true,"schema":{"type":"string"}},{"name":"platform","in":"query","required":false,"schema":{"type":"string","enum":["facebook","instagram","googleads","tiktok","tiktokads","pinterest","linkedin","linkedinads","twitter","xads","redditads"]}},{"name":"type","in":"query","required":false,"schema":{"type":"string","enum":["customer_list","company_list","engagement","meta_engagement","website","website_retargeting","lookalike","saved_targeting"]}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"audiences":{"type":"array","items":{"type":"object","properties":{"id":{"type":["string","null"]},"accountId":{"type":"string"},"platformAudienceId":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"type":{"type":"string","enum":["customer_list","company_list","engagement","meta_engagement","tiktok_engagement","pinterest_engagement","website","website_retargeting","lookalike","saved_targeting","reddit_engagement","third_party","in_market"]},"spec":{"anyOf":[{"$ref":"#/components/schemas/TargetingSpec"},{"type":"null"}]},"platform":{"type":"string"},"size":{"type":"integer"},"status":{"type":"string"}}}}}}}}}},"x-pozy-area":"ads"},"post":{"operationId":"createAdAudience","summary":"Create custom audience","tags":["Ad Audiences"],"responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"audience":{"type":"object"},"message":{"type":"string"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"type":"object","title":"UploadedOrDerivedAudience","required":["accountId","adAccountId","name","type"],"properties":{"accountId":{"type":"string"},"adAccountId":{"type":"string"},"name":{"type":"string","maxLength":255},"description":{"type":"string"},"type":{"type":"string","enum":["customer_list","company_list","engagement","meta_engagement","tiktok_engagement","pinterest_engagement","website","website_retargeting","lookalike"]},"matchRules":{"type":"array","minItems":1,"maxItems":50,"items":{"type":"object","additionalProperties":false,"required":["matchType","matchValue"],"properties":{"matchType":{"type":"string","enum":["EXACT","STARTS_WITH","CONTAINS","ENDS_WITH"]},"matchValue":{"type":"string"}}}},"sourceType":{"type":"string","enum":["VIDEO_ADS","LEAD_GEN_FORMS","ORGANIZATION_PAGES","EVENT_PAGES","SINGLE_IMAGE_ADS"]},"trigger":{"type":"string"},"lookbackDays":{"type":"integer","enum":[30,60,90,180,365]},"engagementSources":{"type":"array","minItems":1,"maxItems":50,"items":{"type":"string"}},"companies":{"type":"array","minItems":1,"maxItems":300000,"items":{"type":"object","additionalProperties":false,"properties":{"name":{"type":"string","maxLength":255},"domain":{"type":"string","maxLength":100},"website":{"type":"string","maxLength":100},"linkedinPageUrl":{"type":"string"}}}},"pixelId":{"type":"string"},"retentionDays":{"type":"integer","minimum":1,"maximum":540},"engagementSource":{"type":"string","enum":["page","instagram","video"]},"sourceId":{"type":"string"},"event":{"type":"string","maxLength":100},"sourceAudienceId":{"type":"string"},"country":{"type":"string"},"ratio":{"type":"number","minimum":0.01,"maximum":0.2},"size":{"type":"string","enum":["narrow","balanced","broad"]},"source":{"type":"string","enum":["ads","organic_video","live_video","business_account"]},"sourceIds":{"type":"array","minItems":1,"maxItems":50,"items":{"type":"string"}},"identityId":{"type":"string"},"identityType":{"type":"string","enum":["TT_USER","BC_AUTH_TT"]},"identityAuthorizedBcId":{"type":"string"},"engagerType":{"type":"integer","enum":[1,2]},"engagementType":{"type":"string","enum":["click","save","closeup","comment","like"]},"engagementDomains":{"type":"array","items":{"type":"string"}},"campaignIds":{"type":"array","items":{"type":"string","pattern":"^\\d+$"}},"adIds":{"type":"array","items":{"type":"string","pattern":"^\\d+$"}},"pinIds":{"type":"array","items":{"type":"string","pattern":"^\\d+$"}},"urlContains":{"type":"string"},"rule":{"type":"object"},"customerFileSource":{"type":"string"}}},{"type":"object","title":"SavedTargetingAudience","required":["type","accountId","name","spec"],"properties":{"type":{"type":"string","enum":["saved_targeting"]},"accountId":{"type":"string"},"name":{"type":"string","maxLength":255},"description":{"type":"string"},"spec":{"allOf":[{"$ref":"#/components/schemas/TargetingSpec"}]}}}]}}}},"x-pozy-area":"ads"}},"/v1/ads/audiences/{audienceId}":{"get":{"operationId":"getAdAudience","summary":"Get audience details","tags":["Ad Audiences"],"parameters":[{"name":"audienceId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"audience":{"type":"object"},"platformData":{"type":["object","null"]}}}}}}},"x-pozy-area":"ads"},"put":{"operationId":"updateAdAudience","summary":"Update an audience","tags":["Ad Audiences"],"parameters":[{"name":"audienceId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"audience":{"type":"object"},"message":{"type":"string"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","maxLength":255},"description":{"type":"string"},"spec":{"allOf":[{"$ref":"#/components/schemas/TargetingSpec"}]}}}}}},"x-pozy-area":"ads"},"delete":{"operationId":"deleteAdAudience","summary":"Delete custom audience","tags":["Ad Audiences"],"parameters":[{"name":"audienceId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}}}}}}},"x-pozy-area":"ads"}},"/v1/ads/audiences/{audienceId}/users":{"post":{"operationId":"addUsersToAdAudience","summary":"Add users to audience","tags":["Ad Audiences"],"parameters":[{"name":"audienceId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"numReceived":{"type":"integer"},"numInvalid":{"type":"integer"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["users"],"properties":{"users":{"type":"array","maxItems":10000,"items":{"type":"object","properties":{"email":{"type":"string","format":"email"},"phone":{"type":"string"}}}}}}}}},"x-pozy-area":"ads"},"delete":{"operationId":"removeUsersFromAdAudience","summary":"Remove users from audience","tags":["Ad Audiences"],"parameters":[{"name":"audienceId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"numReceived":{"type":"integer"},"numInvalid":{"type":"integer"},"invalidEntrySamples":{"type":"object","additionalProperties":{"type":"string"}}}}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["users"],"properties":{"users":{"type":"array","minItems":1,"maxItems":10000,"items":{"type":"object","properties":{"email":{"type":"string","format":"email"},"phone":{"type":"string"}}}}}}}}},"x-pozy-area":"ads"}},"/v1/ads/audiences/{audienceId}/companies":{"post":{"operationId":"replaceAdAudienceCompanies","summary":"Replace audience companies","tags":["Ad Audiences"],"parameters":[{"name":"audienceId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"numReceived":{"type":"integer"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["companies"],"properties":{"companies":{"type":"array","minItems":1,"maxItems":300000,"items":{"type":"object","additionalProperties":false,"properties":{"name":{"type":"string","maxLength":255},"domain":{"type":"string","maxLength":100},"website":{"type":"string","maxLength":100},"linkedinPageUrl":{"type":"string"}}}}}}}}},"x-pozy-area":"ads"}},"/v1/ads/conversions/quality":{"get":{"operationId":"getConversionsQuality","summary":"Get Event Match Quality","tags":["Conversions"],"parameters":[{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}},{"name":"destinationId","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"platform":{"type":"string"},"rows":{"type":"array","items":{"type":"object","properties":{"eventName":{"type":"string"},"compositeScore":{"type":"number"},"matchKeys":{"type":"array","items":{"type":"object","properties":{"identifier":{"type":"string"},"coveragePercentage":{"type":"number"}}}},"eventCoveragePercentage":{"type":"number"}}}}}}}}}},"x-pozy-area":"ads"}},"/v1/ads/conversions":{"post":{"operationId":"sendConversions","summary":"Send conversion events","tags":["Conversions"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"platform":{"type":"string","enum":["metaads","googleads","linkedinads","tiktokads","openaiads","pinterestads","redditads"]},"eventsReceived":{"type":"integer"},"eventsFailed":{"type":"integer"},"failures":{"type":"array","items":{"type":"object","properties":{"eventIndex":{"type":"integer"},"eventId":{"type":"string"},"message":{"type":"string"},"code":{"oneOf":[{"type":"string"},{"type":"integer"}]},"platformError":{"type":"object","additionalProperties":true}}}},"traceId":{"type":"string"},"testCode":{"type":["string","null"]}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","destinationId","events"],"properties":{"accountId":{"type":"string"},"destinationId":{"type":"string"},"events":{"type":"array","minItems":1,"items":{"$ref":"#/components/schemas/ConversionEvent"}},"testCode":{"type":"string"},"consent":{"type":"object","properties":{"adUserData":{"type":"string","enum":["GRANTED","DENIED"]},"adPersonalization":{"type":"string","enum":["GRANTED","DENIED"]}}}}}}}},"x-pozy-area":"ads"}},"/v1/ads/conversions/adjustments":{"post":{"operationId":"adjustConversions","summary":"Adjust uploaded conversions","tags":["Conversions"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"platform":{"type":"string","enum":["googleads"]},"adjustmentsReceived":{"type":"integer"},"adjustmentsFailed":{"type":"integer"},"failures":{"type":"array","items":{"type":"object","properties":{"adjustmentIndex":{"type":"integer"},"message":{"type":"string"},"code":{"oneOf":[{"type":"string"},{"type":"integer"}]}}}},"traceId":{"type":"string"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","destinationId","adjustments"],"properties":{"accountId":{"type":"string"},"destinationId":{"type":"string"},"adjustments":{"type":"array","minItems":1,"maxItems":2000,"items":{"type":"object","required":["adjustmentType","adjustmentTime"],"properties":{"adjustmentType":{"type":"string","enum":["RETRACTION","RESTATEMENT","ENHANCEMENT"]},"adjustmentTime":{"type":"number"},"orderId":{"type":"string"},"gclid":{"type":"string"},"conversionTime":{"type":"number"},"restatementValue":{"type":"number"},"currency":{"type":"string"},"user":{"type":"object","properties":{"email":{"type":"string"},"phone":{"type":"string"}}},"userAgent":{"type":"string"}}}}}}}}},"x-pozy-area":"ads"}},"/v1/ads/conversions/actions":{"get":{"operationId":"listConversionActions","summary":"List conversion actions","tags":["Conversions"],"parameters":[{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}},{"name":"adAccountId","in":"query","required":false,"schema":{"type":"string"}},{"name":"customerId","in":"query","required":false,"schema":{"type":"string"}},{"name":"type","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"customerId":{"type":"string"},"actions":{"type":"array","items":{"$ref":"#/components/schemas/ConversionAction"}},"cachedAt":{"type":["string","null"],"format":"date-time"},"stale":{"type":"boolean"}}}}}}},"x-pozy-area":"ads"},"post":{"operationId":"createConversionAction","summary":"Create website conversion action","tags":["Conversions"],"responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"action":{"$ref":"#/components/schemas/ConversionAction"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","name","type"],"properties":{"accountId":{"type":"string"},"adAccountId":{"type":"string"},"customerId":{"type":"string","deprecated":true},"name":{"type":"string","minLength":1,"maxLength":100},"type":{"type":"string","enum":["WEBPAGE"]},"defaultValue":{"type":"number","minimum":0},"alwaysUseDefaultValue":{"type":"boolean"},"category":{"type":"string","enum":["DEFAULT","PAGE_VIEW","PURCHASE","SIGNUP","DOWNLOAD","ADD_TO_CART","BEGIN_CHECKOUT","SUBSCRIBE_PAID","PHONE_CALL_LEAD","IMPORTED_LEAD","SUBMIT_LEAD_FORM","BOOK_APPOINTMENT","REQUEST_QUOTE","GET_DIRECTIONS","OUTBOUND_CLICK","CONTACT","ENGAGEMENT","STORE_VISIT","STORE_SALE","QUALIFIED_LEAD","CONVERTED_LEAD"]},"countingType":{"type":"string","enum":["ONE_PER_CLICK","MANY_PER_CLICK"]},"defaultCurrency":{"type":"string","pattern":"^[A-Z]{3}$"},"clickThroughLookbackWindowDays":{"type":"integer","minimum":1,"maximum":90},"viewThroughLookbackWindowDays":{"type":"integer","minimum":1,"maximum":30},"primaryForGoal":{"type":"boolean"}}}}}},"x-pozy-area":"ads"}},"/v1/ads/conversions/goals":{"get":{"operationId":"listAdConversionGoals","summary":"List account conversion goals","tags":["Conversions"],"parameters":[{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}},{"name":"adAccountId","in":"query","required":false,"schema":{"type":"string","pattern":"^\\d+$"}},{"name":"customerId","in":"query","required":false,"schema":{"type":"string","pattern":"^\\d+$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"customerId":{"type":"string"},"goals":{"type":"array","items":{"$ref":"#/components/schemas/GoogleCustomerConversionGoal"}},"cachedAt":{"type":["string","null"],"format":"date-time"},"stale":{"type":"boolean"}}}}}}},"x-pozy-area":"ads"},"patch":{"operationId":"updateAdConversionGoals","summary":"Update account conversion goals","tags":["Conversions"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"customerId":{"type":"string"},"goals":{"type":"array","items":{"$ref":"#/components/schemas/GoogleCustomerConversionGoal"}}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["accountId","goals"],"properties":{"accountId":{"type":"string"},"adAccountId":{"type":"string","pattern":"^\\d+$"},"customerId":{"type":"string","pattern":"^\\d+$","deprecated":true},"goals":{"type":"array","minItems":1,"maxItems":100,"items":{"$ref":"#/components/schemas/GoogleBiddableGoalInput"}}}}}}},"x-pozy-area":"ads"}},"/v1/ads/conversions/actions/{actionId}":{"patch":{"operationId":"updateConversionAction","summary":"Update a conversion action's settings","tags":["Conversions"],"parameters":[{"name":"actionId","in":"path","required":true,"schema":{"type":"string","pattern":"^\\d+$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"customerId":{"type":"string"},"action":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"status":{"type":"string"},"primaryForGoal":{"type":"boolean"},"category":{"type":"string"},"countingType":{"type":"string"},"defaultValue":{"type":"number"},"defaultCurrency":{"type":"string"},"alwaysUseDefaultValue":{"type":"boolean"},"clickThroughLookbackWindowDays":{"type":"integer"},"viewThroughLookbackWindowDays":{"type":"integer"}}}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["accountId"],"minProperties":2,"properties":{"accountId":{"type":"string"},"adAccountId":{"type":"string","pattern":"^\\d+$"},"customerId":{"type":"string","pattern":"^\\d+$","deprecated":true},"name":{"type":"string","minLength":1,"maxLength":100},"status":{"type":"string","enum":["ENABLED","REMOVED"]},"defaultValue":{"type":"number","minimum":0},"alwaysUseDefaultValue":{"type":"boolean"},"category":{"type":"string","enum":["DEFAULT","PAGE_VIEW","PURCHASE","SIGNUP","DOWNLOAD","ADD_TO_CART","BEGIN_CHECKOUT","SUBSCRIBE_PAID","PHONE_CALL_LEAD","IMPORTED_LEAD","SUBMIT_LEAD_FORM","BOOK_APPOINTMENT","REQUEST_QUOTE","GET_DIRECTIONS","OUTBOUND_CLICK","CONTACT","ENGAGEMENT","STORE_VISIT","STORE_SALE","QUALIFIED_LEAD","CONVERTED_LEAD"]},"countingType":{"type":"string","enum":["ONE_PER_CLICK","MANY_PER_CLICK"]},"defaultCurrency":{"type":"string","pattern":"^[A-Z]{3}$"},"clickThroughLookbackWindowDays":{"type":"integer","minimum":1,"maximum":90},"viewThroughLookbackWindowDays":{"type":"integer","minimum":1,"maximum":30},"primaryForGoal":{"type":"boolean"}}}}}},"x-pozy-area":"ads"}},"/v1/ads/conversions/custom-goals":{"get":{"operationId":"listCustomConversionGoals","summary":"List custom conversion goals","tags":["Conversions"],"parameters":[{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}},{"name":"adAccountId","in":"query","required":false,"schema":{"type":"string","pattern":"^\\d+$"}},{"name":"customerId","in":"query","required":false,"schema":{"type":"string","pattern":"^\\d+$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"customerId":{"type":"string"},"goals":{"type":"array","items":{"$ref":"#/components/schemas/GoogleCustomConversionGoal"}},"cachedAt":{"type":["string","null"],"format":"date-time"},"stale":{"type":"boolean"}}}}}}},"x-pozy-area":"ads"},"post":{"operationId":"createCustomConversionGoal","summary":"Create a custom conversion goal","tags":["Conversions"],"responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"customerId":{"type":"string"},"id":{"type":"string"},"resourceName":{"type":"string"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["accountId","name","conversionActionIds"],"properties":{"accountId":{"type":"string"},"adAccountId":{"type":"string","pattern":"^\\d+$"},"customerId":{"type":"string","pattern":"^\\d+$","deprecated":true},"name":{"type":"string","minLength":1,"maxLength":255},"conversionActionIds":{"type":"array","minItems":1,"maxItems":100,"items":{"type":"string","pattern":"^\\d+$"}}}}}}},"x-pozy-area":"ads"}},"/v1/ads/conversions/custom-goals/{goalId}":{"patch":{"operationId":"updateCustomConversionGoal","summary":"Update a custom conversion goal","tags":["Conversions"],"parameters":[{"name":"goalId","in":"path","required":true,"schema":{"type":"string","pattern":"^\\d+$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"customerId":{"type":"string"},"goal":{"$ref":"#/components/schemas/GoogleCustomConversionGoal"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["accountId"],"minProperties":2,"properties":{"accountId":{"type":"string"},"adAccountId":{"type":"string","pattern":"^\\d+$"},"customerId":{"type":"string","pattern":"^\\d+$","deprecated":true},"name":{"type":"string","minLength":1,"maxLength":255},"conversionActionIds":{"type":"array","minItems":1,"maxItems":100,"items":{"type":"string","pattern":"^\\d+$"}}}}}}},"x-pozy-area":"ads"},"delete":{"operationId":"removeCustomConversionGoal","summary":"Remove a custom conversion goal","tags":["Conversions"],"parameters":[{"name":"goalId","in":"path","required":true,"schema":{"type":"string","pattern":"^\\d+$"}},{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}},{"name":"adAccountId","in":"query","required":false,"schema":{"type":"string","pattern":"^\\d+$"}},{"name":"customerId","in":"query","required":false,"schema":{"type":"string","pattern":"^\\d+$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"customerId":{"type":"string"},"goalId":{"type":"string"},"removed":{"type":"boolean"}}}}}}},"x-pozy-area":"ads"}},"/v1/events":{"get":{"operationId":"listEvents","summary":"List stored events","tags":["Conversions"],"parameters":[{"name":"profileId","in":"query","required":true,"schema":{"type":"string"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":200,"default":50}},{"name":"from","in":"query","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"to","in":"query","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"eventName","in":"query","required":false,"schema":{"type":"string"}},{"name":"cursor","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"events":{"type":"array","items":{"type":"object","properties":{"eventId":{"type":"string"},"eventName":{"type":"string"},"eventTime":{"type":"string","format":"date-time"},"receivedAt":{"type":"string","format":"date-time"},"actionSource":{"type":["string","null"]},"value":{"type":["number","null"]},"currency":{"type":["string","null"]},"sourceUrl":{"type":["string","null"]},"utm":{"type":"object","properties":{"source":{"type":["string","null"]},"medium":{"type":["string","null"]},"campaign":{"type":["string","null"]},"content":{"type":["string","null"]}}},"adRef":{"type":["string","null"]},"clickIds":{"type":"object","properties":{"gclid":{"type":["string","null"]},"fbc":{"type":["string","null"]}}},"destinationsSent":{"type":"integer"},"hasEmail":{"type":"boolean"},"hasPhone":{"type":"boolean"},"hasExternalId":{"type":"boolean"},"ad":{"type":["object","null"],"properties":{"platform":{"type":"string","enum":["googleads","metaads"]},"customerId":{"type":"string"},"campaignId":{"type":["string","null"]},"adGroupId":{"type":["string","null"]},"adSetId":{"type":["string","null"]},"adId":{"type":["string","null"]}}}}}},"nextCursor":{"type":["string","null"]}}}}}}},"x-pozy-area":"ads"},"post":{"operationId":"sendEvents","summary":"Send events to every destination","tags":["Conversions"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"eventsReceived":{"type":"integer"},"stored":{"type":"boolean"},"testCode":{"type":["string","null"]},"destinations":{"type":"array","items":{"type":"object","properties":{"accountId":{"type":"string"},"destinationId":{"type":"string"},"platform":{"type":"string","enum":["metaads","googleads","linkedinads","tiktokads","openaiads","pinterestads","redditads"]},"eventsSent":{"type":"integer"},"eventsFailed":{"type":"integer"},"failures":{"type":"array","items":{"type":"object","properties":{"eventIndex":{"type":"integer"},"eventId":{"type":"string"},"message":{"type":"string"},"code":{"oneOf":[{"type":"string"},{"type":"integer"}]}}}},"error":{"type":"string"}}}}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["profileId","events"],"additionalProperties":false,"properties":{"profileId":{"type":"string"},"events":{"type":"array","minItems":1,"maxItems":1000,"items":{"$ref":"#/components/schemas/ConversionEvent"}},"destinations":{"type":"array","minItems":1,"maxItems":20,"items":{"type":"object","required":["accountId","destinationId"],"additionalProperties":false,"properties":{"accountId":{"type":"string"},"destinationId":{"type":"string"}}}},"consent":{"type":"object","properties":{"adUserData":{"type":"string","enum":["GRANTED","DENIED"]},"adPersonalization":{"type":"string","enum":["GRANTED","DENIED"]}}},"testCode":{"type":"string"}}}}}},"x-pozy-area":"ads"}},"/v1/events/destinations":{"get":{"operationId":"listEventDestinations","summary":"List event destinations","tags":["Conversions"],"parameters":[{"name":"profileId","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"destinations":{"type":"array","items":{"$ref":"#/components/schemas/EventDestination"}}}}}}}},"x-pozy-area":"ads"},"post":{"operationId":"createEventDestination","summary":"Add an event destination","tags":["Conversions"],"responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"destination":{"$ref":"#/components/schemas/EventDestination"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["profileId","accountId","destinationId"],"additionalProperties":false,"properties":{"profileId":{"type":"string"},"accountId":{"type":"string"},"destinationId":{"type":"string"},"eventNames":{"type":"array","minItems":1,"maxItems":50,"items":{"type":"string"}}}}}}},"x-pozy-area":"ads"}},"/v1/events/destinations/{destinationId}":{"delete":{"operationId":"deleteEventDestination","summary":"Remove an event destination","tags":["Conversions"],"parameters":[{"name":"destinationId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"deleted":{"type":"boolean"}}}}}}},"x-pozy-area":"ads"}},"/v1/ads/campaigns/{campaignId}/conversion-goals":{"get":{"operationId":"getCampaignConversionGoals","summary":"Get campaign conversion goals","tags":["Ad Campaigns"],"parameters":[{"name":"campaignId","in":"path","required":true,"schema":{"type":"string","pattern":"^\\d+$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/GoogleCampaignConversionGoals"},{"type":"object","properties":{"customerId":{"type":"string"},"cachedAt":{"type":["string","null"],"format":"date-time"},"stale":{"type":"boolean"}}}]}}}}},"x-pozy-area":"ads"},"patch":{"operationId":"updateCampaignConversionGoals","summary":"Update campaign conversion goals","tags":["Ad Campaigns"],"parameters":[{"name":"campaignId","in":"path","required":true,"schema":{"type":"string","pattern":"^\\d+$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/GoogleCampaignConversionGoals"},{"type":"object","properties":{"customerId":{"type":"string"}}}]}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"minProperties":1,"properties":{"goals":{"type":"array","maxItems":100,"items":{"$ref":"#/components/schemas/GoogleBiddableGoalInput"}},"goalConfigLevel":{"type":"string","enum":["CUSTOMER","CAMPAIGN"]},"customConversionGoalId":{"type":["string","null"],"pattern":"^\\d+$"}}}}}},"x-pozy-area":"ads"}},"/v1/accounts/{accountId}/conversion-destinations":{"get":{"operationId":"listConversionDestinations","summary":"List conversion destinations","tags":["Conversions"],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"platform":{"type":"string","enum":["metaads","googleads","linkedinads","tiktokads","openaiads","pinterestads","redditads"]},"destinations":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"},"status":{"type":"string","enum":["active","inactive"]},"adAccountId":{"type":"string"},"conversionEvents":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"eventType":{"type":["string","null"]},"customEventName":{"type":["string","null"]},"archived":{"type":"boolean"},"optimizable":{"type":"boolean"}}}}}}}}}}}}},"x-pozy-area":"ads"},"post":{"operationId":"createConversionDestination","summary":"Create a conversion destination","tags":["Conversions"],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"platform":{"type":"string","enum":["linkedinads","googleads"]},"destination":{"$ref":"#/components/schemas/ConversionDestination"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["adAccountId","name","type"],"properties":{"adAccountId":{"type":"string"},"name":{"type":"string","maxLength":255},"type":{"type":"string"},"attributionType":{"type":"string","enum":["LAST_TOUCH_BY_CAMPAIGN","LAST_TOUCH_BY_CONVERSION"]},"postClickAttributionWindowSize":{"type":"integer","enum":[1,7,30,90,365]},"viewThroughAttributionWindowSize":{"type":"integer","enum":[1,7,30,90,365]},"valueType":{"type":"string","enum":["DYNAMIC","FIXED","NO_VALUE"]},"value":{"type":"object","required":["currencyCode","amount"],"properties":{"currencyCode":{"type":"string","minLength":3,"maxLength":3},"amount":{"type":"string"}}},"autoAssociationType":{"type":"string","enum":["ALL_CAMPAIGNS","OBJECTIVE_BASED","NONE"],"default":"ALL_CAMPAIGNS"},"countingType":{"type":"string","enum":["MANY_PER_CLICK","ONE_PER_CLICK"]},"primaryForGoal":{"type":"boolean"}}}}}},"x-pozy-area":"ads"}},"/v1/accounts/{accountId}/conversion-destinations/{destinationId}":{"get":{"operationId":"getConversionDestination","summary":"Get a conversion destination","tags":["Conversions"],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}},{"name":"destinationId","in":"path","required":true,"schema":{"type":"string"}},{"name":"adAccountId","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"platform":{"type":"string","enum":["linkedinads"]},"destination":{"$ref":"#/components/schemas/ConversionDestination"}}}}}}},"x-pozy-area":"ads"},"patch":{"operationId":"updateConversionDestination","summary":"Update a conversion destination","tags":["Conversions"],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}},{"name":"destinationId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"platform":{"type":"string","enum":["linkedinads"]},"destination":{"$ref":"#/components/schemas/ConversionDestination"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["adAccountId"],"properties":{"adAccountId":{"type":"string"},"name":{"type":"string","maxLength":255},"enabled":{"type":"boolean"},"attributionType":{"type":"string","enum":["LAST_TOUCH_BY_CAMPAIGN","LAST_TOUCH_BY_CONVERSION"]},"postClickAttributionWindowSize":{"type":"integer","enum":[1,7,30,90,365]},"viewThroughAttributionWindowSize":{"type":"integer","enum":[1,7,30,90,365]},"valueType":{"type":"string","enum":["DYNAMIC","FIXED","NO_VALUE"]},"value":{"type":"object","properties":{"currencyCode":{"type":"string"},"amount":{"type":"string"}}}}}}}},"x-pozy-area":"ads"},"delete":{"operationId":"deleteConversionDestination","summary":"Delete a conversion destination","tags":["Conversions"],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}},{"name":"destinationId","in":"path","required":true,"schema":{"type":"string"}},{"name":"adAccountId","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"204":{"description":"Success"}},"x-pozy-area":"ads"}},"/v1/accounts/{accountId}/conversion-destinations/{destinationId}/associations":{"get":{"operationId":"listConversionAssociations","summary":"List associated campaigns","tags":["Conversions"],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}},{"name":"destinationId","in":"path","required":true,"schema":{"type":"string"}},{"name":"adAccountId","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"platform":{"type":"string","enum":["linkedinads"]},"associations":{"type":"array","items":{"type":"object","properties":{"campaignId":{"type":"string"},"conversionId":{"type":"string"},"associatedAt":{"type":"integer"}}}}}}}}}},"x-pozy-area":"ads"},"post":{"operationId":"addConversionAssociations","summary":"Associate campaigns","tags":["Conversions"],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}},{"name":"destinationId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"platform":{"type":"string","enum":["linkedinads"]},"succeeded":{"type":"array","items":{"type":"string"}},"failed":{"type":"array","items":{"type":"object","properties":{"campaignId":{"type":"string"},"reason":{"type":"string"}}}}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["adAccountId","campaignIds"],"properties":{"adAccountId":{"type":"string"},"campaignIds":{"type":"array","minItems":1,"maxItems":100,"items":{"type":"string"}}}}}}},"x-pozy-area":"ads"},"delete":{"operationId":"removeConversionAssociations","summary":"Remove associated campaigns","tags":["Conversions"],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}},{"name":"destinationId","in":"path","required":true,"schema":{"type":"string"}},{"name":"adAccountId","in":"query","required":true,"schema":{"type":"string"}},{"name":"campaignIds","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"platform":{"type":"string","enum":["linkedinads"]},"succeeded":{"type":"array","items":{"type":"string"}},"failed":{"type":"array","items":{"type":"object","properties":{"campaignId":{"type":"string"},"reason":{"type":"string"}}}}}}}}}},"x-pozy-area":"ads"}},"/v1/accounts/{accountId}/conversion-destinations/{destinationId}/metrics":{"get":{"operationId":"getConversionMetrics","summary":"Get attribution metrics","tags":["Conversions"],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}},{"name":"destinationId","in":"path","required":true,"schema":{"type":"string"}},{"name":"adAccountId","in":"query","required":true,"schema":{"type":"string"}},{"name":"startDate","in":"query","required":true,"schema":{"type":"string","pattern":"^\\\\d{4}-\\\\d{2}-\\\\d{2}$"}},{"name":"endDate","in":"query","required":false,"schema":{"type":"string","pattern":"^\\\\d{4}-\\\\d{2}-\\\\d{2}$"}},{"name":"granularity","in":"query","required":false,"schema":{"type":"string","enum":["ALL","DAILY","MONTHLY","YEARLY"],"default":"DAILY"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"platform":{"type":"string","enum":["linkedinads"]},"granularity":{"type":"string","enum":["ALL","DAILY","MONTHLY","YEARLY"]},"rows":{"type":"array","items":{"type":"object","properties":{"start":{"type":"string"},"end":{"type":"string"},"metrics":{"type":"object","additionalProperties":{"oneOf":[{"type":"number"},{"type":"string"}]}}}}}}}}}}},"x-pozy-area":"ads"}},"/v1/whatsapp/conversions":{"get":{"operationId":"listWhatsAppConversions","summary":"List conversion events","tags":["WhatsApp"],"parameters":[{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":200,"default":50}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"events":{"type":"array","items":{"type":"object","properties":{"timestamp":{"type":"string","format":"date-time"},"eventName":{"type":"string"},"conversationId":{"type":["string","null"]},"eventsReceived":{"type":["integer","null"]},"eventsFailed":{"type":["integer","null"]},"traceId":{"type":["string","null"]},"durationMs":{"type":["integer","null"]}}}}}}}}}},"x-pozy-area":"whatsapp"},"post":{"operationId":"sendWhatsAppConversion","summary":"Send WhatsApp conversion event","tags":["WhatsApp"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"platform":{"type":"string","enum":["metaads"]},"eventsReceived":{"type":"integer"},"eventsFailed":{"type":"integer"},"failures":{"type":"array","items":{"type":"object","properties":{"eventIndex":{"type":"integer"},"eventId":{"type":"string"},"message":{"type":"string"},"code":{"oneOf":[{"type":"string"},{"type":"integer"}]},"platformError":{"type":"object","additionalProperties":true}}}},"traceId":{"type":"string"},"testCode":{"type":["string","null"]}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","eventName","eventId"],"properties":{"accountId":{"type":"string","minLength":1},"eventName":{"type":"string","enum":["LeadSubmitted","QualifiedLead","Purchase","AddToCart","InitiateCheckout","ViewContent","OrderCreated","OrderCanceled","OrderReturned"]},"eventTime":{"type":"number"},"eventId":{"type":"string","minLength":1},"conversationId":{"type":"string","minLength":1},"phoneE164":{"type":"string","minLength":1},"value":{"type":"number"},"currency":{"type":"string","minLength":3,"maxLength":3},"contentIds":{"type":"array","items":{"type":"string"}},"email":{"type":"string","format":"email"},"externalId":{"type":"string"},"testCode":{"type":"string"}}}}}},"x-pozy-area":"whatsapp"}},"/v1/ads/messaging":{"post":{"operationId":"createMessagingAd","summary":"Create messaging ad","tags":["Messaging Ads"],"parameters":[{"name":"Idempotency-Key","in":"header","required":false,"schema":{"type":"string","maxLength":255}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","required":["validateOnly","results","message"],"properties":{"validateOnly":{"type":"boolean"},"results":{"type":"array","items":{"type":"object","required":["node","status"],"properties":{"node":{"type":"string","enum":["campaign","adSet","creative","ad"]},"status":{"type":"string","enum":["validated","skipped","unverified"]},"reason":{"type":"string"}}}},"message":{"type":"string"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/CtwaAdRequestBody"},{"type":"object","properties":{"destination":{"type":"string","enum":["whatsapp","messenger","instagram_direct"]},"destinations":{"type":"array","minItems":2,"maxItems":3,"uniqueItems":true,"items":{"type":"string","enum":["whatsapp","messenger","instagram_direct"]}},"placementAssets":{"allOf":[{"$ref":"#/components/schemas/MetaPlacementAssets"}]},"workflowId":{"type":"string","pattern":"^[a-fA-F0-9]{24}$"},"validateOnly":{"type":"boolean"}}}]}}}},"x-pozy-area":"ads"}},"/v1/ads/call":{"post":{"operationId":"createCallAd","summary":"Create Click-to-Call ad","tags":["Messaging Ads"],"parameters":[{"name":"Idempotency-Key","in":"header","required":false,"schema":{"type":"string","maxLength":255}}],"responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/CtwaSingleResponse"},{"$ref":"#/components/schemas/CtwaMultiResponse"}],"discriminator":{"propertyName":"adType","mapping":{"single":"#/components/schemas/CtwaSingleResponse","multi":"#/components/schemas/CtwaMultiResponse"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/CtwaAdRequestBody"},{"type":"object","required":["phoneNumber","linkUrl"],"properties":{"phoneNumber":{"type":"string"},"linkUrl":{"type":"string","format":"uri"}}}]}}}},"x-pozy-area":"ads"}},"/v1/ads/ctwa":{"post":{"operationId":"createCtwaAd","summary":"Create CTWA ad (deprecated)","tags":["Messaging Ads"],"deprecated":true,"parameters":[{"name":"Idempotency-Key","in":"header","required":false,"schema":{"type":"string","maxLength":255}}],"responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/CtwaSingleResponse"},{"$ref":"#/components/schemas/CtwaMultiResponse"}],"discriminator":{"propertyName":"adType","mapping":{"single":"#/components/schemas/CtwaSingleResponse","multi":"#/components/schemas/CtwaMultiResponse"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CtwaAdRequestBody"}}}},"x-pozy-area":"ads"}},"/v1/accounts/{accountId}/custom-conversions":{"get":{"operationId":"listCustomConversions","summary":"List custom conversions","tags":["Ad Accounts"],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}},{"name":"adAccountId","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"adAccountId":{"type":"string"},"data":{"type":"array","items":{"$ref":"#/components/schemas/CustomConversion"}}}}}}}},"x-pozy-area":"ads"},"post":{"operationId":"createCustomConversion","summary":"Create custom conversion","tags":["Ad Accounts"],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomConversionResult"}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["adAccountId","name","pixelId","customEventType","rule"],"properties":{"adAccountId":{"type":"string"},"name":{"type":"string","maxLength":255},"pixelId":{"type":"string"},"customEventType":{"type":"string"},"rule":{"type":"object"}}}}}},"x-pozy-area":"ads"}},"/v1/accounts/{accountId}/business-agent":{"get":{"operationId":"getBusinessAgentStatus","summary":"Get agent setup status","tags":["Business Agent"],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessAgentStatus"}}}}},"x-pozy-area":"whatsapp"}},"/v1/accounts/{accountId}/business-agent/onboard":{"post":{"operationId":"onboardBusinessAgent","summary":"Create the agent","tags":["Business Agent"],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"type":"object","required":["agentId"],"properties":{"agentId":{"type":"string"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"x-pozy-area":"whatsapp"}},"/v1/accounts/{accountId}/business-agent/settings":{"get":{"operationId":"listBusinessAgentSettings","summary":"List agent settings","tags":["Business Agent"],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}},{"name":"agentId","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","required":["settings"],"properties":{"settings":{"type":"array","items":{"$ref":"#/components/schemas/BusinessAgentSettings"}}}}}}}},"x-pozy-area":"whatsapp"},"patch":{"operationId":"updateBusinessAgentSettings","summary":"Update agent settings","tags":["Business Agent"],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}},{"name":"agentId","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessAgentSettings"}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"rollout":{"type":"object","required":["enabled"],"properties":{"enabled":{"type":"boolean"}}},"handoff":{"type":"object","required":["enabled"],"properties":{"enabled":{"type":"boolean"},"message":{"type":"string","maxLength":1024},"message_selection":{"type":"string","enum":["DEFAULT","AGENT","CUSTOM"]}}},"followup":{"type":"object","required":["enabled"],"properties":{"enabled":{"type":"boolean"},"followup_interval_in_seconds":{"type":"integer","enum":[0,300,900,1800,3600,7200,28800,86400]},"message":{"type":"string","maxLength":1024}}},"ai_audience":{"type":"string","enum":["EVERYONE","ALLOWLISTED_ONLY"]},"never_say_phrases":{"type":"array","items":{"type":"string"}}}}}}},"x-pozy-area":"whatsapp"}},"/v1/accounts/{accountId}/business-agent/allowlist":{"get":{"operationId":"listBusinessAgentAllowlist","summary":"List allowlisted consumers","tags":["Business Agent"],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","required":["entries"],"properties":{"entries":{"type":"array","items":{"$ref":"#/components/schemas/BusinessAgentAllowlistEntry"}}}}}}}},"x-pozy-area":"whatsapp"},"post":{"operationId":"addBusinessAgentAllowlistEntry","summary":"Allowlist a consumer","tags":["Business Agent"],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessAgentAllowlistEntry"}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["consumer_phone_number"],"properties":{"consumer_phone_number":{"type":"string"}}}}}},"x-pozy-area":"whatsapp"}},"/v1/accounts/{accountId}/business-agent/allowlist/{entryId}":{"delete":{"operationId":"removeBusinessAgentAllowlistEntry","summary":"Remove an allowlisted consumer","tags":["Business Agent"],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}},{"name":"entryId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"}},"x-pozy-area":"whatsapp"}},"/v1/accounts/{accountId}/business-agent/business-information":{"get":{"operationId":"getBusinessAgentBusinessInformation","summary":"Get business information","tags":["Business Agent"],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessAgentBusinessInformation"}}}}},"x-pozy-area":"whatsapp"},"put":{"operationId":"replaceBusinessAgentBusinessInformation","summary":"Replace business information","tags":["Business Agent"],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessAgentBusinessInformation"}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessAgentBusinessInformation"}}}},"x-pozy-area":"whatsapp"},"delete":{"operationId":"resetBusinessAgentBusinessInformation","summary":"Reset business information","tags":["Business Agent"],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"}},"x-pozy-area":"whatsapp"}},"/v1/accounts/{accountId}/business-agent/faqs":{"get":{"operationId":"listBusinessAgentFaqs","summary":"List FAQs","tags":["Business Agent"],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","required":["faqs"],"properties":{"faqs":{"type":"array","items":{"$ref":"#/components/schemas/BusinessAgentFaq"}}}}}}}},"x-pozy-area":"whatsapp"},"post":{"operationId":"createBusinessAgentFaq","summary":"Create a FAQ","tags":["Business Agent"],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessAgentFaq"}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessAgentFaqInput"}}}},"x-pozy-area":"whatsapp"}},"/v1/accounts/{accountId}/business-agent/faqs/{faqId}":{"get":{"operationId":"getBusinessAgentFaq","summary":"Get a FAQ","tags":["Business Agent"],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}},{"name":"faqId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessAgentFaq"}}}}},"x-pozy-area":"whatsapp"},"put":{"operationId":"updateBusinessAgentFaq","summary":"Update a FAQ","tags":["Business Agent"],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}},{"name":"faqId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessAgentFaq"}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessAgentFaqInput"}}}},"x-pozy-area":"whatsapp"},"delete":{"operationId":"deleteBusinessAgentFaq","summary":"Delete a FAQ","tags":["Business Agent"],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}},{"name":"faqId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"}},"x-pozy-area":"whatsapp"}},"/v1/accounts/{accountId}/business-agent/websites":{"get":{"operationId":"listBusinessAgentWebsites","summary":"List crawled websites","tags":["Business Agent"],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","required":["websites"],"properties":{"websites":{"type":"array","items":{"$ref":"#/components/schemas/BusinessAgentWebsite"}}}}}}}},"x-pozy-area":"whatsapp"},"post":{"operationId":"addBusinessAgentWebsite","summary":"Add a website to crawl","tags":["Business Agent"],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessAgentWebsite"}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessAgentWebsiteInput"}}}},"x-pozy-area":"whatsapp"}},"/v1/accounts/{accountId}/business-agent/websites/{websiteId}":{"get":{"operationId":"getBusinessAgentWebsite","summary":"Get a crawled website","tags":["Business Agent"],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}},{"name":"websiteId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessAgentWebsite"}}}}},"x-pozy-area":"whatsapp"},"put":{"operationId":"updateBusinessAgentWebsite","summary":"Update a crawled website","tags":["Business Agent"],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}},{"name":"websiteId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessAgentWebsite"}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessAgentWebsiteInput"}}}},"x-pozy-area":"whatsapp"},"delete":{"operationId":"deleteBusinessAgentWebsite","summary":"Remove a crawled website","tags":["Business Agent"],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}},{"name":"websiteId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"}},"x-pozy-area":"whatsapp"}},"/v1/accounts/{accountId}/business-agent/files":{"get":{"operationId":"listBusinessAgentFiles","summary":"List knowledge files","tags":["Business Agent"],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","required":["files"],"properties":{"files":{"type":"array","items":{"$ref":"#/components/schemas/BusinessAgentKnowledgeFile"}}}}}}}},"x-pozy-area":"whatsapp"},"post":{"operationId":"uploadBusinessAgentFile","summary":"Upload a knowledge file","tags":["Business Agent"],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessAgentKnowledgeFile"}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["url"],"properties":{"url":{"type":"string","format":"uri"},"fileName":{"type":"string"}}}}}},"x-pozy-area":"whatsapp"}},"/v1/accounts/{accountId}/business-agent/files/{fileId}":{"get":{"operationId":"getBusinessAgentFile","summary":"Get a knowledge file","tags":["Business Agent"],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}},{"name":"fileId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessAgentKnowledgeFile"}}}}},"x-pozy-area":"whatsapp"},"delete":{"operationId":"deleteBusinessAgentFile","summary":"Delete a knowledge file","tags":["Business Agent"],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}},{"name":"fileId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"}},"x-pozy-area":"whatsapp"}},"/v1/accounts/{accountId}/business-agent/skills":{"get":{"operationId":"listBusinessAgentSkills","summary":"List skills","tags":["Business Agent"],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","required":["skills"],"properties":{"skills":{"type":"array","items":{"$ref":"#/components/schemas/BusinessAgentSkill"}}}}}}}},"x-pozy-area":"whatsapp"},"post":{"operationId":"createBusinessAgentSkill","summary":"Create a skill","tags":["Business Agent"],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessAgentSkill"}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessAgentSkillInput"}}}},"x-pozy-area":"whatsapp"}},"/v1/accounts/{accountId}/business-agent/skills/{skillId}":{"get":{"operationId":"getBusinessAgentSkill","summary":"Get a skill","tags":["Business Agent"],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}},{"name":"skillId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessAgentSkill"}}}}},"x-pozy-area":"whatsapp"},"put":{"operationId":"updateBusinessAgentSkill","summary":"Update a skill","tags":["Business Agent"],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}},{"name":"skillId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessAgentSkill"}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessAgentSkillInput"}}}},"x-pozy-area":"whatsapp"},"delete":{"operationId":"deleteBusinessAgentSkill","summary":"Delete a skill","tags":["Business Agent"],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}},{"name":"skillId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"}},"x-pozy-area":"whatsapp"}},"/v1/accounts/{accountId}/business-agent/ui-skills":{"get":{"operationId":"listBusinessAgentUiSkills","summary":"List UI skills","tags":["Business Agent"],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}},{"name":"before","in":"query","required":false,"schema":{"type":"string"}},{"name":"after","in":"query","required":false,"schema":{"type":"string"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":100}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","required":["uiSkills"],"properties":{"uiSkills":{"type":"array","items":{"$ref":"#/components/schemas/BusinessAgentUiSkill"}},"paging":{"type":"object","additionalProperties":true}}}}}}},"x-pozy-area":"whatsapp"},"post":{"operationId":"createBusinessAgentUiSkill","summary":"Create a UI skill","tags":["Business Agent"],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessAgentUiSkill"}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessAgentUiSkillInput"}}}},"x-pozy-area":"whatsapp"}},"/v1/accounts/{accountId}/business-agent/ui-skills/{uiSkillId}":{"get":{"operationId":"getBusinessAgentUiSkill","summary":"Get a UI skill","tags":["Business Agent"],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}},{"name":"uiSkillId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessAgentUiSkill"}}}}},"x-pozy-area":"whatsapp"},"put":{"operationId":"updateBusinessAgentUiSkill","summary":"Update a UI skill","tags":["Business Agent"],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}},{"name":"uiSkillId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessAgentUiSkill"}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessAgentUiSkillInput"}}}},"x-pozy-area":"whatsapp"},"delete":{"operationId":"deleteBusinessAgentUiSkill","summary":"Delete a UI skill","tags":["Business Agent"],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}},{"name":"uiSkillId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"}},"x-pozy-area":"whatsapp"}},"/v1/accounts/{accountId}/business-agent/connectors":{"get":{"operationId":"listBusinessAgentConnectors","summary":"List connectors","tags":["Business Agent"],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","required":["connectors"],"properties":{"connectors":{"type":"array","items":{"$ref":"#/components/schemas/BusinessAgentConnector"}}}}}}}},"x-pozy-area":"whatsapp"},"post":{"operationId":"createBusinessAgentConnector","summary":"Create a connector","tags":["Business Agent"],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessAgentConnector"}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessAgentConnectorInput"}}}},"x-pozy-area":"whatsapp"}},"/v1/accounts/{accountId}/business-agent/connectors/{connectorId}":{"get":{"operationId":"getBusinessAgentConnector","summary":"Get a connector","tags":["Business Agent"],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}},{"name":"connectorId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessAgentConnector"}}}}},"x-pozy-area":"whatsapp"},"put":{"operationId":"updateBusinessAgentConnector","summary":"Update a connector","tags":["Business Agent"],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}},{"name":"connectorId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessAgentConnector"}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessAgentConnectorInput"}}}},"x-pozy-area":"whatsapp"},"delete":{"operationId":"deleteBusinessAgentConnector","summary":"Delete a connector","tags":["Business Agent"],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}},{"name":"connectorId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"}},"x-pozy-area":"whatsapp"}},"/v1/accounts/{accountId}/business-agent/connectors/{connectorId}/credentials":{"post":{"operationId":"setBusinessAgentConnectorCredentials","summary":"Set connector credentials","tags":["Business Agent"],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}},{"name":"connectorId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessAgentConnector"}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"type":"object","required":["kind","api_key_config"],"properties":{"kind":{"type":"string","enum":["api_key"]},"api_key_config":{"$ref":"#/components/schemas/BusinessAgentApiKeyConfig"}}},{"type":"object","required":["kind","oauth_config"],"properties":{"kind":{"type":"string","enum":["oauth"]},"oauth_config":{"$ref":"#/components/schemas/BusinessAgentOAuthClientCredentials"}}},{"type":"object","required":["kind","client_certificate","client_key"],"properties":{"kind":{"type":"string","enum":["certificate"]},"client_certificate":{"type":"string"},"client_key":{"type":"string"},"ca_certificate":{"type":"string"}}}]}}}},"x-pozy-area":"whatsapp"}},"/v1/accounts/{accountId}/business-agent/connectors/{connectorId}/refresh-tools":{"post":{"operationId":"refreshBusinessAgentConnectorTools","summary":"Refresh MCP connector tools","tags":["Business Agent"],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}},{"name":"connectorId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessAgentConnector"}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"x-pozy-area":"whatsapp"}},"/v1/accounts/{accountId}/business-agent/connectors/{connectorId}/logs":{"get":{"operationId":"getBusinessAgentConnectorLogs","summary":"Get connector failure logs","tags":["Business Agent"],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}},{"name":"connectorId","in":"path","required":true,"schema":{"type":"string"}},{"name":"startTime","in":"query","required":false,"schema":{"type":"integer"}},{"name":"endTime","in":"query","required":false,"schema":{"type":"integer"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":1000}},{"name":"toolId","in":"query","required":false,"schema":{"type":"string"}},{"name":"includeStats","in":"query","required":false,"schema":{"type":"boolean"}},{"name":"summaryOnly","in":"query","required":false,"schema":{"type":"boolean"}},{"name":"topN","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":50}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","additionalProperties":true}},"stats":{"type":"object","additionalProperties":true}}}}}}},"x-pozy-area":"whatsapp"}},"/v1/accounts/{accountId}/business-agent/connectors/{connectorId}/tools":{"get":{"operationId":"listBusinessAgentConnectorTools","summary":"List connector tools","tags":["Business Agent"],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}},{"name":"connectorId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","required":["tools"],"properties":{"tools":{"type":"array","items":{"$ref":"#/components/schemas/BusinessAgentConnectorTool"}}}}}}}},"x-pozy-area":"whatsapp"},"post":{"operationId":"createBusinessAgentConnectorTool","summary":"Create a connector tool","tags":["Business Agent"],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}},{"name":"connectorId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessAgentConnectorTool"}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessAgentConnectorToolInput"}}}},"x-pozy-area":"whatsapp"}},"/v1/accounts/{accountId}/business-agent/connectors/{connectorId}/tools/{toolId}":{"get":{"operationId":"getBusinessAgentConnectorTool","summary":"Get a connector tool","tags":["Business Agent"],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}},{"name":"connectorId","in":"path","required":true,"schema":{"type":"string"}},{"name":"toolId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessAgentConnectorTool"}}}}},"x-pozy-area":"whatsapp"},"put":{"operationId":"updateBusinessAgentConnectorTool","summary":"Update a connector tool","tags":["Business Agent"],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}},{"name":"connectorId","in":"path","required":true,"schema":{"type":"string"}},{"name":"toolId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessAgentConnectorTool"}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessAgentConnectorToolInput"}}}},"x-pozy-area":"whatsapp"},"delete":{"operationId":"deleteBusinessAgentConnectorTool","summary":"Delete a connector tool","tags":["Business Agent"],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}},{"name":"connectorId","in":"path","required":true,"schema":{"type":"string"}},{"name":"toolId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"}},"x-pozy-area":"whatsapp"}},"/v1/accounts/{accountId}/business-agent/connectors/{connectorId}/tools/{toolId}/run":{"post":{"operationId":"runBusinessAgentConnectorTool","summary":"Run a connector tool once","tags":["Business Agent"],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}},{"name":"connectorId","in":"path","required":true,"schema":{"type":"string"}},{"name":"toolId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"output":{"type":"string"},"status":{"type":"string"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["input"],"properties":{"input":{"type":"string"}}}}}},"x-pozy-area":"whatsapp"}},"/v1/accounts/{accountId}/business-agent/budget":{"get":{"operationId":"getBusinessAgentBudget","summary":"Get usage budgets","tags":["Business Agent"],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","required":["budgets"],"properties":{"budgets":{"type":"array","items":{"$ref":"#/components/schemas/BusinessAgentBudget"}}}}}}}},"x-pozy-area":"whatsapp"},"put":{"operationId":"replaceBusinessAgentBudget","summary":"Replace usage budgets","tags":["Business Agent"],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","required":["budgets"],"properties":{"budgets":{"type":"array","items":{"$ref":"#/components/schemas/BusinessAgentBudget"}}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["budgets"],"properties":{"budgets":{"type":"array","items":{"$ref":"#/components/schemas/BusinessAgentBudget"}}}}}}},"x-pozy-area":"whatsapp"}},"/v1/accounts/{accountId}/business-agent/test-messages":{"post":{"operationId":"sendBusinessAgentTestMessage","summary":"Send a test message","tags":["Business Agent"],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessAgentTestMessageResponse"}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["message"],"properties":{"message":{"type":"string","maxLength":4096},"conversationId":{"type":"string"}}}}}},"x-pozy-area":"whatsapp"}},"/v1/accounts/{accountId}/business-agent/events":{"post":{"operationId":"sendBusinessAgentEvent","summary":"Send a business event","tags":["Business Agent"],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"202":{"description":"Success","content":{"application/json":{"schema":{"type":"object","required":["status"],"properties":{"status":{"type":"string"},"agent_event_id":{"type":"string"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["to","type","description","payload"],"properties":{"to":{"type":"string"},"type":{"type":"string","maxLength":256},"description":{"type":"string","maxLength":1024},"payload":{"type":"string","maxLength":4096}}}}}},"x-pozy-area":"whatsapp"}},"/v1/accounts/{accountId}/business-agent/events/{eventId}":{"get":{"operationId":"getBusinessAgentEvent","summary":"Get a business event status","tags":["Business Agent"],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}},{"name":"eventId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessAgentEventStatus"}}}}},"x-pozy-area":"whatsapp"}},"/v1/accounts/{accountId}/business-agent/evals":{"get":{"operationId":"readBusinessAgentEvals","summary":"Read evaluation data","tags":["Business Agent"],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}},{"name":"jobId","in":"query","required":false,"schema":{"type":"string"}},{"name":"summaryIds","in":"query","required":false,"schema":{"type":"string"}},{"name":"evalIds","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}}},"x-pozy-area":"whatsapp"},"post":{"operationId":"startBusinessAgentEvalRun","summary":"Start an evaluation run","tags":["Business Agent"],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"202":{"description":"Success","content":{"application/json":{"schema":{"type":"object","required":["job_id","status"],"properties":{"job_id":{"type":"string"},"status":{"type":"string"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["evalCaseIds"],"properties":{"evalCaseIds":{"type":"array","items":{"type":"string"},"minItems":1,"maxItems":100}}}}}},"x-pozy-area":"whatsapp"}},"/v1/accounts/{accountId}/tracking-tags":{"get":{"operationId":"listTrackingTags","summary":"List tracking tags","tags":["Tracking Tags"],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}},{"name":"adAccountId","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"platform":{"type":"string","enum":["metaads","openaiads","tiktokads","googleads","xads","linkedinads","pinterestads","whopads"]},"tags":{"type":"array","items":{"$ref":"#/components/schemas/TrackingTag"}}}}}}}},"x-pozy-area":"ads"},"post":{"operationId":"createTrackingTag","summary":"Create a tracking tag","tags":["Tracking Tags"],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"platform":{"type":"string","enum":["metaads","openaiads","tiktokads","googleads","xads","linkedinads","pinterestads","whopads"]},"tag":{"$ref":"#/components/schemas/TrackingTag"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["adAccountId","name"],"properties":{"adAccountId":{"type":"string"},"name":{"type":"string","minLength":1,"maxLength":200},"defaultEventType":{"type":"string","enum":["order_created","lead_created","items_added","contents_viewed","checkout_started","registration_completed","subscription_created","trial_started","appointment_scheduled","page_viewed","app_installed","app_opened"]},"automaticMatchingFields":{"type":"array","items":{"type":"string","enum":["em","ph","fn","ln","ge","db","ct","st","zp","country","external_id"]}}}}}}},"x-pozy-area":"ads"}},"/v1/accounts/{accountId}/tracking-tags/{tagId}":{"get":{"operationId":"getTrackingTag","summary":"Get a tracking tag","tags":["Tracking Tags"],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}},{"name":"tagId","in":"path","required":true,"schema":{"type":"string"}},{"name":"adAccountId","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"platform":{"type":"string","enum":["metaads","tiktokads","googleads","xads","openaiads","linkedinads","pinterestads","whopads"]},"tag":{"$ref":"#/components/schemas/TrackingTag"}}}}}}},"x-pozy-area":"ads"},"patch":{"operationId":"updateTrackingTag","summary":"Update a tracking tag","tags":["Tracking Tags"],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}},{"name":"tagId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"platform":{"type":"string","enum":["metaads","tiktokads","googleads","xads","openaiads","linkedinads","pinterestads","whopads"]},"tag":{"$ref":"#/components/schemas/TrackingTag"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"adAccountId":{"type":"string"},"name":{"type":"string","minLength":1,"maxLength":200},"enableAutomaticMatching":{"type":"boolean"},"automaticMatchingFields":{"type":"array","items":{"type":"string","enum":["em","ph","fn","ln","ge","db","ct","st","zp","country","external_id"]}},"firstPartyCookieStatus":{"type":"string","enum":["empty","first_party_cookie_disabled","first_party_cookie_enabled"]},"dataUseSetting":{"type":"string","enum":["advertising_and_analytics","analytics_only","empty"]},"enableFirstPartyCookies":{"type":"boolean"},"autoTagging":{"type":"boolean"}}}}}},"x-pozy-area":"ads"}},"/v1/accounts/{accountId}/tracking-tags/{tagId}/shared-accounts":{"get":{"operationId":"listTrackingTagSharedAccounts","summary":"List accounts it is shared with","tags":["Tracking Tags"],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}},{"name":"tagId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"platform":{"type":"string","enum":["metaads","linkedinads"]},"sharedAccounts":{"type":"array","items":{"$ref":"#/components/schemas/SharedAdAccount"}}}}}}}},"x-pozy-area":"ads"},"post":{"operationId":"addTrackingTagSharedAccount","summary":"Share with an ad account","tags":["Tracking Tags"],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}},{"name":"tagId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"platform":{"type":"string","enum":["metaads","linkedinads"]},"ok":{"type":"boolean"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["adAccountId"],"properties":{"adAccountId":{"type":"string"}}}}}},"x-pozy-area":"ads"},"delete":{"operationId":"removeTrackingTagSharedAccount","summary":"Stop sharing with an account","tags":["Tracking Tags"],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}},{"name":"tagId","in":"path","required":true,"schema":{"type":"string"}},{"name":"adAccountId","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"204":{"description":"Success"}},"x-pozy-area":"ads"}},"/v1/accounts/{accountId}/tracking-tags/{tagId}/install":{"get":{"operationId":"getTrackingTagStoreInstall","summary":"Get store install status","tags":["Tracking Tags"],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}},{"name":"tagId","in":"path","required":true,"schema":{"type":"string"}},{"name":"storeAccountId","in":"query","required":true,"schema":{"type":"string"}},{"name":"adAccountId","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"platform":{"type":"string","enum":["metaads","tiktokads","googleads","xads","openaiads","linkedinads","pinterestads","whopads"]},"install":{"allOf":[{"$ref":"#/components/schemas/StorePixelInstall"},{"type":"object","properties":{"preflight":{"type":"object","properties":{"ready":{"type":"boolean"},"reason":{"type":["string","null"]},"sidebars":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}}}}}}}}]}}}}}}},"x-pozy-area":"ads"},"post":{"operationId":"installTrackingTagOnStore","summary":"Install on a Shopify, WordPress, Wix or Webflow site","tags":["Tracking Tags"],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}},{"name":"tagId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"platform":{"type":"string","enum":["metaads","tiktokads","googleads","xads","openaiads","linkedinads","pinterestads","whopads"]},"install":{"allOf":[{"$ref":"#/components/schemas/StorePixelInstall"},{"type":"object","properties":{"replacedTagId":{"type":["string","null"]},"sidebarName":{"type":"string"},"created":{"type":"boolean"},"homepageCheck":{"type":"string","enum":["found","not_found","unreachable","skipped"]}}}]}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["storeAccountId"],"properties":{"storeAccountId":{"type":"string"},"adAccountId":{"type":"string"},"sidebarId":{"type":"string"},"verifyHomepage":{"type":"boolean","default":true}}}}}},"x-pozy-area":"ads"},"delete":{"operationId":"removeTrackingTagFromStore","summary":"Remove from a Shopify, WordPress, Wix or Webflow site","tags":["Tracking Tags"],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}},{"name":"tagId","in":"path","required":true,"schema":{"type":"string"}},{"name":"storeAccountId","in":"query","required":true,"schema":{"type":"string"}},{"name":"adAccountId","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"platform":{"type":"string","enum":["metaads","tiktokads","googleads","xads","openaiads","linkedinads","pinterestads","whopads"]},"install":{"allOf":[{"$ref":"#/components/schemas/StorePixelInstall"},{"type":"object","properties":{"removed":{"type":"integer"}}}]}}}}}}},"x-pozy-area":"ads"}},"/v1/accounts/{accountId}/tracking-tags/{tagId}/events":{"get":{"operationId":"listTrackingTagEvents","summary":"List conversion events","tags":["Tracking Tags"],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}},{"name":"tagId","in":"path","required":true,"schema":{"type":"string"}},{"name":"adAccountId","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"platform":{"type":"string"},"events":{"type":"array","items":{"$ref":"#/components/schemas/TrackingTagEvent"}}}}}}}},"x-pozy-area":"ads"},"post":{"operationId":"createTrackingTagEvent","summary":"Create a conversion event","tags":["Tracking Tags"],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}},{"name":"tagId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"platform":{"type":"string"},"event":{"$ref":"#/components/schemas/TrackingTagEvent"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"adAccountId":{"type":"string"},"name":{"type":"string","minLength":1,"maxLength":200},"type":{"type":"string"},"siteEvent":{"type":"string","enum":["page_view","view_content","add_to_cart","search","initiate_checkout","add_payment_info","purchase"]},"enabled":{"type":"boolean"},"defaultValue":{"type":"number","minimum":0},"currency":{"type":"string"},"clickWindowDays":{"type":"integer","minimum":1,"maximum":365},"viewWindowDays":{"type":"integer","minimum":0,"maximum":365},"urlContains":{"type":"string","minLength":1,"maxLength":500}},"required":["name"]}}}},"x-pozy-area":"ads"}},"/v1/accounts/{accountId}/tracking-tags/{tagId}/events/{eventId}":{"patch":{"operationId":"updateTrackingTagEvent","summary":"Update a conversion event","tags":["Tracking Tags"],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}},{"name":"tagId","in":"path","required":true,"schema":{"type":"string"}},{"name":"eventId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"platform":{"type":"string"},"event":{"$ref":"#/components/schemas/TrackingTagEvent"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TrackingTagEventInput"}}}},"x-pozy-area":"ads"},"delete":{"operationId":"deleteTrackingTagEvent","summary":"Delete a conversion event","tags":["Tracking Tags"],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}},{"name":"tagId","in":"path","required":true,"schema":{"type":"string"}},{"name":"eventId","in":"path","required":true,"schema":{"type":"string"}},{"name":"adAccountId","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"platform":{"type":"string"},"eventId":{"type":"string"},"state":{"type":"string","enum":["deleted","archived","disabled"]}}}}}}},"x-pozy-area":"ads"}},"/v1/accounts/{accountId}/tracking-tags/{tagId}/users":{"get":{"operationId":"listTrackingTagUsers","summary":"List tag users","tags":["Tracking Tags"],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}},{"name":"tagId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"platform":{"type":"string"},"users":{"type":"array","items":{"$ref":"#/components/schemas/TrackingTagUser"}}}}}}}},"x-pozy-area":"ads"},"post":{"operationId":"assignTrackingTagUser","summary":"Assign a user to a tag","tags":["Tracking Tags"],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}},{"name":"tagId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"platform":{"type":"string"},"userId":{"type":"string"},"tasks":{"type":"array","items":{"type":"string"}}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["userId","tasks"],"additionalProperties":false,"properties":{"userId":{"type":"string","pattern":"^[1-9][0-9]{0,24}$"},"tasks":{"type":"array","minItems":1,"maxItems":10,"items":{"type":"string"}}}}}}},"x-pozy-area":"ads"}},"/v1/accounts/{accountId}/tracking-tags/{tagId}/users/{userId}":{"delete":{"operationId":"removeTrackingTagUser","summary":"Remove a user from a tag","tags":["Tracking Tags"],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}},{"name":"tagId","in":"path","required":true,"schema":{"type":"string"}},{"name":"userId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"platform":{"type":"string"},"userId":{"type":"string"},"removed":{"type":"boolean"}}}}}}},"x-pozy-area":"ads"}},"/v1/accounts/{accountId}/tracking-tags/{tagId}/partners":{"get":{"operationId":"listTrackingTagPartners","summary":"List partner businesses of a tag","tags":["Tracking Tags"],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}},{"name":"tagId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"platform":{"type":"string"},"partners":{"type":"array","items":{"$ref":"#/components/schemas/TrackingTagPartner"}}}}}}}},"x-pozy-area":"ads"}},"/v1/accounts/{accountId}/tracking-tags/{tagId}/diagnostics":{"get":{"operationId":"getTrackingTagDiagnostics","summary":"Get tag diagnostics","tags":["Tracking Tags"],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}},{"name":"tagId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"platform":{"type":"string"},"checks":{"type":"array","items":{"$ref":"#/components/schemas/TrackingTagDiagnostic"}}}}}}}},"x-pozy-area":"ads"}},"/v1/accounts/{accountId}/tracking-tags/{tagId}/stats":{"get":{"operationId":"getTrackingTagStats","summary":"Get aggregated event stats","tags":["Tracking Tags"],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}},{"name":"tagId","in":"path","required":true,"schema":{"type":"string"}},{"name":"adAccountId","in":"query","required":false,"schema":{"type":"string"}},{"name":"aggregation","in":"query","required":false,"schema":{"type":"string","default":"event","enum":["event","host","url","url_by_rule","pixel_fire","device_type","device_os","browser_type","had_pii","custom_data_field","match_keys","event_source","event_detection_method","event_processing_results","event_total_counts","event_value_count"]}},{"name":"startTime","in":"query","required":false,"schema":{"type":"integer"}},{"name":"endTime","in":"query","required":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"platform":{"type":"string","enum":["metaads","tiktokads","googleads","xads","openaiads","linkedinads","pinterestads","whopads"]},"stats":{"type":"object","properties":{"aggregation":{"type":"string"},"startTime":{"type":"integer"},"endTime":{"type":"integer"},"rows":{"type":"array","items":{"type":"object","additionalProperties":true}}}}}}}}}},"x-pozy-area":"ads"}},"/v1/accounts/{accountId}/blogs":{"get":{"operationId":"listBlogs","summary":"List blogs","tags":["Blogs"],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":50,"default":20}},{"name":"cursor","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"platform":{"type":"string","enum":["shopify","wordpress","wix","webflow"]},"blogs":{"type":"array","items":{"$ref":"#/components/schemas/Blog"}},"nextCursor":{"type":["string","null"]}}}}}}},"x-pozy-area":"publishing"},"post":{"operationId":"createBlog","summary":"Create a blog","tags":["Blogs"],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"platform":{"type":"string","enum":["shopify"]},"blog":{"$ref":"#/components/schemas/Blog"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["title"],"properties":{"title":{"type":"string","minLength":1},"handle":{"type":"string","minLength":1}}}}}},"x-pozy-area":"publishing"}},"/v1/accounts/{accountId}/blogs/{blogId}":{"get":{"operationId":"getBlog","summary":"Get a blog","tags":["Blogs"],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}},{"name":"blogId","in":"path","required":true,"schema":{"type":"string","pattern":"^[A-Za-z0-9_-]{1,64}$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"platform":{"type":"string","enum":["shopify","wordpress","wix","webflow"]},"blog":{"$ref":"#/components/schemas/Blog"}}}}}}},"x-pozy-area":"publishing"},"patch":{"operationId":"updateBlog","summary":"Update a blog","tags":["Blogs"],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}},{"name":"blogId","in":"path","required":true,"schema":{"type":"string","pattern":"^[A-Za-z0-9_-]{1,64}$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"platform":{"type":"string","enum":["shopify"]},"blog":{"$ref":"#/components/schemas/Blog"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"title":{"type":"string","minLength":1},"handle":{"type":"string","minLength":1}}}}}},"x-pozy-area":"publishing"},"delete":{"operationId":"deleteBlog","summary":"Delete a blog","tags":["Blogs"],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}},{"name":"blogId","in":"path","required":true,"schema":{"type":"string","pattern":"^[A-Za-z0-9_-]{1,64}$"}}],"responses":{"204":{"description":"Success"}},"x-pozy-area":"publishing"}},"/v1/accounts/{accountId}/blogs/{blogId}/articles":{"get":{"operationId":"listBlogArticles","summary":"List blog articles","tags":["Blogs"],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}},{"name":"blogId","in":"path","required":true,"schema":{"type":"string","pattern":"^[A-Za-z0-9_-]{1,64}$"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":50,"default":20}},{"name":"cursor","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"platform":{"type":"string","enum":["shopify","wordpress","wix","webflow"]},"articles":{"type":"array","items":{"$ref":"#/components/schemas/BlogArticle"}},"nextCursor":{"type":["string","null"]}}}}}}},"x-pozy-area":"publishing"},"post":{"operationId":"createBlogArticle","summary":"Create a blog article","tags":["Blogs"],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}},{"name":"blogId","in":"path","required":true,"schema":{"type":"string","pattern":"^[A-Za-z0-9_-]{1,64}$"}},{"name":"Idempotency-Key","in":"header","required":false,"schema":{"type":"string","maxLength":255}}],"responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"platform":{"type":"string","enum":["shopify","wordpress","wix","webflow"]},"article":{"$ref":"#/components/schemas/BlogArticle"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["title"],"properties":{"title":{"type":"string","minLength":1},"bodyHtml":{"type":"string"},"handle":{"type":"string"},"tags":{"type":"array","maxItems":100,"items":{"type":"string","minLength":1}},"author":{"type":"string"},"excerpt":{"type":"string"},"image":{"type":"object","required":["url"],"properties":{"url":{"type":"string","format":"uri"},"altText":{"type":"string"}}},"seo":{"type":"object","properties":{"title":{"type":"string"},"description":{"type":"string"}}},"isPublished":{"type":"boolean"},"publishDate":{"type":"string","format":"date-time"},"fieldData":{"type":"object","additionalProperties":true}}}}}},"x-pozy-area":"publishing"}},"/v1/accounts/{accountId}/blogs/{blogId}/articles/{articleId}":{"get":{"operationId":"getBlogArticle","summary":"Get a blog article","tags":["Blogs"],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}},{"name":"blogId","in":"path","required":true,"schema":{"type":"string","pattern":"^[A-Za-z0-9_-]{1,64}$"}},{"name":"articleId","in":"path","required":true,"schema":{"type":"string","pattern":"^[A-Za-z0-9_-]{1,64}$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"platform":{"type":"string","enum":["shopify","wordpress","wix","webflow"]},"article":{"$ref":"#/components/schemas/BlogArticle"}}}}}}},"x-pozy-area":"publishing"},"patch":{"operationId":"updateBlogArticle","summary":"Update a blog article","tags":["Blogs"],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}},{"name":"blogId","in":"path","required":true,"schema":{"type":"string","pattern":"^[A-Za-z0-9_-]{1,64}$"}},{"name":"articleId","in":"path","required":true,"schema":{"type":"string","pattern":"^[A-Za-z0-9_-]{1,64}$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"platform":{"type":"string","enum":["shopify","wordpress","wix","webflow"]},"article":{"$ref":"#/components/schemas/BlogArticle"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"title":{"type":"string","minLength":1},"bodyHtml":{"type":"string"},"handle":{"type":"string"},"tags":{"type":"array","maxItems":100,"items":{"type":"string","minLength":1}},"author":{"type":"string"},"excerpt":{"type":"string"},"image":{"type":"object","required":["url"],"properties":{"url":{"type":"string","format":"uri"},"altText":{"type":"string"}}},"seo":{"type":"object","properties":{"title":{"type":"string"},"description":{"type":"string"}}},"isPublished":{"type":"boolean"},"publishDate":{"type":"string","format":"date-time"},"fieldData":{"type":"object","additionalProperties":true}}}}}},"x-pozy-area":"publishing"},"delete":{"operationId":"deleteBlogArticle","summary":"Delete a blog article","tags":["Blogs"],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}},{"name":"blogId","in":"path","required":true,"schema":{"type":"string","pattern":"^[A-Za-z0-9_-]{1,64}$"}},{"name":"articleId","in":"path","required":true,"schema":{"type":"string","pattern":"^[A-Za-z0-9_-]{1,64}$"}}],"responses":{"204":{"description":"Success"}},"x-pozy-area":"publishing"}},"/v1/accounts/{accountId}/products":{"get":{"operationId":"listProducts","summary":"List products","tags":["Products"],"deprecated":true,"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":50,"default":20}},{"name":"cursor","in":"query","required":false,"schema":{"type":"string"}},{"name":"status","in":"query","required":false,"schema":{"type":"string","enum":["active","draft","archived"]}},{"name":"query","in":"query","required":false,"schema":{"type":"string","maxLength":500}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"platform":{"type":"string","enum":["shopify"]},"products":{"type":"array","items":{"$ref":"#/components/schemas/Product"}},"nextCursor":{"type":["string","null"]}}}}}}},"x-pozy-area":"commerce"}},"/v1/accounts/{accountId}/products/{productId}":{"get":{"operationId":"getProduct","summary":"Get a product","tags":["Products"],"deprecated":true,"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}},{"name":"productId","in":"path","required":true,"schema":{"type":"string","pattern":"^\\d+$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"platform":{"type":"string","enum":["shopify"]},"product":{"$ref":"#/components/schemas/Product"}}}}}}},"x-pozy-area":"commerce"},"patch":{"operationId":"updateProduct","summary":"Update a product","tags":["Products"],"deprecated":true,"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}},{"name":"productId","in":"path","required":true,"schema":{"type":"string","pattern":"^\\d+$"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"platform":{"type":"string","enum":["shopify"]},"product":{"$ref":"#/components/schemas/Product"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"title":{"type":"string","minLength":1},"descriptionHtml":{"type":"string"},"handle":{"type":"string","minLength":1},"vendor":{"type":"string"},"productType":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}},"status":{"type":"string","enum":["active","draft","archived"]},"seo":{"type":"object","properties":{"title":{"type":"string"},"description":{"type":"string"}}},"variants":{"type":"array","minItems":1,"maxItems":100,"items":{"type":"object","required":["id"],"properties":{"id":{"type":"string","pattern":"^\\d+$"},"price":{"oneOf":[{"type":"number","minimum":0},{"type":"string","pattern":"^\\d+(\\.\\d{1,2})?$"}]},"compareAtPrice":{"oneOf":[{"type":"number","minimum":0},{"type":"string","pattern":"^\\d+(\\.\\d{1,2})?$"},{"type":"null"}]}}}}}}}}},"x-pozy-area":"commerce"}},"/v1/commerce/store":{"get":{"operationId":"getCommerceStore","summary":"Get a store","tags":["Commerce"],"parameters":[{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"store":{"$ref":"#/components/schemas/CommerceStore"}}}}}}},"x-pozy-area":"commerce"}},"/v1/commerce/orders":{"get":{"operationId":"listCommerceOrders","summary":"List orders","tags":["Commerce"],"parameters":[{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":100,"default":20}},{"name":"cursor","in":"query","required":false,"schema":{"type":"string"}},{"name":"createdAfter","in":"query","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"createdBefore","in":"query","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"updatedAfter","in":"query","required":false,"schema":{"type":"string","format":"date-time"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"orders":{"type":"array","items":{"$ref":"#/components/schemas/CommerceOrder"}},"nextCursor":{"type":["string","null"]}}}}}}},"x-pozy-area":"commerce"}},"/v1/commerce/orders/{orderId}":{"get":{"operationId":"getCommerceOrder","summary":"Get an order","tags":["Commerce"],"parameters":[{"name":"orderId","in":"path","required":true,"schema":{"type":"string"}},{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"order":{"$ref":"#/components/schemas/CommerceOrder"}}}}}}},"x-pozy-area":"commerce"}},"/v1/commerce/products":{"get":{"operationId":"listCommerceProducts","summary":"List products","tags":["Commerce"],"parameters":[{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":100,"default":20}},{"name":"cursor","in":"query","required":false,"schema":{"type":"string"}},{"name":"status","in":"query","required":false,"schema":{"$ref":"#/components/schemas/CommerceProductStatus"}},{"name":"query","in":"query","required":false,"schema":{"type":"string","maxLength":500}},{"name":"collectionId","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"products":{"type":"array","items":{"$ref":"#/components/schemas/CommerceProduct"}},"nextCursor":{"type":["string","null"]}}}}}}},"x-pozy-area":"commerce"},"post":{"operationId":"createCommerceProduct","summary":"Create a product","tags":["Commerce"],"responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"product":{"$ref":"#/components/schemas/CommerceProduct"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","title","variants"],"properties":{"accountId":{"type":"string"},"title":{"type":"string","minLength":1},"descriptionHtml":{"type":"string"},"handle":{"type":"string","minLength":1},"vendor":{"type":"string"},"productType":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}},"seo":{"type":"object","properties":{"title":{"type":"string"},"description":{"type":"string"}}},"status":{"type":"string","enum":["draft","active"],"default":"draft"},"images":{"type":"array","maxItems":20,"items":{"type":"object","required":["url"],"properties":{"url":{"type":"string","format":"uri"},"altText":{"type":"string"}}}},"options":{"type":"array","maxItems":3,"items":{"type":"object","required":["name","values"],"properties":{"name":{"type":"string"},"values":{"type":"array","minItems":1,"items":{"type":"string"}}}}},"variants":{"type":"array","minItems":1,"maxItems":100,"items":{"type":"object","required":["price"],"properties":{"sku":{"type":"string"},"price":{"oneOf":[{"type":"number","minimum":0},{"type":"string","pattern":"^\\d+(\\.\\d{1,2})?$"}]},"compareAtPrice":{"oneOf":[{"type":"number","minimum":0},{"type":"string","pattern":"^\\d+(\\.\\d{1,2})?$"},{"type":"null"}]},"options":{"type":"array","items":{"type":"object","required":["name","value"],"properties":{"name":{"type":"string"},"value":{"type":"string"}}}}}}}}}}}},"x-pozy-area":"commerce"}},"/v1/commerce/products/state":{"post":{"operationId":"changeCommerceProductState","summary":"Activate, deactivate, archive or delete products","tags":["Commerce"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"action":{"type":"string","enum":["activate","deactivate","archive","delete"]},"succeeded":{"type":"array","items":{"type":"string"}},"failed":{"type":"array","items":{"type":"object","properties":{"productId":{"type":"string"},"message":{"type":"string"}}}}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","productIds","action"],"properties":{"accountId":{"type":"string"},"productIds":{"type":"array","minItems":1,"maxItems":50,"items":{"type":"string"}},"action":{"type":"string","enum":["activate","deactivate","archive","delete"]}}}}}},"x-pozy-area":"commerce"}},"/v1/commerce/products/{productId}":{"get":{"operationId":"getCommerceProduct","summary":"Get a product","tags":["Commerce"],"parameters":[{"name":"productId","in":"path","required":true,"schema":{"type":"string"}},{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"product":{"$ref":"#/components/schemas/CommerceProduct"}}}}}}},"x-pozy-area":"commerce"},"patch":{"operationId":"updateCommerceProduct","summary":"Update a product","tags":["Commerce"],"parameters":[{"name":"productId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"product":{"$ref":"#/components/schemas/CommerceProduct"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId"],"properties":{"accountId":{"type":"string"},"title":{"type":"string","minLength":1},"descriptionHtml":{"type":"string"},"handle":{"type":"string","minLength":1},"vendor":{"type":"string"},"productType":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}},"seo":{"type":"object","properties":{"title":{"type":"string"},"description":{"type":"string"}}}}}}}},"x-pozy-area":"commerce"}},"/v1/commerce/products/{productId}/price":{"post":{"operationId":"updateCommerceProductPrices","summary":"Update variant prices","tags":["Commerce"],"parameters":[{"name":"productId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"product":{"$ref":"#/components/schemas/CommerceProduct"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","variants"],"properties":{"accountId":{"type":"string"},"variants":{"type":"array","minItems":1,"maxItems":100,"items":{"type":"object","required":["id"],"properties":{"id":{"type":"string"},"price":{"oneOf":[{"type":"number","minimum":0},{"type":"string","pattern":"^\\d+(\\.\\d{1,2})?$"}]},"compareAtPrice":{"oneOf":[{"type":"number","minimum":0},{"type":"string","pattern":"^\\d+(\\.\\d{1,2})?$"},{"type":"null"}]}}}}}}}}},"x-pozy-area":"commerce"}},"/v1/commerce/collections":{"get":{"operationId":"listCommerceCollections","summary":"List collections","tags":["Commerce"],"parameters":[{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":100,"default":20}},{"name":"cursor","in":"query","required":false,"schema":{"type":"string"}},{"name":"query","in":"query","required":false,"schema":{"type":"string","maxLength":500}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"collections":{"type":"array","items":{"$ref":"#/components/schemas/CommerceCollection"}},"nextCursor":{"type":["string","null"]}}}}}}},"x-pozy-area":"commerce"},"post":{"operationId":"createCommerceCollection","summary":"Create a collection","tags":["Commerce"],"responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"collection":{"$ref":"#/components/schemas/CommerceCollection"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","title"],"properties":{"accountId":{"type":"string"},"title":{"type":"string","minLength":1},"descriptionHtml":{"type":"string"},"handle":{"type":"string","minLength":1},"sortOrder":{"type":"string","enum":["manual","best_selling","alpha_asc","alpha_desc","price_asc","price_desc","created","created_desc","most_relevant"]},"seo":{"type":"object","properties":{"title":{"type":"string"},"description":{"type":"string"}}},"image":{"type":"object","required":["url"],"properties":{"url":{"type":"string","format":"uri"},"altText":{"type":"string"}}},"productIds":{"type":"array","maxItems":250,"items":{"type":"string"}}}}}}},"x-pozy-area":"commerce"}},"/v1/commerce/collections/{collectionId}":{"get":{"operationId":"getCommerceCollection","summary":"Get a collection","tags":["Commerce"],"parameters":[{"name":"collectionId","in":"path","required":true,"schema":{"type":"string"}},{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"collection":{"$ref":"#/components/schemas/CommerceCollection"}}}}}}},"x-pozy-area":"commerce"},"patch":{"operationId":"updateCommerceCollection","summary":"Update a collection","tags":["Commerce"],"parameters":[{"name":"collectionId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"collection":{"$ref":"#/components/schemas/CommerceCollection"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId"],"properties":{"accountId":{"type":"string"},"title":{"type":"string","minLength":1},"descriptionHtml":{"type":"string"},"handle":{"type":"string","minLength":1},"sortOrder":{"type":"string","enum":["manual","best_selling","alpha_asc","alpha_desc","price_asc","price_desc","created","created_desc","most_relevant"]},"seo":{"type":"object","properties":{"title":{"type":"string"},"description":{"type":"string"}}},"image":{"type":"object","required":["url"],"properties":{"url":{"type":"string","format":"uri"},"altText":{"type":"string"}}}}}}}},"x-pozy-area":"commerce"},"delete":{"operationId":"deleteCommerceCollection","summary":"Delete a collection","tags":["Commerce"],"parameters":[{"name":"collectionId","in":"path","required":true,"schema":{"type":"string"}},{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"deleted":{"type":"boolean"},"collectionId":{"type":"string"}}}}}}},"x-pozy-area":"commerce"}},"/v1/commerce/collections/{collectionId}/products":{"post":{"operationId":"changeCommerceCollectionProducts","summary":"Add or remove products in a collection","tags":["Commerce"],"parameters":[{"name":"collectionId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"collection":{"$ref":"#/components/schemas/CommerceCollection"},"pending":{"type":"boolean"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId"],"properties":{"accountId":{"type":"string"},"add":{"type":"array","maxItems":250,"items":{"type":"string"}},"remove":{"type":"array","maxItems":250,"items":{"type":"string"}}}}}}},"x-pozy-area":"commerce"}},"/v1/commerce/products/{productId}/variants":{"post":{"operationId":"createCommerceProductVariants","summary":"Add variants","tags":["Commerce"],"parameters":[{"name":"productId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"product":{"$ref":"#/components/schemas/CommerceProduct"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","variants"],"properties":{"accountId":{"type":"string"},"variants":{"type":"array","minItems":1,"maxItems":100,"items":{"type":"object","required":["price"],"properties":{"sku":{"type":"string"},"price":{"oneOf":[{"type":"number","minimum":0},{"type":"string","pattern":"^\\d+(\\.\\d{1,2})?$"}]},"compareAtPrice":{"oneOf":[{"type":"number","minimum":0},{"type":"string","pattern":"^\\d+(\\.\\d{1,2})?$"},{"type":"null"}]},"options":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"value":{"type":"string"}}}}}}}}}}}},"x-pozy-area":"commerce"},"delete":{"operationId":"deleteCommerceProductVariants","summary":"Delete variants","tags":["Commerce"],"parameters":[{"name":"productId","in":"path","required":true,"schema":{"type":"string"}},{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}},{"name":"variantIds","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"product":{"$ref":"#/components/schemas/CommerceProduct"}}}}}}},"x-pozy-area":"commerce"}},"/v1/commerce/products/{productId}/options":{"post":{"operationId":"createCommerceProductOptions","summary":"Add options","tags":["Commerce"],"parameters":[{"name":"productId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"product":{"$ref":"#/components/schemas/CommerceProduct"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","options"],"properties":{"accountId":{"type":"string"},"options":{"type":"array","minItems":1,"maxItems":3,"items":{"type":"object","required":["name","values"],"properties":{"name":{"type":"string"},"values":{"type":"array","minItems":1,"items":{"type":"string"}}}}},"createVariants":{"type":"boolean","default":false}}}}}},"x-pozy-area":"commerce"},"delete":{"operationId":"deleteCommerceProductOptions","summary":"Delete options","tags":["Commerce"],"parameters":[{"name":"productId","in":"path","required":true,"schema":{"type":"string"}},{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}},{"name":"names","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"product":{"$ref":"#/components/schemas/CommerceProduct"}}}}}}},"x-pozy-area":"commerce"}},"/v1/commerce/products/{productId}/images":{"post":{"operationId":"addCommerceProductImages","summary":"Add images","tags":["Commerce"],"parameters":[{"name":"productId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"product":{"$ref":"#/components/schemas/CommerceProduct"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","images"],"properties":{"accountId":{"type":"string"},"images":{"type":"array","minItems":1,"maxItems":20,"items":{"type":"object","required":["url"],"properties":{"url":{"type":"string","format":"uri"},"altText":{"type":"string"}}}}}}}}},"x-pozy-area":"commerce"},"delete":{"operationId":"removeCommerceProductImages","summary":"Remove images","tags":["Commerce"],"parameters":[{"name":"productId","in":"path","required":true,"schema":{"type":"string"}},{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}},{"name":"imageIds","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"product":{"$ref":"#/components/schemas/CommerceProduct"}}}}}}},"x-pozy-area":"commerce"}},"/v1/commerce/products/{productId}/images/reorder":{"post":{"operationId":"reorderCommerceProductImages","summary":"Reorder images","tags":["Commerce"],"parameters":[{"name":"productId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"pending":{"type":"boolean"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","imageIds"],"properties":{"accountId":{"type":"string"},"imageIds":{"type":"array","minItems":1,"maxItems":250,"items":{"type":"string"}}}}}}},"x-pozy-area":"commerce"}},"/v1/commerce/products/{productId}/duplicate":{"post":{"operationId":"duplicateCommerceProduct","summary":"Duplicate a product","tags":["Commerce"],"parameters":[{"name":"productId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"product":{"$ref":"#/components/schemas/CommerceProduct"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","title"],"properties":{"accountId":{"type":"string"},"title":{"type":"string","minLength":1},"status":{"type":"string","enum":["draft","active"],"default":"draft"},"includeImages":{"type":"boolean","default":true}}}}}},"x-pozy-area":"commerce"}},"/v1/commerce/products/{productId}/metafields":{"get":{"operationId":"listCommerceProductMetafields","summary":"List product metafields","tags":["Commerce"],"parameters":[{"name":"productId","in":"path","required":true,"schema":{"type":"string"}},{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"metafields":{"type":"array","items":{"$ref":"#/components/schemas/CommerceMetafield"}}}}}}}},"x-pozy-area":"commerce"},"put":{"operationId":"setCommerceProductMetafields","summary":"Set product metafields","tags":["Commerce"],"parameters":[{"name":"productId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"metafields":{"type":"array","items":{"$ref":"#/components/schemas/CommerceMetafield"}}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","metafields"],"properties":{"accountId":{"type":"string"},"metafields":{"type":"array","minItems":1,"maxItems":25,"items":{"$ref":"#/components/schemas/CommerceMetafield"}}}}}}},"x-pozy-area":"commerce"},"delete":{"operationId":"deleteCommerceProductMetafields","summary":"Delete product metafields","tags":["Commerce"],"parameters":[{"name":"productId","in":"path","required":true,"schema":{"type":"string"}},{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}},{"name":"keys","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"deleted":{"type":"integer"}}}}}}},"x-pozy-area":"commerce"}},"/v1/commerce/products/{productId}/channels":{"post":{"operationId":"changeCommerceProductChannels","summary":"Publish or unpublish a product","tags":["Commerce"],"parameters":[{"name":"productId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"productId":{"type":"string"},"published":{"type":"array","items":{"type":"string"}},"unpublished":{"type":"array","items":{"type":"string"}}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId"],"properties":{"accountId":{"type":"string"},"publish":{"type":"array","maxItems":20,"items":{"type":"string"}},"unpublish":{"type":"array","maxItems":20,"items":{"type":"string"}}}}}}},"x-pozy-area":"commerce"}},"/v1/commerce/collections/{collectionId}/metafields":{"get":{"operationId":"listCommerceCollectionMetafields","summary":"List collection metafields","tags":["Commerce"],"parameters":[{"name":"collectionId","in":"path","required":true,"schema":{"type":"string"}},{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"metafields":{"type":"array","items":{"$ref":"#/components/schemas/CommerceMetafield"}}}}}}}},"x-pozy-area":"commerce"},"put":{"operationId":"setCommerceCollectionMetafields","summary":"Set collection metafields","tags":["Commerce"],"parameters":[{"name":"collectionId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"metafields":{"type":"array","items":{"$ref":"#/components/schemas/CommerceMetafield"}}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","metafields"],"properties":{"accountId":{"type":"string"},"metafields":{"type":"array","minItems":1,"maxItems":25,"items":{"$ref":"#/components/schemas/CommerceMetafield"}}}}}}},"x-pozy-area":"commerce"},"delete":{"operationId":"deleteCommerceCollectionMetafields","summary":"Delete collection metafields","tags":["Commerce"],"parameters":[{"name":"collectionId","in":"path","required":true,"schema":{"type":"string"}},{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}},{"name":"keys","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"deleted":{"type":"integer"}}}}}}},"x-pozy-area":"commerce"}},"/v1/commerce/collections/{collectionId}/channels":{"post":{"operationId":"changeCommerceCollectionChannels","summary":"Publish or unpublish a collection","tags":["Commerce"],"parameters":[{"name":"collectionId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"collectionId":{"type":"string"},"published":{"type":"array","items":{"type":"string"}},"unpublished":{"type":"array","items":{"type":"string"}}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId"],"properties":{"accountId":{"type":"string"},"publish":{"type":"array","maxItems":20,"items":{"type":"string"}},"unpublish":{"type":"array","maxItems":20,"items":{"type":"string"}}}}}}},"x-pozy-area":"commerce"}},"/v1/commerce/products/tags":{"post":{"operationId":"changeCommerceProductTags","summary":"Add or remove tags in bulk","tags":["Commerce"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"succeeded":{"type":"array","items":{"type":"string"}},"failed":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"message":{"type":"string"}}}}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","productIds"],"properties":{"accountId":{"type":"string"},"productIds":{"type":"array","minItems":1,"maxItems":50,"items":{"type":"string"}},"add":{"type":"array","maxItems":50,"items":{"type":"string"}},"remove":{"type":"array","maxItems":50,"items":{"type":"string"}}}}}}},"x-pozy-area":"commerce"}},"/v1/commerce/collections/{collectionId}/reorder":{"post":{"operationId":"reorderCommerceCollectionProducts","summary":"Reorder products in a collection","tags":["Commerce"],"parameters":[{"name":"collectionId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"pending":{"type":"boolean"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","moves"],"properties":{"accountId":{"type":"string"},"moves":{"type":"array","minItems":1,"maxItems":250,"items":{"type":"object","required":["productId","position"],"properties":{"productId":{"type":"string"},"position":{"type":"integer","minimum":0}}}}}}}}},"x-pozy-area":"commerce"}},"/v1/commerce/pages":{"get":{"operationId":"listCommercePages","summary":"List pages","tags":["Commerce"],"parameters":[{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":100,"default":20}},{"name":"cursor","in":"query","required":false,"schema":{"type":"string"}},{"name":"query","in":"query","required":false,"schema":{"type":"string","maxLength":500}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"pages":{"type":"array","items":{"$ref":"#/components/schemas/CommercePage"}},"nextCursor":{"type":["string","null"]}}}}}}},"x-pozy-area":"commerce"},"post":{"operationId":"createCommercePage","summary":"Create a page","tags":["Commerce"],"responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"page":{"$ref":"#/components/schemas/CommercePage"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","title"],"properties":{"accountId":{"type":"string"},"title":{"type":"string","minLength":1},"handle":{"type":"string"},"bodyHtml":{"type":"string"},"isPublished":{"type":"boolean"}}}}}},"x-pozy-area":"commerce"}},"/v1/commerce/pages/{pageId}":{"get":{"operationId":"getCommercePage","summary":"Get a page","tags":["Commerce"],"parameters":[{"name":"pageId","in":"path","required":true,"schema":{"type":"string"}},{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"page":{"$ref":"#/components/schemas/CommercePage"}}}}}}},"x-pozy-area":"commerce"},"patch":{"operationId":"updateCommercePage","summary":"Update a page","tags":["Commerce"],"parameters":[{"name":"pageId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"page":{"$ref":"#/components/schemas/CommercePage"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId"],"properties":{"accountId":{"type":"string"},"title":{"type":"string","minLength":1},"handle":{"type":"string"},"bodyHtml":{"type":"string"},"isPublished":{"type":"boolean"}}}}}},"x-pozy-area":"commerce"},"delete":{"operationId":"deleteCommercePage","summary":"Delete a page","tags":["Commerce"],"parameters":[{"name":"pageId","in":"path","required":true,"schema":{"type":"string"}},{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"deleted":{"type":"boolean"},"pageId":{"type":"string"}}}}}}},"x-pozy-area":"commerce"}},"/v1/commerce/locations":{"get":{"operationId":"listCommerceLocations","summary":"List locations","tags":["Commerce"],"parameters":[{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"locations":{"type":"array","items":{"$ref":"#/components/schemas/CommerceLocation"}}}}}}}},"x-pozy-area":"commerce"}},"/v1/commerce/inventory":{"get":{"operationId":"listCommerceInventory","summary":"Get a product's stock","tags":["Commerce"],"parameters":[{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}},{"name":"productId","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"inventory":{"type":"array","items":{"$ref":"#/components/schemas/CommerceInventoryItem"}}}}}}}},"x-pozy-area":"commerce"}},"/v1/commerce/products/{productId}/inventory":{"post":{"operationId":"changeCommerceInventory","summary":"Set or adjust stock","tags":["Commerce"],"parameters":[{"name":"productId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"inventory":{"type":"array","items":{"$ref":"#/components/schemas/CommerceInventoryItem"}}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","changes"],"properties":{"accountId":{"type":"string"},"mode":{"type":"string","enum":["set","adjust"],"default":"set"},"changes":{"type":"array","minItems":1,"maxItems":250,"items":{"type":"object","required":["variantId","locationId","quantity"],"properties":{"variantId":{"type":"string"},"locationId":{"type":"string"},"quantity":{"type":"integer"}}}}}}}}},"x-pozy-area":"commerce"}},"/v1/commerce/channels":{"get":{"operationId":"listCommerceChannels","summary":"List sales channels","tags":["Commerce"],"parameters":[{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"channels":{"type":"array","items":{"$ref":"#/components/schemas/CommerceChannel"}}}}}}}},"x-pozy-area":"commerce"}},"/v1/commerce/discounts":{"get":{"operationId":"listCommerceDiscounts","summary":"List discounts","tags":["Commerce"],"parameters":[{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":100,"default":20}},{"name":"cursor","in":"query","required":false,"schema":{"type":"string"}},{"name":"query","in":"query","required":false,"schema":{"type":"string","maxLength":500}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"discounts":{"type":"array","items":{"$ref":"#/components/schemas/CommerceDiscount"}},"nextCursor":{"type":["string","null"]}}}}}}},"x-pozy-area":"commerce"},"post":{"operationId":"createCommerceDiscount","summary":"Create a discount","tags":["Commerce"],"responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"discount":{"$ref":"#/components/schemas/CommerceDiscount"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","title","method","type"],"properties":{"accountId":{"type":"string"},"title":{"type":"string","minLength":1},"method":{"type":"string","enum":["code","automatic"]},"type":{"type":"string","enum":["percentage","fixed_amount","free_shipping"]},"code":{"type":"string"},"percentage":{"type":"number","exclusiveMinimum":0,"maximum":100},"amount":{"type":"string"},"appliesOnEachItem":{"type":"boolean"},"minimumSubtotal":{"type":["string","null"]},"minimumQuantity":{"type":["integer","null"],"minimum":1},"usageLimit":{"type":["integer","null"],"minimum":1},"oncePerCustomer":{"type":"boolean"},"startsAt":{"type":"string","format":"date-time"},"endsAt":{"type":["string","null"],"format":"date-time"},"productIds":{"type":"array","maxItems":100,"items":{"type":"string"}},"collectionIds":{"type":"array","maxItems":100,"items":{"type":"string"}}}}}}},"x-pozy-area":"commerce"}},"/v1/commerce/discounts/{discountId}":{"get":{"operationId":"getCommerceDiscount","summary":"Get a discount","tags":["Commerce"],"parameters":[{"name":"discountId","in":"path","required":true,"schema":{"type":"string"}},{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"discount":{"$ref":"#/components/schemas/CommerceDiscount"}}}}}}},"x-pozy-area":"commerce"},"patch":{"operationId":"updateCommerceDiscount","summary":"Update a discount","tags":["Commerce"],"parameters":[{"name":"discountId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"discount":{"$ref":"#/components/schemas/CommerceDiscount"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId"],"properties":{"accountId":{"type":"string"},"title":{"type":"string"},"code":{"type":"string"},"percentage":{"type":"number","exclusiveMinimum":0,"maximum":100},"amount":{"type":"string"},"appliesOnEachItem":{"type":"boolean"},"minimumSubtotal":{"type":["string","null"]},"minimumQuantity":{"type":["integer","null"],"minimum":1},"usageLimit":{"type":["integer","null"],"minimum":1},"oncePerCustomer":{"type":"boolean"},"startsAt":{"type":"string","format":"date-time"},"endsAt":{"type":["string","null"],"format":"date-time"}}}}}},"x-pozy-area":"commerce"},"delete":{"operationId":"deleteCommerceDiscount","summary":"Delete a discount","tags":["Commerce"],"parameters":[{"name":"discountId","in":"path","required":true,"schema":{"type":"string"}},{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"deleted":{"type":"boolean"},"discountId":{"type":"string"}}}}}}},"x-pozy-area":"commerce"}},"/v1/commerce/discounts/{discountId}/state":{"post":{"operationId":"setCommerceDiscountActive","summary":"Activate or deactivate a discount","tags":["Commerce"],"parameters":[{"name":"discountId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"discount":{"$ref":"#/components/schemas/CommerceDiscount"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","active"],"properties":{"accountId":{"type":"string"},"active":{"type":"boolean"}}}}}},"x-pozy-area":"commerce"}},"/v1/commerce/discounts/{discountId}/codes":{"post":{"operationId":"addCommerceDiscountCodes","summary":"Add codes to a discount","tags":["Commerce"],"parameters":[{"name":"discountId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"202":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"pending":{"type":"boolean"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","codes"],"properties":{"accountId":{"type":"string"},"codes":{"type":"array","minItems":1,"maxItems":250,"items":{"type":"string"}}}}}}},"x-pozy-area":"commerce"}},"/v1/commerce/redirects":{"get":{"operationId":"listCommerceRedirects","summary":"List URL redirects","tags":["Commerce"],"parameters":[{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":100,"default":20}},{"name":"cursor","in":"query","required":false,"schema":{"type":"string"}},{"name":"query","in":"query","required":false,"schema":{"type":"string","maxLength":500}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"redirects":{"type":"array","items":{"$ref":"#/components/schemas/CommerceRedirect"}},"nextCursor":{"type":["string","null"]}}}}}}},"x-pozy-area":"commerce"},"post":{"operationId":"createCommerceRedirect","summary":"Create a URL redirect","tags":["Commerce"],"responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"redirect":{"$ref":"#/components/schemas/CommerceRedirect"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","path","target"],"properties":{"accountId":{"type":"string"},"path":{"type":"string"},"target":{"type":"string"}}}}}},"x-pozy-area":"commerce"}},"/v1/commerce/redirects/{redirectId}":{"patch":{"operationId":"updateCommerceRedirect","summary":"Update a URL redirect","tags":["Commerce"],"parameters":[{"name":"redirectId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"redirect":{"$ref":"#/components/schemas/CommerceRedirect"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId"],"properties":{"accountId":{"type":"string"},"path":{"type":"string"},"target":{"type":"string"}}}}}},"x-pozy-area":"commerce"},"delete":{"operationId":"deleteCommerceRedirect","summary":"Delete a URL redirect","tags":["Commerce"],"parameters":[{"name":"redirectId","in":"path","required":true,"schema":{"type":"string"}},{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"deleted":{"type":"boolean"},"redirectId":{"type":"string"}}}}}}},"x-pozy-area":"commerce"}},"/v1/commerce/menus":{"get":{"operationId":"listCommerceMenus","summary":"List navigation menus","tags":["Commerce"],"parameters":[{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"menus":{"type":"array","items":{"$ref":"#/components/schemas/CommerceMenu"}}}}}}}},"x-pozy-area":"commerce"},"post":{"operationId":"createCommerceMenu","summary":"Create a navigation menu","tags":["Commerce"],"responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"menu":{"$ref":"#/components/schemas/CommerceMenu"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","title","handle","items"],"properties":{"accountId":{"type":"string"},"title":{"type":"string"},"handle":{"type":"string"},"items":{"type":"array","maxItems":100,"items":{"$ref":"#/components/schemas/CommerceMenuItemInput"}}}}}}},"x-pozy-area":"commerce"}},"/v1/commerce/menus/{menuId}":{"get":{"operationId":"getCommerceMenu","summary":"Get a navigation menu","tags":["Commerce"],"parameters":[{"name":"menuId","in":"path","required":true,"schema":{"type":"string"}},{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"menu":{"$ref":"#/components/schemas/CommerceMenu"}}}}}}},"x-pozy-area":"commerce"},"put":{"operationId":"updateCommerceMenu","summary":"Replace a navigation menu","tags":["Commerce"],"parameters":[{"name":"menuId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"menu":{"$ref":"#/components/schemas/CommerceMenu"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","title","items"],"properties":{"accountId":{"type":"string"},"title":{"type":"string"},"handle":{"type":"string"},"items":{"type":"array","maxItems":100,"items":{"$ref":"#/components/schemas/CommerceMenuItemInput"}}}}}}},"x-pozy-area":"commerce"},"delete":{"operationId":"deleteCommerceMenu","summary":"Delete a navigation menu","tags":["Commerce"],"parameters":[{"name":"menuId","in":"path","required":true,"schema":{"type":"string"}},{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"deleted":{"type":"boolean"},"menuId":{"type":"string"}}}}}}},"x-pozy-area":"commerce"}},"/v1/commerce/metaobject-definitions":{"get":{"operationId":"listCommerceMetaobjectDefinitions","summary":"List metaobject definitions","tags":["Commerce"],"parameters":[{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"definitions":{"type":"array","items":{"$ref":"#/components/schemas/CommerceMetaobjectDefinition"}}}}}}}},"x-pozy-area":"commerce"}},"/v1/commerce/metaobjects":{"get":{"operationId":"listCommerceMetaobjects","summary":"List metaobjects of a type","tags":["Commerce"],"parameters":[{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}},{"name":"type","in":"query","required":true,"schema":{"type":"string"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":100,"default":20}},{"name":"cursor","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"metaobjects":{"type":"array","items":{"$ref":"#/components/schemas/CommerceMetaobject"}},"nextCursor":{"type":["string","null"]}}}}}}},"x-pozy-area":"commerce"},"post":{"operationId":"createCommerceMetaobject","summary":"Create a metaobject","tags":["Commerce"],"responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"metaobject":{"$ref":"#/components/schemas/CommerceMetaobject"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","type","fields"],"properties":{"accountId":{"type":"string"},"type":{"type":"string"},"handle":{"type":"string"},"fields":{"type":"array","minItems":1,"maxItems":100,"items":{"type":"object","required":["key","value"],"properties":{"key":{"type":"string"},"value":{"type":"string"}}}}}}}}},"x-pozy-area":"commerce"}},"/v1/commerce/metaobjects/{metaobjectId}":{"get":{"operationId":"getCommerceMetaobject","summary":"Get a metaobject","tags":["Commerce"],"parameters":[{"name":"metaobjectId","in":"path","required":true,"schema":{"type":"string"}},{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"metaobject":{"$ref":"#/components/schemas/CommerceMetaobject"}}}}}}},"x-pozy-area":"commerce"},"patch":{"operationId":"updateCommerceMetaobject","summary":"Update a metaobject","tags":["Commerce"],"parameters":[{"name":"metaobjectId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"metaobject":{"$ref":"#/components/schemas/CommerceMetaobject"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","fields"],"properties":{"accountId":{"type":"string"},"handle":{"type":"string"},"fields":{"type":"array","minItems":1,"maxItems":100,"items":{"type":"object","required":["key","value"],"properties":{"key":{"type":"string"},"value":{"type":"string"}}}}}}}}},"x-pozy-area":"commerce"},"delete":{"operationId":"deleteCommerceMetaobject","summary":"Delete a metaobject","tags":["Commerce"],"parameters":[{"name":"metaobjectId","in":"path","required":true,"schema":{"type":"string"}},{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"deleted":{"type":"boolean"},"metaobjectId":{"type":"string"}}}}}}},"x-pozy-area":"commerce"}},"/v1/commerce/markets":{"get":{"operationId":"listCommerceMarkets","summary":"List markets","tags":["Commerce"],"parameters":[{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"markets":{"type":"array","items":{"$ref":"#/components/schemas/CommerceMarket"}}}}}}}},"x-pozy-area":"commerce"}},"/v1/commerce/price-lists":{"get":{"operationId":"listCommercePriceLists","summary":"List price lists","tags":["Commerce"],"parameters":[{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"priceLists":{"type":"array","items":{"$ref":"#/components/schemas/CommercePriceList"}}}}}}}},"x-pozy-area":"commerce"}},"/v1/commerce/price-lists/{priceListId}/prices":{"put":{"operationId":"setCommercePriceListPrices","summary":"Set fixed prices","tags":["Commerce"],"parameters":[{"name":"priceListId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"priceListId":{"type":"string"},"updated":{"type":"integer"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","prices"],"properties":{"accountId":{"type":"string"},"prices":{"type":"array","minItems":1,"maxItems":250,"items":{"type":"object","required":["variantId","price"],"properties":{"variantId":{"type":"string"},"price":{"type":"string"},"compareAtPrice":{"type":["string","null"]}}}}}}}}},"x-pozy-area":"commerce"},"delete":{"operationId":"deleteCommercePriceListPrices","summary":"Remove fixed prices","tags":["Commerce"],"parameters":[{"name":"priceListId","in":"path","required":true,"schema":{"type":"string"}},{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}},{"name":"variantIds","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"priceListId":{"type":"string"},"deleted":{"type":"integer"}}}}}}},"x-pozy-area":"commerce"}},"/v1/commerce/marketing-activities":{"put":{"operationId":"upsertCommerceMarketingActivity","summary":"Record a marketing activity","tags":["Commerce"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"marketingActivity":{"type":"object","properties":{"id":{"type":"string"},"remoteId":{"type":"string"}}}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","remoteId","title","url","tactic","channel","status"],"properties":{"accountId":{"type":"string"},"remoteId":{"type":"string","maxLength":255},"title":{"type":"string"},"url":{"type":"string","format":"uri"},"previewImageUrl":{"type":"string","format":"uri"},"utm":{"type":"object","required":["campaign","source","medium"],"properties":{"campaign":{"type":"string"},"source":{"type":"string"},"medium":{"type":"string"}}},"tactic":{"type":"string","enum":["ad","post","message","newsletter","link","affiliate","retargeting","loyalty","seo"]},"channel":{"type":"string","enum":["social","search","display","email","referral"]},"status":{"type":"string","enum":["active","inactive","paused","scheduled"]},"budget":{"type":"object","required":["type","amount"],"properties":{"type":{"type":"string","enum":["daily","lifetime"]},"amount":{"type":"string"}}},"adSpend":{"type":"string"},"startedAt":{"type":"string","format":"date-time"},"endedAt":{"type":"string","format":"date-time"}}}}}},"x-pozy-area":"commerce"}},"/v1/commerce/marketing-activities/{remoteId}":{"delete":{"operationId":"deleteCommerceMarketingActivity","summary":"Delete a marketing activity","tags":["Commerce"],"parameters":[{"name":"remoteId","in":"path","required":true,"schema":{"type":"string"}},{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"deleted":{"type":"boolean"},"remoteId":{"type":"string"}}}}}}},"x-pozy-area":"commerce"}},"/v1/commerce/marketing-activities/{remoteId}/engagements":{"post":{"operationId":"addCommerceMarketingEngagement","summary":"Report daily engagement","tags":["Commerce"],"parameters":[{"name":"remoteId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"remoteId":{"type":"string"},"recorded":{"type":"boolean"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","date"],"properties":{"accountId":{"type":"string"},"date":{"type":"string","format":"date"},"impressions":{"type":"integer","minimum":0},"views":{"type":"integer","minimum":0},"clicks":{"type":"integer","minimum":0},"shares":{"type":"integer","minimum":0},"likes":{"type":"integer","minimum":0},"comments":{"type":"integer","minimum":0},"adSpend":{"type":"string"}}}}}},"x-pozy-area":"commerce"}},"/v1/commerce/catalog-syncs":{"get":{"operationId":"listCommerceCatalogSyncs","summary":"List catalog syncs","tags":["Commerce"],"parameters":[{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"catalogSyncs":{"type":"array","items":{"$ref":"#/components/schemas/CommerceCatalogSync"}}}}}}}},"x-pozy-area":"commerce"},"post":{"operationId":"createCommerceCatalogSync","summary":"Sync a store into a Meta catalog","tags":["Commerce"],"responses":{"202":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"catalogSync":{"$ref":"#/components/schemas/CommerceCatalogSync"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","catalogAccountId","catalogId"],"properties":{"accountId":{"type":"string"},"catalogAccountId":{"type":"string"},"catalogId":{"type":"string","pattern":"^\\d+$"}}}}}},"x-pozy-area":"commerce"}},"/v1/commerce/catalog-syncs/{syncId}":{"get":{"operationId":"getCommerceCatalogSync","summary":"Get a catalog sync","tags":["Commerce"],"parameters":[{"name":"syncId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"catalogSync":{"$ref":"#/components/schemas/CommerceCatalogSync"}}}}}}},"x-pozy-area":"commerce"},"delete":{"operationId":"deleteCommerceCatalogSync","summary":"Stop a catalog sync","tags":["Commerce"],"parameters":[{"name":"syncId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"deleted":{"type":"boolean"},"syncId":{"type":"string"}}}}}}},"x-pozy-area":"commerce"}},"/v1/commerce/catalog-syncs/{syncId}/run":{"post":{"operationId":"runCommerceCatalogSync","summary":"Run a catalog sync now","tags":["Commerce"],"parameters":[{"name":"syncId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"202":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"catalogSync":{"$ref":"#/components/schemas/CommerceCatalogSync"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"x-pozy-area":"commerce"}},"/v1/verify/verifications":{"post":{"operationId":"createVerification","summary":"Send a verification code","tags":["Verify"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Verification"}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["channel","to"],"properties":{"channel":{"type":"string","enum":["sms","whatsapp"]},"to":{"type":"string"},"from":{"type":"string"},"brandName":{"type":"string","maxLength":30},"codeLength":{"type":"integer","minimum":4,"maximum":8,"default":6},"ttlMinutes":{"type":"integer","minimum":1,"maximum":15,"default":10}}}}}},"x-pozy-area":"messaging"}},"/v1/verify/verifications/{verificationId}":{"get":{"operationId":"getVerification","summary":"Get a verification","tags":["Verify"],"parameters":[{"name":"verificationId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Verification"}}}}},"x-pozy-area":"messaging"}},"/v1/verify/verifications/{verificationId}/check":{"post":{"operationId":"checkVerification","summary":"Check a verification code","tags":["Verify"],"parameters":[{"name":"verificationId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Verification"},{"type":"object","properties":{"valid":{"type":"boolean"}}}]}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["code"],"properties":{"code":{"type":"string","pattern":"^\\d{4,8}$"}}}}}},"x-pozy-area":"messaging"}},"/v1/ads/pixels":{"get":{"operationId":"listTikTokAdPixels","summary":"List TikTok ad pixels","tags":["Ad Accounts"],"parameters":[{"name":"accountId","in":"query","required":true,"schema":{"type":"string","pattern":"^[a-fA-F0-9]{24}$"}},{"name":"adAccountId","in":"query","required":false,"schema":{"type":"string"}},{"name":"advertiserId","in":"query","required":false,"schema":{"type":"string"}},{"name":"code","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"advertiserId":{"type":"string"},"pixels":{"type":"array","items":{"type":"object","properties":{"pixelId":{"type":"string"},"pixelCode":{"type":"string"},"name":{"type":"string"},"events":{"type":"array","items":{"type":"string"}},"eventDetails":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"optimizationEvent":{"type":["string","null"]},"custom":{"type":"boolean"}}}}}}}}}}}}},"x-pozy-area":"ads"}},"/v1/ads/partnership-content":{"get":{"operationId":"listPartnershipAdContent","summary":"List partnership ad content","tags":["Ad Creatives"],"parameters":[{"name":"accountId","in":"query","required":true,"schema":{"type":"string","pattern":"^[a-fA-F0-9]{24}$"}},{"name":"creatorUsername","in":"query","required":false,"schema":{"type":"string"}},{"name":"postUrl","in":"query","required":false,"schema":{"type":"string","format":"uri"}},{"name":"onlyAllowlisted","in":"query","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"media":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"permalink":{"type":"string"},"ownerId":{"type":"string"},"hasPermissionForPartnershipAd":{"type":"boolean"},"isCreatorAllowlisted":{"type":"boolean"},"eligibilityErrors":{"type":"array","items":{"type":"string"}},"recommendedCampaignObjectives":{"type":"array","items":{"type":"string"}}}}}}}}}}},"x-pozy-area":"ads"}},"/v1/ads/partnership-permissions":{"get":{"operationId":"listPartnershipAdPermissions","summary":"List partnership permissions","tags":["Ad Creatives"],"parameters":[{"name":"accountId","in":"query","required":true,"schema":{"type":"string","pattern":"^[a-fA-F0-9]{24}$"}},{"name":"creatorUsername","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"permissions":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"permissionType":{"type":"string"},"status":{"type":"string"}}}}}}}}}},"x-pozy-area":"ads"},"post":{"operationId":"setPartnershipAdPermission","summary":"Set partnership permission","tags":["Ad Creatives"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"permission":{"type":"object","properties":{"id":{"type":"string"},"permissionType":{"type":"string"},"status":{"type":"string"}}}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","creatorUsername"],"properties":{"accountId":{"type":"string","pattern":"^[a-fA-F0-9]{24}$"},"creatorUsername":{"type":"string","minLength":1},"revoke":{"type":"boolean"}}}}}},"x-pozy-area":"ads"}},"/v1/tools/tiktok/download":{"get":{"operationId":"downloadTikTokVideo","summary":"Download a TikTok video","tags":["Tools"],"parameters":[{"name":"url","in":"query","required":true,"schema":{"type":"string"}},{"name":"action","in":"query","required":false,"schema":{"type":"string","enum":["download","formats"],"default":"download"}},{"name":"formatId","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","required":["success","title"],"properties":{"success":{"type":"boolean"},"title":{"type":"string"},"format":{"type":"string"},"downloadUrl":{"type":"string"},"duration":{"type":"number"},"cover":{"type":"string"},"formats":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"label":{"type":"string"},"ext":{"type":"string"},"type":{"type":"string"},"height":{"type":"number"},"width":{"type":"number"},"fps":{"type":"number"},"hasAudio":{"type":"boolean"},"hasVideo":{"type":"boolean"}}}}}}}}}},"x-pozy-area":"publishing"}},"/v1/media/prepare":{"post":{"operationId":"prepareMedia","summary":"Prepare media for a platform","tags":["Media"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","required":["target","url","changed","mediaType","originalSize","outputSize"],"properties":{"target":{"type":"string"},"url":{"type":"string","format":"uri"},"changed":{"type":"boolean"},"mediaType":{"type":"string","enum":["image","video"]},"originalSize":{"type":["integer","null"]},"outputSize":{"type":["integer","null"]}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["url","target"],"properties":{"url":{"type":"string","format":"uri"},"target":{"type":"string","enum":["instagram","instagram_story","facebook","facebook_reel","facebook_story","threads","tiktok","linkedin","twitter","bluesky","pinterest","reddit","snapchat","telegram","googlebusiness","youtube_thumbnail"]}}}}}},"x-pozy-area":"publishing"}},"/v1/changelog":{"get":{"operationId":"listChangelog","summary":"List API changelog entries","tags":["Changelog"],"parameters":[{"name":"type","in":"query","required":false,"schema":{"type":"string","enum":["new_feature","breaking_change","improvement","deprecation","minor"]}},{"name":"impact","in":"query","required":false,"schema":{"type":"string","enum":["none","additive","action_required"]}},{"name":"platform","in":"query","required":false,"schema":{"type":"string","pattern":"^[a-z0-9-]+$"}},{"name":"before","in":"query","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":100,"default":20}}],"security":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","required":["entries","nextCursor"],"properties":{"entries":{"type":"array","items":{"$ref":"#/components/schemas/ApiChangelogEntry"}},"nextCursor":{"type":["string","null"],"format":"date-time"}}}}}}},"x-pozy-area":"workspace"}},"/v1/creator-campaigns":{"get":{"operationId":"listCreatorCampaigns","summary":"List creator campaigns","tags":["Creator Campaigns"],"parameters":[{"name":"status","in":"query","required":false,"schema":{"type":"string","enum":["draft","active","paused","closed"]}},{"name":"profileId","in":"query","required":false,"schema":{"type":"string"}},{"name":"q","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":100}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":200,"default":50}},{"name":"skip","in":"query","required":false,"schema":{"type":"integer","minimum":0,"default":0}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","required":["campaigns","total"],"properties":{"campaigns":{"type":"array","items":{"$ref":"#/components/schemas/CreatorCampaign"}},"total":{"type":"integer"}}}}}}},"x-pozy-area":"creators"},"post":{"operationId":"createCreatorCampaign","summary":"Create creator campaign","tags":["Creator Campaigns"],"parameters":[{"name":"Idempotency-Key","in":"header","required":false,"schema":{"type":"string","maxLength":255}}],"responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"type":"object","required":["campaign"],"properties":{"campaign":{"$ref":"#/components/schemas/CreatorCampaign"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCreatorCampaignRequest"}}}},"x-pozy-area":"creators"}},"/v1/creator-campaigns/{campaignId}":{"get":{"operationId":"getCreatorCampaign","summary":"Get creator campaign","tags":["Creator Campaigns"],"parameters":[{"name":"campaignId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","required":["campaign"],"properties":{"campaign":{"$ref":"#/components/schemas/CreatorCampaign"}}}}}}},"x-pozy-area":"creators"},"patch":{"operationId":"updateCreatorCampaign","summary":"Update creator campaign","tags":["Creator Campaigns"],"parameters":[{"name":"campaignId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","required":["campaign"],"properties":{"campaign":{"$ref":"#/components/schemas/CreatorCampaign"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCreatorCampaignRequest"}}}},"x-pozy-area":"creators"}},"/v1/creator-campaigns/{campaignId}/budget":{"post":{"operationId":"raiseCreatorCampaignBudget","summary":"Raise creator campaign budget","tags":["Creator Campaigns"],"parameters":[{"name":"campaignId","in":"path","required":true,"schema":{"type":"string"}},{"name":"Idempotency-Key","in":"header","required":false,"schema":{"type":"string","maxLength":255}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","required":["campaign"],"properties":{"campaign":{"$ref":"#/components/schemas/CreatorCampaign"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["budgetCents"],"properties":{"budgetCents":{"type":"integer","minimum":1}}}}}},"x-pozy-area":"creators"}},"/v1/creator-campaigns/{campaignId}/activate":{"post":{"operationId":"activateCreatorCampaign","summary":"Activate creator campaign","tags":["Creator Campaigns"],"parameters":[{"name":"campaignId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","required":["campaign"],"properties":{"campaign":{"$ref":"#/components/schemas/CreatorCampaign"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"x-pozy-area":"creators"}},"/v1/creator-campaigns/{campaignId}/pause":{"post":{"operationId":"pauseCreatorCampaign","summary":"Pause creator campaign","tags":["Creator Campaigns"],"parameters":[{"name":"campaignId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","required":["campaign"],"properties":{"campaign":{"$ref":"#/components/schemas/CreatorCampaign"}}}}}}},"x-pozy-area":"creators"}},"/v1/creator-campaigns/{campaignId}/close":{"post":{"operationId":"closeCreatorCampaign","summary":"Close creator campaign","tags":["Creator Campaigns"],"parameters":[{"name":"campaignId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","required":["campaign"],"properties":{"campaign":{"$ref":"#/components/schemas/CreatorCampaign"}}}}}}},"x-pozy-area":"creators"}},"/v1/creator-campaigns/{campaignId}/participants":{"get":{"operationId":"listCampaignParticipants","summary":"List campaign participants","tags":["Creator Campaigns"],"parameters":[{"name":"campaignId","in":"path","required":true,"schema":{"type":"string"}},{"name":"status","in":"query","required":false,"schema":{"type":"string","enum":["invited","active","suspended","removed"]}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":200,"default":50}},{"name":"skip","in":"query","required":false,"schema":{"type":"integer","minimum":0,"default":0}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","required":["participants","total"],"properties":{"participants":{"type":"array","items":{"$ref":"#/components/schemas/CampaignParticipant"}},"total":{"type":"integer"}}}}}}},"x-pozy-area":"creators"},"post":{"operationId":"createCampaignParticipant","summary":"Invite campaign participant","tags":["Creator Campaigns"],"parameters":[{"name":"campaignId","in":"path","required":true,"schema":{"type":"string"}},{"name":"Idempotency-Key","in":"header","required":false,"schema":{"type":"string","maxLength":255}}],"responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"type":"object","required":["participant","inviteUrl","emailSent"],"properties":{"participant":{"$ref":"#/components/schemas/CampaignParticipant"},"inviteUrl":{"type":"string","format":"uri"},"emailSent":{"type":"boolean","description":"True when Pozy emailed the invitation. False when no email address was given or the email could not be sent: share inviteUrl yourself."}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"description":"email_not_verified: Confirm your email address, or add a payment method, first. Invite links you share yourself keep working. workspace_suspended: The workspace was paused by Pozy (contact support@pozy.ai to resume). On the creator portal: the brand's workspace is paused, so the creator should contact the brand.","x-pozy-error-codes":["email_not_verified","workspace_suspended"],"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"invite_limit_reached: The workspace reached its invitation email limit: 20 a day and 50 pending team invitations without a payment method, 500 a day with one. Share the invite link instead.","x-pozy-error-codes":["invite_limit_reached"],"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["displayName"],"properties":{"displayName":{"type":"string","minLength":1,"maxLength":200},"email":{"type":"string","format":"email"}}}}}},"x-pozy-area":"creators"}},"/v1/creator-campaigns/{campaignId}/participants/{participantId}":{"get":{"operationId":"getCampaignParticipant","summary":"Get campaign participant","tags":["Creator Campaigns"],"parameters":[{"name":"campaignId","in":"path","required":true,"schema":{"type":"string"}},{"name":"participantId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","required":["participant"],"properties":{"participant":{"$ref":"#/components/schemas/CampaignParticipant"}}}}}}},"x-pozy-area":"creators"}},"/v1/creator-campaigns/{campaignId}/participants/{participantId}/suspend":{"post":{"operationId":"suspendCampaignParticipant","summary":"Suspend campaign participant","tags":["Creator Campaigns"],"parameters":[{"name":"campaignId","in":"path","required":true,"schema":{"type":"string"}},{"name":"participantId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","required":["participant"],"properties":{"participant":{"$ref":"#/components/schemas/CampaignParticipant"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"x-pozy-area":"creators"}},"/v1/creator-campaigns/{campaignId}/participants/{participantId}/reinstate":{"post":{"operationId":"reinstateCampaignParticipant","summary":"Reinstate campaign participant","tags":["Creator Campaigns"],"parameters":[{"name":"campaignId","in":"path","required":true,"schema":{"type":"string"}},{"name":"participantId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","required":["participant"],"properties":{"participant":{"$ref":"#/components/schemas/CampaignParticipant"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"x-pozy-area":"creators"}},"/v1/creator-campaigns/{campaignId}/participants/{participantId}/remove":{"post":{"operationId":"removeCampaignParticipant","summary":"Remove campaign participant","tags":["Creator Campaigns"],"parameters":[{"name":"campaignId","in":"path","required":true,"schema":{"type":"string"}},{"name":"participantId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","required":["participant"],"properties":{"participant":{"$ref":"#/components/schemas/CampaignParticipant"}}}}}}},"x-pozy-area":"creators"}},"/v1/creator-campaigns/{campaignId}/participants/{participantId}/resend-invite":{"post":{"operationId":"resendCampaignParticipantInvite","summary":"Resend campaign participant invite","tags":["Creator Campaigns"],"parameters":[{"name":"campaignId","in":"path","required":true,"schema":{"type":"string"}},{"name":"participantId","in":"path","required":true,"schema":{"type":"string"}},{"name":"Idempotency-Key","in":"header","required":false,"schema":{"type":"string","maxLength":255}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","required":["participant"],"properties":{"participant":{"$ref":"#/components/schemas/CampaignParticipant"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"description":"email_not_verified: Confirm your email address, or add a payment method, first. Invite links you share yourself keep working. workspace_suspended: The workspace was paused by Pozy (contact support@pozy.ai to resume). On the creator portal: the brand's workspace is paused, so the creator should contact the brand.","x-pozy-error-codes":["email_not_verified","workspace_suspended"],"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"invite_limit_reached: The workspace reached its invitation email limit: 20 a day and 50 pending team invitations without a payment method, 500 a day with one. Share the invite link instead. invite_resend_too_soon: An invitation can be emailed again once an hour. The message says how many minutes are left.","x-pozy-error-codes":["invite_limit_reached","invite_resend_too_soon"],"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"502":{"description":"email_not_sent: Pozy could not send the email. Copy the creator's invite link and share it instead.","x-pozy-error-codes":["email_not_sent"],"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-pozy-area":"creators"}},"/v1/creator-campaigns/{campaignId}/participants/{participantId}/settle":{"post":{"operationId":"settleCampaignParticipant","summary":"Settle campaign participant","tags":["Creator Campaigns"],"parameters":[{"name":"campaignId","in":"path","required":true,"schema":{"type":"string"}},{"name":"participantId","in":"path","required":true,"schema":{"type":"string"}},{"name":"Idempotency-Key","in":"header","required":false,"schema":{"type":"string","maxLength":255}}],"responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"type":"object","required":["settlement"],"properties":{"settlement":{"$ref":"#/components/schemas/CampaignSettlement"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"amountCents":{"type":"integer","minimum":1},"externalReference":{"type":"string","minLength":1,"maxLength":200},"recordOnly":{"type":"boolean"}}}}}},"x-pozy-area":"creators"}},"/v1/creator-campaigns/{campaignId}/payout-batches":{"get":{"operationId":"listCampaignPayoutBatches","summary":"List payout batches","tags":["Creator Campaigns"],"parameters":[{"name":"campaignId","in":"path","required":true,"schema":{"type":"string"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":100,"default":20}},{"name":"skip","in":"query","required":false,"schema":{"type":"integer","minimum":0,"default":0}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","required":["batches","total"],"properties":{"batches":{"type":"array","items":{"$ref":"#/components/schemas/PayoutBatch"}},"total":{"type":"integer"}}}}}}},"x-pozy-area":"creators"},"post":{"operationId":"createCampaignPayoutBatch","summary":"Pay creators with one card payment","tags":["Creator Campaigns"],"parameters":[{"name":"campaignId","in":"path","required":true,"schema":{"type":"string"}},{"name":"Idempotency-Key","in":"header","required":false,"schema":{"type":"string","maxLength":255}}],"responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"type":"object","required":["batch","payment"],"properties":{"batch":{"$ref":"#/components/schemas/PayoutBatch"},"payment":{"type":"object","required":["status","clientSecret"],"properties":{"status":{"type":"string","enum":["succeeded","processing","requires_action"]},"clientSecret":{"type":["string","null"]}}}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{"participantIds":{"type":"array","items":{"type":"string"},"minItems":1,"maxItems":500},"excludeParticipantIds":{"type":"array","items":{"type":"string"},"minItems":1,"maxItems":500},"paymentMethodId":{"type":"string"}}}}}},"x-pozy-area":"creators"}},"/v1/creator-campaigns/{campaignId}/invite-link":{"post":{"operationId":"createCampaignInviteLink","summary":"Create campaign invite link","tags":["Creator Campaigns"],"parameters":[{"name":"campaignId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"type":"object","required":["inviteUrl"],"properties":{"inviteUrl":{"type":"string","format":"uri"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"x-pozy-area":"creators"}},"/v1/creator-campaigns/{campaignId}/submissions":{"get":{"operationId":"listCampaignSubmissions","summary":"List campaign submissions","tags":["Creator Campaigns"],"parameters":[{"name":"campaignId","in":"path","required":true,"schema":{"type":"string"}},{"name":"status","in":"query","required":false,"schema":{"type":"string","enum":["received","tracking","pending_review","approved","rejected","expired","withdrawn"]}},{"name":"participantId","in":"query","required":false,"schema":{"type":"string"}},{"name":"flag","in":"query","required":false,"schema":{"type":"string","enum":["duplicate_media","duplicate_post","view_spike","linked_accounts","cross_operator","unreachable","post_deleted","account_restricted","low_authenticity","x_read_cap"]}},{"name":"platform","in":"query","required":false,"schema":{"type":"string","enum":["tiktok","instagram","youtube","threads","pinterest","facebook","twitter"]}},{"name":"minScore","in":"query","required":false,"schema":{"type":"integer","minimum":0,"maximum":100}},{"name":"maxScore","in":"query","required":false,"schema":{"type":"integer","minimum":0,"maximum":100}},{"name":"q","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":100}},{"name":"sort","in":"query","required":false,"schema":{"type":"string","enum":["submittedAt","viewsEligible","earnedCents","authenticityScore"],"default":"submittedAt"}},{"name":"order","in":"query","required":false,"schema":{"type":"string","enum":["asc","desc"],"default":"desc"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":200,"default":50}},{"name":"skip","in":"query","required":false,"schema":{"type":"integer","minimum":0,"default":0}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","required":["submissions","total"],"properties":{"submissions":{"type":"array","items":{"$ref":"#/components/schemas/CampaignSubmission"}},"total":{"type":"integer"}}}}}}},"x-pozy-area":"creators"}},"/v1/creator-campaigns/{campaignId}/submissions/{submissionId}":{"get":{"operationId":"getCampaignSubmission","summary":"Get campaign submission","tags":["Creator Campaigns"],"parameters":[{"name":"campaignId","in":"path","required":true,"schema":{"type":"string"}},{"name":"submissionId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","required":["submission"],"properties":{"submission":{"$ref":"#/components/schemas/CampaignSubmissionDetail"}}}}}}},"x-pozy-area":"creators"}},"/v1/creator-campaigns/{campaignId}/submissions/{submissionId}/approve":{"post":{"operationId":"approveCampaignSubmission","summary":"Approve campaign submission","tags":["Creator Campaigns"],"parameters":[{"name":"campaignId","in":"path","required":true,"schema":{"type":"string"}},{"name":"submissionId","in":"path","required":true,"schema":{"type":"string"}},{"name":"Idempotency-Key","in":"header","required":false,"schema":{"type":"string","maxLength":255}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","required":["submission"],"properties":{"submission":{"$ref":"#/components/schemas/CampaignSubmission"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"x-pozy-area":"creators"}},"/v1/creator-campaigns/{campaignId}/submissions/{submissionId}/reject":{"post":{"operationId":"rejectCampaignSubmission","summary":"Reject campaign submission","tags":["Creator Campaigns"],"parameters":[{"name":"campaignId","in":"path","required":true,"schema":{"type":"string"}},{"name":"submissionId","in":"path","required":true,"schema":{"type":"string"}},{"name":"Idempotency-Key","in":"header","required":false,"schema":{"type":"string","maxLength":255}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","required":["submission"],"properties":{"submission":{"$ref":"#/components/schemas/CampaignSubmission"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["reason"],"properties":{"reason":{"type":"string","minLength":1,"maxLength":1000}}}}}},"x-pozy-area":"creators"}},"/v1/creator-campaigns/{campaignId}/submissions/{submissionId}/reopen":{"post":{"operationId":"reopenCampaignSubmission","summary":"Reopen campaign submission","tags":["Creator Campaigns"],"parameters":[{"name":"campaignId","in":"path","required":true,"schema":{"type":"string"}},{"name":"submissionId","in":"path","required":true,"schema":{"type":"string"}},{"name":"Idempotency-Key","in":"header","required":false,"schema":{"type":"string","maxLength":255}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","required":["submission"],"properties":{"submission":{"$ref":"#/components/schemas/CampaignSubmission"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"x-pozy-area":"creators"}},"/v1/creator-campaigns/{campaignId}/payables":{"get":{"operationId":"listCampaignPayables","summary":"List campaign payables","tags":["Creator Campaigns"],"parameters":[{"name":"campaignId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","required":["payables"],"properties":{"payables":{"type":"array","items":{"$ref":"#/components/schemas/CampaignPayable"}}}}}}}},"x-pozy-area":"creators"}},"/v1/creator-campaigns/{campaignId}/adjustments":{"post":{"operationId":"createCampaignAdjustment","summary":"Create campaign adjustment","tags":["Creator Campaigns"],"parameters":[{"name":"campaignId","in":"path","required":true,"schema":{"type":"string"}},{"name":"Idempotency-Key","in":"header","required":false,"schema":{"type":"string","maxLength":255}}],"responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"type":"object","required":["entry"],"properties":{"entry":{"$ref":"#/components/schemas/CampaignAdjustment"}}}}}},"402":{"$ref":"#/components/responses/WorkspaceSuspended"},"403":{"$ref":"#/components/responses/WorkspacePaused"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["participantId","amountCents","cause"],"properties":{"participantId":{"type":"string"},"amountCents":{"type":"integer"},"cause":{"type":"string","minLength":1,"maxLength":500}}}}}},"x-pozy-area":"creators"}},"/v1/creator-campaigns/{campaignId}/ledger":{"get":{"operationId":"listCampaignLedger","summary":"List campaign ledger","tags":["Creator Campaigns"],"parameters":[{"name":"campaignId","in":"path","required":true,"schema":{"type":"string"}},{"name":"participantId","in":"query","required":false,"schema":{"type":"string"}},{"name":"kind","in":"query","required":false,"schema":{"type":"string","enum":["accrual","approval","hold_release","adjustment","settling","settlement","reversal","topup","transfer","fee"]}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":200,"default":50}},{"name":"skip","in":"query","required":false,"schema":{"type":"integer","minimum":0,"default":0}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","required":["entries","pagination"],"properties":{"entries":{"type":"array","items":{"$ref":"#/components/schemas/CampaignLedgerEntry"}},"pagination":{"type":"object","required":["total","limit","skip"],"properties":{"total":{"type":"integer"},"limit":{"type":"integer"},"skip":{"type":"integer"}}}}}}}}},"x-pozy-area":"creators"}},"/v1/creator-campaigns/{campaignId}/report":{"get":{"operationId":"getCampaignReport","summary":"Get campaign report","tags":["Creator Campaigns"],"parameters":[{"name":"campaignId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","required":["report"],"properties":{"report":{"$ref":"#/components/schemas/CampaignReport"}}}}}}},"x-pozy-area":"creators"}}},"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"pz_live_..."},"connectToken":{"type":"apiKey","in":"header","name":"X-Connect-Token"}},"responses":{"WorkspaceSuspended":{"description":"workspace_suspended: The workspace is paused because a payment failed and the 7-day grace period ended. Reads, billing and paying keep working. Update the card in Billing to resume.","x-pozy-error-codes":["workspace_suspended"],"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"WorkspacePaused":{"description":"workspace_suspended: The workspace was paused by Pozy (contact support@pozy.ai to resume). On the creator portal: the brand's workspace is paused, so the creator should contact the brand.","x-pozy-error-codes":["workspace_suspended"],"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"schemas":{"CreatorPortalCampaign":{"type":"object","required":["id","name","brandName","logoUrl","theme","status","platforms","contentRules","startsAt","endsAt","currency","economics","maxPostAgeMinutes","holdDays","trackingDays"],"properties":{"id":{"type":"string"},"name":{"type":"string"},"brandName":{"type":"string"},"logoUrl":{"type":["string","null"]},"theme":{"type":["object","null"]},"status":{"type":"string","enum":["draft","active","paused","closed"]},"platforms":{"type":"array","items":{"type":"string"}},"contentRules":{"type":["string","null"]},"startsAt":{"type":["string","null"],"format":"date-time"},"endsAt":{"type":["string","null"],"format":"date-time"},"currency":{"type":"string"},"economics":{"$ref":"#/components/schemas/CreatorPortalEconomics"},"maxPostAgeMinutes":{"type":["integer","null"]},"holdDays":{"type":"integer"},"trackingDays":{"type":"integer"}}},"CreatorPortalEconomics":{"oneOf":[{"type":"object","title":"CPM","required":["type","ratePer1kCents","minViewsToEarn"],"properties":{"type":{"type":"string","enum":["cpm"]},"ratePer1kCents":{"type":"integer"},"minViewsToEarn":{"type":"integer"},"maxPayoutPerClipCents":{"type":"integer"}}},{"type":"object","title":"Per post","required":["type","perApprovedPostCents"],"properties":{"type":{"type":"string","enum":["per_post"]},"perApprovedPostCents":{"type":"integer"},"maxPostsPerParticipant":{"type":"integer"}}},{"type":"object","title":"Pool","required":["type","poolCents","minViewsToQualify"],"properties":{"type":{"type":"string","enum":["pool"]},"poolCents":{"type":"integer"},"minViewsToQualify":{"type":"integer"}}}]},"CreatorPortalSubmission":{"type":"object","required":["id","platform","postId","url","status","submittedAt","publishedAt","views","earnedCents","rejectReason","flags","trackingEndsAt"],"properties":{"id":{"type":"string"},"platform":{"type":"string"},"postId":{"type":"string"},"url":{"type":["string","null"]},"status":{"type":"string","enum":["received","tracking","pending_review","approved","rejected","expired","withdrawn"]},"submittedAt":{"type":"string","format":"date-time"},"publishedAt":{"type":["string","null"],"format":"date-time"},"views":{"type":"integer"},"earnedCents":{"type":"integer"},"rejectReason":{"type":["string","null"]},"flags":{"type":"array","items":{"type":"string","enum":["unreachable","post_deleted","duplicate_post","under_review"]}},"trackingEndsAt":{"type":["string","null"],"format":"date-time"}}},"CreatorPortalPayoutSetup":{"type":"object","required":["mode","status","country","transfers"],"properties":{"mode":{"type":"string","enum":["none","external","treasury"]},"status":{"type":"string","enum":["not_started","pending","enabled","not_applicable"]},"country":{"type":["string","null"]},"transfers":{"type":"array","items":{"type":"object","required":["id","amountCents","createdAt"],"properties":{"id":{"type":"string"},"amountCents":{"type":"integer"},"createdAt":{"type":"string","format":"date-time"}}}}}},"CreatorPortalPayoutEntry":{"type":"object","required":["id","kind","amountCents","fromBucket","toBucket","holdUntil","createdAt"],"properties":{"id":{"type":"string"},"kind":{"type":"string","enum":["accrual","approval","hold_release","adjustment","settling","settlement","reversal","topup","transfer","fee"]},"amountCents":{"type":"integer"},"fromBucket":{"type":["string","null"]},"toBucket":{"type":["string","null"]},"holdUntil":{"type":["string","null"],"format":"date-time"},"createdAt":{"type":"string","format":"date-time"}}},"CreatorPortalInvite":{"type":"object","required":["kind","campaign"],"properties":{"kind":{"type":"string","enum":["invite"]},"campaign":{"$ref":"#/components/schemas/CreatorPortalCampaign"}}},"CreatorPortalParticipant":{"type":"object","required":["kind","campaign","participant","accounts","submissions","earnings","payouts"],"properties":{"kind":{"type":"string","enum":["participant"]},"campaign":{"$ref":"#/components/schemas/CreatorPortalCampaign"},"participant":{"type":"object","required":["displayName","status","joinedAt"],"properties":{"displayName":{"type":"string"},"status":{"type":"string","enum":["invited","active","suspended","removed"]},"joinedAt":{"type":["string","null"],"format":"date-time"}}},"accounts":{"type":"array","items":{"type":"object","required":["platform","username","displayName","avatarUrl"],"properties":{"platform":{"type":"string"},"username":{"type":"string"},"displayName":{"type":["string","null"]},"avatarUrl":{"type":["string","null"]}}}},"submissions":{"type":"array","items":{"$ref":"#/components/schemas/CreatorPortalSubmission"}},"earnings":{"type":"object","required":["accruingCents","owedCents","payableCents","payingCents","paidCents","nextReleaseAt"],"properties":{"accruingCents":{"type":"integer"},"owedCents":{"type":"integer"},"payableCents":{"type":"integer"},"payingCents":{"type":"integer"},"paidCents":{"type":"integer"},"nextReleaseAt":{"type":["string","null"],"format":"date-time"}}},"payouts":{"$ref":"#/components/schemas/CreatorPortalPayoutSetup"}}},"TreasuryTopup":{"type":"object","properties":{"id":{"type":"string"},"method":{"type":"string","enum":["card","bank_transfer"]},"purpose":{"type":"string","enum":["balance","payout_batch"]},"payoutBatch":{"type":["object","null"],"properties":{"id":{"type":"string"},"campaignId":{"type":["string","null"]}}},"feeCoveredByPozy":{"type":"boolean"},"amountCents":{"type":"integer"},"stripeFeeCents":{"type":["integer","null"]},"netCents":{"type":["integer","null"]},"status":{"type":"string","enum":["pending","succeeded","failed","expired"]},"createdAt":{"type":"string","format":"date-time"},"succeededAt":{"type":["string","null"],"format":"date-time"}}},"PayoutBatchItem":{"type":"object","required":["id","participantId","creator","amountCents","feeCents","totalCents","status","failureReason","transferId"],"properties":{"id":{"type":"string"},"participantId":{"type":"string"},"creator":{"type":"object","required":["displayName"],"properties":{"displayName":{"type":"string"}}},"amountCents":{"type":"integer"},"feeCents":{"type":"integer"},"totalCents":{"type":"integer"},"status":{"type":"string","enum":["pending","paid","failed","skipped"]},"failureReason":{"type":["string","null"]},"transferId":{"type":["string","null"]}}},"PayoutBatch":{"type":"object","required":["id","campaignId","status","method","amountCents","feeCents","totalCents","items","paidAt","finishedAt","createdAt"],"properties":{"id":{"type":"string"},"campaignId":{"type":["string","null"]},"status":{"type":"string","enum":["awaiting_payment","paying","paid","partially_failed","failed","expired"]},"method":{"type":"string","enum":["card"]},"amountCents":{"type":"integer"},"feeCents":{"type":"integer"},"totalCents":{"type":"integer"},"items":{"type":"array","items":{"$ref":"#/components/schemas/PayoutBatchItem"}},"paidAt":{"type":["string","null"],"format":"date-time"},"finishedAt":{"type":["string","null"],"format":"date-time"},"createdAt":{"type":"string","format":"date-time"}}},"TreasuryTransfer":{"type":"object","properties":{"id":{"type":"string"},"payeeId":{"type":"string","minLength":24,"maxLength":24},"payeeName":{"type":["string","null"]},"destinationType":{"type":"string","enum":["creator","ad_account"]},"amountCents":{"type":"integer"},"feeCents":{"type":"integer"},"totalCents":{"type":"integer"},"currency":{"type":"string"},"reference":{"type":"object","properties":{"type":{"type":"string"},"id":{"type":"string"},"name":{"type":["string","null"]}}},"status":{"type":"string","enum":["pending","paid","failed","reversed"]},"failureReason":{"type":["string","null"]},"createdAt":{"type":"string","format":"date-time"}}},"TreasuryPayee":{"type":"object","properties":{"id":{"type":"string"},"payeeType":{"type":"string","enum":["creator","ad_account"]},"payeeRef":{"type":"string"},"country":{"type":"string"},"onboardingStatus":{"type":"string","enum":["pending","complete","restricted"]},"detailsSubmitted":{"type":"boolean"},"payoutsEnabled":{"type":"boolean"},"createdAt":{"type":"string","format":"date-time"}}},"LedgerAccountSide":{"type":"object","properties":{"scopeType":{"type":"string"},"scopeId":{"type":"string"},"bucket":{"type":"string"}}},"AdLeadConsent":{"type":"object","required":["checkboxKey","isChecked"],"properties":{"checkboxKey":{"type":"string"},"isChecked":{"type":"boolean"}}},"AdLeadConsents":{"type":"array","items":{"$ref":"#/components/schemas/AdLeadConsent"}},"AdLead":{"type":"object","properties":{"id":{"type":"string"},"leadgenId":{"type":"string"},"formId":{"type":"string"},"formName":{"type":["string","null"]},"accountId":{"type":"string"},"adId":{"type":["string","null"]},"adsetId":{"type":["string","null"]},"campaignId":{"type":["string","null"]},"isOrganic":{"type":"boolean"},"createdTime":{"type":["string","null"]},"fields":{"type":"object","additionalProperties":{"type":"string"}},"fieldData":{"type":"array","items":{"type":"object"}},"consents":{"$ref":"#/components/schemas/AdLeadConsents"},"status":{"type":"string","enum":["new","contacted","unreachable","qualified","converted","disqualified"]},"statusChangedAt":{"type":["string","null"],"format":"date-time"},"value":{"type":["number","null"]},"currency":{"type":["string","null"]},"contactId":{"type":["string","null"]},"firstContactedAt":{"type":["string","null"],"format":"date-time"},"conversationId":{"type":["string","null"]},"webhookDeliveredAt":{"type":["string","null"],"format":"date-time"}}},"ConnectHandoffLink":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"url":{"type":"string","format":"uri"},"expiresAt":{"type":"string","format":"date-time"}}},"ConnectHandoff":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"status":{"type":"string","enum":["waiting","opened","connected","failed","expired"]},"platform":{"type":"string"},"accounts":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"profileId":{"type":"string"},"username":{"type":"string"}}}},"error":{"type":["object","null"],"properties":{"code":{"type":"string"},"message":{"type":["string","null"]},"details":{"type":"object","additionalProperties":{"type":"string"}}}}}},"OAuthApp":{"type":"object","required":["id","platform","label","clientId","scopeAreas","status","accountCount","redirectUri","createdAt"],"properties":{"id":{"type":"string"},"platform":{"type":"string"},"label":{"type":"string"},"clientId":{"type":"string"},"scopeAreas":{"type":"array","items":{"type":"string","enum":["posting","analytics","comments","messaging"]}},"status":{"type":"string","enum":["ok","unchecked","invalid"]},"lastCheckedAt":{"type":["string","null"],"format":"date-time"},"lastError":{"type":["string","null"]},"accountCount":{"type":"integer"},"redirectUri":{"type":"string","format":"uri"},"webhook":{"type":["object","null"],"required":["callbackUrl","verifyToken","object","fields"],"properties":{"callbackUrl":{"type":"string","format":"uri"},"verifyToken":{"type":"string"},"object":{"$ref":"#/components/schemas/OAuthAppWebhookObject"},"fields":{"type":"array","items":{"type":"string"}}}},"sharedWebhookUrl":{"type":["string","null"],"format":"uri"},"hasSlackSigningSecret":{"type":"boolean"},"slackEvents":{"type":["object","null"],"required":["requestUrl","botEvents"],"properties":{"requestUrl":{"type":"string","format":"uri"},"botEvents":{"type":"array","items":{"type":"string"}}}},"createdAt":{"type":"string","format":"date-time"}}},"OAuthAppWebhookObject":{"type":"string","enum":["page","instagram"]},"OAuthAppSetup":{"type":"object","required":["platform","redirectUri","coreScopes","scopeAreas"],"properties":{"platform":{"type":"string"},"redirectUri":{"type":"string","format":"uri"},"coreScopes":{"type":"array","items":{"type":"string"}},"scopeAreas":{"type":"array","items":{"type":"object","required":["area","scopes"],"properties":{"area":{"type":"string","enum":["posting","analytics","comments","messaging"]},"scopes":{"type":"array","items":{"type":"string"}}}}}}},"ConnectWelcomeScreen":{"type":"object","properties":{"showByDefault":{"type":"boolean"},"brandName":{"type":["string","null"]},"logoUrl":{"type":["string","null"]},"theme":{"type":["object","null"]}}},"AnalyticsDashboardTotals":{"type":"object","properties":{"impressions":{"type":"integer"},"reach":{"type":"integer"},"likes":{"type":"integer"},"comments":{"type":"integer"},"shares":{"type":"integer"},"saves":{"type":"integer"},"clicks":{"type":"integer"},"views":{"type":"integer"},"engagementRate":{"type":"number"}}},"AnalyticsDashboardFollowers":{"type":"object","properties":{"current":{"type":"integer"},"gained":{"type":"integer"},"byAccount":{"type":"array","items":{"type":"object","properties":{"accountId":{"type":"string"},"platform":{"type":"string"},"current":{"type":"integer"},"gained":{"type":"integer"}}}}}},"AnalyticsDashboardPost":{"type":"object","properties":{"postId":{"type":"string"},"platform":{"type":"string"},"publishedAt":{"type":"string","format":"date-time"},"metrics":{"type":"object","properties":{"impressions":{"type":"integer"},"reach":{"type":"integer"},"likes":{"type":"integer"},"comments":{"type":"integer"},"shares":{"type":"integer"},"saves":{"type":"integer"},"clicks":{"type":"integer"},"views":{"type":"integer"},"engagementRate":{"type":"number"}}}}},"BrandedCallingContact":{"type":"object","required":["firstName","lastName","email","phoneNumber"],"properties":{"firstName":{"type":"string","maxLength":100},"lastName":{"type":"string","maxLength":100},"email":{"type":"string","format":"email"},"jobTitle":{"type":"string","maxLength":100},"phoneNumber":{"type":"string"}}},"BrandedCallingAddress":{"type":"object","required":["streetAddress","city","administrativeArea","postalCode","country"],"properties":{"streetAddress":{"type":"string","maxLength":255},"extendedAddress":{"type":"string","maxLength":255},"city":{"type":"string","maxLength":100},"administrativeArea":{"type":"string"},"postalCode":{"type":"string","maxLength":20},"country":{"type":"string"}}},"BrandedCallingReference":{"type":"object","required":["fullName","phoneNumber","email","timezone"],"properties":{"fullName":{"type":"string","maxLength":255},"jobTitle":{"type":"string","maxLength":255},"organization":{"type":"string","maxLength":255},"relationshipToRegistrant":{"type":"string","maxLength":255},"phoneNumber":{"type":"string"},"email":{"type":"string","format":"email"},"timezone":{"type":"string"}}},"BrandedCallingReferences":{"type":"object","required":["business","financial"],"properties":{"business":{"type":"array","minItems":2,"maxItems":2,"items":{"$ref":"#/components/schemas/BrandedCallingReference"}},"financial":{"$ref":"#/components/schemas/BrandedCallingReference"}}},"BrandedCallingEnterprise":{"type":"object","properties":{"id":{"type":"string"},"legalName":{"type":"string"},"doingBusinessAs":{"type":"string"},"organizationType":{"type":"string","enum":["commercial","government","non_profit"]},"organizationLegalType":{"type":"string","enum":["corporation","llc","partnership","nonprofit","other"]},"countryCode":{"type":"string","enum":["US","CA"]},"jurisdictionOfIncorporation":{"type":"string"},"website":{"type":"string"},"feinLast4":{"type":"string"},"industry":{"type":"string"},"numberOfEmployees":{"type":"string","enum":["1-10","11-50","51-200","201-500","501-2000","2001-10000","10001+"]},"organizationContact":{"$ref":"#/components/schemas/BrandedCallingContact"},"billingContact":{"$ref":"#/components/schemas/BrandedCallingContact"},"physicalAddress":{"$ref":"#/components/schemas/BrandedCallingAddress"},"billingAddress":{"$ref":"#/components/schemas/BrandedCallingAddress"},"registered":{"type":"boolean"},"createdAt":{"type":["string","null"],"format":"date-time"}}},"BrandedCallingIdentityNumber":{"type":"object","properties":{"phoneNumberId":{"type":"string"},"phoneNumber":{"type":"string"},"status":{"type":"string","enum":["submitted","in_review","verified","unsuccessful","suspended","expired","permanently_rejected"]},"rejectionReason":{"type":["object","null"],"properties":{"code":{"type":"string"},"title":{"type":"string"},"detail":{"type":"string"},"message":{"type":["string","null"]}}},"verifiedAt":{"type":["string","null"],"format":"date-time"},"addedAt":{"type":["string","null"],"format":"date-time"}}},"BrandedCallingIdentity":{"type":"object","properties":{"id":{"type":"string"},"enterpriseId":{"type":"string"},"displayName":{"type":"string","maxLength":35},"callReasons":{"type":"array","items":{"type":"string","maxLength":64}},"callReasonsPreApproved":{"type":"boolean"},"logoUrl":{"type":["string","null"]},"authorizer":{"type":"object","properties":{"name":{"type":"string"},"email":{"type":"string","format":"email"}}},"references":{"$ref":"#/components/schemas/BrandedCallingReferences"},"status":{"type":"string","enum":["requested","changes_requested","rejected","pending_email_verification","in_review","verified","suspended","expired","permanently_rejected"]},"rejectionReasons":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string"},"title":{"type":"string"},"detail":{"type":"string"},"message":{"type":["string","null"]}}}},"reviewNote":{"type":["string","null"]},"reviewRequest":{"type":["object","null"],"properties":{"id":{"type":"string"},"intro":{"type":"string"},"points":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"title":{"type":"string"},"detail":{"type":"string"},"answer":{"type":"string","enum":["text","link","file","link_or_file"]}}}}}},"emailVerifiedAt":{"type":["string","null"],"format":"date-time"},"submittedAt":{"type":["string","null"],"format":"date-time"},"verifiedAt":{"type":["string","null"],"format":"date-time"},"expiringAt":{"type":["string","null"],"format":"date-time"},"numbers":{"type":"array","items":{"$ref":"#/components/schemas/BrandedCallingIdentityNumber"}},"createdAt":{"type":["string","null"],"format":"date-time"},"updatedAt":{"type":["string","null"],"format":"date-time"}}},"RcsBrandInput":{"type":"object","required":["displayName","legalName","legalEntityType","organizationType","websiteUrl","taxId","address","contact"],"properties":{"displayName":{"type":"string","maxLength":100},"legalName":{"type":"string","maxLength":100},"legalEntityType":{"type":"string","enum":["LIMITED_LIABILITY_COMPANY","SOLE_PROPRIETORSHIP","PARTNERSHIP","CORPORATION","S_CORPORATION"]},"organizationType":{"type":"string","enum":["PRIVATE_PROFIT","PUBLIC_PROFIT","NON_PROFIT","GOVERNMENT"]},"websiteUrl":{"type":"string","format":"uri"},"taxId":{"type":"string"},"stockSymbol":{"type":"string"},"address":{"type":"object","required":["line1","city","postalCode","country"],"properties":{"line1":{"type":"string"},"line2":{"type":"string"},"city":{"type":"string"},"state":{"type":"string"},"postalCode":{"type":"string"},"country":{"type":"string","enum":["US","GB","AT","BD","BR","CD","DE","ES","FR","IN","IT","MX","NG","NL","NO","PT","SE","SG","ZA"]}}},"contact":{"type":"object","required":["firstName","lastName","email","phone"],"properties":{"firstName":{"type":"string"},"lastName":{"type":"string"},"title":{"type":"string"},"email":{"type":"string","format":"email"},"phone":{"type":"string"}}}}},"RcsBrand":{"allOf":[{"$ref":"#/components/schemas/RcsBrandInput"},{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string","enum":["draft","vetting","verified","rejected"]},"createdAt":{"type":"string","format":"date-time"}}}]},"RcsAgentProfile":{"type":"object","required":["description","logoUrl","heroUrl","brandColor","privacyPolicyUrl","termsUrl"],"properties":{"description":{"type":"string","maxLength":100},"logoUrl":{"type":"string","format":"uri"},"heroUrl":{"type":"string","format":"uri"},"brandColor":{"type":"string"},"privacyPolicyUrl":{"type":"string","format":"uri"},"termsUrl":{"type":"string","format":"uri"},"phone":{"type":"object","required":["number","label"],"properties":{"number":{"type":"string"},"label":{"type":"string","maxLength":25}}},"website":{"type":"object","required":["url","label"],"properties":{"url":{"type":"string","format":"uri"},"label":{"type":"string","maxLength":25}}},"email":{"type":"object","required":["address","label"],"properties":{"address":{"type":"string","format":"email"},"label":{"type":"string","maxLength":25}}}}},"RcsLaunchRequest":{"type":"object","required":["companyOverview","agentOverview","interactions","messageExamples","consent","testVideoUrl"],"properties":{"companyOverview":{"type":"string","maxLength":2000},"agentOverview":{"type":"string","maxLength":2000},"interactions":{"type":"array","minItems":1,"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["TRANSACTIONAL_UPDATES","CUSTOMER_SUPPORT","LOYALTY_OR_REWARD","MARKETING_OR_PROMOTIONAL","ACCOUNT_ALERTS","TWO_WAY_CONVERSATION","OTHER"]},"description":{"type":"string"}}}},"messageExamples":{"type":"array","minItems":3,"maxItems":10,"items":{"type":"string","maxLength":2000}},"consent":{"type":"object","required":["optInMethods","callToAction","doubleOptIn","optInMessage","helpResponse","optOutResponse"],"properties":{"optInMethods":{"type":"array","minItems":1,"items":{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["SMS","WEBSITE","MOBILE_APP","QR_CODE","SALE_POINT","OTHER"]},"description":{"type":"string"}}}},"callToAction":{"type":"string"},"callToActionUrl":{"type":"string","format":"uri"},"callToActionMediaUrl":{"type":"string","format":"uri"},"doubleOptIn":{"type":"boolean"},"doubleOptInMessage":{"type":"string"},"optInMessage":{"type":"string"},"helpResponse":{"type":"string"},"optOutResponse":{"type":"string"}}},"testVideoUrl":{"type":"string","format":"uri"},"additionalInformation":{"type":"string","maxLength":2000}}},"RcsCarrierApproval":{"type":"object","properties":{"approvalId":{"type":"string"},"scope":{"type":"string","enum":["carrier","hub","bot"]},"status":{"type":"string","enum":["PENDING","SUBMITTED","APPROVED","REJECTED"]},"carrier":{"type":["string","null"]},"approvedAt":{"type":["string","null"],"format":"date-time"},"rejectedReason":{"type":["string","null"]}}},"RcsTestDevice":{"type":"object","properties":{"testDeviceId":{"type":"string"},"phoneNumber":{"type":"string"},"inviteStatus":{"type":"string","enum":["PENDING","ACCEPTED","DECLINED"]}}},"RcsAgent":{"type":"object","properties":{"id":{"type":"string"},"profileId":{"type":"string"},"accountId":{"type":["string","null"]},"country":{"type":"string"},"status":{"type":"string","enum":["requested","changes_requested","brand_vetting","agent_review","testing","launch_review","launching","live","rejected","deactivated"]},"displayName":{"type":"string","maxLength":40},"useCase":{"type":"string","enum":["MULTI_USE","PROMOTIONAL","TRANSACTIONAL","OTP"]},"profile":{"$ref":"#/components/schemas/RcsAgentProfile"},"brand":{"oneOf":[{"$ref":"#/components/schemas/RcsBrand"},{"type":"null"}]},"launchRequest":{"oneOf":[{"$ref":"#/components/schemas/RcsLaunchRequest"},{"type":"null"}]},"carrierApprovals":{"type":"array","items":{"$ref":"#/components/schemas/RcsCarrierApproval"}},"testDevices":{"type":"array","items":{"$ref":"#/components/schemas/RcsTestDevice"}},"smsFallbackFrom":{"type":["string","null"]},"reviewNote":{"type":["string","null"]},"declineReason":{"type":["string","null"]},"requestedAt":{"type":["string","null"],"format":"date-time"},"submittedAt":{"type":["string","null"],"format":"date-time"},"liveAt":{"type":["string","null"],"format":"date-time"},"createdAt":{"type":"string","format":"date-time"}}},"RcsSuggestion":{"oneOf":[{"type":"object","required":["type","text"],"properties":{"type":{"type":"string","enum":["reply"]},"text":{"type":"string","maxLength":25},"postbackData":{"type":"string"}}},{"type":"object","required":["type","text","phoneNumber"],"properties":{"type":{"type":"string","enum":["dial"]},"text":{"type":"string","maxLength":25},"phoneNumber":{"type":"string"},"postbackData":{"type":"string"}}},{"type":"object","required":["type","text","url"],"properties":{"type":{"type":"string","enum":["openUrl"]},"text":{"type":"string","maxLength":25},"url":{"type":"string","format":"uri"},"application":{"type":"string","enum":["BROWSER","WEBVIEW"],"default":"BROWSER"},"webviewViewMode":{"type":"string","enum":["FULL","HALF","TALL"],"default":"FULL"},"postbackData":{"type":"string"}}},{"type":"object","required":["type","text"],"properties":{"type":{"type":"string","enum":["viewLocation"]},"text":{"type":"string","maxLength":25},"latitude":{"type":"number"},"longitude":{"type":"number"},"query":{"type":"string"},"label":{"type":"string"},"postbackData":{"type":"string"}}},{"type":"object","required":["type","text"],"properties":{"type":{"type":"string","enum":["shareLocation"]},"text":{"type":"string","maxLength":25},"postbackData":{"type":"string"}}},{"type":"object","required":["type","text","startTime","endTime","title"],"properties":{"type":{"type":"string","enum":["calendarEvent"]},"text":{"type":"string","maxLength":25},"startTime":{"type":"string","format":"date-time"},"endTime":{"type":"string","format":"date-time"},"title":{"type":"string","maxLength":100},"description":{"type":"string","maxLength":500},"postbackData":{"type":"string"}}}]},"RcsMedia":{"type":"object","required":["url"],"properties":{"url":{"type":"string","format":"uri"},"thumbnailUrl":{"type":"string","format":"uri"},"height":{"type":"string","enum":["SHORT","MEDIUM","TALL"],"default":"MEDIUM"}}},"RcsCard":{"type":"object","properties":{"title":{"type":"string","maxLength":200},"description":{"type":"string","maxLength":2000},"media":{"$ref":"#/components/schemas/RcsMedia"},"suggestions":{"type":"array","maxItems":4,"items":{"$ref":"#/components/schemas/RcsSuggestion"}}}},"RcsContent":{"oneOf":[{"type":"object","required":["type","text"],"properties":{"type":{"type":"string","enum":["text"]},"text":{"type":"string","maxLength":3072},"suggestions":{"type":"array","maxItems":11,"items":{"$ref":"#/components/schemas/RcsSuggestion"}}}},{"type":"object","required":["type","media"],"properties":{"type":{"type":"string","enum":["media"]},"media":{"$ref":"#/components/schemas/RcsMedia"},"suggestions":{"type":"array","maxItems":11,"items":{"$ref":"#/components/schemas/RcsSuggestion"}}}},{"type":"object","required":["type","card"],"properties":{"type":{"type":"string","enum":["card"]},"card":{"$ref":"#/components/schemas/RcsCard"},"orientation":{"type":"string","enum":["VERTICAL","HORIZONTAL"],"default":"VERTICAL"},"thumbnailAlignment":{"type":"string","enum":["LEFT","RIGHT"],"default":"LEFT"},"suggestions":{"type":"array","maxItems":11,"items":{"$ref":"#/components/schemas/RcsSuggestion"}}}},{"type":"object","required":["type","cards"],"properties":{"type":{"type":"string","enum":["carousel"]},"cards":{"type":"array","minItems":2,"maxItems":10,"items":{"$ref":"#/components/schemas/RcsCard"}},"cardWidth":{"type":"string","enum":["SMALL","MEDIUM"],"default":"MEDIUM"},"suggestions":{"type":"array","maxItems":11,"items":{"$ref":"#/components/schemas/RcsSuggestion"}}}}]},"RcsCapability":{"type":"object","properties":{"phoneNumber":{"type":"string"},"rcsCapable":{"type":"boolean"},"features":{"type":"array","items":{"type":"string"}}}},"FeedbackReceipt":{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string","enum":["received"]},"duplicate":{"type":"boolean"}}},"SmsRegistrationReviewRequest":{"type":"object","properties":{"id":{"type":"string"},"intro":{"type":"string"},"points":{"type":"array","items":{"type":"object","required":["id","title","detail","answer"],"properties":{"id":{"type":"string"},"title":{"type":"string"},"detail":{"type":"string"},"answer":{"type":"string","enum":["text","link","file","link_or_file"]}}}}}},"MetaProductCatalog":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"vertical":{"type":["string","null"]},"productCount":{"type":"integer"},"businessId":{"type":["string","null"]}}},"MetaCatalogProductInput":{"type":"object","properties":{"retailerId":{"type":"string","maxLength":100},"name":{"type":"string","maxLength":200},"description":{"type":"string","maxLength":9999},"url":{"type":"string","format":"uri"},"imageUrl":{"type":"string","format":"uri"},"additionalImageUrls":{"type":"array","maxItems":20,"items":{"type":"string","format":"uri"}},"price":{"type":"number"},"currency":{"type":"string"},"salePrice":{"type":"number"},"salePriceStartDate":{"type":"string"},"salePriceEndDate":{"type":"string"},"availability":{"type":"string","enum":["in stock","out of stock","preorder","available for order","discontinued","pending"]},"condition":{"type":"string","enum":["new","refurbished","used"]},"brand":{"type":"string","maxLength":100},"category":{"type":"string","maxLength":250},"googleProductCategory":{"type":"string","maxLength":250},"productType":{"type":"string","maxLength":750},"gtin":{"type":"string","maxLength":50},"mpn":{"type":"string","maxLength":100},"inventory":{"type":"integer","minimum":0},"visibility":{"type":"string","enum":["published","staging"]},"color":{"type":"string","maxLength":200},"size":{"type":"string","maxLength":200},"gender":{"type":"string","enum":["female","male","unisex"]},"material":{"type":"string","maxLength":200},"pattern":{"type":"string","maxLength":100},"customLabel0":{"type":"string","maxLength":100},"customLabel1":{"type":"string","maxLength":100},"customLabel2":{"type":"string","maxLength":100},"customLabel3":{"type":"string","maxLength":100},"customLabel4":{"type":"string","maxLength":100}}},"MetaCatalogProduct":{"type":"object","properties":{"id":{"type":"string"},"retailerId":{"type":["string","null"]},"name":{"type":"string"},"description":{"type":["string","null"]},"url":{"type":["string","null"]},"imageUrl":{"type":["string","null"]},"additionalImageUrls":{"type":"array","items":{"type":"string"}},"price":{"type":["string","null"]},"salePrice":{"type":["string","null"]},"currency":{"type":["string","null"]},"availability":{"type":["string","null"]},"condition":{"type":["string","null"]},"brand":{"type":["string","null"]},"category":{"type":["string","null"]},"productType":{"type":["string","null"]},"gtin":{"type":["string","null"]},"inventory":{"type":["integer","null"]},"visibility":{"type":["string","null"]},"color":{"type":["string","null"]},"size":{"type":["string","null"]},"gender":{"type":["string","null"]},"material":{"type":["string","null"]},"pattern":{"type":["string","null"]},"customLabels":{"type":"array","items":{"type":["string","null"]}},"reviewStatus":{"type":["string","null"]},"reviewRejectionReasons":{"type":"array","items":{"type":"string"}}}},"MetaProductFeed":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"productCount":{"type":"integer"},"schedule":{"type":["object","null"],"properties":{"interval":{"type":"string"},"url":{"type":"string"},"hour":{"type":["integer","null"]},"dayOfWeek":{"type":["string","null"]}}},"createdTime":{"type":["string","null"]},"latestUpload":{"oneOf":[{"$ref":"#/components/schemas/MetaFeedUpload"},{"type":"null"}]}}},"MetaFeedUpload":{"type":"object","properties":{"id":{"type":"string"},"url":{"type":["string","null"]},"startTime":{"type":["string","null"]},"endTime":{"type":["string","null"]},"errorCount":{"type":"integer"},"warningCount":{"type":"integer"},"itemsDetected":{"type":"integer"},"itemsDeleted":{"type":"integer"}}},"MetaProductSet":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"productCount":{"type":"integer"},"filter":{"type":["object","null"],"additionalProperties":true}}},"WhatsAppCommerceSettings":{"type":"object","properties":{"isCartEnabled":{"type":"boolean"},"isCatalogVisible":{"type":"boolean"}}},"WhatsAppTemplateLookupError":{"type":"object","required":["error","type","code","platform","details"],"properties":{"error":{"type":"string"},"type":{"type":"string","enum":["platform_error"]},"code":{"type":"string","enum":["platform_api_error"]},"platform":{"type":"string","enum":["whatsapp"]},"platformError":{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"},"error_data":{"type":"object","properties":{"details":{"type":"string"}}}}},"details":{"type":"object","required":["phase","endpoint"],"properties":{"phase":{"type":"string","enum":["template_lookup"]},"endpoint":{"type":"string"},"upstreamStatus":{"type":"integer"},"providerHeaders":{"type":"object","properties":{"retry-after":{"type":"string"},"x-app-usage":{"type":"string"},"x-business-use-case-usage":{"type":"string"}},"additionalProperties":false}}}}},"AdAppliedDefaults":{"type":"object","properties":{"name":{"type":"string"},"goal":{"type":"string"},"budgetType":{"type":"string","enum":["daily"]},"endDate":{"type":"string"},"countries":{"type":"array","items":{"type":"string"}}}},"AdTracking":{"type":"object","properties":{"pixelId":{"type":"string"},"urlTags":{"type":"array","items":{"type":"object","required":["key","value"],"properties":{"key":{"type":"string"},"value":{"type":"string"}}}},"pozyTag":{"type":"boolean","default":false}}},"MetaLeadForm":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"status":{"type":"string"},"locale":{"type":"string"},"created_time":{"type":"string","format":"date-time"},"page_id":{"type":"string"},"leads_count":{"type":"integer"},"organic_leads_count":{"type":"integer"},"expired_leads_count":{"type":"integer"},"privacy_policy_url":{"type":"string","format":"uri"},"follow_up_action_url":{"type":"string","format":"uri"},"follow_up_action_text":{"type":"string"},"question_page_custom_headline":{"type":"string"},"is_optimized_for_quality":{"type":"boolean"},"block_display_for_non_targeted_viewer":{"type":"boolean"},"allow_organic_lead":{"type":"boolean"},"tracking_parameters":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}}}},"legal_content":{"type":"object","properties":{"id":{"type":"string"},"privacy_policy":{"type":"object","properties":{"url":{"type":"string","format":"uri"},"link_text":{"type":"string"}}},"custom_disclaimer":{"type":"object"}}},"context_card":{"type":"object","properties":{"id":{"type":"string"},"title":{"type":"string"},"style":{"type":"string","enum":["LIST_STYLE","PARAGRAPH_STYLE"]},"content":{"type":"array","items":{"type":"string"}},"button_text":{"type":"string"},"cover_photo":{"type":"object","properties":{"id":{"type":"string"}}}}},"thank_you_page":{"type":"object","properties":{"id":{"type":"string"},"title":{"type":"string"},"body":{"type":"string"},"button_text":{"type":"string"},"button_type":{"type":"string"},"website_url":{"type":"string","format":"uri"},"enable_messenger":{"type":"boolean"},"status":{"type":"string"},"lead_gen_use_case":{"type":"string"},"business_phone_number":{"type":"string"},"country_code":{"type":"string"}}},"questions":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"key":{"type":"string"},"label":{"type":"string"},"type":{"type":"string"},"inline_context":{"type":"string"},"options":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}}}},"conditional_questions_group_id":{"type":"string"},"conditional_questions_choices":{"type":"array","items":{"type":"object"}},"dependent_conditional_questions":{"type":"array","items":{"type":"object"}}}}}}},"MetaInstagramIdentityRef":{"type":"object","required":["igUserId","username"],"properties":{"igUserId":{"type":"string"},"username":{"type":"string"},"profilePictureUrl":{"type":"string"}}},"GoogleBusinessReview":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"reviewer":{"type":"object","properties":{"displayName":{"type":"string"},"profilePhotoUrl":{"type":["string","null"]},"isAnonymous":{"type":"boolean"}}},"rating":{"type":"integer","minimum":0,"maximum":5},"starRating":{"type":"string","enum":["ONE","TWO","THREE","FOUR","FIVE"]},"comment":{"type":"string"},"createTime":{"type":"string","format":"date-time"},"updateTime":{"type":"string","format":"date-time"},"reviewReply":{"type":["object","null"],"properties":{"comment":{"type":"string"},"updateTime":{"type":"string","format":"date-time"}}},"photoCount":{"type":"integer"},"photos":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string","format":"uri"}}}}}},"Verification":{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string","enum":["pending","approved","expired","max_attempts_reached","canceled","delivery_failed"]},"channel":{"type":"string","enum":["sms","whatsapp"]},"to":{"type":"string"},"expiresAt":{"type":"string","format":"date-time"},"attempts":{"type":"integer"},"maxAttempts":{"type":"integer"},"sendCount":{"type":"integer"},"lastSentAt":{"type":["string","null"],"format":"date-time"},"deliveryStatus":{"type":["string","null"],"enum":["delivered","read","failed",null]},"deliveryErrorCode":{"type":["integer","null"]},"createdAt":{"type":"string","format":"date-time"},"resend":{"type":"boolean"}}},"ImessageSenderLifecycle":{"type":"object","properties":{"id":{"type":"string"},"kind":{"type":"string","enum":["phone","email"]},"region":{"type":["string","null"],"enum":["US","GB",null]},"handle":{"type":["string","null"]},"optInLink":{"type":["string","null"]},"status":{"type":"string","enum":["ordering","awaiting_payment","activating","active","suspended","canceled","failed"]},"priceCents":{"type":"integer"},"provider":{"type":"string"},"profileId":{"type":"string"},"displayName":{"type":["string","null"]},"failureReason":{"type":["string","null"]},"accountId":{"type":["string","null"]},"createdAt":{"type":"string","format":"date-time"}}},"ImessageSandboxContact":{"type":"object","properties":{"id":{"type":"string"},"handle":{"type":"string"},"status":{"type":"string","enum":["pending","active"]},"joinText":{"type":"string"},"joinLink":{"type":"string"},"activatedAt":{"type":["string","null"],"format":"date-time"},"lastInboundAt":{"type":["string","null"],"format":"date-time"},"createdAt":{"type":"string","format":"date-time"}}},"ImessageAudienceContact":{"type":"object","properties":{"conversationId":{"type":"string"},"accountId":{"type":"string"},"contact":{"type":"string"},"name":{"type":["string","null"]},"subscribed":{"type":"boolean"},"lastMessage":{"type":["string","null"]},"lastMessageAt":{"type":["string","null"],"format":"date-time"},"firstSeenAt":{"type":["string","null"],"format":"date-time"},"optIn":{"type":["object","null"],"properties":{"at":{"type":"string","format":"date-time"},"parameters":{"type":"object","additionalProperties":true}}}}},"ImessageSender":{"type":"object","properties":{"id":{"type":"string"},"platform":{"type":"string","enum":["imessage"]},"sender":{"type":"string"},"optInLink":{"type":["string","null"]},"displayName":{"type":"string"},"profileId":{"type":["string","null"]},"provider":{"type":"string"},"senderVerified":{"type":"boolean"},"isActive":{"type":"boolean"}}},"RfPrediction":{"type":"object","properties":{"predictionId":{"type":"string"},"status":{"type":"string"},"budget":{"type":["number","null"]},"reach":{"type":["integer","null"]},"impressions":{"type":["integer","null"]},"minBudget":{"type":["number","null"]},"maxBudget":{"type":["number","null"]},"minReach":{"type":["integer","null"]},"maxReach":{"type":["integer","null"]},"frequencyCap":{"type":["integer","null"]},"startTime":{"type":["integer","null"]},"stopTime":{"type":["integer","null"]},"expiresAt":{"type":["string","null"]}}},"MessagingCarouselCard":{"type":"object","required":["imageUrl"],"properties":{"imageUrl":{"type":"string","format":"uri"},"headline":{"type":"string","maxLength":255},"description":{"type":"string","maxLength":255},"callToAction":{"type":"string"},"linkUrl":{"type":"string"}}},"CtwaAdRequestBody":{"type":"object","required":["accountId","adAccountId","name"],"properties":{"creativeFeatures":{"$ref":"#/components/schemas/MetaCreativeFeatures"},"tracking":{"$ref":"#/components/schemas/AdTracking"},"accountId":{"type":"string","minLength":1},"adAccountId":{"type":"string","minLength":1},"name":{"type":"string","minLength":1},"campaignName":{"type":"string","maxLength":255},"adSetName":{"type":"string","maxLength":255},"platformPostId":{"type":"string","minLength":1},"existingPostId":{"type":"string","minLength":1,"deprecated":true},"objectStoryId":{"type":"string","pattern":"^\\d+_\\d+$"},"pageId":{"type":"string"},"whatsappPhoneNumber":{"type":"string","pattern":"^\\+[1-9]\\d{6,14}$"},"headline":{"type":"string","minLength":1,"maxLength":255},"body":{"type":"string","minLength":1},"description":{"type":"string","minLength":1,"maxLength":255},"imageUrl":{"type":"string","format":"uri"},"video":{"type":"object","properties":{"url":{"type":"string","format":"uri"},"id":{"type":"string"},"thumbnailUrl":{"type":"string","format":"uri"}}},"welcomeMessage":{"type":"object","required":["text"],"properties":{"text":{"type":"string","minLength":1},"prefillText":{"type":"string","minLength":1},"quickReplies":{"type":"array","minItems":1,"maxItems":13,"items":{"type":"object","required":["title","payload"],"properties":{"title":{"type":"string","minLength":1,"maxLength":20},"payload":{"type":"string","minLength":1,"maxLength":1000}}}}}},"carouselCards":{"type":"array","minItems":2,"maxItems":10,"items":{"$ref":"#/components/schemas/MessagingCarouselCard"}},"optimizeCardOrder":{"type":"boolean"},"creatives":{"type":"array","minItems":1,"items":{"type":"object","properties":{"platformPostId":{"type":"string","minLength":1},"existingPostId":{"type":"string","minLength":1,"deprecated":true},"objectStoryId":{"type":"string","pattern":"^\\d+_\\d+$"},"creativeFeatures":{"$ref":"#/components/schemas/MetaCreativeFeatures"},"headline":{"type":"string","minLength":1,"maxLength":255},"body":{"type":"string","minLength":1},"imageUrl":{"type":"string","format":"uri"},"video":{"type":"object","properties":{"url":{"type":"string","format":"uri"},"id":{"type":"string"},"thumbnailUrl":{"type":"string","format":"uri"}}},"welcomeMessage":{"type":"object","required":["text"],"properties":{"text":{"type":"string","minLength":1},"prefillText":{"type":"string","minLength":1},"quickReplies":{"type":"array","minItems":1,"maxItems":13,"items":{"type":"object","required":["title","payload"],"properties":{"title":{"type":"string","minLength":1,"maxLength":20},"payload":{"type":"string","minLength":1,"maxLength":1000}}}}}},"carouselCards":{"type":"array","minItems":2,"maxItems":10,"items":{"$ref":"#/components/schemas/MessagingCarouselCard"}}}}},"adSetId":{"type":"string"},"existingCampaignId":{"type":"string","pattern":"^\\d+$"},"budgetLevel":{"type":"string","enum":["adset","campaign"]},"budgetAmount":{"type":"number","exclusiveMinimum":0},"budgetType":{"type":"string","enum":["daily","lifetime"]},"currency":{"type":"string","minLength":3,"maxLength":3},"startDate":{"type":"string"},"endDate":{"type":"string"},"countries":{"type":"array","items":{"type":"string","minLength":2,"maxLength":2}},"cities":{"type":"array","items":{"type":"object","required":["key"],"properties":{"key":{"type":"string","minLength":1},"radius":{"type":"number","exclusiveMinimum":0},"distance_unit":{"type":"string","enum":["mile","kilometer"]}}}},"regions":{"type":"array","items":{"type":"object","required":["key"],"properties":{"key":{"type":"string","minLength":1}}}},"zips":{"type":"array","items":{"type":"object","required":["key"],"properties":{"key":{"type":"string","minLength":1},"name":{"type":"string"}}}},"metros":{"type":"array","items":{"type":"object","required":["key"],"properties":{"key":{"type":"string","minLength":1},"name":{"type":"string"}}}},"countryGroups":{"type":"array","items":{"type":"string","enum":["africa","asia","europe","north_america","south_america","oceania","central_america","caribbean","eea","euro_area","nafta","mercosur","afta","apec","gcc","cisfta","emerging_markets","itunes_app_store","android_free_store","android_paid_store"]}},"customLocations":{"type":"array","items":{"type":"object","required":["latitude","longitude","radius","distanceUnit"],"properties":{"latitude":{"type":"number","minimum":-90,"maximum":90},"longitude":{"type":"number","minimum":-180,"maximum":180},"radius":{"type":"number","exclusiveMinimum":0},"distanceUnit":{"type":"string","enum":["mile","kilometer"]},"name":{"type":"string"},"address":{"type":"string"}}}},"ageMin":{"type":"integer","minimum":13,"maximum":65},"ageMax":{"type":"integer","minimum":13,"maximum":65},"interests":{"type":"array","items":{"type":"object","required":["id"],"properties":{"id":{"type":"string"},"name":{"type":"string"}}}},"audienceId":{"type":"string"},"placements":{"type":"object","properties":{"publisherPlatforms":{"type":"array","items":{"type":"string","enum":["facebook","instagram","threads","messenger","audience_network","whatsapp"]}},"facebookPositions":{"type":"array","items":{"type":"string","enum":["feed","right_hand_column","marketplace","story","search","instream_video","facebook_reels","facebook_reels_overlay","profile_feed","notification"]}},"instagramPositions":{"type":"array","items":{"type":"string","enum":["stream","story","explore","explore_home","reels","profile_feed","ig_search","profile_reels"]}},"messengerPositions":{"type":"array","items":{"type":"string","enum":["messenger_home","sponsored_messages","story"]}},"audienceNetworkPositions":{"type":"array","items":{"type":"string","enum":["classic","rewarded_video"]}},"threadsPositions":{"type":"array","items":{"type":"string","enum":["threads_stream"]}},"whatsappPositions":{"type":"array","items":{"type":"string","enum":["status"]}},"devicePlatforms":{"type":"array","items":{"type":"string","enum":["mobile","desktop"]}}}},"gender":{"type":"string","enum":["all","male","female"]},"languages":{"type":"array","items":{"type":"string"}},"places":{"type":"array","items":{"type":"object","required":["key"],"properties":{"key":{"type":"string"}}}},"neighborhoods":{"type":"array","items":{"type":"object","required":["key"],"properties":{"key":{"type":"string"}}}},"excludedLocations":{"type":"object","additionalProperties":true},"behaviors":{"type":"array","items":{"type":"object","required":["id"],"properties":{"id":{"type":"string"},"name":{"type":"string"}}}},"workPositions":{"type":"array","items":{"type":"object","required":["id"],"properties":{"id":{"type":"string"},"name":{"type":"string"}}}},"workEmployers":{"type":"array","items":{"type":"object","required":["id"],"properties":{"id":{"type":"string"},"name":{"type":"string"}}}},"workIndustries":{"type":"array","items":{"type":"object","required":["id"],"properties":{"id":{"type":"string"},"name":{"type":"string"}}}},"incomeTier":{"type":"string","enum":["top_5","top_10","top_10_25","top_25_50"]},"userOs":{"type":"array","items":{"type":"string"},"minItems":1},"userDevice":{"type":"array","items":{"type":"string"},"minItems":1},"audienceInclude":{"type":"array","items":{"type":"string"},"minItems":1},"audienceExclude":{"type":"array","items":{"type":"string"},"minItems":1},"savedTargetingId":{"type":"string"},"targeting":{"$ref":"#/components/schemas/TargetingSpec"},"rawTargeting":{"type":"object","additionalProperties":true},"specialAdCategories":{"type":"array","items":{"type":"string","enum":["HOUSING","EMPLOYMENT","CREDIT","ISSUES_ELECTIONS_POLITICS","FINANCIAL_PRODUCTS_SERVICES","ONLINE_GAMBLING_AND_GAMING"]}},"specialAdCategoryCountry":{"type":"array","items":{"type":"string"}},"advantageAudience":{"type":"integer","enum":[0,1]},"objective":{"type":"string","enum":["OUTCOME_ENGAGEMENT","OUTCOME_SALES","OUTCOME_LEADS"]},"status":{"type":"string","enum":["ACTIVE","PAUSED"]},"campaignStatus":{"type":"string","enum":["ACTIVE","PAUSED"]},"adSetStatus":{"type":"string","enum":["ACTIVE","PAUSED"]},"adStatus":{"$ref":"#/components/schemas/AdActivationStatus"},"bidStrategy":{"type":"string","enum":["LOWEST_COST_WITHOUT_CAP","LOWEST_COST_WITH_BID_CAP","COST_CAP","LOWEST_COST_WITH_MIN_ROAS"]},"bidAmount":{"type":"number","exclusiveMinimum":0},"roasAverageFloor":{"type":"number","exclusiveMinimum":0},"dsaBeneficiary":{"type":"string","maxLength":100},"dsaPayor":{"type":"string","maxLength":100},"regionalRegulatedCategories":{"type":"array","items":{"type":"string"}},"regionalRegulationIdentities":{"type":"object","additionalProperties":{"type":["string","integer"]}}}},"WorkflowNode":{"type":"object","required":["id","type"],"properties":{"id":{"type":"string"},"type":{"type":"string","enum":["trigger","send_message","wait_for_reply","condition","set_variable","delay","webhook","hubspot_upsert_contact","ai","handoff","start_call","a_b_split","set_field","enroll_sequence","add_tag","remove_tag","end"]},"config":{"type":"object","additionalProperties":true},"position":{"type":"object","properties":{"x":{"type":"number"},"y":{"type":"number"}}},"label":{"type":"string","minLength":1,"maxLength":80}}},"WorkflowEdge":{"type":"object","required":["id","source","target"],"properties":{"id":{"type":"string"},"source":{"type":"string"},"target":{"type":"string"},"sourceHandle":{"type":["string","null"]}}},"WorkflowExecutionEvent":{"type":"object","properties":{"action":{"type":"string","enum":["execution_started","execution_completed","execution_exited","execution_paused","execution_resumed","node_started","node_completed","node_failed","node_skipped"]},"status":{"type":["string","null"],"enum":["success","failed","pending"]},"nodeId":{"type":["string","null"]},"nodeType":{"type":["string","null"]},"sourceHandle":{"type":["string","null"]},"durationMs":{"type":["integer","null"]},"errorMessage":{"type":["string","null"]},"meta":{"type":["object","null"],"additionalProperties":true},"at":{"type":"string","format":"date-time"}}},"BulkUploadResult":{"type":"object","properties":{"total":{"type":"integer"},"valid":{"type":"integer"},"invalid":{"type":"integer"},"results":{"type":"array","items":{"type":"object","properties":{"rowIndex":{"type":"integer"},"ok":{"type":"boolean"},"createdPostId":{"type":"string"},"errors":{"type":"array","items":{"type":"string"}}}}},"warnings":{"type":"array","items":{"type":"string"}},"rateLimitedAccounts":{"type":"array","items":{"type":"object","properties":{"accountId":{"type":"string"},"platform":{"type":"string"},"username":{"type":"string"},"rateLimitedUntil":{"type":"string","format":"date-time"}}}}}},"RedditPost":{"type":"object","properties":{"id":{"type":"string"},"fullname":{"type":"string"},"title":{"type":"string"},"author":{"type":"string"},"subreddit":{"type":"string"},"url":{"type":"string"},"permalink":{"type":"string"},"selftext":{"type":"string"},"createdUtc":{"type":"number"},"score":{"type":"integer"},"numComments":{"type":"integer"},"over18":{"type":"boolean"},"stickied":{"type":"boolean"},"flairText":{"type":["string","null"]},"isGallery":{"type":"boolean"},"galleryImages":{"type":"array","items":{"type":"string","format":"uri"}}}},"RedditComment":{"type":"object","properties":{"id":{"type":"string"},"fullname":{"type":"string"},"parentId":{"type":"string"},"author":{"type":"string"},"body":{"type":"string"},"permalink":{"type":"string"},"createdUtc":{"type":"number"},"score":{"type":"integer"},"numReplies":{"type":"integer"},"depth":{"type":"integer"},"isSubmitter":{"type":"boolean"},"edited":{"type":"boolean"},"stickied":{"type":"boolean"},"distinguished":{"type":["string","null"]}}},"ExternalPostSummary":{"type":"object","properties":{"platform":{"type":"string"},"platformPostId":{"type":"string"},"platformPostUrl":{"type":"string"},"content":{"type":"string"},"publishedAt":{"type":"string","format":"date-time"},"mediaType":{"type":"string"},"thumbnailUrl":{"type":"string"},"mediaItems":{"type":"array","items":{"type":"object"}},"mediaProductType":{"type":"string"},"isAiGenerated":{"type":"boolean"},"isSharedToFeed":{"type":"boolean"},"mediaAudioType":{"type":"string"},"analytics":{"type":"object","properties":{"likes":{"type":"integer"},"comments":{"type":"integer"},"shares":{"type":"integer"},"saves":{"type":"integer"},"sends":{"type":"integer"},"clicks":{"type":"integer"},"views":{"type":"integer"},"reach":{"type":"integer"},"impressions":{"type":"integer"},"engagementRate":{"type":"number"},"lastUpdated":{"type":"string","format":"date-time"}}}}},"MetaPageOwnership":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"business":{"type":["object","null"],"properties":{"id":{"type":"string"},"name":{"type":"string"}}},"instagramBusinessAccount":{"type":["object","null"],"properties":{"id":{"type":"string"},"username":{"type":"string"}}}}},"MetaPagePartner":{"type":"object","properties":{"businessId":{"type":"string"},"name":{"type":"string"},"permittedTasks":{"type":"array","items":{"type":"string"}}}},"MetaAssignedUser":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"tasks":{"type":"array","items":{"type":"string"}}}},"MetaBusinessUser":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"email":{"type":"string"},"role":{"type":"string"}}},"CreateMetaAdAccountRequest":{"type":"object","additionalProperties":false,"required":["accountId","businessId","name","currency","timezoneId"],"properties":{"platform":{"type":"string","enum":["meta"]},"accountId":{"type":"string","pattern":"^[a-fA-F0-9]{24}$"},"businessId":{"type":"string","pattern":"^[1-9][0-9]*$"},"name":{"type":"string","minLength":1,"maxLength":255},"currency":{"type":"string","pattern":"^[A-Z]{3}$"},"timezoneId":{"type":"integer","minimum":0,"maximum":4294967295},"endAdvertiser":{"type":"string","pattern":"^(NONE|[1-9][0-9]*)$","default":"NONE"},"mediaAgency":{"type":"string","pattern":"^(NONE|[1-9][0-9]*)$","default":"NONE"},"partner":{"type":"string","pattern":"^(NONE|[1-9][0-9]*)$","default":"NONE"},"invoice":{"type":"boolean"},"invoiceGroupId":{"type":"string","pattern":"^[1-9][0-9]*$"},"invoicingEmails":{"type":"array","minItems":1,"maxItems":100,"items":{"type":"string","format":"email"}},"io":{"type":"boolean"},"poNumber":{"type":"string","minLength":1,"maxLength":255},"fundingId":{"type":"string","pattern":"^[1-9][0-9]*$"},"adAccountCreatedFromBmFlag":{"type":"boolean"}}},"CreateGoogleAdAccountRequest":{"type":"object","additionalProperties":false,"required":["platform","accountId","managerCustomerId","name","currency","timeZone"],"properties":{"platform":{"type":"string","enum":["google"]},"accountId":{"type":"string","pattern":"^[a-fA-F0-9]{24}$"},"managerCustomerId":{"type":"string","pattern":"^[0-9]+$"},"name":{"type":"string","minLength":1,"maxLength":255},"currency":{"type":"string","pattern":"^[A-Z]{3}$"},"timeZone":{"type":"string"},"validateOnly":{"type":"boolean","default":false}}},"CreatedMetaAdAccount":{"type":"object","required":["adAccountId","businessId","connectionUpdated","paymentMethodRequired","adsManagerUrl","nextSteps","warnings"],"properties":{"adAccountId":{"type":"string","pattern":"^act_[0-9]+$"},"businessId":{"type":"string"},"connectionUpdated":{"type":"boolean"},"paymentMethodRequired":{"type":"boolean"},"adsManagerUrl":{"type":"string","format":"uri"},"nextSteps":{"type":"string"},"warnings":{"type":"array","items":{"type":"string"}}}},"CreatedGoogleAdAccount":{"type":"object","required":["platform","adAccountId","managerCustomerId","connectionUpdated","warnings","paymentMethodRequired","nextSteps","validateOnly"],"properties":{"platform":{"type":"string","enum":["google"]},"adAccountId":{"type":"string","pattern":"^[0-9]+$"},"managerCustomerId":{"type":"string"},"connectionUpdated":{"type":"boolean"},"warnings":{"type":"array","items":{"type":"string"}},"paymentMethodRequired":{"type":"boolean"},"nextSteps":{"type":"string"},"validateOnly":{"type":"boolean"}}},"LinkedInMentionIssue":{"type":"object","required":["input","code","message"],"properties":{"input":{"type":"string"},"code":{"type":"string","enum":["linkedin_mention_unresolvable","linkedin_mention_requires_page_admin","linkedin_mention_name_unavailable","linkedin_mentions_limit_exceeded","rate_limited","reconnect_required","temporarily_unavailable"]},"message":{"type":"string"}}},"PinPostRequest":{"type":"object","required":["platform"],"properties":{"platform":{"type":"string"},"accountId":{"type":"string"}}},"PinPostResponse":{"type":"object","properties":{"success":{"type":"boolean"},"pinned":{"type":"boolean"},"platformPostId":{"type":"string"},"message":{"type":"string"}}},"ErrorResponse":{"type":"object","properties":{"error":{"type":"string"},"type":{"type":"string","enum":["invalid_request_error","authentication_error","permission_error","not_found","rate_limit_error","platform_error","api_error","payment_required"]},"code":{"type":"string"},"param":{"type":"string"},"docUrl":{"type":"string"},"platform":{"type":"string"},"platformError":{"type":"object","additionalProperties":true},"details":{"type":"object","additionalProperties":true,"properties":{"stage":{"type":"string","enum":["media","campaign","adset","creative","ad","activation","other"]},"adAccountId":{"type":"string"},"createdObjects":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["campaign","adset","creative","ad","video","image"]},"id":{"type":"string"},"cleanup":{"type":"string","enum":["deleted","left_behind","kept"]}}}},"unconfirmedWrite":{"type":"object","properties":{"type":{"type":"string","enum":["campaign","adset","creative","ad"]},"parentId":{"type":"string"}}},"quotaExhausted":{"type":"boolean"},"quotaScope":{"type":"string","enum":["DEVELOPER","ACCOUNT"]},"budgetScope":{"type":"string","enum":["account","user"]}}}}},"CommentAutomationAudience":{"type":"object","properties":{"followerStatus":{"type":"string","enum":["any","follower","non_follower"],"default":"any"},"minFollowerCount":{"type":"integer","minimum":0},"whenUnknown":{"type":"string","enum":["send","skip","verify"],"default":"send"},"tapToUnlock":{"type":"boolean","default":false}}},"CommentAutomationFollowGate":{"type":"object","properties":{"message":{"type":"string","maxLength":640},"buttonLabel":{"type":"string","maxLength":20},"profileButtonLabel":{"type":"string","minLength":1,"maxLength":20},"notFollowingMessage":{"type":"string","maxLength":1000}}},"CommentAutomationRepeatPolicy":{"type":"object","required":["mode"],"properties":{"mode":{"type":"string","enum":["once","every_comment"],"default":"once"},"cooldownHours":{"type":"integer","minimum":1,"maximum":8760}}},"CommentAutomationActions":{"type":"object","properties":{"likeComment":{"type":"boolean"},"hideComment":{"type":"boolean"}}},"CommentAutomationDmMedia":{"type":"object","required":["type","url"],"properties":{"type":{"type":"string","enum":["image","video","audio","file"]},"url":{"type":"string","format":"uri"}}},"CommentAutomationQuickReply":{"type":"object","required":["title","payload"],"properties":{"title":{"type":"string","maxLength":20},"payload":{"type":"string"},"imageUrl":{"type":"string","format":"uri"}}},"CommentAutomationStats":{"type":"object","properties":{"triggered":{"type":"integer"},"dmsSent":{"type":"integer"},"dmsFailed":{"type":"integer"},"uniqueContacts":{"type":"integer"},"trackedSends":{"type":"integer"},"linkClicks":{"type":"integer"},"uniqueClicks":{"type":"integer"},"delivered":{"type":"integer"},"read":{"type":"integer"},"audienceSkipped":{"type":"integer"},"followGateSent":{"type":"integer"},"followGatePassed":{"type":"integer"},"followGateFailed":{"type":"integer"}}},"CommentAutomationLog":{"type":"object","properties":{"id":{"type":"string"},"commentId":{"type":"string"},"commenterId":{"type":"string"},"commenterName":{"type":["string","null"]},"commenterUsername":{"type":["string","null"]},"commentText":{"type":["string","null"]},"source":{"type":["string","null"],"enum":["comment","live_comment","story_reply","story_mention","dm",null]},"status":{"type":"string","enum":["pending","sent","failed","skipped","gated"]},"audienceOutcome":{"type":["string","null"],"enum":["passed","blocked","gate_sent","gate_passed","gate_failed",null]},"gateButtonStatus":{"type":["string","null"],"enum":["delivered","rejected","omitted",null]},"commenterIsFollower":{"type":["boolean","null"]},"commenterFollowerCount":{"type":["integer","null"]},"gateResolvedAt":{"type":["string","null"],"format":"date-time"},"error":{"type":["string","null"]},"platformError":{"type":["object","null"],"properties":{"code":{"type":"integer"},"subcode":{"type":"integer"}}},"privateReplyConsumed":{"type":["boolean","null"]},"commentReplyStatus":{"type":["string","null"],"enum":["pending","sent","failed","skipped",null]},"commentReplyError":{"type":["string","null"]},"publicReplyPostedAt":{"type":["string","null"],"format":"date-time"},"likeSkipped":{"type":["string","null"]},"hideSkipped":{"type":["string","null"]},"mediaError":{"type":["string","null"]},"nextDueAt":{"type":["string","null"],"format":"date-time"},"clickedAt":{"type":["string","null"],"format":"date-time"},"clickCount":{"type":"integer"},"createdAt":{"type":"string","format":"date-time"}}},"DmButton":{"type":"object","required":["type","title"],"properties":{"type":{"type":"string","enum":["url","postback","phone"]},"title":{"type":"string","maxLength":20},"url":{"type":"string","format":"uri"},"payload":{"type":"string"},"phone":{"type":"string"}}},"CommentAutomationTemplate":{"type":"object","required":["type","elements"],"properties":{"type":{"type":"string","enum":["generic"]},"imageAspectRatio":{"type":"string","enum":["horizontal","square"]},"elements":{"type":"array","minItems":1,"maxItems":10,"items":{"$ref":"#/components/schemas/CommentAutomationTemplateElement"}}}},"CommentAutomationTemplateElement":{"type":"object","required":["title"],"properties":{"title":{"type":"string","maxLength":80},"subtitle":{"type":"string","maxLength":80},"imageUrl":{"type":"string","format":"uri"},"buttons":{"type":"array","maxItems":3,"items":{"type":"object","required":["type","title"],"properties":{"type":{"type":"string","enum":["url","postback"]},"title":{"type":"string","maxLength":20},"url":{"type":"string","format":"uri"},"payload":{"type":"string"}}}}}},"WhatsAppTemplateButton":{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["quick_reply","url","phone_number","otp","copy_code","flow","mpm","catalog"]},"text":{"type":"string"},"url":{"type":"string","format":"uri"},"example":{},"phone_number":{"type":"string"},"otp_type":{"type":"string","enum":["copy_code","one_tap","zero_tap"]},"autofill_text":{"type":"string"},"package_name":{"type":"string"},"signature_hash":{"type":"string"},"flow_id":{"type":"string"},"flow_name":{"type":"string"},"flow_json":{"type":"string"},"flow_action":{"type":"string"},"navigate_screen":{"type":"string"}}},"WhatsAppTemplateComponent":{"oneOf":[{"$ref":"#/components/schemas/WhatsAppHeaderComponent"},{"$ref":"#/components/schemas/WhatsAppBodyComponent"},{"$ref":"#/components/schemas/WhatsAppFooterComponent"},{"$ref":"#/components/schemas/WhatsAppButtonsComponent"},{"$ref":"#/components/schemas/WhatsAppCarouselComponent"},{"$ref":"#/components/schemas/WhatsAppLimitedTimeOfferComponent"}],"discriminator":{"propertyName":"type","mapping":{"header":"#/components/schemas/WhatsAppHeaderComponent","body":"#/components/schemas/WhatsAppBodyComponent","footer":"#/components/schemas/WhatsAppFooterComponent","buttons":"#/components/schemas/WhatsAppButtonsComponent","carousel":"#/components/schemas/WhatsAppCarouselComponent","limited_time_offer":"#/components/schemas/WhatsAppLimitedTimeOfferComponent"}}},"WhatsAppHeaderComponent":{"type":"object","required":["type","format"],"properties":{"type":{"type":"string","enum":["header"]},"format":{"type":"string","enum":["text","image","video","gif","document","location"]},"text":{"type":"string"},"example":{"type":"object","properties":{"header_text":{"type":"array","items":{"type":"string"}},"header_text_named_params":{"type":"array","items":{"$ref":"#/components/schemas/WhatsAppNamedParamExample"}},"header_handle":{"type":"array","minItems":1,"maxItems":1,"items":{"type":"string","format":"uri"}}}}}},"WhatsAppBodyComponent":{"type":"object","required":["type","text"],"properties":{"type":{"type":"string","enum":["body"]},"text":{"type":"string"},"add_security_recommendation":{"type":"boolean"},"example":{"type":"object","properties":{"body_text":{"type":"array","items":{"type":"array","items":{"type":"string"}}},"body_text_named_params":{"type":"array","items":{"$ref":"#/components/schemas/WhatsAppNamedParamExample"}}}}}},"WhatsAppNamedParamExample":{"type":"object","required":["param_name","example"],"properties":{"param_name":{"type":"string","pattern":"^[a-z0-9_]+$"},"example":{"type":"string"}}},"WhatsAppFooterComponent":{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["footer"]},"text":{"type":"string"},"code_expiration_minutes":{"type":"integer","minimum":1}}},"WhatsAppButtonsComponent":{"type":"object","required":["type","buttons"],"properties":{"type":{"type":"string","enum":["buttons"]},"buttons":{"type":"array","minItems":1,"items":{"$ref":"#/components/schemas/WhatsAppTemplateButton"}}}},"WhatsAppCarouselComponent":{"type":"object","required":["type","cards"],"properties":{"type":{"type":"string","enum":["carousel"]},"cards":{"type":"array","minItems":2,"maxItems":10,"items":{"type":"object","required":["components"],"properties":{"components":{"type":"array","minItems":1,"items":{"$ref":"#/components/schemas/WhatsAppCarouselCardComponent"}}}}}}},"WhatsAppCarouselCardComponent":{"oneOf":[{"$ref":"#/components/schemas/WhatsAppHeaderComponent"},{"$ref":"#/components/schemas/WhatsAppBodyComponent"},{"$ref":"#/components/schemas/WhatsAppButtonsComponent"}],"discriminator":{"propertyName":"type","mapping":{"header":"#/components/schemas/WhatsAppHeaderComponent","body":"#/components/schemas/WhatsAppBodyComponent","buttons":"#/components/schemas/WhatsAppButtonsComponent"}}},"WhatsAppLimitedTimeOfferComponent":{"type":"object","required":["type","limited_time_offer"],"properties":{"type":{"type":"string","enum":["limited_time_offer"]},"limited_time_offer":{"type":"object","required":["text"],"properties":{"text":{"type":"string","minLength":1,"maxLength":16},"has_expiration":{"type":"boolean"}}}}},"WhatsAppSandboxSession":{"type":"object","required":["id","phoneE164","status","expiresAt"],"properties":{"id":{"type":"string"},"phoneE164":{"type":"string"},"status":{"type":"string","enum":["pending","active"]},"expiresAt":{"type":"string","format":"date-time"},"activatedAt":{"type":["string","null"],"format":"date-time"},"createdAt":{"type":["string","null"],"format":"date-time"}}},"FoodMenuLabel":{"type":"object","required":["displayName"],"properties":{"displayName":{"type":"string"},"description":{"type":"string"},"languageCode":{"type":"string"}}},"Money":{"type":"object","required":["currencyCode","units"],"properties":{"currencyCode":{"type":"string"},"units":{"type":"string"},"nanos":{"type":"integer"}}},"FoodMenuItemAttributes":{"type":"object","properties":{"price":{"$ref":"#/components/schemas/Money"},"spiciness":{"type":"string","enum":["SPICINESS_UNSPECIFIED","MILD","MEDIUM","HOT"]},"allergen":{"type":"array","items":{"type":"string"}},"dietaryRestriction":{"type":"array","items":{"type":"string"}},"servesNumPeople":{"type":"integer","minimum":1},"preparationMethods":{"type":"array","items":{"type":"string"}},"mediaKeys":{"type":"array","items":{"type":"string"}}}},"FoodMenuItem":{"type":"object","required":["labels"],"properties":{"labels":{"type":"array","minItems":1,"items":{"$ref":"#/components/schemas/FoodMenuLabel"}},"attributes":{"$ref":"#/components/schemas/FoodMenuItemAttributes"},"options":{"type":"array","items":{"type":"object","required":["labels","attributes"],"properties":{"labels":{"type":"array","minItems":1,"items":{"$ref":"#/components/schemas/FoodMenuLabel"}},"attributes":{"$ref":"#/components/schemas/FoodMenuItemAttributes"}}}}}},"FoodMenuSection":{"type":"object","required":["labels"],"properties":{"labels":{"type":"array","minItems":1,"items":{"$ref":"#/components/schemas/FoodMenuLabel"}},"items":{"type":"array","items":{"$ref":"#/components/schemas/FoodMenuItem"}}}},"FoodMenu":{"type":"object","required":["labels"],"properties":{"labels":{"type":"array","minItems":1,"items":{"$ref":"#/components/schemas/FoodMenuLabel"}},"sections":{"type":"array","items":{"$ref":"#/components/schemas/FoodMenuSection"}},"cuisines":{"type":"array","items":{"type":"string"}},"sourceUrl":{"type":"string","format":"uri"}}},"YouTubeDailyViewsResponse":{"type":"object","properties":{"success":{"type":"boolean"},"videoId":{"type":"string"},"durationSeconds":{"type":["integer","null"]},"dateRange":{"type":"object","properties":{"startDate":{"type":"string","format":"date"},"endDate":{"type":"string","format":"date"}}},"provisionalSince":{"type":"string","format":"date"},"totalViews":{"type":"integer"},"dailyViews":{"type":"array","items":{"type":"object","properties":{"date":{"type":"string","format":"date"},"views":{"type":"integer"},"estimatedMinutesWatched":{"type":"number"},"averageViewDuration":{"type":"number"},"averageViewPercentage":{"type":"number"},"subscribersGained":{"type":"integer"},"subscribersLost":{"type":"integer"},"likes":{"type":"integer"},"comments":{"type":"integer"},"shares":{"type":"integer"}}}},"lastSyncedAt":{"type":["string","null"],"format":"date-time"},"scopeStatus":{"type":"object","properties":{"hasAnalyticsScope":{"type":"boolean"}}}}},"YouTubeVideoRetentionResponse":{"type":"object","properties":{"success":{"type":"boolean"},"accountId":{"type":"string"},"videoId":{"type":"string"},"title":{"type":["string","null"]},"publishedAt":{"type":["string","null"],"format":"date-time"},"durationSeconds":{"type":["integer","null"]},"dateRange":{"type":"object","properties":{"startDate":{"type":"string","format":"date"},"endDate":{"type":"string","format":"date"}}},"provisionalSince":{"type":"string","format":"date"},"retentionCurve":{"type":"array","items":{"type":"object","properties":{"elapsedVideoTimeRatio":{"type":"number"},"audienceWatchRatio":{"type":"number"},"relativeRetentionPerformance":{"type":"number"},"startedWatching":{"type":"integer"},"stoppedWatching":{"type":"integer"},"totalSegmentImpressions":{"type":"integer"}}}},"note":{"type":"string"},"scopeStatus":{"type":"object","properties":{"hasAnalyticsScope":{"type":"boolean"}}}}},"YouTubeScopeMissingResponse":{"type":"object","properties":{"success":{"type":"boolean"},"error":{"type":"string"},"code":{"type":"string"},"scopeStatus":{"type":"object","properties":{"hasAnalyticsScope":{"type":"boolean"},"requiresReauthorization":{"type":"boolean"},"reauthorizeUrl":{"type":"string","format":"uri"}}}}},"InstagramAccountInsightsResponse":{"type":"object","properties":{"success":{"type":"boolean"},"accountId":{"type":"string"},"platform":{"type":"string","enum":["facebook","instagram","youtube","linkedin","tiktok"]},"dateRange":{"type":"object","properties":{"since":{"type":"string","format":"date"},"until":{"type":"string","format":"date"}}},"metricType":{"type":"string","enum":["time_series","total_value"]},"breakdown":{"type":"string"},"metrics":{"type":"object","additionalProperties":{"type":"object","properties":{"total":{"type":"number"},"values":{"type":"array","items":{"type":"object","properties":{"date":{"type":"string","format":"date"},"value":{"type":"number"}}}},"breakdowns":{"type":"array","items":{"type":"object","properties":{"dimension":{"type":"string"},"value":{"type":"number"}}}},"unit":{"type":"string","enum":["micro_amount","unspecified"]},"currency":{"type":["string","null"]}}}},"unavailableMetrics":{"type":"array","items":{"type":"object","properties":{"metric":{"type":"string"},"reason":{"type":"string","enum":["not_enrolled","permission_missing","unsupported_metric","no_data","unreadable_value","mixed_currency","upstream_error"]},"message":{"type":"string"}}}},"dataDelay":{"type":"string"}}},"FacebookPostEarningsResponse":{"type":"object","properties":{"success":{"type":"boolean"},"accountId":{"type":"string"},"postId":{"type":"string"},"platform":{"type":"string"},"period":{"type":"string","enum":["lifetime"]},"metrics":{"type":"object","additionalProperties":{"type":"object","properties":{"total":{"type":"number"},"unit":{"type":"string","enum":["micro_amount","unspecified"]},"currency":{"type":["string","null"]}}}},"unavailableMetrics":{"type":"array","items":{"type":"object","properties":{"metric":{"type":"string"},"reason":{"type":"string","enum":["not_enrolled","permission_missing","unsupported_metric","no_data","unreadable_value","mixed_currency","upstream_error"]},"message":{"type":"string"}}}},"dataDelay":{"type":"string"}}},"InstagramDemographicsResponse":{"type":"object","properties":{"success":{"type":"boolean"},"accountId":{"type":"string"},"platform":{"type":"string"},"metric":{"type":"string","enum":["follower_demographics","engaged_audience_demographics"]},"timeframe":{"type":"string","enum":["this_week","this_month"]},"demographics":{"type":"object","additionalProperties":{"type":"array","items":{"type":"object","properties":{"dimension":{"type":"string"},"value":{"type":"number"}}}}},"note":{"type":"string"}}},"YouTubeDemographicsResponse":{"type":"object","properties":{"success":{"type":"boolean"},"accountId":{"type":"string"},"platform":{"type":"string"},"videoId":{"type":"string"},"title":{"type":["string","null"]},"publishedAt":{"type":["string","null"],"format":"date-time"},"demographics":{"type":"object","additionalProperties":{"type":"array","items":{"type":"object","properties":{"dimension":{"type":"string"},"value":{"type":"number"}}}}},"dateRange":{"type":"object","properties":{"startDate":{"type":"string"},"endDate":{"type":"string"}}},"provisionalSince":{"type":"string","format":"date"},"note":{"type":"string"}}},"Webhook":{"type":"object","properties":{"_id":{"type":"string"},"name":{"type":"string","maxLength":50},"url":{"type":"string","format":"uri"},"secret":{"type":"string"},"events":{"type":"array","items":{"type":"string","enum":["post.scheduled","post.published","post.failed","post.partial","post.cancelled","post.recycled","post.platform.published","post.platform.failed","post.platform.deleted","post.tiktok.url_resolved","post.external.created","post.external.updated","post.external.deleted","account.connected","account.disconnected","account.permissions_changed","account.ads.initial_sync_completed","account.ads.sync_failed","account.ads.sync_recovered","analytics.synced","post.tracking_completed","post.authenticity_changed","message.received","conversation.started","conversation.control_changed","call.received","call.ended","call.failed","call.permission_request","message.sent","message.edited","message.deleted","message.delivered","message.read","message.played","message.failed","reaction.received","referral.received","comment.received","review.new","review.updated","review.deleted","review.restored","lead.received","ad.status_changed","ad.review.approved","ad.review.rejected","ad.delivery_issue","campaign.budget.depleted","ad_account.status_changed","ad.video.processed","ad_rule.triggered","whatsapp.template.status_updated","whatsapp.template.category_updated","whatsapp.account.name_status_updated","whatsapp.account.quality_updated","whatsapp.account.status_updated","whatsapp.account.alert_received","whatsapp.contact.identity_changed","whatsapp.automatic_event","whatsapp.number.activated","whatsapp.number.declined","whatsapp.number.action_required","whatsapp.number.verification_required","whatsapp.number.suspended","whatsapp.number.reactivated","whatsapp.number.released","whatsapp.number.kyc_submitted","phone_number.stock_available","verification.approved","verification.failed","api.changelog.published","sms.registration.action_required","sms.registration.status_updated","branded_calling.identity.status_updated","branded_calling.identity.action_required","branded_calling.number.status_updated","rcs.agent.status_updated","commerce.product.created","commerce.product.updated","commerce.product.deleted","commerce.order.created","commerce.order.updated","commerce.order.refunded","contact.tag_added","contact.tag_removed","contact.field_changed","sequence.enrolled","sequence.exited","workflow.run.started","workflow.run.completed","workflow.run.failed","support.run.completed","support.run.failed","campaign_submission.received","campaign_submission.flagged","campaign_submission.pending_review","campaign_submission.approved","campaign_submission.rejected","creator_campaign.budget_exhausted","creator_campaign.closed","campaign_payout.payable","campaign_payout.settled","campaign_payout.failed","campaign_participant.joined","campaign_participant.suspended","campaign_participant.removed","account.rate_limited","calendar.event.created","calendar.event.updated","calendar.event.deleted","file.created","file.updated","file.deleted","file.picked","contact.updated","contact.deleted"]}},"isActive":{"type":"boolean"},"lastFiredAt":{"type":"string","format":"date-time"},"failureCount":{"type":"integer"},"customHeaders":{"type":"object","additionalProperties":{"type":"string"}},"disabledResourceGroups":{"type":"array","items":{"type":"string","enum":["publishing","engagement","messages","contacts","analytics","ads","telephony","accounts","billing","webhooks","commerce","creator_campaigns","money","calendar","files"]}},"profileIds":{"type":"array","items":{"type":"string"}},"accountIds":{"type":"array","items":{"type":"string"}}}},"WebhookLog":{"type":"object","properties":{"userId":{"type":"string"},"webhookId":{"type":"string"},"webhookName":{"type":"string"},"eventId":{"type":"string"},"event":{"type":"string"},"test":{"type":"boolean"},"url":{"type":"string","format":"uri"},"status":{"type":"string","enum":["success","failed"]},"statusCode":{"type":"integer"},"requestPayload":{"type":"object","additionalProperties":true},"responseBody":{"type":"string"},"errorMessage":{"type":"string"},"attemptNumber":{"type":"integer"},"responseTime":{"type":"integer"},"createdAt":{"type":"string","format":"date-time"}}},"WebhookProfiles":{"type":"array","items":{"type":"object","required":["id","externalId"],"properties":{"id":{"type":"string"},"externalId":{"type":["string","null"]}}}},"WebhookPayloadPost":{"type":"object","required":["id","event","post","timestamp"],"properties":{"id":{"type":"string"},"profiles":{"$ref":"#/components/schemas/WebhookProfiles"},"test":{"type":"boolean"},"event":{"type":"string","enum":["post.scheduled","post.published","post.failed","post.partial","post.cancelled","post.recycled"]},"post":{"type":"object","required":["id","content","status","scheduledFor","platforms"],"properties":{"id":{"type":"string"},"content":{"type":"string"},"status":{"type":"string"},"scheduledFor":{"type":"string","format":"date-time"},"publishedAt":{"type":"string","format":"date-time"},"platforms":{"type":"array","items":{"type":"object","required":["platform","status"],"properties":{"platform":{"type":"string"},"status":{"type":"string"},"accountId":{"type":"string"},"platformPostId":{"type":"string"},"publishedUrl":{"type":"string"},"error":{"type":"string"},"errorCategory":{"type":"string","enum":["auth_expired","user_content","user_abuse","account_issue","platform_rejected","platform_error","platform_rate_limit","quota_exhausted","system_error","unknown"]},"errorSource":{"type":"string","enum":["user","platform","system"]},"platformError":{"$ref":"#/components/schemas/PostPlatformError"}}}},"metadata":{"type":"object","additionalProperties":true}}},"timestamp":{"type":"string","format":"date-time"}}},"WebhookPayloadPostPlatform":{"type":"object","required":["id","event","post","platform","account","timestamp"],"properties":{"id":{"type":"string"},"profiles":{"$ref":"#/components/schemas/WebhookProfiles"},"test":{"type":"boolean"},"event":{"type":"string","enum":["post.platform.published","post.platform.failed","post.platform.deleted","post.tiktok.url_resolved"]},"post":{"type":"object","required":["id","content","status","scheduledFor","platforms"],"properties":{"id":{"type":"string"},"content":{"type":"string"},"status":{"type":"string"},"scheduledFor":{"type":"string","format":"date-time"},"publishedAt":{"type":"string","format":"date-time"},"platforms":{"type":"array","items":{"type":"object","required":["platform","status"],"properties":{"platform":{"type":"string"},"status":{"type":"string"},"accountId":{"type":"string"},"platformPostId":{"type":"string"},"publishedUrl":{"type":"string"},"error":{"type":"string"},"errorCategory":{"type":"string","enum":["auth_expired","user_content","user_abuse","account_issue","platform_rejected","platform_error","platform_rate_limit","quota_exhausted","system_error","unknown"]},"errorSource":{"type":"string","enum":["user","platform","system"]},"platformError":{"$ref":"#/components/schemas/PostPlatformError"}}}},"metadata":{"type":"object","additionalProperties":true}}},"platform":{"type":"object","required":["name","status"],"properties":{"name":{"type":"string"},"status":{"type":"string","enum":["published","failed","deleted"]},"platformPostId":{"type":"string"},"publishedUrl":{"type":"string"},"error":{"type":"string"},"errorCategory":{"type":"string","enum":["auth_expired","user_content","user_abuse","account_issue","platform_rejected","platform_error","platform_rate_limit","quota_exhausted","system_error","unknown"]},"errorSource":{"type":"string","enum":["user","platform","system"]},"deletedAt":{"type":"string","format":"date-time"}}},"account":{"type":"object","required":["accountId","platform","username"],"properties":{"accountId":{"type":"string"},"platform":{"type":"string"},"username":{"type":"string"},"displayName":{"type":"string"}}},"timestamp":{"type":"string","format":"date-time"}}},"WebhookPayloadAccountConnected":{"type":"object","required":["id","event","account","timestamp"],"properties":{"id":{"type":"string"},"profiles":{"$ref":"#/components/schemas/WebhookProfiles"},"test":{"type":"boolean"},"event":{"type":"string","enum":["account.connected"]},"account":{"type":"object","required":["accountId","profileId","platform","username"],"properties":{"accountId":{"type":"string"},"profileId":{"type":"string"},"platform":{"type":"string"},"username":{"type":"string"},"displayName":{"type":"string"}}},"timestamp":{"type":"string","format":"date-time"}}},"OwnedPhoneNumber":{"type":"object","properties":{"_id":{"type":"string"},"phoneNumber":{"type":"string"},"country":{"type":"string"},"numberType":{"type":"string"},"status":{"type":"string","enum":["pending_payment","pending_regulatory","regulatory_declined","provisioning","verifying","active","suspended","releasing","released"]},"profileId":{"oneOf":[{"type":"object","properties":{"_id":{"type":"string"},"name":{"type":["string","null"]}}},{"type":"string"}]},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"carrierOrderId":{"type":["string","null"]},"carrierAdvancedOrderId":{"type":"string"},"registrantName":{"type":["string","null"]},"endUserFirstName":{"type":["string","null"]},"endUserLastName":{"type":["string","null"]},"regulatoryDeclineReason":{"type":["string","null"]},"regulatoryReviewComment":{"type":"string"},"regulatoryInfoStatus":{"type":"string"},"identityVerificationUrl":{"type":["string","null"]},"verifyUrl":{"type":["string","null"]},"identityVerificationOpened":{"type":"boolean"},"metaPreverifiedId":{"type":"string"},"metaVerificationStatus":{"type":"string","enum":["pending","code_requested","verified","expired"]},"metaVerifiedAt":{"type":"string","format":"date-time"},"metaVerificationExpiresAt":{"type":"string","format":"date-time"},"metaPoolAddRejectedAt":{"type":"string","format":"date-time"},"socialAccountId":{"type":["string","null"]},"ownerAccountId":{"type":["string","null"]},"sipTrunkId":{"type":["string","null"]},"whatsAppRequested":{"type":"boolean"},"smsRequested":{"type":"boolean"},"provisionedAt":{"type":"string","format":"date-time"},"activatedAt":{"type":"string","format":"date-time"},"connectedAt":{"type":"string","format":"date-time"},"suspendedAt":{"type":"string","format":"date-time"},"releasedAt":{"type":"string","format":"date-time"},"signupError":{"type":"string"},"signupErrorAt":{"type":"string","format":"date-time"},"signupErrorStep":{"type":"string"},"monthlyCents":{"type":"integer"},"hostedByPozy":{"type":"boolean"},"smsCapable":{"type":"boolean"},"mmsCapable":{"type":"boolean"},"domesticOnly":{"type":"boolean"},"smsRegistrationPending":{"type":"boolean"},"smsSendApproved":{"type":"boolean"},"smsBrandName":{"type":["string","null"]},"features":{"type":"object","properties":{"calls":{"type":"boolean"},"whatsapp":{"type":"boolean"},"smsPending":{"type":"boolean"}}},"callingEnabled":{"type":"boolean"},"forwardTo":{"type":"string"},"sipAuthUsername":{"type":"string"},"callerIdVerifiedAt":{"type":"string","format":"date-time"},"maxCallDurationSeconds":{"type":"integer"},"recordingEnabled":{"type":"boolean"},"transcriptionEnabled":{"type":"boolean"},"transcriptionLanguage":{"type":"string","enum":["auto","en","es"]},"callIconCountries":{"type":"array","items":{"type":"string"}},"forwardCallerId":{"type":"string","enum":["business","caller"]},"pstnVoiceEnabled":{"type":"boolean"},"pstnForwardTo":{"type":"string"},"voicemailEnabled":{"type":"boolean"},"voicemailGreeting":{"type":"string"},"businessHoursEnabled":{"type":"boolean"},"businessHoursTimezone":{"type":"string"},"businessHours":{"type":"array","items":{"type":"object","properties":{"day":{"type":"integer"},"open":{"type":"string"},"close":{"type":"string"}}}},"blockedCallers":{"type":"array","items":{"type":"string"}},"ivrEnabled":{"type":"boolean"},"ivrPrompt":{"type":"string"},"ivrOptions":{"type":"array","items":{"type":"object","properties":{"digit":{"type":"string"},"forwardTo":{"type":"string"},"label":{"type":"string"}}}}}},"PhoneNumberStockWatch":{"type":"object","required":["id","country","countryName","numberType","createdAt"],"properties":{"id":{"type":"string"},"country":{"type":"string"},"countryName":{"type":"string"},"numberType":{"type":["string","null"],"enum":["local","mobile","national","toll_free",null]},"areaCode":{"type":["string","null"]},"createdAt":{"type":"string","format":"date-time"}}},"WebhookPayloadPhoneNumberStockAvailable":{"type":"object","required":["id","event","stock","timestamp"],"properties":{"id":{"type":"string"},"test":{"type":"boolean"},"event":{"type":"string","enum":["phone_number.stock_available"]},"stock":{"type":"object","required":["country","types"],"properties":{"country":{"type":"string"},"types":{"type":"array","items":{"type":"object","required":["numberType","availableCount"],"properties":{"numberType":{"type":"string"},"availableCount":{"type":"integer"}}}},"areaCode":{"type":"string"},"areaName":{"type":"string"}}},"timestamp":{"type":"string","format":"date-time"}}},"WebhookPayloadAccountPermissionsChanged":{"type":"object","required":["id","event","account","timestamp"],"properties":{"id":{"type":"string"},"profiles":{"$ref":"#/components/schemas/WebhookProfiles"},"test":{"type":"boolean"},"event":{"type":"string","enum":["account.permissions_changed"]},"account":{"type":"object","required":["accountId","profileId","platform","username","oauthAppId","missingScopeAreas","reason"],"properties":{"accountId":{"type":"string"},"profileId":{"type":"string"},"platform":{"type":"string"},"username":{"type":"string"},"displayName":{"type":"string"},"oauthAppId":{"type":"string"},"missingScopeAreas":{"type":"array","items":{"type":"string","enum":["posting","analytics","comments","messaging"]}},"reason":{"type":"string"}}},"timestamp":{"type":"string","format":"date-time"}}},"WebhookPayloadAccountDisconnected":{"type":"object","required":["id","event","account","timestamp"],"properties":{"id":{"type":"string"},"profiles":{"$ref":"#/components/schemas/WebhookProfiles"},"test":{"type":"boolean"},"event":{"type":"string","enum":["account.disconnected"]},"account":{"type":"object","required":["accountId","profileId","platform","username","disconnectionType","reason"],"properties":{"accountId":{"type":"string"},"profileId":{"type":"string"},"platform":{"type":"string"},"username":{"type":"string"},"displayName":{"type":"string"},"disconnectionType":{"type":"string","enum":["intentional","unintentional"]},"reason":{"type":"string"}}},"timestamp":{"type":"string","format":"date-time"}}},"WebhookAdsSyncAccount":{"type":"object","required":["accountId","profileId","platform","username"],"properties":{"accountId":{"type":"string"},"profileId":{"type":"string"},"platform":{"type":"string"},"username":{"type":"string"},"displayName":{"type":["string","null"]}}},"WebhookAdsSyncAdAccount":{"type":"object","required":["platformAdAccountId","name"],"properties":{"platformAdAccountId":{"type":"string"},"name":{"type":["string","null"]}}},"WebhookPayloadAccountAdsSyncFailed":{"type":"object","required":["id","event","account","adAccount","sync","timestamp"],"properties":{"id":{"type":"string"},"profiles":{"$ref":"#/components/schemas/WebhookProfiles"},"test":{"type":"boolean"},"event":{"type":"string","enum":["account.ads.sync_failed"]},"account":{"$ref":"#/components/schemas/WebhookAdsSyncAccount"},"adAccount":{"$ref":"#/components/schemas/WebhookAdsSyncAdAccount"},"sync":{"type":"object","required":["lastSuccessfulSyncAt","failureCount","errorCategory","error"],"properties":{"lastSuccessfulSyncAt":{"type":"string","format":"date-time"},"failureCount":{"type":"integer"},"errorCategory":{"type":"string","enum":["ad_account_not_listed","sync_error","stale"]},"error":{"type":"string"}}},"timestamp":{"type":"string","format":"date-time"}}},"WebhookPayloadAccountAdsSyncRecovered":{"type":"object","required":["id","event","account","adAccount","sync","timestamp"],"properties":{"id":{"type":"string"},"profiles":{"$ref":"#/components/schemas/WebhookProfiles"},"test":{"type":"boolean"},"event":{"type":"string","enum":["account.ads.sync_recovered"]},"account":{"$ref":"#/components/schemas/WebhookAdsSyncAccount"},"adAccount":{"$ref":"#/components/schemas/WebhookAdsSyncAdAccount"},"sync":{"type":"object","required":["lastSuccessfulSyncAt","failingSince"],"properties":{"lastSuccessfulSyncAt":{"type":"string","format":"date-time"},"failingSince":{"type":"string","format":"date-time"}}},"timestamp":{"type":"string","format":"date-time"}}},"WebhookPayloadAccountAdsInitialSyncCompleted":{"type":"object","required":["id","event","account","sync","timestamp"],"properties":{"id":{"type":"string"},"profiles":{"$ref":"#/components/schemas/WebhookProfiles"},"test":{"type":"boolean"},"event":{"type":"string","enum":["account.ads.initial_sync_completed"]},"account":{"type":"object","required":["accountId","profileId","platform","username"],"properties":{"accountId":{"type":"string"},"profileId":{"type":"string"},"platform":{"type":"string"},"username":{"type":"string"},"displayName":{"type":"string"},"platformUserId":{"type":"string"},"profilePicture":{"type":"string","format":"uri"},"platformAdAccountId":{"type":"string"},"platformAdAccountIds":{"type":"array","items":{"type":"string"}}}},"sync":{"type":"object","required":["status","totalAds","synced","failed"],"properties":{"status":{"type":"string","enum":["success","failure"]},"totalAds":{"type":"integer"},"synced":{"type":"integer"},"failed":{"type":"integer"},"error":{"type":"string"},"errorCode":{"type":"string"},"errorSubcode":{"type":"string"},"errorCategory":{"type":"string","enum":["token_invalid","permission_denied","no_ad_accounts","rate_limited","discovery_failed","unknown"]}}},"timestamp":{"type":"string","format":"date-time"}}},"WebhookPayloadCampaignSubmission":{"type":"object","required":["id","event","campaign","participant","creator","submission","timestamp"],"properties":{"id":{"type":"string"},"profiles":{"$ref":"#/components/schemas/WebhookProfiles"},"test":{"type":"boolean"},"event":{"type":"string","enum":["campaign_submission.received","campaign_submission.flagged","campaign_submission.pending_review","campaign_submission.approved","campaign_submission.rejected"]},"campaign":{"type":"object","required":["id","name"],"properties":{"id":{"type":"string"},"name":{"type":"string"}}},"participant":{"type":"object","required":["id"],"properties":{"id":{"type":"string"}}},"creator":{"type":"object","required":["id","displayName"],"properties":{"id":{"type":"string"},"displayName":{"type":"string"}}},"submission":{"type":"object","required":["id","platform","platformPostId","platformPostUrl","status","viewsAtSubmission","flags"],"properties":{"id":{"type":"string"},"platform":{"type":"string"},"platformPostId":{"type":"string"},"platformPostUrl":{"type":["string","null"]},"status":{"type":"string"},"viewsAtSubmission":{"type":["integer","null"]},"flags":{"type":"array","items":{"type":"object","required":["code","detail"],"properties":{"code":{"type":"string"},"detail":{"type":"string"}}}}}},"timestamp":{"type":"string","format":"date-time"}}},"WebhookPayloadCreatorCampaign":{"type":"object","required":["id","event","campaign","timestamp"],"properties":{"id":{"type":"string"},"profiles":{"$ref":"#/components/schemas/WebhookProfiles"},"test":{"type":"boolean"},"event":{"type":"string","enum":["creator_campaign.budget_exhausted","creator_campaign.closed"]},"campaign":{"type":"object","required":["id","name","budgetCents"],"properties":{"id":{"type":"string"},"name":{"type":"string"},"budgetCents":{"type":"integer"},"budgetExhaustedAt":{"type":"string","format":"date-time"},"closedAt":{"type":"string","format":"date-time"}}},"timestamp":{"type":"string","format":"date-time"}}},"WebhookPayloadCampaignPayout":{"type":"object","required":["id","event","campaign","participant","creator","payout","timestamp"],"properties":{"id":{"type":"string"},"profiles":{"$ref":"#/components/schemas/WebhookProfiles"},"test":{"type":"boolean"},"event":{"type":"string","enum":["campaign_payout.payable","campaign_payout.settled","campaign_payout.failed"]},"campaign":{"type":"object","required":["id","name","settlement"],"properties":{"id":{"type":"string"},"name":{"type":"string"},"settlement":{"type":"string","enum":["none","external","treasury"]}}},"participant":{"type":"object","required":["id"],"properties":{"id":{"type":"string"}}},"creator":{"type":"object","required":["id","displayName"],"properties":{"id":{"type":"string"},"displayName":{"type":"string"}}},"payout":{"type":"object","required":["payableCents"],"properties":{"payableCents":{"type":"integer"},"settlement":{"type":"object","required":["entryId","amountCents","externalReference","recorded"],"properties":{"entryId":{"type":"string"},"amountCents":{"type":"integer"},"externalReference":{"type":["string","null"]},"recorded":{"type":"boolean"},"transferId":{"type":"string"},"feeCents":{"type":"integer"},"totalCents":{"type":"integer"}}},"failure":{"type":"object","required":["transferId","amountCents","reason"],"properties":{"transferId":{"type":"string"},"amountCents":{"type":"integer"},"reason":{"type":"string","enum":["returned","stale","reversed"]}}}}},"timestamp":{"type":"string","format":"date-time"}}},"WebhookPayloadCampaignParticipant":{"type":"object","required":["id","event","campaign","participant","creator","timestamp"],"properties":{"id":{"type":"string"},"profiles":{"$ref":"#/components/schemas/WebhookProfiles"},"test":{"type":"boolean"},"event":{"type":"string","enum":["campaign_participant.joined","campaign_participant.suspended","campaign_participant.removed"]},"campaign":{"type":"object","required":["id","name"],"properties":{"id":{"type":"string"},"name":{"type":"string"}}},"participant":{"type":"object","required":["id","status","joinedAt"],"properties":{"id":{"type":"string"},"status":{"type":"string","enum":["invited","active","suspended","removed"]},"joinedAt":{"type":["string","null"],"format":"date-time"}}},"creator":{"type":"object","required":["id","displayName"],"properties":{"id":{"type":"string"},"displayName":{"type":"string"}}},"timestamp":{"type":"string","format":"date-time"}}},"CreatorCampaignEconomics":{"oneOf":[{"$ref":"#/components/schemas/CreatorCampaignEconomicsCpm"},{"$ref":"#/components/schemas/CreatorCampaignEconomicsPerPost"},{"$ref":"#/components/schemas/CreatorCampaignEconomicsPool"}],"discriminator":{"propertyName":"type","mapping":{"cpm":"#/components/schemas/CreatorCampaignEconomicsCpm","per_post":"#/components/schemas/CreatorCampaignEconomicsPerPost","pool":"#/components/schemas/CreatorCampaignEconomicsPool"}}},"CreatorCampaignEconomicsCpm":{"type":"object","title":"CPM","required":["type","ratePer1kCents","minViewsToEarn","budgetCents"],"properties":{"type":{"type":"string","enum":["cpm"]},"ratePer1kCents":{"type":"integer","minimum":1},"minViewsToEarn":{"type":"integer","minimum":0},"maxPayoutPerClipCents":{"type":"integer","minimum":1},"budgetCents":{"type":"integer","minimum":0}}},"CreatorCampaignEconomicsPerPost":{"type":"object","title":"Per post","required":["type","perApprovedPostCents","budgetCents"],"properties":{"type":{"type":"string","enum":["per_post"]},"perApprovedPostCents":{"type":"integer","minimum":1},"maxPostsPerParticipant":{"type":"integer","minimum":1},"budgetCents":{"type":"integer","minimum":0}}},"CreatorCampaignEconomicsPool":{"type":"object","title":"Pool","required":["type","budgetCents","minViewsToQualify"],"properties":{"type":{"type":"string","enum":["pool"]},"budgetCents":{"type":"integer","minimum":0},"minViewsToQualify":{"type":"integer","minimum":0}}},"CreatorCampaignCaps":{"type":"object","required":["authenticityThreshold"],"properties":{"maxParticipants":{"type":"integer","minimum":1},"maxSubmissionsPerParticipantPerDay":{"type":"integer","minimum":1},"maxAccountsPerParticipant":{"type":"integer","minimum":1},"maxXReadSpendCents":{"type":"integer","minimum":1},"authenticityThreshold":{"type":"number","minimum":0,"maximum":100}}},"CreatorCampaignBranding":{"type":"object","properties":{"brandName":{"type":"string"},"primaryColor":{"type":"string"},"logoUrl":{"type":"string"},"theme":{"type":"object","additionalProperties":true}}},"CampaignSubmissionCounts":{"type":"object","required":["received","tracking","pending_review","approved","rejected","expired","withdrawn"],"properties":{"received":{"type":"integer"},"tracking":{"type":"integer"},"pending_review":{"type":"integer"},"approved":{"type":"integer"},"rejected":{"type":"integer"},"expired":{"type":"integer"},"withdrawn":{"type":"integer"}}},"CreatorCampaign":{"type":"object","required":["id","userId","profileId","kind","name","brandName","status","type","currency","platforms","contentRules","startsAt","endsAt","trackingDays","holdDays","maxPostAgeMinutes","settlement","economics","caps","branding","budgetExhaustedAt","closedAt","activatedAt","payableScannedAt","createdAt","updatedAt","hasOpenInvite","consumedCents","participantCount","submissionCounts","payableCents"],"properties":{"id":{"type":"string"},"userId":{"type":"string"},"profileId":{"type":"string"},"kind":{"type":"string"},"name":{"type":"string"},"brandName":{"type":"string"},"status":{"type":"string","enum":["draft","active","paused","closed"]},"type":{"type":"string","enum":["cpm","per_post","pool"]},"currency":{"type":"string"},"platforms":{"type":"array","items":{"type":"string","enum":["tiktok","instagram","youtube","threads","pinterest","facebook","twitter"]}},"contentRules":{"type":["string","null"]},"startsAt":{"type":["string","null"],"format":"date-time"},"endsAt":{"type":["string","null"],"format":"date-time"},"trackingDays":{"type":"integer"},"holdDays":{"type":"integer"},"maxPostAgeMinutes":{"type":["integer","null"]},"activatedAt":{"type":["string","null"],"format":"date-time"},"settlement":{"type":"string","enum":["none","external","treasury"]},"economics":{"$ref":"#/components/schemas/CreatorCampaignEconomics"},"caps":{"$ref":"#/components/schemas/CreatorCampaignCaps"},"branding":{"oneOf":[{"$ref":"#/components/schemas/CreatorCampaignBranding"},{"type":"null"}]},"budgetExhaustedAt":{"type":["string","null"],"format":"date-time"},"closedAt":{"type":["string","null"],"format":"date-time"},"payableScannedAt":{"type":["string","null"],"format":"date-time"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"hasOpenInvite":{"type":"boolean"},"consumedCents":{"type":"integer"},"participantCount":{"type":"integer"},"submissionCounts":{"$ref":"#/components/schemas/CampaignSubmissionCounts"},"payableCents":{"type":"integer"}}},"CreateCreatorCampaignRequest":{"type":"object","required":["profileId","name","brandName","economics"],"properties":{"profileId":{"type":"string"},"name":{"type":"string","minLength":1,"maxLength":200},"brandName":{"type":"string","minLength":1,"maxLength":200},"economics":{"$ref":"#/components/schemas/CreatorCampaignEconomics"},"caps":{"allOf":[{"$ref":"#/components/schemas/CreatorCampaignCaps"}]},"platforms":{"type":"array","items":{"type":"string","enum":["tiktok","instagram","youtube","threads","pinterest","facebook","twitter"]}},"contentRules":{"type":["string","null"],"maxLength":10000},"startsAt":{"type":["string","null"],"format":"date-time"},"endsAt":{"type":["string","null"],"format":"date-time"},"trackingDays":{"type":"integer","minimum":1,"maximum":365,"default":30},"holdDays":{"type":"integer","minimum":0,"maximum":90,"default":10},"maxPostAgeMinutes":{"type":["integer","null"],"minimum":1},"settlement":{"type":"string","enum":["none","external","treasury"],"default":"none"},"branding":{"oneOf":[{"$ref":"#/components/schemas/CreatorCampaignBranding"},{"type":"null"}]}}},"UpdateCreatorCampaignRequest":{"type":"object","minProperties":1,"properties":{"name":{"type":"string","minLength":1,"maxLength":200},"brandName":{"type":"string","minLength":1,"maxLength":200},"platforms":{"type":"array","items":{"type":"string","enum":["tiktok","instagram","youtube","threads","pinterest","facebook","twitter"]}},"contentRules":{"type":["string","null"],"maxLength":10000},"startsAt":{"type":["string","null"],"format":"date-time"},"endsAt":{"type":["string","null"],"format":"date-time"},"trackingDays":{"type":"integer","minimum":1,"maximum":365},"holdDays":{"type":"integer","minimum":0,"maximum":90},"maxPostAgeMinutes":{"type":["integer","null"],"minimum":1},"settlement":{"type":"string","enum":["none","external","treasury"]},"economics":{"$ref":"#/components/schemas/CreatorCampaignEconomics"},"caps":{"$ref":"#/components/schemas/CreatorCampaignCaps"},"branding":{"oneOf":[{"$ref":"#/components/schemas/CreatorCampaignBranding"},{"type":"null"}]}}},"CampaignParticipantBalances":{"type":"object","required":["accruing","owed","payable","settling","settled"],"properties":{"accruing":{"type":"integer"},"owed":{"type":"integer"},"payable":{"type":"integer"},"settling":{"type":"integer"},"settled":{"type":"integer"}}},"CampaignParticipant":{"type":"object","required":["id","campaignId","creator","status","joinedAt","accounts","balances","flags","submissionCounts","payout"],"properties":{"id":{"type":"string"},"campaignId":{"type":"string"},"creator":{"type":"object","required":["id","displayName","email"],"properties":{"id":{"type":"string"},"displayName":{"type":"string"},"email":{"type":["string","null"]}}},"status":{"type":"string","enum":["invited","active","suspended","removed"]},"joinedAt":{"type":["string","null"],"format":"date-time"},"accounts":{"type":"array","items":{"type":"object","required":["accountId","verifiedAt","platform","username"],"properties":{"accountId":{"type":"string"},"verifiedAt":{"type":["string","null"],"format":"date-time"},"platform":{"type":["string","null"]},"username":{"type":["string","null"]}}}},"balances":{"$ref":"#/components/schemas/CampaignParticipantBalances"},"flags":{"type":"array","items":{"type":"object","required":["code","detail","raisedAt"],"properties":{"code":{"type":"string","enum":["linked_accounts","cross_operator"]},"detail":{"type":"string"},"raisedAt":{"type":"string","format":"date-time"}}}},"submissionCounts":{"$ref":"#/components/schemas/CampaignSubmissionCounts"},"payout":{"type":"object","required":["status"],"properties":{"status":{"type":"string","enum":["not_started","onboarding","ready","restricted"]}}}}},"CampaignSubmissionFlag":{"type":"object","required":["code","detail","raisedAt"],"properties":{"code":{"type":"string","enum":["duplicate_media","duplicate_post","view_spike","linked_accounts","cross_operator","unreachable","post_deleted","account_restricted","low_authenticity","x_read_cap"]},"detail":{"type":"string"},"raisedAt":{"type":"string","format":"date-time"}}},"CampaignSubmission":{"type":"object","required":["id","campaignId","participantId","creatorId","accountId","platform","platformPostId","platformPostUrl","externalPostId","trackingWindowId","mediaHash","submittedAt","postPublishedAt","status","rejectReason","reviewRound","reviewedBy","reviewedAt","viewsAtSubmission","viewsLatest","viewsEligible","lastAccruedViews","accruedCents","approvedCents","authenticityScore","authenticityConfidence","flags","createdAt","updatedAt","creator","authenticity","earnedCents","releasedCents","paidOutCents","window","post"],"properties":{"id":{"type":"string"},"campaignId":{"type":"string"},"participantId":{"type":"string"},"creatorId":{"type":"string"},"accountId":{"type":"string"},"platform":{"type":"string","enum":["tiktok","instagram","youtube","threads","pinterest","facebook","twitter"]},"platformPostId":{"type":"string"},"platformPostUrl":{"type":["string","null"]},"externalPostId":{"type":["string","null"]},"trackingWindowId":{"type":["string","null"]},"mediaHash":{"type":["string","null"]},"submittedAt":{"type":"string","format":"date-time"},"postPublishedAt":{"type":["string","null"],"format":"date-time"},"status":{"type":"string","enum":["received","tracking","pending_review","approved","rejected","expired","withdrawn"]},"rejectReason":{"type":["string","null"]},"reviewRound":{"type":"integer","minimum":0},"reviewedBy":{"type":["string","null"]},"reviewedAt":{"type":["string","null"],"format":"date-time"},"viewsAtSubmission":{"type":["integer","null"]},"viewsLatest":{"type":["integer","null"]},"viewsEligible":{"type":["integer","null"]},"lastAccruedViews":{"type":"integer"},"accruedCents":{"type":"integer"},"approvedCents":{"type":"integer"},"authenticityScore":{"type":["integer","null"],"minimum":0,"maximum":100},"authenticityConfidence":{"type":["number","null"]},"flags":{"type":"array","items":{"$ref":"#/components/schemas/CampaignSubmissionFlag"}},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"creator":{"type":"object","required":["id","displayName"],"properties":{"id":{"type":"string"},"displayName":{"type":"string"}}},"authenticity":{"type":["object","null"],"required":["score","confidence","reasons"],"properties":{"score":{"type":"integer"},"confidence":{"type":["number","null"]},"reasons":{"type":"array","items":{}}}},"earnedCents":{"type":"integer"},"releasedCents":{"type":"integer"},"paidOutCents":{"type":"integer"},"window":{"type":["object","null"],"required":["id","endsAt","status"],"properties":{"id":{"type":"string"},"endsAt":{"type":"string","format":"date-time"},"status":{"type":"string"}}},"post":{"type":"object","required":["thumbnailUrl","caption","accountHandle","publishedAt"],"properties":{"thumbnailUrl":{"type":["string","null"]},"caption":{"type":["string","null"]},"accountHandle":{"type":["string","null"]},"publishedAt":{"type":"string","format":"date-time"}}}}},"CampaignSubmissionDetail":{"allOf":[{"$ref":"#/components/schemas/CampaignSubmission"},{"type":"object","required":["samples"],"properties":{"samples":{"type":"array","items":{"type":"object","required":["syncedAt","views","likes","comments","shares","saves"],"properties":{"syncedAt":{"type":"string","format":"date-time"},"views":{"type":"integer"},"likes":{"type":"integer"},"comments":{"type":"integer"},"shares":{"type":"integer"},"saves":{"type":"integer"}}}}}}]},"CampaignLedgerEntry":{"type":"object","required":["id","kind","amountCents","debit","credit","holdUntil","releasedByEntryId","reversesEntryId","referenceType","referenceId","cause","externalReference","actor","createdAt"],"properties":{"id":{"type":"string"},"kind":{"type":"string","enum":["accrual","approval","hold_release","adjustment","settling","settlement","reversal","topup","transfer","fee"]},"amountCents":{"type":"integer"},"debit":{"$ref":"#/components/schemas/LedgerAccountSide"},"credit":{"$ref":"#/components/schemas/LedgerAccountSide"},"holdUntil":{"type":["string","null"],"format":"date-time"},"releasedByEntryId":{"type":["string","null"]},"reversesEntryId":{"type":["string","null"]},"referenceType":{"type":["string","null"]},"referenceId":{"type":["string","null"]},"cause":{"type":"string"},"externalReference":{"type":["string","null"]},"actor":{"type":"string"},"createdAt":{"type":"string","format":"date-time"}}},"CampaignPayable":{"type":"object","required":["participantId","creator","payableCents","entries"],"properties":{"participantId":{"type":"string"},"creator":{"type":"object","required":["id","displayName"],"properties":{"id":{"type":"string"},"displayName":{"type":"string"}}},"payableCents":{"type":"integer"},"entries":{"type":"array","items":{"type":"string"}}}},"CampaignSettlement":{"type":"object","required":["entryId","participantId","amountCents","externalReference","payableCents","settledAt"],"properties":{"entryId":{"type":"string"},"participantId":{"type":"string"},"amountCents":{"type":"integer"},"externalReference":{"type":["string","null"]},"payableCents":{"type":"integer"},"settledAt":{"type":"string","format":"date-time"},"transferId":{"type":"string"},"feeCents":{"type":"integer"},"totalCents":{"type":"integer"}}},"CampaignAdjustment":{"type":"object","required":["id","kind","participantId","amountCents","cause","actor","createdAt"],"properties":{"id":{"type":"string"},"kind":{"type":"string","enum":["adjustment"]},"participantId":{"type":"string"},"amountCents":{"type":"integer"},"cause":{"type":"string"},"actor":{"type":"string"},"createdAt":{"type":"string","format":"date-time"}}},"CampaignReport":{"type":"object","required":["spend","views","submissions","participants","authenticity"],"properties":{"spend":{"type":"object","required":["budgetCents","consumedCents","settledCents"],"properties":{"budgetCents":{"type":"integer"},"consumedCents":{"type":"integer"},"settledCents":{"type":"integer"}}},"views":{"type":"object","required":["eligible","total"],"properties":{"eligible":{"type":"integer"},"total":{"type":"integer"}}},"submissions":{"$ref":"#/components/schemas/CampaignSubmissionCounts"},"participants":{"type":"array","items":{"type":"object","required":["participantId","creator","payableCents","settlingCents","settledCents"],"properties":{"participantId":{"type":"string"},"creator":{"type":"object","required":["id","displayName"],"properties":{"id":{"type":"string"},"displayName":{"type":"string"}}},"payableCents":{"type":"integer"},"settlingCents":{"type":"integer"},"settledCents":{"type":"integer"}}}},"authenticity":{"type":"array","items":{"type":"object","required":["from","to","count"],"properties":{"from":{"type":"integer"},"to":{"type":"integer"},"count":{"type":"integer"}}}}}},"TrackingWindow":{"type":"object","required":["id","postId","accountId","platform","platformPostId","startsAt","endsAt","status","finalReadAt","completionReason","requestedBy","latest"],"properties":{"id":{"type":"string"},"postId":{"type":"string"},"accountId":{"type":"string"},"platform":{"type":"string"},"platformPostId":{"type":"string"},"startsAt":{"type":"string","format":"date-time"},"endsAt":{"type":"string","format":"date-time"},"status":{"type":"string","enum":["open","completing","completed","cancelled"]},"finalReadAt":{"type":["string","null"],"format":"date-time"},"completionReason":{"type":["string","null"],"enum":["final_read","unreachable","post_deleted","cancelled",null]},"requestedBy":{"type":"string"},"latest":{"type":["object","null"],"required":["views","likes","comments","shares","saves","syncedAt"],"properties":{"views":{"type":"integer"},"likes":{"type":"integer"},"comments":{"type":"integer"},"shares":{"type":"integer"},"saves":{"type":"integer"},"syncedAt":{"type":["string","null"],"format":"date-time"}}}}},"TrackingWindowResponse":{"type":"object","required":["window"],"properties":{"window":{"$ref":"#/components/schemas/TrackingWindow"}}},"PostSample":{"type":"object","required":["syncedAt","views","likes","comments","shares","saves","watchSeconds","completionRate"],"properties":{"syncedAt":{"type":"string","format":"date-time"},"views":{"type":"integer"},"likes":{"type":"integer"},"comments":{"type":"integer"},"shares":{"type":["integer","null"]},"saves":{"type":["integer","null"]},"watchSeconds":{"type":["number","null"]},"completionRate":{"type":["number","null"]}}},"PostAuthenticity":{"type":"object","required":["postId","score","confidence","reasons","version","computedAt","sampleCount"],"properties":{"postId":{"type":"string"},"score":{"type":"integer","minimum":0,"maximum":100},"confidence":{"type":"number","minimum":0,"maximum":1},"reasons":{"type":"array","items":{"type":"object","required":["code","weight"],"properties":{"code":{"type":"string","enum":["late_block","flat_engagement","view_follower_gap","cap_seeking","prior_flags","no_watch_signal"]},"weight":{"type":"number"}}}},"version":{"type":"string"},"computedAt":{"type":"string","format":"date-time"},"sampleCount":{"type":"integer"}}},"WebhookPayloadPostTrackingCompleted":{"type":"object","required":["id","event","post","window","final","timestamp"],"properties":{"id":{"type":"string"},"profiles":{"$ref":"#/components/schemas/WebhookProfiles"},"test":{"type":"boolean"},"event":{"type":"string","enum":["post.tracking_completed"]},"post":{"type":"object","required":["id","platform","platformPostId","accountId","profileId"],"properties":{"id":{"type":"string"},"platform":{"type":"string"},"platformPostId":{"type":"string"},"accountId":{"type":"string"},"profileId":{"type":"string"}}},"window":{"type":"object","required":["id","startsAt","endsAt","finalReadAt","completionReason"],"properties":{"id":{"type":"string"},"startsAt":{"type":"string","format":"date-time"},"endsAt":{"type":"string","format":"date-time"},"finalReadAt":{"type":"string","format":"date-time"},"completionReason":{"type":"string","enum":["final_read","unreachable","post_deleted"]}}},"final":{"type":["object","null"],"required":["views","likes","comments","shares","saves","syncedAt"],"properties":{"views":{"type":"integer"},"likes":{"type":"integer"},"comments":{"type":"integer"},"shares":{"type":"integer"},"saves":{"type":"integer"},"syncedAt":{"type":"string","format":"date-time"}}},"timestamp":{"type":"string","format":"date-time"}}},"WebhookPayloadPostAuthenticityChanged":{"type":"object","required":["id","event","post","authenticity","timestamp"],"properties":{"id":{"type":"string"},"profiles":{"$ref":"#/components/schemas/WebhookProfiles"},"test":{"type":"boolean"},"event":{"type":"string","enum":["post.authenticity_changed"]},"post":{"type":"object","required":["id","platform","platformPostId","accountId","profileId"],"properties":{"id":{"type":"string"},"platform":{"type":"string"},"platformPostId":{"type":"string"},"accountId":{"type":"string"},"profileId":{"type":"string"}}},"authenticity":{"type":"object","required":["score","previousScore","confidence","reasons","version","computedAt"],"properties":{"score":{"type":"integer"},"previousScore":{"type":"integer"},"confidence":{"type":"number"},"reasons":{"type":"array","items":{"type":"object","required":["code","weight"],"properties":{"code":{"type":"string"},"weight":{"type":"number"}}}},"version":{"type":"string"},"computedAt":{"type":"string","format":"date-time"}}},"timestamp":{"type":"string","format":"date-time"}}},"WebhookPayloadAnalyticsSynced":{"type":"object","required":["id","event","account","sync","timestamp"],"properties":{"id":{"type":"string"},"profiles":{"$ref":"#/components/schemas/WebhookProfiles"},"test":{"type":"boolean"},"event":{"type":"string","enum":["analytics.synced"]},"account":{"type":"object","required":["accountId","profileId","platform","username"],"properties":{"accountId":{"type":"string"},"profileId":{"type":"string"},"platform":{"type":"string"},"username":{"type":"string"}}},"sync":{"type":"object","required":["syncedAt","postsUpdated"],"properties":{"syncedAt":{"type":"string","format":"date-time"},"postsUpdated":{"type":"integer"}}},"timestamp":{"type":"string","format":"date-time"}}},"WebhookPayloadComment":{"type":"object","required":["id","event","comment","post","account","timestamp"],"properties":{"id":{"type":"string"},"profiles":{"$ref":"#/components/schemas/WebhookProfiles"},"test":{"type":"boolean"},"event":{"type":"string","enum":["comment.received"]},"comment":{"type":"object","required":["id","postId","platformPostId","platform","text","author","createdAt","isReply","parentCommentId"],"properties":{"id":{"type":"string"},"postId":{"type":["string","null"]},"platformPostId":{"type":"string"},"platform":{"type":"string","enum":["instagram","facebook","threads","youtube","linkedin","bluesky","reddit","tiktok"]},"text":{"type":"string"},"author":{"type":"object","required":["id"],"properties":{"id":{"type":"string"},"username":{"type":"string"},"name":{"type":"string"},"picture":{"type":["string","null"]},"isOwnAccount":{"type":"boolean"},"instagramProfile":{"type":"object","properties":{"isFollower":{"type":["boolean","null"]},"isFollowing":{"type":["boolean","null"]},"followerCount":{"type":["integer","null"]},"isVerified":{"type":["boolean","null"]}}}}},"createdAt":{"type":"string","format":"date-time"},"isReply":{"type":"boolean"},"parentCommentId":{"type":["string","null"]},"isLive":{"type":"boolean"},"ad":{"type":"object","properties":{"id":{"type":"string"},"title":{"type":"string"},"originalMediaId":{"type":"string"},"promotionStatus":{"type":"string"},"isDarkPost":{"type":"boolean"}}},"attachment":{"type":"object","required":["type"],"properties":{"type":{"type":"string"},"imageUrl":{"type":"string"},"url":{"type":"string"}}}}},"post":{"type":"object","required":["id","platformPostId","content","imageUrl","permalink"],"properties":{"id":{"type":["string","null"]},"platformPostId":{"type":"string"},"content":{"type":["string","null"]},"imageUrl":{"type":["string","null"]},"permalink":{"type":["string","null"]}}},"account":{"type":"object","required":["id","platform","username"],"properties":{"id":{"type":"string"},"accountId":{"type":"string"},"platform":{"type":"string"},"username":{"type":"string"}}},"timestamp":{"type":"string","format":"date-time"}}},"WebhookPayloadLead":{"type":"object","required":["id","event","lead","account","timestamp"],"properties":{"id":{"type":"string"},"profiles":{"$ref":"#/components/schemas/WebhookProfiles"},"test":{"type":"boolean"},"event":{"type":"string","enum":["lead.received"]},"lead":{"type":"object","required":["id","leadgenId","formId","fields","isOrganic","createdAt"],"properties":{"id":{"type":"string"},"leadgenId":{"type":"string"},"formId":{"type":"string"},"formName":{"type":["string","null"]},"adId":{"type":["string","null"]},"adsetId":{"type":["string","null"]},"campaignId":{"type":["string","null"]},"fields":{"type":"object","additionalProperties":{"type":"string"}},"consents":{"allOf":[{"$ref":"#/components/schemas/AdLeadConsents"}]},"isOrganic":{"type":"boolean"},"createdAt":{"type":"string","format":"date-time"}}},"account":{"type":"object","required":["id","platform","profileId"],"properties":{"id":{"type":"string"},"accountId":{"type":"string"},"platform":{"type":"string","enum":["facebook"]},"profileId":{"type":["string","null"]}}},"timestamp":{"type":"string","format":"date-time"}}},"ReviewWebhookReview":{"type":"object","required":["id","platform","rating","text","reviewer","createdAt","hasReply"],"properties":{"id":{"type":"string"},"platform":{"type":"string","enum":["googlebusiness"]},"rating":{"type":"integer","minimum":1,"maximum":5},"text":{"type":"string"},"reviewer":{"type":"object","required":["id","name","profileImage"],"properties":{"id":{"type":["string","null"]},"name":{"type":"string"},"profileImage":{"type":["string","null"]}}},"createdAt":{"type":"string","format":"date-time"},"hasReply":{"type":"boolean"},"reply":{"type":"object","required":["text","createdAt"],"properties":{"text":{"type":"string"},"createdAt":{"type":"string","format":"date-time"}}}}},"WebhookPayloadReviewNew":{"type":"object","required":["id","event","review","account","timestamp"],"properties":{"id":{"type":"string"},"profiles":{"$ref":"#/components/schemas/WebhookProfiles"},"test":{"type":"boolean"},"event":{"type":"string","enum":["review.new"]},"review":{"$ref":"#/components/schemas/ReviewWebhookReview"},"account":{"type":"object","required":["id","platform","username"],"properties":{"id":{"type":"string"},"accountId":{"type":"string"},"platform":{"type":"string"},"username":{"type":"string"}}},"timestamp":{"type":"string","format":"date-time"}}},"WebhookPayloadReviewUpdated":{"type":"object","required":["id","event","review","account","timestamp"],"properties":{"id":{"type":"string"},"profiles":{"$ref":"#/components/schemas/WebhookProfiles"},"test":{"type":"boolean"},"event":{"type":"string","enum":["review.updated"]},"review":{"$ref":"#/components/schemas/ReviewWebhookReview"},"account":{"type":"object","required":["id","platform","username"],"properties":{"id":{"type":"string"},"accountId":{"type":"string"},"platform":{"type":"string"},"username":{"type":"string"}}},"timestamp":{"type":"string","format":"date-time"}}},"WebhookPayloadReviewDeleted":{"type":"object","required":["id","event","review","account","timestamp"],"properties":{"id":{"type":"string"},"profiles":{"$ref":"#/components/schemas/WebhookProfiles"},"test":{"type":"boolean"},"event":{"type":"string","enum":["review.deleted"]},"review":{"type":"object","required":["id","platform","rating","createdAt","lastSeenAt"],"properties":{"id":{"type":"string"},"platform":{"type":"string","enum":["googlebusiness"]},"rating":{"type":["integer","null"],"minimum":1,"maximum":5},"createdAt":{"type":["string","null"],"format":"date-time"},"lastSeenAt":{"type":"string","format":"date-time"}}},"account":{"type":"object","required":["id","platform","username"],"properties":{"id":{"type":"string"},"accountId":{"type":"string"},"platform":{"type":"string"},"username":{"type":"string"}}},"timestamp":{"type":"string","format":"date-time"}}},"WebhookPayloadReviewRestored":{"type":"object","required":["id","event","review","account","timestamp"],"properties":{"id":{"type":"string"},"profiles":{"$ref":"#/components/schemas/WebhookProfiles"},"test":{"type":"boolean"},"event":{"type":"string","enum":["review.restored"]},"review":{"$ref":"#/components/schemas/ReviewWebhookReview"},"account":{"type":"object","required":["id","platform","username"],"properties":{"id":{"type":"string"},"accountId":{"type":"string"},"platform":{"type":"string"},"username":{"type":"string"}}},"timestamp":{"type":"string","format":"date-time"}}},"ExternalPostWebhookPost":{"type":"object","required":["id","platform","accountId","url","content","mediaType","mediaItems","thumbnailUrl","publishedAt","source"],"properties":{"id":{"type":"string"},"platform":{"type":"string"},"accountId":{"type":"string"},"url":{"type":["string","null"]},"content":{"type":"string"},"mediaType":{"type":"string"},"mediaItems":{"type":"array","items":{"$ref":"#/components/schemas/ExternalPostMediaItem"}},"thumbnailUrl":{"type":["string","null"]},"publishedAt":{"type":"string","format":"date-time"},"mediaProductType":{"type":"string"},"isAiGenerated":{"type":"boolean"},"isSharedToFeed":{"type":"boolean"},"mediaAudioType":{"type":"string"},"source":{"type":"string","enum":["external"]},"deletedAt":{"type":["string","null"],"format":"date-time"}}},"WebhookPayloadExternalPost":{"type":"object","required":["id","event","post","account","timestamp"],"properties":{"id":{"type":"string"},"profiles":{"$ref":"#/components/schemas/WebhookProfiles"},"test":{"type":"boolean"},"event":{"type":"string","enum":["post.external.created","post.external.updated","post.external.deleted"]},"post":{"$ref":"#/components/schemas/ExternalPostWebhookPost"},"account":{"type":"object","required":["id","platform","username"],"properties":{"id":{"type":"string"},"accountId":{"type":"string"},"platform":{"type":"string"},"username":{"type":"string"}}},"timestamp":{"type":"string","format":"date-time"}}},"InboxWebhookMessage":{"type":"object","required":["id","conversationId","platform","platformMessageId","direction","text","attachments","sender","sentAt","isRead"],"properties":{"id":{"type":"string"},"conversationId":{"type":"string"},"platform":{"type":"string","enum":["instagram","facebook","telegram","whatsapp","sms"]},"platformMessageId":{"type":"string"},"direction":{"type":"string","enum":["incoming","outgoing"]},"text":{"type":["string","null"]},"attachments":{"type":"array","items":{"type":"object","required":["type","url"],"properties":{"type":{"type":"string"},"url":{"type":"string"},"payload":{"type":"object","properties":{"voice":{"type":"boolean"}}}}}},"sender":{"type":"object","required":["id"],"properties":{"id":{"type":"string"},"contactId":{"type":"string"},"name":{"type":"string"},"username":{"type":"string"},"picture":{"type":"string"},"phoneNumber":{"type":["string","null"]},"businessScopedUserId":{"type":"string"},"parentBusinessScopedUserId":{"type":"string"},"whatsappUsername":{"type":"string"},"instagramProfile":{"type":"object","properties":{"isFollower":{"type":["boolean","null"]},"isFollowing":{"type":["boolean","null"]},"followerCount":{"type":["integer","null"]},"isVerified":{"type":["boolean","null"]}}}}},"sentAt":{"type":"string","format":"date-time"},"isRead":{"type":"boolean"}}},"InboxWebhookConversation":{"type":"object","required":["id","platformConversationId","status"],"properties":{"id":{"type":"string"},"platformConversationId":{"type":"string"},"participantId":{"type":"string"},"participantName":{"type":"string"},"participantUsername":{"type":"string"},"participantPicture":{"type":"string"},"status":{"type":"string","enum":["active","archived"]},"contactId":{"type":"string"}}},"InboxWebhookConversationDetail":{"type":"object","required":["id","platform","platformConversationId","participantName","status"],"properties":{"id":{"type":"string"},"platform":{"type":"string","enum":["instagram","facebook","telegram","whatsapp","twitter","reddit","bluesky","sms","rcs","slack","tiktok","imessage"]},"platformConversationId":{"type":"string"},"participantId":{"type":"string"},"participantName":{"type":"string"},"participantUsername":{"type":"string"},"participantPicture":{"type":"string"},"status":{"type":"string","enum":["active","archived"]},"contactId":{"type":"string"}}},"ConversationAdAttribution":{"type":["object","null"],"required":["adId","name","synced","campaignId","campaignName","adSetId","adSetName","adAccountId","adAccountName","platformPostId","isExternal"],"properties":{"adId":{"type":["string","null"]},"name":{"type":["string","null"]},"synced":{"type":"boolean"},"campaignId":{"type":["string","null"]},"campaignName":{"type":["string","null"]},"adSetId":{"type":["string","null"]},"adSetName":{"type":["string","null"]},"adAccountId":{"type":["string","null"]},"adAccountName":{"type":["string","null"]},"platformPostId":{"type":["string","null"]},"isExternal":{"type":["boolean","null"]}}},"InboxConversationAdMetadata":{"type":["object","null"],"properties":{"ctwa_clid":{"type":"string"},"ctwa_source_id":{"type":"string"},"ctwa_source_type":{"type":"string"},"ctwa_source_url":{"type":"string"},"ctwa_headline":{"type":"string"},"ctwa_body":{"type":"string"},"ctwa_media_type":{"type":"string"},"ctwa_image_url":{"type":"string"},"ctwa_video_url":{"type":"string"},"ctwa_thumbnail_url":{"type":"string"},"ctwa_captured_at":{"type":"string","format":"date-time"},"meta_ad_id":{"type":"string"},"meta_ad_source":{"type":"string"},"meta_ad_type":{"type":"string"},"meta_ad_ref":{"type":"string"},"meta_ad_title":{"type":"string"},"meta_ad_photo_url":{"type":"string"},"meta_ad_video_url":{"type":"string"},"meta_ad_post_id":{"type":"string"},"meta_ad_product_id":{"type":"string"},"meta_ad_flow_id":{"type":"string"},"meta_ad_captured_at":{"type":"string","format":"date-time"}}},"InboxWebhookAccount":{"type":"object","required":["id","platform","username"],"properties":{"id":{"type":"string"},"accountId":{"type":"string"},"profileId":{"type":"string"},"platform":{"type":"string"},"username":{"type":"string"},"displayName":{"type":"string"},"pageId":{"type":"string"}}},"WebhookPayloadReaction":{"type":"object","required":["id","event","reaction","conversation","account","timestamp"],"properties":{"id":{"type":"string"},"profiles":{"$ref":"#/components/schemas/WebhookProfiles"},"test":{"type":"boolean"},"event":{"type":"string","enum":["reaction.received"]},"reaction":{"type":"object","required":["emoji","action","platformMessageId","sender","reactedAt"],"properties":{"emoji":{"type":"string"},"action":{"type":"string","enum":["added","removed"]},"messageId":{"type":"string"},"platformMessageId":{"type":"string"},"sender":{"type":"object","required":["id"],"properties":{"id":{"type":"string"},"contactId":{"type":"string"},"name":{"type":"string"},"username":{"type":"string"},"picture":{"type":"string"},"phoneNumber":{"type":["string","null"]}}},"reactedAt":{"type":"string","format":"date-time"}}},"conversation":{"$ref":"#/components/schemas/InboxWebhookConversation"},"account":{"$ref":"#/components/schemas/InboxWebhookAccount"},"timestamp":{"type":"string","format":"date-time"}}},"WebhookPayloadReferral":{"type":"object","required":["id","event","referral","sender","conversation","account","timestamp"],"properties":{"id":{"type":"string"},"profiles":{"$ref":"#/components/schemas/WebhookProfiles"},"test":{"type":"boolean"},"event":{"type":"string","enum":["referral.received"]},"referral":{"type":"object","properties":{"ref":{"type":"string"},"source":{"type":"string"},"type":{"type":"string"},"referer_uri":{"type":"string"},"ad_id":{"type":"string"},"ads_context_data":{"type":"object","properties":{"ad_title":{"type":"string"},"photo_url":{"type":"string"},"video_url":{"type":"string"},"post_id":{"type":"string"},"product_id":{"type":"string"},"flow_id":{"type":"string"}}}}},"sender":{"type":"object","required":["id"],"properties":{"id":{"type":"string"},"contactId":{"type":"string"}}},"conversation":{"$ref":"#/components/schemas/InboxWebhookConversation"},"account":{"$ref":"#/components/schemas/InboxWebhookAccount"},"timestamp":{"type":"string","format":"date-time"}}},"WebhookPayloadMessage":{"type":"object","required":["id","event","message","conversation","account","timestamp"],"properties":{"id":{"type":"string"},"profiles":{"$ref":"#/components/schemas/WebhookProfiles"},"test":{"type":"boolean"},"event":{"type":"string","enum":["message.received"]},"message":{"type":"object","required":["id","conversationId","platform","platformMessageId","direction","text","attachments","sender","sentAt","isRead"],"properties":{"id":{"type":"string"},"conversationId":{"type":"string"},"platform":{"type":"string","enum":["instagram","facebook","telegram","whatsapp","sms","rcs","twitter","bluesky","reddit","slack","tiktok","imessage"]},"platformMessageId":{"type":"string"},"direction":{"type":"string","enum":["incoming","outgoing"]},"text":{"type":["string","null"]},"attachments":{"type":"array","items":{"type":"object","required":["type","url"],"properties":{"type":{"type":"string"},"originalType":{"type":"string"},"mimeType":{"type":"string"},"url":{"type":"string"},"payload":{"type":"object","properties":{"voice":{"type":"boolean"}}}}}},"sender":{"type":"object","required":["id"],"properties":{"id":{"type":"string"},"contactId":{"type":"string"},"name":{"type":"string"},"username":{"type":"string"},"picture":{"type":"string"},"phoneNumber":{"type":["string","null"]},"businessScopedUserId":{"type":"string"},"parentBusinessScopedUserId":{"type":"string"},"whatsappUsername":{"type":"string"},"instagramProfile":{"type":"object","properties":{"isFollower":{"type":["boolean","null"]},"isFollowing":{"type":["boolean","null"]},"followerCount":{"type":["integer","null"]},"isVerified":{"type":["boolean","null"]}}}}},"sentAt":{"type":"string","format":"date-time"},"isRead":{"type":"boolean"},"sentVia":{"type":["string","null"],"enum":["human","api","broadcast","sequence","workflow","comment_automation","bulk-api",null]},"automationId":{"type":["string","null"]},"workflowId":{"type":["string","null"]},"executionId":{"type":["string","null"]},"broadcastId":{"type":["string","null"]},"sequenceId":{"type":["string","null"]}}},"conversation":{"$ref":"#/components/schemas/InboxWebhookConversation"},"account":{"$ref":"#/components/schemas/InboxWebhookAccount"},"metadata":{"type":["object","null"],"properties":{"standby":{"type":"boolean"},"quotedMessageId":{"type":"string"},"quotedMessage":{"type":"object","properties":{"messageId":{"type":"string"},"platformMessageId":{"type":"string"}}},"quickReplyPayload":{"type":"string"},"postbackPayload":{"type":"string"},"postbackTitle":{"type":"string"},"callbackData":{"type":"string"},"interactiveType":{"type":"string","enum":["button_reply","list_reply","nfm_reply"]},"interactiveId":{"type":"string"},"buttonPayload":{"type":"string"},"flowResponseJson":{"type":"string"},"flowResponseData":{"type":"object","additionalProperties":true},"nfmReplyName":{"type":"string"},"order":{"type":"object","properties":{"catalog_id":{"type":"string"},"text":{"type":"string"},"product_items":{"type":"array","items":{"type":"object","properties":{"product_retailer_id":{"type":"string"},"quantity":{"type":"integer"},"item_price":{"type":"number"},"currency":{"type":"string"}}}}}},"referredProduct":{"type":"object","properties":{"catalog_id":{"type":"string"},"product_retailer_id":{"type":"string"}}},"forwarded":{"type":"boolean"},"frequentlyForwarded":{"type":"boolean"},"location":{"type":"object","properties":{"latitude":{"type":"number"},"longitude":{"type":"number"},"name":{"type":"string"},"address":{"type":"string"}}},"contacts":{"type":"array","items":{"type":"object","additionalProperties":true}},"contactsOrigin":{"type":"string","enum":["contact_request","other"]},"storyReply":{"type":"object","required":["storyId"],"properties":{"storyId":{"type":"string"},"storyUrl":{"type":"string"}}},"isStoryMention":{"type":"boolean"},"referral":{"type":["object","null"],"properties":{"ctwa_clid":{"type":"string"},"source_id":{"type":"string"},"source_type":{"type":"string"},"source_url":{"type":"string"},"headline":{"type":"string"},"body":{"type":"string"},"media_type":{"type":"string"},"image_url":{"type":"string"},"video_url":{"type":"string"},"thumbnail_url":{"type":"string"},"welcome_message":{"type":"object","properties":{"text":{"type":"string"}}},"ad_id":{"type":"string"},"ref":{"type":"string"},"source":{"type":"string"},"type":{"type":"string"},"referer_uri":{"type":"string"},"ads_context_data":{"type":"object","properties":{"ad_title":{"type":"string"},"photo_url":{"type":"string"},"video_url":{"type":"string"},"post_id":{"type":"string"},"product_id":{"type":"string"},"flow_id":{"type":"string"}}}}},"ad":{"allOf":[{"$ref":"#/components/schemas/ConversationAdAttribution"}]},"unsupported":{"type":"object","properties":{"code":{"type":"integer"},"title":{"type":"string"},"details":{"type":"string"},"type":{"type":"string"}}},"noRenderableContent":{"type":"boolean"},"tiktokMessageType":{"type":"string"}}},"timestamp":{"type":"string","format":"date-time"}}},"WebhookPayloadMessageSent":{"type":"object","required":["id","event","message","conversation","account","timestamp"],"properties":{"id":{"type":"string"},"profiles":{"$ref":"#/components/schemas/WebhookProfiles"},"test":{"type":"boolean"},"event":{"type":"string","enum":["message.sent"]},"message":{"type":"object","required":["id","conversationId","platform","platformMessageId","direction","text","attachments","sender","sentAt","isRead"],"properties":{"id":{"type":"string"},"conversationId":{"type":"string"},"platform":{"type":"string","enum":["instagram","facebook","telegram","whatsapp","twitter","reddit","bluesky","slack","tiktok","imessage"]},"platformMessageId":{"type":"string"},"direction":{"type":"string","enum":["incoming","outgoing"]},"text":{"type":["string","null"]},"attachments":{"type":"array","items":{"type":"object","required":["type","url"],"properties":{"type":{"type":"string"},"originalType":{"type":"string"},"url":{"type":"string"},"payload":{"type":"object"}}}},"sender":{"type":"object","required":["id"],"properties":{"id":{"type":"string"},"contactId":{"type":"string"},"name":{"type":"string"},"username":{"type":"string"},"picture":{"type":"string"}}},"sentAt":{"type":"string","format":"date-time"},"isRead":{"type":"boolean"},"source":{"type":"string","enum":["whatsapp_business_app","cloud_api","meta_business_agent"]},"sentVia":{"type":["string","null"],"enum":["human","api","broadcast","sequence","workflow","comment_automation","bulk-api",null]},"automationId":{"type":["string","null"]},"workflowId":{"type":["string","null"]},"executionId":{"type":["string","null"]},"broadcastId":{"type":["string","null"]},"sequenceId":{"type":["string","null"]}}},"pricing":{"$ref":"#/components/schemas/WhatsAppMessagePricing"},"billingConversation":{"$ref":"#/components/schemas/WhatsAppBillingConversation"},"conversation":{"$ref":"#/components/schemas/InboxWebhookConversation"},"account":{"$ref":"#/components/schemas/InboxWebhookAccount"},"metadata":{"type":"object","properties":{"metaInteractive":{"type":"object","additionalProperties":true},"location":{"type":"object","properties":{"latitude":{"type":"number"},"longitude":{"type":"number"},"name":{"type":"string"},"address":{"type":"string"}}},"contacts":{"type":"array","items":{"type":"object","additionalProperties":true}},"quotedMessageId":{"type":"string"},"threadTs":{"type":"string"},"tiktokMessageType":{"type":"string"}}},"timestamp":{"type":"string","format":"date-time"}}},"InboxMessageEditAttachment":{"type":"object","properties":{"type":{"type":"string"},"url":{"type":"string"},"payload":{"type":"object"}}},"InboxMessageEditHistoryEntry":{"type":"object","required":["text","attachments","editedAt"],"properties":{"text":{"type":["string","null"]},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/InboxMessageEditAttachment"}},"editedAt":{"type":"string","format":"date-time"}}},"WebhookPayloadMessageEdited":{"type":"object","required":["id","event","message","editHistory","editCount","editedAt","conversation","account","timestamp"],"properties":{"test":{"type":"boolean"},"id":{"type":"string"},"profiles":{"$ref":"#/components/schemas/WebhookProfiles"},"event":{"type":"string","enum":["message.edited"]},"message":{"$ref":"#/components/schemas/InboxWebhookMessage"},"editHistory":{"type":"array","items":{"$ref":"#/components/schemas/InboxMessageEditHistoryEntry"}},"editCount":{"type":"integer"},"editedAt":{"type":"string","format":"date-time"},"conversation":{"$ref":"#/components/schemas/InboxWebhookConversation"},"account":{"$ref":"#/components/schemas/InboxWebhookAccount"},"timestamp":{"type":"string","format":"date-time"}}},"WebhookPayloadMessageDeleted":{"type":"object","required":["id","event","message","deletedAt","conversation","account","timestamp"],"properties":{"test":{"type":"boolean"},"id":{"type":"string"},"profiles":{"$ref":"#/components/schemas/WebhookProfiles"},"event":{"type":"string","enum":["message.deleted"]},"message":{"$ref":"#/components/schemas/InboxWebhookMessage"},"deletedAt":{"type":"string","format":"date-time"},"conversation":{"$ref":"#/components/schemas/InboxWebhookConversation"},"account":{"$ref":"#/components/schemas/InboxWebhookAccount"},"timestamp":{"type":"string","format":"date-time"}}},"WebhookPayloadMessageDeliveryStatus":{"type":"object","required":["id","event","message","statusAt","conversation","account","timestamp"],"properties":{"test":{"type":"boolean"},"id":{"type":"string"},"profiles":{"$ref":"#/components/schemas/WebhookProfiles"},"event":{"type":"string","enum":["message.delivered","message.read","message.played","message.failed"]},"message":{"$ref":"#/components/schemas/InboxWebhookMessage"},"statusAt":{"type":"string","format":"date-time"},"error":{"type":["object","null"],"properties":{"code":{"type":"integer"},"title":{"type":"string"},"message":{"type":"string"},"details":{"type":"string"},"href":{"type":"string","format":"uri"},"explanation":{"type":["string","null"]}}},"pricing":{"$ref":"#/components/schemas/WhatsAppMessagePricing"},"billingConversation":{"$ref":"#/components/schemas/WhatsAppBillingConversation"},"conversation":{"$ref":"#/components/schemas/InboxWebhookConversation"},"account":{"$ref":"#/components/schemas/InboxWebhookAccount"},"timestamp":{"type":"string","format":"date-time"}}},"WhatsAppMessagePricing":{"type":["object","null"],"required":["billable","pricingModel","category","type"],"properties":{"billable":{"type":["boolean","null"]},"pricingModel":{"type":["string","null"]},"category":{"type":["string","null"]},"type":{"type":["string","null"]}}},"WhatsAppBillingConversation":{"type":["object","null"],"required":["id","expiresAt","originType"],"properties":{"id":{"type":["string","null"]},"expiresAt":{"type":["string","null"],"format":"date-time"},"originType":{"type":["string","null"]}}},"WebhookPayloadConversationStarted":{"type":"object","required":["id","event","conversation","account","startedAt","timestamp"],"properties":{"test":{"type":"boolean"},"id":{"type":"string"},"profiles":{"$ref":"#/components/schemas/WebhookProfiles"},"event":{"type":"string","enum":["conversation.started"]},"conversation":{"allOf":[{"$ref":"#/components/schemas/InboxWebhookConversationDetail"},{"type":"object","required":["adAttribution"],"properties":{"metadata":{"$ref":"#/components/schemas/InboxConversationAdMetadata"},"adAttribution":{"$ref":"#/components/schemas/ConversationAdAttribution"}}}]},"account":{"$ref":"#/components/schemas/InboxWebhookAccount"},"startedAt":{"type":"string","format":"date-time"},"timestamp":{"type":"string","format":"date-time"}}},"MessengerGreeting":{"type":"object","required":["locale","text"],"properties":{"locale":{"type":"string"},"text":{"type":"string","minLength":1,"maxLength":160}}},"MessengerIceBreakerLocale":{"type":"object","required":["locale","call_to_actions"],"properties":{"locale":{"type":"string"},"call_to_actions":{"type":"array","minItems":1,"maxItems":4,"items":{"type":"object","required":["question","payload"],"properties":{"question":{"type":"string","minLength":1,"maxLength":80},"payload":{"type":"string","minLength":1,"maxLength":1000}}}}}},"WhatsAppConversationalAutomation":{"type":"object","properties":{"enable_welcome_message":{"type":"boolean"},"prompts":{"type":"array","maxItems":3,"items":{"type":"string","minLength":1,"maxLength":80}},"commands":{"type":"array","maxItems":30,"items":{"type":"object","required":["command_name","command_description"],"properties":{"command_name":{"type":"string","minLength":1,"maxLength":30,"pattern":"^[a-zA-Z0-9_]+$"},"command_description":{"type":"string","minLength":1,"maxLength":256}}}}}},"WebhookPayloadConversationControlChanged":{"type":"object","required":["id","event","conversation","account","control","changedAt","timestamp"],"properties":{"test":{"type":"boolean"},"id":{"type":"string"},"profiles":{"$ref":"#/components/schemas/WebhookProfiles"},"event":{"type":"string","enum":["conversation.control_changed"]},"conversation":{"$ref":"#/components/schemas/InboxWebhookConversationDetail"},"account":{"$ref":"#/components/schemas/InboxWebhookAccount"},"control":{"type":"object","required":["owner","previousOwner"],"properties":{"owner":{"type":"string","enum":["app","ai_agent","other"]},"previousOwner":{"type":["string","null"],"enum":["app","ai_agent","other",null]},"ownerAppId":{"type":"string"},"metadata":{"type":"string"}}},"changedAt":{"type":"string","format":"date-time"},"timestamp":{"type":"string","format":"date-time"}}},"CallRecord":{"type":"object","properties":{"_id":{"type":"string"},"accountId":{"type":"string"},"conversationId":{"type":["string","null"]},"contactId":{"type":["string","null"]},"channel":{"type":"string","enum":["whatsapp","pstn"]},"direction":{"type":"string","enum":["inbound","outbound"]},"from":{"type":"string"},"to":{"type":"string"},"forwardTo":{"type":["string","null"]},"greeting":{"type":["string","null"]},"status":{"type":"string","enum":["ringing","answered","ended","failed"]},"isVoicemail":{"type":"boolean"},"amd":{"type":"boolean"},"answeredMachine":{"type":["boolean","null"]},"forwardCallerId":{"type":"string","enum":["business","caller"]},"recordingEnabled":{"type":"boolean"},"transcriptionEnabled":{"type":"boolean"},"transcriptionLanguage":{"type":"string","enum":["auto","en","es"]},"startedAt":{"type":"string","format":"date-time"},"answeredAt":{"type":["string","null"],"format":"date-time"},"endedAt":{"type":["string","null"],"format":"date-time"},"transferredAt":{"type":["string","null"],"format":"date-time"},"durationSeconds":{"type":"integer"},"endReason":{"type":"string","enum":["hangup","no_answer","rejected","error"]},"hangupCause":{"type":["string","null"]},"sipHangupCause":{"type":["string","null"]},"callErrors":{"type":"array","items":{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"}}}},"recordingUrl":{"type":["string","null"]},"lastTranscriptSnippet":{"type":["string","null"]},"transcript":{"type":"array","items":{"type":"object","properties":{"text":{"type":"string"},"confidence":{"type":"number"},"at":{"type":"string","format":"date-time"}}}},"billing":{"type":"object","properties":{"metaMinutes":{"type":"number"},"carrierSeconds":{"type":"number"},"transcriptionSeconds":{"type":"number"},"transcriptionCostUSD":{"type":"number"},"metaCostUSD":{"type":"number"},"carrierCostUSD":{"type":"number"},"recordingCostUSD":{"type":"number"},"billableCostUSD":{"type":"number"},"totalCostUSD":{"type":"number"},"currency":{"type":"string"}}},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}}},"WebhookPayloadCallReceived":{"type":"object","required":["id","event","call","account","timestamp"],"properties":{"test":{"type":"boolean"},"id":{"type":"string"},"profiles":{"$ref":"#/components/schemas/WebhookProfiles"},"event":{"type":"string","enum":["call.received"]},"call":{"type":"object","properties":{"id":{"type":"string"},"metaCallId":{"type":["string","null"]},"accountId":{"type":"string"},"phoneNumberId":{"type":"string"},"direction":{"type":"string","enum":["inbound","outbound"]},"from":{"type":"string"},"to":{"type":"string"},"forwardTo":{"type":"string"},"contactId":{"type":"string"},"conversationId":{"type":"string"},"startedAt":{"type":"string","format":"date-time"}}},"account":{"$ref":"#/components/schemas/InboxWebhookAccount"},"timestamp":{"type":"string","format":"date-time"}}},"WebhookPayloadCallEnded":{"type":"object","required":["id","event","call","account","timestamp"],"properties":{"test":{"type":"boolean"},"id":{"type":"string"},"profiles":{"$ref":"#/components/schemas/WebhookProfiles"},"event":{"type":"string","enum":["call.ended"]},"call":{"type":"object","properties":{"id":{"type":"string"},"metaCallId":{"type":["string","null"]},"accountId":{"type":"string"},"phoneNumberId":{"type":"string"},"direction":{"type":"string","enum":["inbound","outbound"]},"from":{"type":"string"},"to":{"type":"string"},"startedAt":{"type":"string","format":"date-time"},"endedAt":{"type":"string","format":"date-time"},"durationSeconds":{"type":"integer"},"endReason":{"type":"string","enum":["hangup","no_answer","rejected","error"]},"hangupCause":{"type":["string","null"]},"sipHangupCause":{"type":["string","null"]},"isVoicemail":{"type":"boolean"},"callErrors":{"type":"array","items":{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"}}}},"recordingUrl":{"type":"string"},"recordingExpiresAt":{"type":"string","format":"date-time"},"billing":{"type":"object","properties":{"metaCostUSD":{"type":"number"},"carrierCostUSD":{"type":"number"},"recordingCostUSD":{"type":"number"},"billableCostUSD":{"type":"number"},"totalCostUSD":{"type":"number"}}}}},"account":{"$ref":"#/components/schemas/InboxWebhookAccount"},"timestamp":{"type":"string","format":"date-time"}}},"WebhookPayloadCallFailed":{"type":"object","required":["id","event","call","account","timestamp"],"properties":{"test":{"type":"boolean"},"id":{"type":"string"},"profiles":{"$ref":"#/components/schemas/WebhookProfiles"},"event":{"type":"string","enum":["call.failed"]},"call":{"type":"object","properties":{"id":{"type":"string"},"metaCallId":{"type":["string","null"]},"accountId":{"type":"string"},"phoneNumberId":{"type":"string"},"direction":{"type":"string","enum":["inbound","outbound"]},"from":{"type":"string"},"to":{"type":"string"},"failedAt":{"type":"string","format":"date-time"},"error":{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"}}}}},"account":{"$ref":"#/components/schemas/InboxWebhookAccount"},"timestamp":{"type":"string","format":"date-time"}}},"WebhookPayloadCallPermissionRequest":{"type":"object","required":["id","event","permission","account","timestamp"],"properties":{"test":{"type":"boolean"},"id":{"type":"string"},"profiles":{"$ref":"#/components/schemas/WebhookProfiles"},"event":{"type":"string","enum":["call.permission_request"]},"permission":{"type":"object","properties":{"from":{"type":"string"},"response":{"type":"string","enum":["accept","reject"]},"isPermanent":{"type":"boolean"},"expirationTimestamp":{"type":"string","format":"date-time"},"responseSource":{"type":"string"}}},"account":{"$ref":"#/components/schemas/InboxWebhookAccount"},"timestamp":{"type":"string","format":"date-time"}}},"WebhookPayloadAdVideoProcessed":{"type":"object","required":["id","event","account","video","timestamp"],"properties":{"id":{"type":"string"},"profiles":{"$ref":"#/components/schemas/WebhookProfiles"},"test":{"type":"boolean"},"event":{"type":"string","enum":["ad.video.processed"]},"account":{"type":"object","required":["accountId","profileId","platform","username"],"properties":{"accountId":{"type":"string"},"profileId":{"type":"string"},"platform":{"type":"string"},"username":{"type":"string"},"displayName":{"type":["string","null"]}}},"video":{"type":"object","required":["id","platformAdAccountId","status","error","thumbnailUrl"],"properties":{"id":{"type":"string"},"platformAdAccountId":{"type":"string"},"status":{"type":"string","enum":["ready","error"]},"error":{"type":["string","null"]},"thumbnailUrl":{"type":["string","null"]}}},"timestamp":{"type":"string","format":"date-time"}}},"WebhookPayloadAdReview":{"type":"object","required":["id","event","account","adObject","review","timestamp"],"properties":{"id":{"type":"string"},"profiles":{"$ref":"#/components/schemas/WebhookProfiles"},"test":{"type":"boolean"},"event":{"type":"string","enum":["ad.review.approved","ad.review.rejected"]},"account":{"$ref":"#/components/schemas/WebhookAdsAccount"},"adObject":{"type":"object","required":["level","platformId","platformAdAccountId","adId","name"],"properties":{"level":{"type":"string","enum":["AD"]},"platformId":{"type":"string"},"platformAdAccountId":{"type":"string"},"adId":{"type":"string"},"name":{"type":"string"}}},"review":{"type":"object","required":["status","raw","reasons"],"properties":{"status":{"type":"string","enum":["approved","rejected"]},"raw":{"type":"string"},"reasons":{"type":"array","items":{"type":"object","required":["message"],"properties":{"message":{"type":"string"}}}}}},"timestamp":{"type":"string","format":"date-time"}}},"WebhookPayloadAdDeliveryIssue":{"type":"object","required":["id","event","account","adObject","issue","timestamp"],"properties":{"id":{"type":"string"},"profiles":{"$ref":"#/components/schemas/WebhookProfiles"},"test":{"type":"boolean"},"event":{"type":"string","enum":["ad.delivery_issue"]},"account":{"$ref":"#/components/schemas/WebhookAdsAccount"},"adObject":{"type":"object","required":["level","platformId","platformAdAccountId","adId","name"],"properties":{"level":{"type":"string","enum":["AD"]},"platformId":{"type":"string"},"platformAdAccountId":{"type":"string"},"adId":{"type":"string"},"name":{"type":"string"}}},"issue":{"type":"object","required":["raw","reasons"],"properties":{"raw":{"type":"string"},"reasons":{"type":"array","items":{"type":"object","required":["message"],"properties":{"message":{"type":"string"}}}}}},"timestamp":{"type":"string","format":"date-time"}}},"WebhookPayloadCampaignBudgetDepleted":{"type":"object","required":["id","event","account","adObject","budget","timestamp"],"properties":{"id":{"type":"string"},"profiles":{"$ref":"#/components/schemas/WebhookProfiles"},"test":{"type":"boolean"},"event":{"type":"string","enum":["campaign.budget.depleted"]},"account":{"$ref":"#/components/schemas/WebhookAdsAccount"},"adObject":{"type":"object","required":["level","platformId","platformAdAccountId","name"],"properties":{"level":{"type":"string","enum":["CAMPAIGN"]},"platformId":{"type":"string"},"platformAdAccountId":{"type":"string"},"name":{"type":["string","null"]}}},"budget":{"type":"object","required":["raw"],"properties":{"raw":{"type":"string"}}},"timestamp":{"type":"string","format":"date-time"}}},"WebhookPayloadAdAccountStatusChanged":{"type":"object","required":["id","event","account","adAccount","status","timestamp"],"properties":{"id":{"type":"string"},"profiles":{"$ref":"#/components/schemas/WebhookProfiles"},"test":{"type":"boolean"},"event":{"type":"string","enum":["ad_account.status_changed"]},"account":{"$ref":"#/components/schemas/WebhookAdsAccount"},"adAccount":{"type":"object","required":["platformAdAccountId","name"],"properties":{"platformAdAccountId":{"type":"string"},"name":{"type":["string","null"]}}},"status":{"type":"object","required":["previous","current","raw"],"properties":{"previous":{"type":"string","enum":["active","restricted","disabled","closed"]},"current":{"type":"string","enum":["active","restricted","disabled","closed"]},"raw":{"type":"string"}}},"timestamp":{"type":"string","format":"date-time"}}},"WebhookPayloadAdRuleTriggered":{"type":"object","required":["id","event","account","rule","run","objects","timestamp"],"properties":{"id":{"type":"string"},"profiles":{"$ref":"#/components/schemas/WebhookProfiles"},"test":{"type":"boolean"},"event":{"type":"string","enum":["ad_rule.triggered"]},"account":{"$ref":"#/components/schemas/WebhookAdsAccount"},"rule":{"type":"object","required":["id","name","level","platformAdAccountId"],"properties":{"id":{"type":"string"},"name":{"type":"string"},"level":{"type":"string","enum":["campaign","adset","ad"]},"platformAdAccountId":{"type":"string"}}},"run":{"type":"object","required":["id","ranAt","today","timezone","timezoneAssumed","currency"],"properties":{"id":{"type":"string"},"ranAt":{"type":"string","format":"date-time"},"today":{"type":"string","format":"date"},"timezone":{"type":"string"},"timezoneAssumed":{"type":"boolean"},"currency":{"type":["string","null"]}}},"objects":{"type":"array","items":{"type":"object","required":["platformId","name","platformCampaignId","conditions","actions"],"properties":{"platformId":{"type":"string"},"name":{"type":"string"},"platformCampaignId":{"type":["string","null"]},"conditions":{"type":"array","items":{"type":"object","required":["metric","window","op","value","actual"],"properties":{"metric":{"type":"string"},"window":{"type":"string"},"op":{"type":"string","enum":[">",">=","<","<="]},"value":{"type":"number"},"actual":{"type":["number","null"]}}}},"actions":{"type":"array","items":{"type":"object","required":["type","status","reason","previousDailyBudget","newDailyBudget"],"properties":{"type":{"type":"string","enum":["pause","activate","adjust_budget"]},"status":{"type":"string","enum":["done","skipped","failed"]},"reason":{"type":["string","null"]},"previousDailyBudget":{"type":["number","null"]},"newDailyBudget":{"type":["number","null"]}}}}}}},"timestamp":{"type":"string","format":"date-time"}}},"WebhookAdsAccount":{"type":"object","required":["accountId","profileId","platform","username"],"properties":{"accountId":{"type":"string"},"profileId":{"type":"string"},"platform":{"type":"string"},"username":{"type":"string"},"displayName":{"type":["string","null"]}}},"WebhookPayloadAdStatusChanged":{"type":"object","required":["id","event","account","adObject","status","timestamp"],"properties":{"id":{"type":"string"},"profiles":{"$ref":"#/components/schemas/WebhookProfiles"},"test":{"type":"boolean"},"event":{"type":"string","enum":["ad.status_changed"]},"account":{"type":"object","required":["accountId","profileId","platform","username"],"properties":{"accountId":{"type":"string"},"profileId":{"type":"string"},"platform":{"type":"string"},"username":{"type":"string"},"displayName":{"type":"string"}}},"adObject":{"type":"object","required":["level","platformId","platformAdAccountId"],"properties":{"level":{"type":"string","enum":["CAMPAIGN","AD_SET","AD"]},"platformId":{"type":"string"},"platformAdAccountId":{"type":"string"}}},"status":{"type":"object","required":["raw"],"properties":{"raw":{"type":"string"}}},"error":{"type":"object","required":["code"],"properties":{"code":{"type":"string"},"summary":{"type":"string"},"message":{"type":"string"}}},"timestamp":{"type":"string","format":"date-time"}}},"WebhookPayloadWhatsAppTemplateStatusUpdated":{"type":"object","required":["id","event","account","template","timestamp"],"properties":{"id":{"type":"string"},"profiles":{"$ref":"#/components/schemas/WebhookProfiles"},"test":{"type":"boolean"},"event":{"type":"string","enum":["whatsapp.template.status_updated"]},"account":{"type":"object","required":["accountId","profileId","platform","username"],"properties":{"accountId":{"type":"string"},"profileId":{"type":"string"},"platform":{"type":"string","enum":["whatsapp"]},"username":{"type":"string"},"displayName":{"type":"string"}}},"template":{"type":"object","required":["templateId","name","language","status","reason"],"properties":{"templateId":{"type":"string"},"name":{"type":"string"},"language":{"type":"string"},"status":{"type":"string","enum":["APPROVED","REJECTED","PENDING","PAUSED","DISABLED","IN_APPEAL","PENDING_DELETION"]},"reason":{"type":"string"}}},"timestamp":{"type":"string","format":"date-time"}}},"WebhookPayloadWhatsAppTemplateCategoryUpdated":{"type":"object","required":["id","event","account","template","timestamp"],"properties":{"id":{"type":"string"},"profiles":{"$ref":"#/components/schemas/WebhookProfiles"},"test":{"type":"boolean"},"event":{"type":"string","enum":["whatsapp.template.category_updated"]},"account":{"type":"object","required":["accountId","profileId","platform","username"],"properties":{"accountId":{"type":"string"},"profileId":{"type":"string"},"platform":{"type":"string","enum":["whatsapp"]},"username":{"type":"string"},"displayName":{"type":"string"}}},"template":{"type":"object","required":["templateId","name","language","changeType","category"],"properties":{"templateId":{"type":"string"},"name":{"type":"string"},"language":{"type":"string"},"changeType":{"type":"string","enum":["scheduled","applied"]},"category":{"type":"string","enum":["UTILITY","MARKETING","AUTHENTICATION"]},"previousCategory":{"type":"string","enum":["UTILITY","MARKETING","AUTHENTICATION"]},"scheduledCategory":{"type":"string","enum":["UTILITY","MARKETING","AUTHENTICATION"]},"effectiveAt":{"type":"string","format":"date-time"}}},"timestamp":{"type":"string","format":"date-time"}}},"WebhookPayloadWhatsAppAccountNameStatusUpdated":{"type":"object","required":["id","event","account","name","timestamp"],"properties":{"id":{"type":"string"},"profiles":{"$ref":"#/components/schemas/WebhookProfiles"},"test":{"type":"boolean"},"event":{"type":"string","enum":["whatsapp.account.name_status_updated"]},"account":{"type":"object","required":["accountId","profileId","platform","username"],"properties":{"accountId":{"type":"string"},"profileId":{"type":"string"},"platform":{"type":"string","enum":["whatsapp"]},"username":{"type":"string"},"displayName":{"type":"string"}}},"name":{"type":"object","required":["status","requestedName","rejectionReason","displayPhoneNumber"],"properties":{"status":{"type":"string","enum":["APPROVED","DECLINED","PENDING_REVIEW"]},"requestedName":{"type":["string","null"]},"rejectionReason":{"type":["string","null"]},"displayPhoneNumber":{"type":["string","null"]}}},"timestamp":{"type":"string","format":"date-time"}}},"WebhookPayloadWhatsAppAccountQualityUpdated":{"type":"object","required":["id","event","account","quality","timestamp"],"properties":{"id":{"type":"string"},"profiles":{"$ref":"#/components/schemas/WebhookProfiles"},"test":{"type":"boolean"},"event":{"type":"string","enum":["whatsapp.account.quality_updated"]},"account":{"type":"object","required":["accountId","profileId","platform","username"],"properties":{"accountId":{"type":"string"},"profileId":{"type":"string"},"platform":{"type":"string","enum":["whatsapp"]},"username":{"type":"string"},"displayName":{"type":["string","null"]}}},"quality":{"type":"object","required":["source","metaEvent","qualityRating","previousQualityRating","messagingLimitTier","previousMessagingLimitTier","displayPhoneNumber"],"properties":{"source":{"type":"string","enum":["phone_number_quality_update","business_capability_update"]},"metaEvent":{"type":["string","null"]},"qualityRating":{"type":["string","null"]},"previousQualityRating":{"type":["string","null"]},"messagingLimitTier":{"type":["string","null"]},"previousMessagingLimitTier":{"type":["string","null"]},"displayPhoneNumber":{"type":["string","null"]}}},"timestamp":{"type":"string","format":"date-time"}}},"WebhookPayloadWhatsAppAccountStatusUpdated":{"type":"object","required":["id","event","account","status","timestamp"],"properties":{"id":{"type":"string"},"profiles":{"$ref":"#/components/schemas/WebhookProfiles"},"test":{"type":"boolean"},"event":{"type":"string","enum":["whatsapp.account.status_updated"]},"account":{"type":"object","required":["accountId","profileId","platform","username"],"properties":{"accountId":{"type":"string"},"profileId":{"type":"string"},"platform":{"type":"string","enum":["whatsapp"]},"username":{"type":"string"},"displayName":{"type":["string","null"]}}},"status":{"type":"object","required":["status","metaEvent","reason","violationType","restrictions","banState","banDate"],"properties":{"status":{"type":"string","enum":["restricted","active"]},"metaEvent":{"type":"string"},"reason":{"type":["string","null"]},"violationType":{"type":["string","null"]},"restrictions":{"type":"array","items":{"type":"object","required":["type","expiresAt"],"properties":{"type":{"type":"string"},"expiresAt":{"type":["string","null"]}}}},"banState":{"type":["string","null"]},"banDate":{"type":["string","null"]}}},"timestamp":{"type":"string","format":"date-time"}}},"WebhookPayloadWhatsAppAccountAlertReceived":{"type":"object","required":["id","event","account","alert","timestamp"],"properties":{"id":{"type":"string"},"profiles":{"$ref":"#/components/schemas/WebhookProfiles"},"test":{"type":"boolean"},"event":{"type":"string","enum":["whatsapp.account.alert_received"]},"account":{"type":"object","required":["accountId","profileId","platform","username"],"properties":{"accountId":{"type":"string"},"profileId":{"type":"string"},"platform":{"type":"string","enum":["whatsapp"]},"username":{"type":"string"},"displayName":{"type":["string","null"]}}},"alert":{"type":"object","required":["entityType","entityId","severity","status","type","description"],"properties":{"entityType":{"type":["string","null"]},"entityId":{"type":["string","null"]},"severity":{"type":["string","null"]},"status":{"type":["string","null"]},"type":{"type":["string","null"]},"description":{"type":["string","null"]}}},"timestamp":{"type":"string","format":"date-time"}}},"WhatsAppContactIdentity":{"type":"object","required":["phoneNumber","businessScopedUserId","parentBusinessScopedUserId","whatsappUsername"],"properties":{"phoneNumber":{"type":["string","null"]},"businessScopedUserId":{"type":["string","null"]},"parentBusinessScopedUserId":{"type":["string","null"]},"whatsappUsername":{"type":["string","null"]}}},"WebhookPayloadWhatsAppContactIdentityChanged":{"type":"object","required":["id","event","account","reason","previous","current","contactId","conversationId","changedAt","timestamp"],"properties":{"id":{"type":"string"},"profiles":{"$ref":"#/components/schemas/WebhookProfiles"},"test":{"type":"boolean"},"event":{"type":"string","enum":["whatsapp.contact.identity_changed"]},"account":{"type":"object","required":["accountId","profileId","platform","username"],"properties":{"accountId":{"type":"string"},"profileId":{"type":"string"},"platform":{"type":"string","enum":["whatsapp"]},"username":{"type":"string"},"displayName":{"type":["string","null"]}}},"reason":{"type":"string","enum":["user_changed_number","user_changed_user_id","user_identity_changed","user_id_update"]},"previous":{"$ref":"#/components/schemas/WhatsAppContactIdentity"},"current":{"$ref":"#/components/schemas/WhatsAppContactIdentity"},"contactId":{"type":["string","null"]},"conversationId":{"type":["string","null"]},"changedAt":{"type":"string","format":"date-time"},"timestamp":{"type":"string","format":"date-time"}}},"ApiChangelogOperationRef":{"type":"object","required":["method","path"],"properties":{"method":{"type":"string"},"path":{"type":"string"},"operationId":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}},"xPlatforms":{"type":"array","items":{"type":"string"}}}},"ApiChangelogEntry":{"type":"object","required":["id","type","impact","platforms","title","summary","message","publishedAt","specVersion","url","changes"],"properties":{"id":{"type":"string"},"type":{"type":"string","enum":["new_feature","breaking_change","improvement","deprecation","minor"]},"impact":{"type":["string","null"],"enum":["none","additive","action_required",null]},"platforms":{"type":"array","items":{"type":"string"}},"title":{"type":["string","null"]},"summary":{"type":["string","null"]},"message":{"type":"string"},"publishedAt":{"type":"string","format":"date-time"},"specVersion":{"type":["string","null"]},"url":{"type":"string","format":"uri"},"changes":{"type":"object","required":["endpoints","schemas"],"properties":{"endpoints":{"type":"object","required":["added","removed","modified"],"properties":{"added":{"type":"array","items":{"$ref":"#/components/schemas/ApiChangelogOperationRef"}},"removed":{"type":"array","items":{"$ref":"#/components/schemas/ApiChangelogOperationRef"}},"modified":{"type":"array","items":{"$ref":"#/components/schemas/ApiChangelogOperationRef"}}}},"schemas":{"type":"object","required":["added","removed","modified"],"properties":{"added":{"type":"array","items":{"type":"string"}},"removed":{"type":"array","items":{"type":"string"}},"modified":{"type":"array","items":{"type":"string"}}}}}}}},"WebhookPayloadApiChangelogPublished":{"type":"object","required":["id","event","entry","timestamp"],"properties":{"id":{"type":"string"},"test":{"type":"boolean"},"event":{"type":"string","enum":["api.changelog.published"]},"entry":{"$ref":"#/components/schemas/ApiChangelogEntry"},"timestamp":{"type":"string","format":"date-time"}}},"WebhookPayloadTest":{"type":"object","required":["id","event","message","timestamp"],"properties":{"id":{"type":"string"},"event":{"type":"string","enum":["webhook.test"]},"message":{"type":"string"},"timestamp":{"type":"string","format":"date-time"}}},"DiscordGuildMember":{"type":"object","properties":{"user":{"type":"object","properties":{"id":{"type":"string"},"username":{"type":"string"},"discriminator":{"type":"string"},"avatar":{"type":["string","null"]},"global_name":{"type":["string","null"]}}},"nick":{"type":["string","null"]},"roles":{"type":"array","items":{"type":"string"}},"joined_at":{"type":"string","format":"date-time"},"premium_since":{"type":["string","null"],"format":"date-time"}}},"DiscordRole":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"color":{"type":"integer"},"position":{"type":"integer"},"permissions":{"type":"string"},"managed":{"type":"boolean"},"mentionable":{"type":"boolean"},"hoist":{"type":"boolean"}}},"GeoRestriction":{"type":"object","properties":{"countries":{"type":"array","minItems":1,"maxItems":25,"items":{"type":"string","pattern":"^[A-Z]{2}$"}}},"required":["countries"]},"MediaItem":{"type":"object","properties":{"type":{"type":"string","enum":["image","video","gif","document"]},"url":{"type":"string","format":"uri"},"fileId":{"type":"string"},"accountId":{"type":"string"},"title":{"type":"string"},"altText":{"type":"string"},"filename":{"type":"string"},"size":{"type":"integer"},"mimeType":{"type":"string"},"thumbnail":{"type":"string","format":"uri"},"instagramThumbnail":{"type":"string","format":"uri"},"subtitles":{"type":"array","maxItems":20,"items":{"$ref":"#/components/schemas/MediaSubtitle"}},"tiktokProcessed":{"type":"boolean"}}},"MediaSubtitle":{"type":"object","required":["url","language"],"properties":{"url":{"type":"string","format":"uri"},"language":{"type":"string"}}},"ExternalPostMediaItem":{"type":"object","required":["type","url"],"properties":{"type":{"type":"string","enum":["image","video"]},"url":{"type":["string","null"]},"thumbnail":{"type":"string"},"mediaStatus":{"type":"string","enum":["available","unavailable"]},"unavailableReason":{"type":"string","enum":["platform_withheld"]}}},"MediaContentType":{"type":"string","enum":["image/jpeg","image/jpg","image/png","image/webp","image/gif","video/mp4","video/mpeg","video/quicktime","video/avi","video/x-msvideo","video/webm","video/x-m4v","application/pdf","audio/mpeg","audio/mp4","audio/aac","audio/ogg","audio/wav","audio/webm","audio/x-m4a","application/x-subrip","text/vtt"]},"PlatformTarget":{"type":"object","properties":{"platform":{"type":"string"},"accountId":{"oneOf":[{"type":"string"},{"$ref":"#/components/schemas/SocialAccount"}]},"customContent":{"type":"string"},"customMedia":{"type":"array","items":{"$ref":"#/components/schemas/MediaItem"}},"scheduledFor":{"type":"string","format":"date-time"},"platformSpecificData":{"type":"object","additionalProperties":true},"status":{"type":"string"},"platformPostId":{"type":"string"},"platformPostUrl":{"type":["string","null"]},"publishedAt":{"type":"string","format":"date-time"},"removedFromPlatformAt":{"type":["string","null"],"format":"date-time"},"isTrialReel":{"type":"boolean"},"trialGraduationStrategy":{"type":"string","enum":["MANUAL","SS_PERFORMANCE"]},"publishAttempts":{"type":"integer"},"publishRetries":{"type":"integer"},"errorMessage":{"type":"string"},"errorCategory":{"type":"string","enum":["auth_expired","user_content","user_abuse","account_issue","platform_rejected","platform_error","platform_rate_limit","quota_exhausted","system_error","unknown"]},"errorSource":{"type":"string","enum":["user","platform","system"]},"platformError":{"$ref":"#/components/schemas/PostPlatformError"}}},"PostPlatformError":{"type":"object","required":["message"],"properties":{"code":{"type":"integer"},"subcode":{"type":"integer"},"message":{"type":"string"}}},"Post":{"type":"object","properties":{"_id":{"type":"string"},"userId":{"oneOf":[{"type":"string"},{"$ref":"#/components/schemas/User"}]},"title":{"type":"string"},"content":{"type":"string"},"mediaItems":{"type":"array","items":{"$ref":"#/components/schemas/MediaItem"}},"platforms":{"type":"array","items":{"$ref":"#/components/schemas/PlatformTarget"}},"scheduledFor":{"type":"string","format":"date-time"},"timezone":{"type":"string"},"status":{"type":"string","enum":["draft","pending_approval","scheduled","publishing","published","partial","failed","cancelled"]},"tags":{"type":"array","items":{"type":"string"}},"hashtags":{"type":"array","items":{"type":"string"}},"mentions":{"type":"array","items":{"type":"string"}},"visibility":{"type":"string","enum":["public","private","unlisted"]},"metadata":{"type":"object","additionalProperties":true},"recycling":{"$ref":"#/components/schemas/RecyclingState"},"recycledFromPostId":{"type":"string"},"queuedFromProfile":{"type":"string"},"queueId":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}}},"RecyclingConfig":{"type":"object","properties":{"enabled":{"type":"boolean","default":true},"gap":{"type":"integer","minimum":1},"gapFreq":{"type":"string","enum":["week","month"],"default":"month"},"startDate":{"type":"string","format":"date-time"},"expireCount":{"type":["integer","null"],"minimum":1},"expireDate":{"type":["string","null"],"format":"date-time"},"contentVariations":{"type":"array","items":{"type":"string"},"maxItems":20}}},"RecyclingState":{"type":"object","properties":{"enabled":{"type":"boolean"},"gap":{"type":"integer"},"gapFreq":{"type":"string","enum":["week","month"]},"startDate":{"type":"string","format":"date-time"},"expireCount":{"type":"integer"},"expireDate":{"type":"string","format":"date-time"},"contentVariations":{"type":"array","items":{"type":"string"}},"contentVariationIndex":{"type":"integer"},"recycleCount":{"type":"integer"},"nextRecycleAt":{"type":"string","format":"date-time"},"lastRecycledAt":{"type":"string","format":"date-time"}}},"XArticleTextRange":{"type":"object","additionalProperties":false,"required":["from_index","to_index","text"],"properties":{"from_index":{"type":"integer","minimum":0},"to_index":{"type":"integer","minimum":0},"text":{"type":"string"}}},"XArticleInlineStyleRange":{"type":"object","additionalProperties":false,"required":["offset","length","style"],"properties":{"offset":{"type":"integer","minimum":0},"length":{"type":"integer","minimum":0},"style":{"type":"string","enum":["bold","italic","strikethrough"]}}},"XArticleEntityRange":{"type":"object","additionalProperties":false,"required":["key","offset","length"],"properties":{"key":{"type":"integer","minimum":0},"offset":{"type":"integer","minimum":0},"length":{"type":"integer","minimum":0}}},"XArticleBlock":{"type":"object","additionalProperties":false,"required":["type","text"],"properties":{"type":{"type":"string","enum":["unstyled","header-one","header-two","header-three","unordered-list-item","ordered-list-item","blockquote","atomic"]},"text":{"type":"string"},"key":{"type":"string","minLength":1},"data":{"type":"object","additionalProperties":false,"properties":{"cashtags":{"type":"array","items":{"$ref":"#/components/schemas/XArticleTextRange"}},"hashtags":{"type":"array","items":{"$ref":"#/components/schemas/XArticleTextRange"}},"mentions":{"type":"array","items":{"$ref":"#/components/schemas/XArticleTextRange"}},"urls":{"type":"array","items":{"$ref":"#/components/schemas/XArticleTextRange"}}}},"inline_style_ranges":{"type":"array","items":{"$ref":"#/components/schemas/XArticleInlineStyleRange"}},"entity_ranges":{"type":"array","items":{"$ref":"#/components/schemas/XArticleEntityRange"}}}},"XArticleEntity":{"oneOf":[{"type":"object","additionalProperties":false,"required":["key","value"],"properties":{"key":{"type":"string","minLength":1},"value":{"type":"object","additionalProperties":false,"required":["type","mutability","data"],"properties":{"type":{"type":"string","const":"post"},"mutability":{"type":"string","enum":["immutable","mutable","segmented"]},"data":{"type":"object","additionalProperties":false,"required":["post_id"],"properties":{"post_id":{"type":"string","minLength":1}}}}}}},{"type":"object","additionalProperties":false,"required":["key","value"],"properties":{"key":{"type":"string","minLength":1},"value":{"type":"object","additionalProperties":false,"required":["type","mutability","data"],"properties":{"type":{"type":"string","const":"link"},"mutability":{"type":"string","enum":["immutable","mutable","segmented"]},"data":{"type":"object","additionalProperties":false,"required":["url"],"properties":{"url":{"type":"string","format":"uri"}}}}}}},{"type":"object","additionalProperties":false,"required":["key","value"],"properties":{"key":{"type":"string","minLength":1},"value":{"type":"object","additionalProperties":false,"required":["type","mutability","data"],"properties":{"type":{"type":"string","const":"image"},"mutability":{"type":"string","enum":["immutable","mutable","segmented"]},"data":{"type":"object","additionalProperties":false,"required":["url"],"properties":{"url":{"type":"string","format":"uri","pattern":"^https?://.+\\.(?:[jJ][pP][eE]?[gG]|[pP][nN][gG]|[wW][eE][bB][pP]|[gG][iI][fF]|[mM][pP]4)(?:[?#].*)?$"},"caption":{"type":"string"},"altText":{"type":"string","maxLength":1000}}}}}}},{"type":"object","additionalProperties":false,"required":["key","value"],"properties":{"key":{"type":"string","minLength":1},"value":{"type":"object","additionalProperties":false,"required":["type","mutability","data"],"properties":{"type":{"type":"string","const":"emoji"},"mutability":{"type":"string","enum":["immutable","mutable","segmented"]},"data":{"type":"object","additionalProperties":false,"required":["entity_key"],"properties":{"entity_key":{"type":"string","minLength":1}}}}}}},{"type":"object","additionalProperties":false,"required":["key","value"],"properties":{"key":{"type":"string","minLength":1},"value":{"type":"object","additionalProperties":false,"required":["type","mutability","data"],"properties":{"type":{"type":"string","const":"markdown"},"mutability":{"type":"string","enum":["immutable","mutable","segmented"]},"data":{"type":"object","additionalProperties":false,"required":["markdown"],"properties":{"markdown":{"type":"string"}}}}}}},{"type":"object","additionalProperties":false,"required":["key","value"],"properties":{"key":{"type":"string","minLength":1},"value":{"type":"object","additionalProperties":false,"required":["type","mutability","data"],"properties":{"type":{"type":"string","enum":["divider","latex"]},"mutability":{"type":"string","enum":["immutable","mutable","segmented"]},"data":{"type":"object","additionalProperties":false}}}}}]},"XArticleContentState":{"type":"object","additionalProperties":false,"required":["blocks","entities"],"properties":{"blocks":{"type":"array","minItems":1,"items":{"$ref":"#/components/schemas/XArticleBlock"}},"entities":{"type":"array","items":{"$ref":"#/components/schemas/XArticleEntity"}}}},"XArticle":{"type":"object","additionalProperties":false,"required":["title","content_state"],"properties":{"title":{"type":"string","minLength":1},"content_state":{"$ref":"#/components/schemas/XArticleContentState"},"mode":{"type":"string","enum":["publish","draft"],"default":"publish"},"cover":{"type":"object","additionalProperties":false,"required":["url"],"properties":{"url":{"type":"string","format":"uri","pattern":"^https?://.+\\.(?:[jJ][pP][eE]?[gG]|[pP][nN][gG]|[wW][eE][bB][pP])(?:[?#].*)?$"},"altText":{"type":"string","maxLength":1000}}}}},"TwitterPlatformData":{"type":"object","properties":{"article":{"$ref":"#/components/schemas/XArticle"},"replyToTweetId":{"type":"string"},"quoteTweetId":{"type":"string"},"replySettings":{"type":"string","enum":["following","mentionedUsers","subscribers","verified"]},"threadItems":{"type":"array","items":{"type":"object","properties":{"content":{"type":"string"},"mediaItems":{"type":"array","items":{"$ref":"#/components/schemas/MediaItem"}}}}},"poll":{"type":"object","properties":{"options":{"type":"array","minItems":2,"maxItems":4,"items":{"type":"string","minLength":1,"maxLength":25}},"duration_minutes":{"type":"integer","minimum":5,"maximum":10080}},"required":["options","duration_minutes"]},"longVideo":{"type":"boolean","default":false},"geoRestriction":{"$ref":"#/components/schemas/GeoRestriction"},"paidPartnership":{"type":"boolean","default":false},"madeWithAi":{"type":"boolean","default":false},"sensitiveMedia":{"type":"object","properties":{"adultContent":{"type":"boolean"},"graphicViolence":{"type":"boolean"},"other":{"type":"boolean"}}},"mediaTaggedUsers":{"type":"array","maxItems":10,"items":{"type":"string","pattern":"^@?\\w{1,15}$"}}}},"ThreadsPlatformData":{"type":"object","properties":{"topic_tag":{"type":"string","minLength":1,"maxLength":50},"firstComment":{"type":"string","maxLength":500},"threadItems":{"type":"array","items":{"type":"object","properties":{"content":{"type":"string"},"mediaItems":{"type":"array","items":{"$ref":"#/components/schemas/MediaItem"}}}}}}},"FacebookPlatformData":{"type":"object","properties":{"contentType":{"type":"string","enum":["story","reel"]},"title":{"type":"string"},"firstComment":{"type":"string"},"pageId":{"type":"string"},"geoRestriction":{"$ref":"#/components/schemas/GeoRestriction"},"facebookSettings":{"$ref":"#/components/schemas/FacebookSettings"}}},"FacebookSettings":{"type":"object","properties":{"draft":{"type":"boolean","default":false},"carouselCards":{"type":"array","minItems":2,"maxItems":10,"items":{"type":"object","required":["link"],"properties":{"link":{"type":"string","format":"uri"},"name":{"type":"string","maxLength":255},"description":{"type":"string","maxLength":255}}}},"carouselLink":{"type":"string","format":"uri"},"textFormatPresetId":{"type":"string","pattern":"^\\d+$"}}},"InstagramPlatformData":{"type":"object","properties":{"contentType":{"type":"string","enum":["story"]},"shareToFeed":{"type":"boolean","default":true},"collaborators":{"type":"array","items":{"type":"string"}},"droppedCollaborators":{"type":"array","readOnly":true,"items":{"type":"object","required":["username","reason"],"properties":{"username":{"type":"string"},"reason":{"type":"string"}}}},"firstComment":{"type":"string"},"trialParams":{"type":"object","properties":{"graduationStrategy":{"type":"string","enum":["MANUAL","SS_PERFORMANCE"]}}},"userTags":{"type":"array","items":{"type":"object","required":["username"],"properties":{"username":{"type":"string"},"x":{"type":"number","minimum":0,"maximum":1},"y":{"type":"number","minimum":0,"maximum":1},"mediaIndex":{"type":"integer","minimum":0}}}},"audioName":{"type":"string"},"audioConfiguration":{"type":"object","required":["audioId"],"properties":{"audioId":{"type":"string"},"audioVolume":{"type":"integer","minimum":0,"maximum":100},"videoVolume":{"type":"integer","minimum":0,"maximum":100}}},"muteAudio":{"type":"boolean","default":false},"thumbOffset":{"type":"integer","minimum":0},"instagramThumbnail":{"type":"string","format":"uri"},"reelCover":{"type":"string","format":"uri"},"isAiGenerated":{"type":"boolean","default":false},"isPaidPartnership":{"type":"boolean","default":false},"brandedContentSponsors":{"type":"array","maxItems":2,"items":{"type":"string"}},"commentsEnabled":{"type":"boolean","default":true},"locationId":{"type":"string","pattern":"^[0-9]+$"}}},"InstagramMediaCollaborator":{"type":"object","required":["id","username","inviteStatus"],"properties":{"id":{"type":"string"},"username":{"type":["string","null"]},"inviteStatus":{"type":["string","null"]}}},"InstagramLiveMedia":{"type":"object","required":["id","mediaType","mediaProductType","username","timestamp"],"properties":{"id":{"type":"string"},"mediaType":{"type":["string","null"]},"mediaProductType":{"type":["string","null"]},"username":{"type":["string","null"]},"timestamp":{"type":["string","null"]}}},"FacebookVisitorPost":{"type":"object","required":["id","message","createdTime","from","permalinkUrl","media"],"properties":{"id":{"type":"string"},"message":{"type":["string","null"]},"createdTime":{"type":["string","null"]},"from":{"type":["object","null"],"required":["id","name"],"properties":{"id":{"type":"string"},"name":{"type":["string","null"]}}},"permalinkUrl":{"type":["string","null"]},"media":{"type":["object","null"],"required":["mediaType","thumbnailUrl","mediaItems"],"properties":{"mediaType":{"type":"string","enum":["image","video","carousel","text"]},"thumbnailUrl":{"type":"string"},"mediaItems":{"type":"array","items":{"type":"object","required":["type","url"],"properties":{"type":{"type":"string","enum":["image","video"]},"url":{"type":"string"},"thumbnail":{"type":"string"}}}}}}}},"FacebookTaggedPost":{"type":"object","required":["id","message","createdTime","taggedTime","permalinkUrl","pictureUrl","from"],"properties":{"id":{"type":"string"},"message":{"type":["string","null"]},"createdTime":{"type":["string","null"]},"taggedTime":{"type":["string","null"]},"permalinkUrl":{"type":["string","null"]},"pictureUrl":{"type":["string","null"]},"from":{"type":["object","null"],"required":["id","name"],"properties":{"id":{"type":"string"},"name":{"type":["string","null"]}}}}},"FacebookPageInfo":{"type":"object","required":["about","description","website","phone","emails","hours"],"properties":{"about":{"type":["string","null"]},"description":{"type":["string","null"]},"website":{"type":["string","null"]},"phone":{"type":["string","null"]},"emails":{"type":"array","items":{"type":"string"}},"hours":{"type":"object","additionalProperties":{"type":"string"}}}},"InstagramTaggedMedia":{"type":"object","required":["id","caption","mediaType","mediaProductType","mediaUrl","thumbnailUrl","permalink","timestamp","username","likeCount","commentsCount"],"properties":{"id":{"type":"string"},"caption":{"type":["string","null"]},"mediaType":{"type":["string","null"]},"mediaProductType":{"type":["string","null"]},"mediaUrl":{"type":["string","null"]},"thumbnailUrl":{"type":["string","null"]},"permalink":{"type":["string","null"]},"timestamp":{"type":["string","null"]},"username":{"type":["string","null"]},"likeCount":{"type":["integer","null"]},"commentsCount":{"type":["integer","null"]}}},"InstagramMentionedMedia":{"type":"object","required":["id","caption","mediaType","mediaUrl","timestamp","username","likeCount","commentsCount"],"properties":{"id":{"type":"string"},"caption":{"type":["string","null"]},"mediaType":{"type":["string","null"]},"mediaUrl":{"type":["string","null"]},"timestamp":{"type":["string","null"]},"username":{"type":["string","null"]},"likeCount":{"type":["integer","null"]},"commentsCount":{"type":["integer","null"]}}},"InstagramMentionedComment":{"type":"object","required":["id","text","timestamp","likeCount","media"],"properties":{"id":{"type":"string"},"text":{"type":["string","null"]},"timestamp":{"type":["string","null"]},"likeCount":{"type":["integer","null"]},"media":{"type":["object","null"],"required":["id"],"properties":{"id":{"type":"string"}}}}},"InstagramBusinessDiscovery":{"type":"object","required":["profile","media"],"properties":{"profile":{"type":"object","required":["id","username"],"properties":{"id":{"type":"string"},"username":{"type":"string"},"name":{"type":["string","null"]},"biography":{"type":["string","null"]},"website":{"type":["string","null"]},"profilePictureUrl":{"type":["string","null"]},"followersCount":{"type":["integer","null"]},"followsCount":{"type":["integer","null"]},"mediaCount":{"type":["integer","null"]}}},"media":{"type":"array","items":{"type":"object","required":["id","caption","mediaType","mediaProductType","timestamp","permalink","likeCount","commentsCount","mediaUrl","thumbnailUrl","viewCount","children"],"properties":{"id":{"type":"string"},"caption":{"type":["string","null"]},"mediaType":{"type":["string","null"]},"mediaProductType":{"type":["string","null"]},"timestamp":{"type":["string","null"],"format":"date-time"},"permalink":{"type":["string","null"]},"likeCount":{"type":["integer","null"]},"commentsCount":{"type":["integer","null"]},"mediaUrl":{"type":["string","null"]},"thumbnailUrl":{"type":["string","null"]},"viewCount":{"type":["integer","null"]},"children":{"type":["array","null"],"items":{"type":"object","required":["id","mediaType","mediaUrl","thumbnailUrl"],"properties":{"id":{"type":"string"},"mediaType":{"type":["string","null"]},"mediaUrl":{"type":["string","null"]},"thumbnailUrl":{"type":["string","null"]}}}}}}}}},"InstagramAudioAsset":{"type":"object","properties":{"audioId":{"type":"string"},"title":{"type":["string","null"]},"audioType":{"type":["string","null"],"enum":["music","original_sound",null]},"durationInMs":{"type":["integer","null"]},"displayArtist":{"type":["string","null"]},"coverArtworkThumbnailUrl":{"type":["string","null"]},"downloadUrl":{"type":["string","null"]},"igUsername":{"type":["string","null"]},"profilePictureUrl":{"type":["string","null"]},"isAdsEligible":{"type":["boolean","null"]},"onPlatformAudioPreviewLink":{"type":["string","null"]}}},"LinkedInPlatformData":{"type":"object","properties":{"documentTitle":{"type":"string"},"organizationUrn":{"type":"string"},"firstComment":{"type":"string"},"disableLinkPreview":{"type":"boolean"},"audience":{"type":"object","properties":{"countries":{"type":"array","maxItems":25,"items":{"type":"string"}},"geoLocations":{"type":"array","items":{"type":"string"}},"interfaceLocales":{"type":"array","items":{"type":"object","required":["language","country"],"properties":{"language":{"type":"string"},"country":{"type":"string"}}}},"industries":{"type":"array","items":{"type":"string"}},"jobFunctions":{"type":"array","items":{"type":"string"}},"seniorities":{"type":"array","items":{"type":"string"}},"staffCountRanges":{"type":"array","items":{"type":"string","enum":["SIZE_1","SIZE_2_TO_10","SIZE_11_TO_50","SIZE_51_TO_200","SIZE_201_TO_500","SIZE_501_TO_1000","SIZE_1001_TO_5000","SIZE_5001_TO_10000","SIZE_10001_OR_MORE"]}},"degrees":{"type":"array","items":{"type":"string"}},"fieldsOfStudy":{"type":"array","items":{"type":"string"}},"organizations":{"type":"array","items":{"type":"string"}}}},"reshareUrl":{"type":"string"},"geoRestriction":{"$ref":"#/components/schemas/GeoRestriction"},"poll":{"type":"object","properties":{"question":{"type":"string","minLength":1,"maxLength":140},"options":{"type":"array","minItems":2,"maxItems":4,"items":{"type":"string","minLength":1,"maxLength":30}},"duration":{"type":"string","enum":["ONE_DAY","THREE_DAYS","SEVEN_DAYS","FOURTEEN_DAYS"],"default":"SEVEN_DAYS"}},"required":["question","options"]}}},"MoneyAmount":{"type":"object","required":["amount","currencyCode"],"properties":{"amount":{"type":"string"},"currencyCode":{"type":"string"}}},"MetaAdsPlatformData":{"type":"object","additionalProperties":false,"properties":{"bidStrategy":{"$ref":"#/components/schemas/BidStrategy"},"bidAmount":{"type":"number"},"roasAverageFloor":{"type":"number"},"dailyMinSpendTarget":{"type":"number"},"lifetimeMinSpendTarget":{"type":"number"},"customerLifecycle":{"$ref":"#/components/schemas/MetaCustomerLifecycle"},"adSchedule":{"allOf":[{"$ref":"#/components/schemas/MetaAdSchedule"}],"minItems":1}}},"MetaAdSchedule":{"type":"array","maxItems":168,"items":{"type":"object","additionalProperties":false,"required":["dayOfWeek","startHour","endHour"],"properties":{"dayOfWeek":{"type":"string","enum":["MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY","SUNDAY"]},"startHour":{"type":"integer","minimum":0,"maximum":23},"endHour":{"type":"integer","minimum":1,"maximum":24},"timezoneType":{"type":"string","enum":["USER","ADVERTISER"],"default":"USER"}}}},"MetaCustomerLifecycle":{"type":"object","additionalProperties":false,"required":["strategy"],"properties":{"strategy":{"type":"string","enum":["all_customers","new_customers","new_customers_excluding_engaged"]},"existingCustomerAudienceIds":{"type":"array","items":{"type":"string"}},"engagedAudienceIds":{"type":"array","items":{"type":"string"}}}},"LinkedInAdsPlatformData":{"type":"object","additionalProperties":false,"properties":{"costType":{"type":"string","enum":["CPM","CPC","CPV"]},"unitCost":{"type":"number"},"optimizationTargetType":{"type":"string"},"creativeSelection":{"type":"string","enum":["OPTIMIZED","ROUND_ROBIN"]},"audienceExpansionEnabled":{"type":"boolean"},"offsiteDeliveryEnabled":{"type":"boolean"},"connectedTelevisionOnly":{"type":"boolean"},"carousel":{"type":"object","additionalProperties":false,"required":["cards"],"properties":{"cards":{"type":"array","minItems":2,"maxItems":10,"items":{"type":"object","additionalProperties":false,"required":["imageUrl"],"properties":{"imageUrl":{"type":"string","format":"uri"},"headline":{"type":"string"},"landingUrl":{"type":"string","format":"uri"}}}}}},"document":{"type":"object","additionalProperties":false,"required":["url","title"],"properties":{"url":{"type":"string","format":"uri"},"title":{"type":"string"}}},"spotlight":{"type":"object","additionalProperties":false,"required":["headline","callToAction","landingUrl"],"properties":{"headline":{"type":"string"},"description":{"type":"string"},"callToAction":{"type":"string"},"landingUrl":{"type":"string","format":"uri"},"logoUrl":{"type":"string","format":"uri"},"organizationName":{"type":"string"},"showMemberProfilePhoto":{"type":"boolean"},"backgroundImageUrl":{"type":"string","format":"uri"}}},"follower":{"type":"object","additionalProperties":false,"required":["headline","description","callToAction"],"properties":{"headline":{"type":"object","additionalProperties":false,"properties":{"preApproved":{"type":"string"},"custom":{"type":"string"}}},"description":{"type":"object","additionalProperties":false,"properties":{"preApproved":{"type":"string"},"custom":{"type":"string"}}},"callToAction":{"type":"string","enum":["VISIT_ORGANIZATION_COMPANY_PAGE","VISIT_ORGANIZATION_LIFE_PAGE","VISIT_ORGANIZATION_JOBS_PAGE","VISIT_ORGANIZATION_CAREERS_PAGE"]},"logoUrl":{"type":"string","format":"uri"},"organizationName":{"type":"string"},"showMemberProfilePhoto":{"type":"boolean"}}},"jobs":{"type":"object","additionalProperties":false,"required":["headline","buttonLabel"],"properties":{"headline":{"type":"object","additionalProperties":false,"properties":{"preApproved":{"type":"string"},"custom":{"type":"string"}}},"buttonLabel":{"type":"object","additionalProperties":false,"properties":{"preApproved":{"type":"string"},"custom":{"type":"string"}}},"logoUrl":{"type":"string","format":"uri"},"organizationName":{"type":"string"},"showMemberProfilePhoto":{"type":"boolean"}}},"textAd":{"type":"object","additionalProperties":false,"required":["headline","description","landingUrl"],"properties":{"headline":{"type":"string","maxLength":25},"description":{"type":"string","maxLength":75},"landingUrl":{"type":"string","format":"uri"},"imageUrl":{"type":"string","format":"uri"}}},"conversation":{"type":"object","additionalProperties":false,"required":["subject","firstMessageId","messages"],"properties":{"subject":{"type":"string"},"sender":{"type":"string"},"body":{"type":"string"},"footer":{"type":"string"},"headline":{"type":"string"},"firstMessageId":{"type":"string"},"messages":{"type":"array","minItems":1,"maxItems":25,"items":{"type":"object","additionalProperties":false,"required":["id","text"],"properties":{"id":{"type":"string"},"text":{"type":"string","maxLength":500},"buttons":{"type":"array","minItems":1,"maxItems":5,"items":{"type":"object","additionalProperties":false,"required":["text"],"properties":{"text":{"type":"string","maxLength":35},"nextMessageId":{"type":"string"},"url":{"type":"string","format":"uri"}}}}}}}}},"event":{"type":"object","additionalProperties":false,"required":["urn"],"properties":{"urn":{"type":"string","pattern":"^urn:li:event:\\d+$"}}},"thoughtLeader":{"type":"object","additionalProperties":false,"required":["postUrn"],"properties":{"postUrn":{"type":"string","pattern":"^urn:li:(share|ugcPost):\\d+$"}}}}},"PinterestPlatformData":{"type":"object","properties":{"title":{"type":"string","maxLength":100},"boardId":{"type":"string"},"boardSectionId":{"type":"string"},"link":{"type":"string","format":"uri"},"coverImageUrl":{"type":"string","format":"uri"},"coverImageKeyFrameTime":{"type":"integer"},"isAiGenerated":{"type":"boolean","default":false}}},"YouTubePlatformData":{"type":"object","properties":{"title":{"type":"string","maxLength":100},"visibility":{"type":"string","enum":["public","private","unlisted"],"default":"public"},"madeForKids":{"type":"boolean","default":false},"firstComment":{"type":"string","maxLength":10000},"containsSyntheticMedia":{"type":"boolean","default":false},"notifySubscribers":{"type":"boolean","default":true},"categoryId":{"type":"string","default":"22"},"playlistId":{"type":"string"}}},"GoogleBusinessPlatformData":{"type":"object","properties":{"locationId":{"type":"string"},"languageCode":{"type":"string"},"topicType":{"type":"string","enum":["STANDARD","EVENT","OFFER"],"default":"STANDARD"},"callToAction":{"type":"object","properties":{"type":{"type":"string","enum":["LEARN_MORE","BOOK","ORDER","SHOP","SIGN_UP","CALL"]},"url":{"type":"string","format":"uri"}},"required":["type","url"]},"event":{"type":"object","properties":{"title":{"type":"string"},"schedule":{"type":"object","properties":{"startDate":{"type":"object","properties":{"year":{"type":"integer"},"month":{"type":"integer","minimum":1,"maximum":12},"day":{"type":"integer","minimum":1,"maximum":31}},"required":["year","month","day"]},"startTime":{"type":"object","properties":{"hours":{"type":"integer","minimum":0,"maximum":23},"minutes":{"type":"integer","minimum":0,"maximum":59}}},"endDate":{"type":"object","properties":{"year":{"type":"integer"},"month":{"type":"integer","minimum":1,"maximum":12},"day":{"type":"integer","minimum":1,"maximum":31}},"required":["year","month","day"]},"endTime":{"type":"object","properties":{"hours":{"type":"integer","minimum":0,"maximum":23},"minutes":{"type":"integer","minimum":0,"maximum":59}}}},"required":["startDate","endDate"]}},"required":["title","schedule"]},"offer":{"type":"object","properties":{"redeemOnlineUrl":{"type":"string","format":"uri"},"termsConditions":{"type":"string"},"couponCode":{"type":"string"}}}}},"TikTokPlatformData":{"type":"object","properties":{"draft":{"type":"boolean"},"privacyLevel":{"type":"string"},"allowComment":{"type":"boolean"},"allowDuet":{"type":"boolean"},"allowStitch":{"type":"boolean"},"commercialContentType":{"type":"string","enum":["none","brand_organic","brand_content"]},"brandPartnerPromote":{"type":"boolean"},"isBrandOrganicPost":{"type":"boolean"},"contentPreviewConfirmed":{"type":"boolean"},"expressConsentGiven":{"type":"boolean"},"mediaType":{"type":"string","enum":["video","photo"]},"videoCoverTimestampMs":{"type":"integer","minimum":0},"videoCoverImageUrl":{"type":"string","format":"uri"},"photoCoverIndex":{"type":"integer","minimum":0},"autoAddMusic":{"type":"boolean"},"musicSoundInfo":{"type":"object","required":["musicSoundId"],"properties":{"musicSoundId":{"type":"string"},"musicSoundVolume":{"type":"integer","minimum":0,"maximum":100,"default":50},"musicSoundStart":{"type":"integer","minimum":0},"musicSoundEnd":{"type":"integer","minimum":0}}},"videoOriginalSoundVolume":{"type":"integer","minimum":0,"maximum":100},"videoMadeWithAi":{"type":"boolean"},"locationId":{"type":"string"},"locationName":{"type":"string"},"isAdsOnly":{"type":"boolean"},"description":{"type":"string","maxLength":4000}}},"TelegramPlatformData":{"type":"object","properties":{"parseMode":{"type":"string","enum":["HTML","Markdown","MarkdownV2"]},"disableWebPagePreview":{"type":"boolean"},"disableNotification":{"type":"boolean"},"protectContent":{"type":"boolean"}}},"SnapchatPlatformData":{"type":"object","properties":{"contentType":{"type":"string","enum":["story","saved_story","spotlight"],"default":"story"}}},"RedditPlatformData":{"type":"object","properties":{"subreddit":{"type":"string"},"title":{"type":"string","maxLength":300},"url":{"type":"string","format":"uri"},"forceSelf":{"type":"boolean"},"flairId":{"type":"string"},"flairText":{"type":"string"},"nsfw":{"type":"boolean","default":false},"spoiler":{"type":"boolean","default":false},"sendreplies":{"type":"boolean","default":true},"nativeVideo":{"type":"boolean","default":true},"videogif":{"type":"boolean"},"videoPosterUrl":{"type":"string","format":"uri"}}},"BlueskyPlatformData":{"type":"object","properties":{"langs":{"type":"array","minItems":1,"maxItems":3,"items":{"type":"string"}},"threadItems":{"type":"array","items":{"type":"object","properties":{"content":{"type":"string"},"mediaItems":{"type":"array","items":{"$ref":"#/components/schemas/MediaItem"}}}}}}},"DiscordPlatformData":{"type":"object","required":["channelId"],"properties":{"channelId":{"type":"string"},"embeds":{"type":"array","maxItems":10,"items":{"type":"object","properties":{"title":{"type":"string"},"description":{"type":"string"},"url":{"type":"string"},"color":{"type":"integer"},"image":{"type":"object","properties":{"url":{"type":"string"}}},"thumbnail":{"type":"object","properties":{"url":{"type":"string"}}},"footer":{"type":"object","properties":{"text":{"type":"string"},"icon_url":{"type":"string"}}},"author":{"type":"object","properties":{"name":{"type":"string"},"url":{"type":"string"},"icon_url":{"type":"string"}}},"fields":{"type":"array","maxItems":25,"items":{"type":"object","required":["name","value"],"properties":{"name":{"type":"string"},"value":{"type":"string"},"inline":{"type":"boolean"}}}}}}},"poll":{"type":"object","properties":{"question":{"type":"object","required":["text"],"properties":{"text":{"type":"string"}}},"answers":{"type":"array","maxItems":10,"items":{"type":"object","properties":{"poll_media":{"type":"object","properties":{"text":{"type":"string"}}}}}},"duration":{"type":"integer","minimum":1,"maximum":768},"allow_multiselect":{"type":"boolean"}}},"crosspost":{"type":"boolean"},"forumThreadName":{"type":"string"},"forumAppliedTags":{"type":"array","maxItems":5,"items":{"type":"string"}},"threadFromMessage":{"type":"object","properties":{"name":{"type":"string"},"autoArchiveDuration":{"type":"integer","enum":[60,1440,4320,10080]},"rateLimitPerUser":{"type":"integer","minimum":0,"maximum":21600}}},"tts":{"type":"boolean"},"webhookUsername":{"type":"string"},"webhookAvatarUrl":{"type":"string"}}},"SlackPlatformData":{"type":"object","properties":{"threadTs":{"type":"string"},"unfurlLinks":{"type":"boolean"},"unfurlMedia":{"type":"boolean"},"username":{"type":"string"},"iconUrl":{"type":"string"}}},"DiscordScheduledEvent":{"type":"object","properties":{"id":{"type":"string"},"guild_id":{"type":"string"},"channel_id":{"type":["string","null"]},"creator_id":{"type":["string","null"]},"name":{"type":"string"},"description":{"type":["string","null"]},"scheduled_start_time":{"type":"string","format":"date-time"},"scheduled_end_time":{"type":["string","null"],"format":"date-time"},"privacy_level":{"type":"integer","enum":[2]},"status":{"type":"integer","enum":[1,2,3,4]},"entity_type":{"type":"integer","enum":[1,2,3]},"entity_id":{"type":["string","null"]},"entity_metadata":{"type":["object","null"],"properties":{"location":{"type":"string"}}},"user_count":{"type":"integer"},"image":{"type":["string","null"]}}},"QueueSlot":{"type":"object","properties":{"dayOfWeek":{"type":"integer","minimum":0,"maximum":6},"time":{"type":"string","pattern":"^([0-1][0-9]|2[0-3]):[0-5][0-9]$"}}},"QueueSchedule":{"type":"object","properties":{"_id":{"type":"string"},"profileId":{"type":"string"},"name":{"type":"string"},"timezone":{"type":"string"},"slots":{"type":"array","items":{"$ref":"#/components/schemas/QueueSlot"}},"active":{"type":"boolean"},"isDefault":{"type":"boolean"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}}},"Pagination":{"type":"object","properties":{"page":{"type":"integer"},"limit":{"type":"integer"},"total":{"type":"integer"},"pages":{"type":"integer"}}},"Profile":{"type":"object","properties":{"_id":{"type":"string"},"userId":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"color":{"type":"string"},"timezone":{"type":["string","null"]},"externalId":{"type":["string","null"]},"isDefault":{"type":"boolean"},"isOverLimit":{"type":"boolean"},"accountCount":{"type":"integer"},"createdAt":{"type":"string","format":"date-time"}}},"EmailAddress":{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email"},"name":{"type":["string","null"]}}},"CursorPagination":{"type":"object","properties":{"hasMore":{"type":"boolean"},"nextCursor":{"type":["string","null"]}}},"EmailListMeta":{"type":"object","properties":{"filteredClientSide":{"type":"array","items":{"type":"string"}}}},"EmailAttachment":{"type":"object","properties":{"id":{"type":"string"},"filename":{"type":"string"},"contentType":{"type":"string"},"size":{"type":"integer"},"isInline":{"type":"boolean"},"contentId":{"type":["string","null"]}}},"EmailMessage":{"type":"object","properties":{"id":{"type":"string"},"threadId":{"type":"string"},"accountId":{"type":"string"},"provider":{"type":"string","enum":["google","microsoft"]},"folders":{"type":"array","items":{"type":"string"}},"from":{"oneOf":[{"$ref":"#/components/schemas/EmailAddress"},{"type":"null"}]},"to":{"type":"array","items":{"$ref":"#/components/schemas/EmailAddress"}},"cc":{"type":"array","items":{"$ref":"#/components/schemas/EmailAddress"}},"bcc":{"type":"array","items":{"$ref":"#/components/schemas/EmailAddress"}},"replyTo":{"type":"array","items":{"$ref":"#/components/schemas/EmailAddress"}},"subject":{"type":"string"},"snippet":{"type":"string"},"text":{"type":["string","null"]},"html":{"type":["string","null"]},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/EmailAttachment"}},"headers":{"type":"object","additionalProperties":{"type":"string"}},"raw":{"type":"string"},"date":{"type":"string","format":"date-time"},"unread":{"type":"boolean"},"starred":{"type":"boolean"},"metadata":{"type":"object","additionalProperties":{"type":"string"}}}},"EmailThread":{"type":"object","properties":{"id":{"type":"string"},"accountId":{"type":"string"},"provider":{"type":"string","enum":["google","microsoft"]},"subject":{"type":"string"},"snippet":{"type":"string"},"participants":{"type":"array","items":{"$ref":"#/components/schemas/EmailAddress"}},"messageIds":{"type":"array","items":{"type":"string"}},"draftIds":{"type":"array","items":{"type":"string"}},"folders":{"type":"array","items":{"type":"string"}},"hasAttachments":{"type":"boolean"},"hasDrafts":{"type":"boolean"},"unread":{"type":"boolean"},"starred":{"type":"boolean"},"earliestMessageAt":{"type":["string","null"],"format":"date-time"},"latestMessageReceivedAt":{"type":["string","null"],"format":"date-time"},"latestMessageSentAt":{"type":["string","null"],"format":"date-time"}}},"EmailFolder":{"type":"object","properties":{"id":{"type":"string"},"accountId":{"type":"string"},"provider":{"type":"string","enum":["google","microsoft"]},"name":{"type":"string"},"wellKnown":{"type":"string","enum":["inbox","sent","drafts","trash","spam","archive"]},"unreadCount":{"type":"integer"},"totalCount":{"type":"integer"}}},"EmailMessagePatch":{"type":"object","required":["accountId"],"properties":{"accountId":{"type":"string"},"unread":{"type":"boolean"},"starred":{"type":"boolean"},"folder":{"type":"string"}}},"SendEmailRequest":{"type":"object","required":["accountId","to","subject"],"properties":{"accountId":{"type":"string"},"to":{"type":"array","minItems":1,"maxItems":100,"items":{"$ref":"#/components/schemas/EmailAddress"}},"cc":{"type":"array","maxItems":100,"items":{"$ref":"#/components/schemas/EmailAddress"}},"bcc":{"type":"array","maxItems":100,"items":{"$ref":"#/components/schemas/EmailAddress"}},"replyTo":{"type":"array","maxItems":5,"items":{"$ref":"#/components/schemas/EmailAddress"}},"fromName":{"type":"string","maxLength":200},"subject":{"type":"string","maxLength":998},"text":{"type":"string"},"html":{"type":"string"},"attachments":{"type":"array","maxItems":20,"items":{"type":"object","required":["filename","contentType"],"properties":{"filename":{"type":"string"},"contentType":{"type":"string"},"url":{"type":"string","format":"uri"},"base64":{"type":"string"},"contentId":{"type":"string"}}}},"headers":{"type":"object","additionalProperties":{"type":"string"}},"metadata":{"type":"object","additionalProperties":{"type":"string"}},"scheduledFor":{"type":"string","format":"date-time"},"holdAsDraft":{"type":"boolean"},"trackOpens":{"type":"boolean"},"trackLinks":{"type":"boolean"}}},"Calendar":{"type":"object","properties":{"id":{"type":"string"},"accountId":{"type":"string"},"provider":{"type":"string","enum":["google","microsoft"]},"name":{"type":"string"},"primary":{"type":"boolean"},"timezone":{"type":["string","null"]},"color":{"type":["string","null"]},"readOnly":{"type":"boolean"}}},"CalendarEventFields":{"type":"object","properties":{"title":{"type":"string","maxLength":1000},"description":{"type":"string"},"location":{"type":"string"},"start":{"type":"string"},"end":{"type":"string"},"allDay":{"type":"boolean"},"timezone":{"type":"string"},"participants":{"type":"array","maxItems":100,"items":{"$ref":"#/components/schemas/EmailAddress"}},"recurrence":{"type":"array","maxItems":5,"items":{"type":"string"}},"reminders":{"type":"object","properties":{"useDefault":{"type":"boolean"},"overrides":{"type":"array","maxItems":5,"items":{"type":"object","properties":{"minutes":{"type":"integer"}}}}}},"conferencing":{"type":"string","enum":["google_meet","teams"]},"busy":{"type":"boolean"},"visibility":{"type":"string","enum":["default","public","private"]},"metadata":{"type":"object","additionalProperties":{"type":"string"}}}},"CreateCalendarEventRequest":{"allOf":[{"type":"object","required":["accountId","title","start","end"],"properties":{"accountId":{"type":"string"},"calendarId":{"type":"string"}}},{"$ref":"#/components/schemas/CalendarEventFields"}]},"CalendarEvent":{"type":"object","properties":{"id":{"type":"string"},"accountId":{"type":"string"},"provider":{"type":"string","enum":["google","microsoft"]},"calendarId":{"type":"string"},"title":{"type":"string"},"description":{"type":["string","null"]},"location":{"type":["string","null"]},"start":{"type":"string"},"end":{"type":"string"},"allDay":{"type":"boolean"},"timezone":{"type":["string","null"]},"participants":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/EmailAddress"},{"type":"object","properties":{"status":{"type":"string","enum":["accepted","declined","tentative","pending"]},"comment":{"type":["string","null"]}}}]}},"organizer":{"oneOf":[{"$ref":"#/components/schemas/EmailAddress"},{"type":"null"}]},"recurrence":{"type":["array","null"],"items":{"type":"string"}},"reminders":{"type":"object","properties":{"useDefault":{"type":"boolean"},"overrides":{"type":"array","items":{"type":"object","properties":{"minutes":{"type":"integer"}}}}}},"conferencing":{"type":["object","null"],"properties":{"provider":{"type":"string","enum":["google_meet","teams","other"]},"url":{"type":"string","format":"uri"}}},"busy":{"type":"boolean"},"visibility":{"type":"string","enum":["default","public","private"]},"status":{"type":"string","enum":["confirmed","tentative","cancelled"]},"icalUid":{"type":["string","null"]},"masterEventId":{"type":["string","null"]},"htmlLink":{"type":["string","null"]},"readOnly":{"type":"boolean"},"metadata":{"type":"object","additionalProperties":{"type":"string"}},"createdAt":{"type":["string","null"],"format":"date-time"},"updatedAt":{"type":["string","null"],"format":"date-time"}}},"BusyBlock":{"type":"object","properties":{"start":{"type":"string","format":"date-time"},"end":{"type":"string","format":"date-time"}}},"OpenHours":{"type":"array","items":{"type":"object","required":["days","timezone","start","end"],"properties":{"days":{"type":"array","items":{"type":"integer","minimum":0,"maximum":6}},"timezone":{"type":"string"},"start":{"type":"string"},"end":{"type":"string"},"exdates":{"type":"array","items":{"type":"string","format":"date"}}}}},"WebhookPayloadAccountRateLimited":{"type":"object","required":["id","event","account","timestamp"],"properties":{"id":{"type":"string"},"profiles":{"$ref":"#/components/schemas/WebhookProfiles"},"test":{"type":"boolean"},"event":{"type":"string","enum":["account.rate_limited"]},"account":{"type":"object","required":["accountId","profileId","platform","username","reason","cooldownMinutes","resetsAt"],"properties":{"accountId":{"type":"string"},"profileId":{"type":"string"},"platform":{"type":"string"},"username":{"type":"string"},"displayName":{"type":["string","null"]},"reason":{"type":"string","enum":["recipient_burst","provider_rejection","bounces","daily_cap"]},"cooldownMinutes":{"type":"integer"},"resetsAt":{"type":"string","format":"date-time"}}},"timestamp":{"type":"string","format":"date-time"}}},"WebhookPayloadCalendarEvent":{"type":"object","required":["id","event","account","calendarEvent","timestamp"],"properties":{"id":{"type":"string"},"profiles":{"$ref":"#/components/schemas/WebhookProfiles"},"test":{"type":"boolean"},"event":{"type":"string","enum":["calendar.event.created","calendar.event.updated","calendar.event.deleted"]},"account":{"type":"object","properties":{"accountId":{"type":"string"},"profileId":{"type":"string"},"platform":{"type":"string"},"username":{"type":"string"},"displayName":{"type":["string","null"]}}},"calendarEvent":{"type":"object","properties":{"id":{"type":"string"},"changeType":{"type":"string","enum":["created","updated","deleted"]}}},"timestamp":{"type":"string","format":"date-time"}}},"FileItem":{"type":"object","required":["id","accountId","provider","name","kind","mimeType","size","parentId","webUrl","downloadable","createdAt","modifiedAt","trashed"],"properties":{"id":{"type":"string"},"accountId":{"type":"string"},"provider":{"type":"string","enum":["google","microsoft"]},"name":{"type":"string"},"kind":{"type":"string","enum":["file","folder"]},"mimeType":{"type":["string","null"]},"size":{"type":["integer","null"]},"parentId":{"type":["string","null"]},"webUrl":{"type":["string","null"]},"downloadable":{"type":"boolean"},"exportMimeType":{"type":["string","null"]},"createdAt":{"type":["string","null"],"format":"date-time"},"modifiedAt":{"type":["string","null"],"format":"date-time"},"trashed":{"type":"boolean"}}},"FileShareLink":{"type":"object","required":["url","scope"],"properties":{"url":{"type":"string","format":"uri"},"scope":{"type":"string","enum":["anyone_with_link"]}}},"WebhookPayloadFilePicked":{"type":"object","required":["id","event","account","picker","timestamp"],"properties":{"id":{"type":"string"},"profiles":{"$ref":"#/components/schemas/WebhookProfiles"},"test":{"type":"boolean"},"event":{"type":"string","enum":["file.picked"]},"account":{"type":"object","properties":{"accountId":{"type":"string"},"profileId":{"type":"string"},"platform":{"type":"string"},"username":{"type":"string"},"displayName":{"type":["string","null"]}}},"picker":{"type":"object","properties":{"sessionId":{"type":"string"},"files":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"mimeType":{"type":["string","null"]},"kind":{"type":"string","enum":["file","folder"]}}}}}},"timestamp":{"type":"string","format":"date-time"}}},"FilePickerSession":{"type":"object","required":["id","url","expiresAt"],"properties":{"id":{"type":"string"},"url":{"type":"string","format":"uri"},"expiresAt":{"type":"string","format":"date-time"}}},"WebhookPayloadFile":{"type":"object","required":["id","event","account","file","timestamp"],"properties":{"id":{"type":"string"},"profiles":{"$ref":"#/components/schemas/WebhookProfiles"},"test":{"type":"boolean"},"event":{"type":"string","enum":["file.created","file.updated","file.deleted"]},"account":{"type":"object","properties":{"accountId":{"type":"string"},"profileId":{"type":"string"},"platform":{"type":"string"},"username":{"type":"string"},"displayName":{"type":["string","null"]}}},"file":{"type":"object","properties":{"id":{"type":"string"},"changeType":{"type":"string","enum":["created","updated","deleted"]}}},"timestamp":{"type":"string","format":"date-time"}}},"WebhookPayloadContact":{"type":"object","required":["id","event","account","contact","timestamp"],"properties":{"id":{"type":"string"},"profiles":{"$ref":"#/components/schemas/WebhookProfiles"},"test":{"type":"boolean"},"event":{"type":"string","enum":["contact.updated","contact.deleted"]},"account":{"type":"object","properties":{"accountId":{"type":"string"},"profileId":{"type":"string"},"platform":{"type":"string"},"username":{"type":"string"},"displayName":{"type":["string","null"]}}},"contact":{"type":"object","properties":{"id":{"type":"string"},"changeType":{"type":"string","enum":["updated","deleted"]}}},"timestamp":{"type":"string","format":"date-time"}}},"HubSpotSettings":{"type":"object","required":["_id","platform","hubId","hubDomain","scopes","syncContacts","logMessages","reportDeals"],"properties":{"_id":{"type":"string"},"platform":{"type":"string","enum":["hubspot"]},"hubId":{"type":"string"},"hubDomain":{"type":["string","null"]},"scopes":{"type":"array","items":{"type":"string"}},"syncContacts":{"type":"boolean"},"logMessages":{"type":"boolean"},"reportDeals":{"type":"boolean"}}},"GoogleAnalyticsReport":{"type":"object","properties":{"accountId":{"type":"string"},"propertyId":{"type":"string"},"dimensionHeaders":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"}}}},"metricHeaders":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"type":{"type":"string"}}}},"rows":{"type":"array","items":{"type":"object","properties":{"dimensionValues":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"}}}},"metricValues":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"}}}}}}},"rowCount":{"type":"integer"},"metadata":{"type":"object","additionalProperties":true},"propertyQuota":{"type":"object","additionalProperties":true}}},"GoogleAnalyticsReportFields":{"type":"object","required":["accountId","metrics"],"properties":{"accountId":{"type":"string"},"dimensions":{"type":"array","maxItems":9,"items":{"type":"string"}},"metrics":{"type":"array","minItems":1,"maxItems":10,"items":{"type":"string"}},"dimensionFilter":{"type":"object","additionalProperties":true},"metricFilter":{"type":"object","additionalProperties":true},"orderBys":{"type":"array","maxItems":10,"items":{"type":"object","additionalProperties":true}},"limit":{"type":"integer","minimum":1,"maximum":10000}}},"SocialAccount":{"type":"object","required":["_id","platform","profileId","isActive"],"properties":{"_id":{"type":"string"},"platform":{"type":"string","enum":["tiktok","instagram","facebook","youtube","linkedin","twitter","threads","pinterest","reddit","bluesky","googlebusiness","telegram","snapchat","discord","slack","whatsapp","shopify","wordpress","wix","linkedinads","metaads","pinterestads","tiktokads","xads","googleads","openaiads","redditads","sms","phone","rcs","whopads","google","microsoft","hubspot","webflow","googleanalytics","imessage","tiktokshop","microsoftads"]},"profileId":{"oneOf":[{"type":"string"},{"$ref":"#/components/schemas/Profile"}]},"username":{"type":"string"},"displayName":{"type":"string"},"platformUserId":{"type":"string"},"scopeAreas":{"type":["array","null"],"items":{"type":"string"}},"oauthAppId":{"type":["string","null"]},"tiktokAccountType":{"type":"string","enum":["business","personal","unknown"]},"profilePicture":{"type":["string","null"]},"profileUrl":{"type":"string"},"isActive":{"type":"boolean"},"needsReconnection":{"type":"boolean"},"followersCount":{"type":"number"},"followersLastUpdated":{"type":"string","format":"date-time"},"parentAccountId":{"type":["string","null"]},"enabled":{"type":"boolean"},"rateLimitedUntil":{"type":["string","null"],"format":"date-time"},"metadata":{"type":"object"}}},"AccountWithFollowerStats":{"allOf":[{"$ref":"#/components/schemas/SocialAccount"},{"type":"object","properties":{"currentFollowers":{"type":"number"},"lastUpdated":{"type":"string","format":"date-time"},"growth":{"type":"number"},"growthPercentage":{"type":"number"},"dataPoints":{"type":"number"},"accountStats":{"type":"object","properties":{"followingCount":{"type":"number"},"mediaCount":{"type":"number"},"videoCount":{"type":"number"},"tweetCount":{"type":"number"},"postsCount":{"type":"number"},"pinCount":{"type":"number"},"totalViews":{"type":"number"},"likesCount":{"type":"number"},"monthlyViews":{"type":"number"},"listedCount":{"type":"number"},"boardCount":{"type":"number"}}}}}]},"ApiKey":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"keyPreview":{"type":"string"},"expiresAt":{"type":"string","format":"date-time"},"createdAt":{"type":"string","format":"date-time"},"key":{"type":"string"},"scope":{"type":"string","enum":["full","profiles"],"default":"full"},"profileIds":{"type":"array","items":{"type":"object","properties":{"_id":{"type":"string"},"name":{"type":"string"},"color":{"type":"string"}}}},"permission":{"type":"string","enum":["read-write","read"],"default":"read-write"},"disabledResourceGroups":{"type":"array","items":{"type":"string","enum":["publishing","engagement","messages","contacts","analytics","ads","telephony","accounts","billing","webhooks","commerce","creator_campaigns","money","calendar","files"]}},"createdBy":{"type":["object","null"],"properties":{"id":{"type":"string"},"email":{"type":"string"}}}}},"ConnectedApp":{"type":"object","properties":{"clientId":{"type":"string"},"clientName":{"type":"string"},"redirectHost":{"type":["string","null"]},"scopes":{"type":"array","items":{"type":"string"}},"authorizedAt":{"type":["string","null"],"format":"date-time"},"lastUsedAt":{"type":["string","null"],"format":"date-time"},"tokenCount":{"type":"integer"}}},"BillingSnapshot":{"type":"object","properties":{"billingSystem":{"type":"string","enum":["metronome","stripe","shopify"]},"plan":{"type":"object","properties":{"name":{"type":"string"},"isUsageBased":{"type":"boolean"},"isPaid":{"type":"boolean"}}},"shopifyShopDomain":{"type":["string","null"]},"period":{"type":"object","properties":{"start":{"type":["string","null"],"format":"date-time"},"end":{"type":["string","null"],"format":"date-time"},"anchorDay":{"type":"integer"}}},"balance":{"type":["object","null"],"properties":{"accruedThisPeriodCents":{"type":"integer"},"creditsRemainingCents":{"type":"integer"}}},"caps":{"type":"object","properties":{"xSpendUsedCents":{"type":"integer"},"xSpendLimitCents":{"type":["integer","null"]}}},"status":{"type":"object","properties":{"hasAccess":{"type":"boolean"},"suspended":{"type":"boolean"},"suspendedAt":{"type":["string","null"],"format":"date-time"},"suspensionReason":{"type":["string","null"]},"openInvoiceUrl":{"type":["string","null"]},"declineReason":{"type":["string","null"]},"autoUpgradeEnabled":{"type":"boolean"}}},"legacy":{"type":"object","properties":{"limits":{"type":"object","properties":{"uploads":{"type":"integer"},"profiles":{"type":"integer"}}}}}}},"UsageMetering":{"type":"object","properties":{"supported":{"type":"boolean"},"granularity":{"type":"string","enum":["day","month","total"]},"days":{"type":"array","items":{"type":"object","properties":{"date":{"type":"string","format":"date"},"accounts":{"type":"number"},"numbers":{"type":"number"},"imessage":{"type":"number"},"calls":{"type":"number"},"sms":{"type":"number"},"messages":{"type":"number"},"verify":{"type":"number"},"dlc":{"type":"number"},"xApi":{"type":"number"},"ads":{"type":"number"},"credits":{"type":"number"},"other":{"type":"number"}}}},"totals":{"type":"object","properties":{"accounts":{"type":"number"},"numbers":{"type":"number"},"imessage":{"type":"number"},"calls":{"type":"number"},"sms":{"type":"number"},"messages":{"type":"number"},"verify":{"type":"number"},"dlc":{"type":"number"},"xApi":{"type":"number"},"ads":{"type":"number"},"credits":{"type":"number"},"other":{"type":"number"},"total":{"type":"number"}}},"lineItems":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"product":{"type":"string","enum":["accounts","numbers","imessage","calls","sms","messages","verify","dlc","xApi","ads","credits","other"]},"totalUsd":{"type":"number"},"quantity":{"type":"number"}}}},"peaks":{"type":["object","null"],"properties":{"accounts":{"type":"integer"},"numbers":{"type":"integer"}}},"callUsage":{"type":["object","null"],"properties":{"whatsapp":{"type":"object","properties":{"count":{"type":"integer"},"minutes":{"type":"integer"}}},"pstn":{"type":"object","properties":{"count":{"type":"integer"},"minutes":{"type":"integer"}}}}},"period":{"type":"object","properties":{"start":{"type":"string","format":"date-time"},"end":{"type":"string","format":"date-time"},"source":{"type":"string","enum":["cycle","window"]}}},"tax":{"type":["object","null"],"properties":{"taxUsd":{"type":"number"},"ratePercent":{"type":["number","null"]},"jurisdictionLabel":{"type":["string","null"]},"reverseCharge":{"type":"boolean"}}},"attribution":{"type":"object","properties":{"groupBy":{"type":"string","enum":["profile","account"]},"groups":{"type":"array","items":{"$ref":"#/components/schemas/UsageAttributionGroup"}},"unattributed":{"$ref":"#/components/schemas/UsageAttributionSlice"},"totals":{"$ref":"#/components/schemas/UsageAttributionSlice"},"restricted":{"type":"boolean"}}},"scope":{"oneOf":[{"type":"object","required":["profileId"],"properties":{"profileId":{"type":"string"}}},{"type":"object","required":["accountId"],"properties":{"accountId":{"type":"string"}}}]}}},"UsageAttributionGroup":{"allOf":[{"$ref":"#/components/schemas/UsageAttributionSlice"},{"type":"object","required":["key"],"properties":{"key":{"type":"string"}}}]},"UsageAttributionSlice":{"type":"object","properties":{"byProduct":{"type":"object","properties":{"accounts":{"type":"number"},"numbers":{"type":"number"},"imessage":{"type":"number"},"calls":{"type":"number"},"sms":{"type":"number"},"messages":{"type":"number"},"verify":{"type":"number"},"dlc":{"type":"number"},"xApi":{"type":"number"},"ads":{"type":"number"},"credits":{"type":"number"},"other":{"type":"number"}}},"totalUsd":{"type":"number"}}},"UsageStats":{"type":"object","properties":{"billingSystem":{"type":"string","enum":["stripe","metronome"]},"planName":{"type":"string"},"billingPeriod":{"type":"string","enum":["monthly","yearly"]},"signupDate":{"type":"string","format":"date-time"},"billingAnchorDay":{"type":"integer"},"hasAccess":{"type":"boolean"},"customerId":{"type":["string","null"]},"isInvitedUser":{"type":"boolean"},"autoUpgradeEnabled":{"type":"boolean"},"limits":{"type":"object","properties":{"uploads":{"type":"integer"},"profiles":{"type":"integer"}}},"usage":{"type":"object","properties":{"uploads":{"type":"integer"},"profiles":{"type":"integer"},"lastReset":{"type":"string","format":"date-time"},"connectedAccounts":{"type":"integer"},"xApiCalls":{"type":"object","deprecated":true,"properties":{"x_api_005":{"type":"integer"},"x_api_010":{"type":"integer"},"x_api_015":{"type":"integer"}}},"xApiCallsByOperation":{"type":"object","additionalProperties":{"type":"integer"}}}},"spend":{"type":"object","properties":{"currentPeriodCents":{"type":"integer"},"creditsRemainingCents":{"type":"integer"},"xSpendCents":{"type":"integer"},"xSpendLimitCents":{"type":["integer","null"]}}}}},"XApiPricing":{"type":"object","properties":{"currency":{"type":"string"},"markup":{"type":"string"},"source":{"type":"string","format":"uri"},"lastVerified":{"type":"string","format":"date"},"tiers":{"type":"array","items":{"type":"object","properties":{"tier":{"type":"string"},"pricePerCallUsd":{"type":"number"},"operationCount":{"type":"integer"}}}},"operations":{"type":"array","items":{"$ref":"#/components/schemas/XApiOperation"}}}},"XApiOperation":{"type":"object","properties":{"operation":{"type":"string"},"eventType":{"type":"string"},"displayName":{"type":"string"},"pricePerCallUsd":{"type":"number"},"pricePerCallCents":{"type":"number"},"tier":{"type":"string"},"triggeredBy":{"type":"array","items":{"type":"object","properties":{"method":{"type":"string"},"metering":{"type":"string","enum":["always","analytics_optin","inbox_optin","absorbed"]}}}}}},"PostAnalytics":{"type":"object","properties":{"impressions":{"type":"integer"},"reach":{"type":"integer"},"likes":{"type":"integer"},"comments":{"type":"integer"},"shares":{"type":"integer"},"saves":{"type":"integer"},"clicks":{"type":"integer"},"views":{"type":"integer"},"follows":{"type":["integer","null"]},"igReelsAvgWatchTime":{"type":"integer"},"igReelsVideoViewTotalTime":{"type":"integer"},"reelsSkipRate":{"type":"number"},"completionRate":{"type":"number"},"profileViews":{"type":"integer"},"websiteClicks":{"type":"integer"},"impressionSources":{"type":"object","additionalProperties":{"type":"number"}},"audienceTypes":{"type":"object","additionalProperties":{"type":"number"}},"audienceCountries":{"type":"object","additionalProperties":{"type":"number"}},"replays":{"type":"integer"},"retentionCurve":{"type":"object","additionalProperties":{"type":"number"}},"reposts":{"type":"integer"},"videoDurationSeconds":{"type":["integer","null"]},"engagementRate":{"type":"number"},"lastUpdated":{"type":"string","format":"date-time"}}},"PlatformAnalytics":{"type":"object","properties":{"platform":{"type":"string"},"status":{"type":"string","enum":["published","failed"]},"platformPostId":{"type":["string","null"]},"accountId":{"type":"string"},"accountUsername":{"type":["string","null"]},"analytics":{"anyOf":[{"$ref":"#/components/schemas/PostAnalytics"},{"type":"null"}]},"syncStatus":{"type":"string","enum":["synced","pending","unavailable"]},"platformPostUrl":{"type":["string","null"],"format":"uri"},"errorMessage":{"type":["string","null"]},"errorCode":{"type":["string","null"],"enum":["post_not_found","not_post_owner","permission_missing",null]},"isOwner":{"type":["boolean","null"]}}},"AnalyticsOverview":{"type":"object","properties":{"totalPosts":{"type":"integer"},"publishedPosts":{"type":"integer"},"scheduledPosts":{"type":"integer"},"lastSync":{"type":["string","null"],"format":"date-time"},"dataStaleness":{"type":"object","properties":{"staleAccountCount":{"type":"integer"},"syncTriggered":{"type":"boolean"}}}}},"AnalyticsSinglePostResponse":{"type":"object","properties":{"postId":{"type":"string"},"pozyPostId":{"type":["string","null"]},"status":{"type":"string","enum":["published","failed","partial","scheduled","publishing","draft","cancelled"]},"content":{"type":"string"},"scheduledFor":{"type":"string","format":"date-time"},"publishedAt":{"type":["string","null"],"format":"date-time"},"analytics":{"$ref":"#/components/schemas/PostAnalytics"},"platformAnalytics":{"type":"array","items":{"$ref":"#/components/schemas/PlatformAnalytics"}},"platform":{"type":"string"},"platformPostUrl":{"type":["string","null"],"format":"uri"},"isExternal":{"type":"boolean"},"syncStatus":{"type":"string","enum":["synced","pending","partial","unavailable"]},"message":{"type":["string","null"]},"thumbnailUrl":{"type":["string","null"],"format":"uri"},"mediaType":{"type":["string","null"],"enum":["image","video","carousel","text"]},"mediaItems":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["image","video"]},"url":{"type":["string","null"],"format":"uri"},"thumbnail":{"type":["string","null"],"format":"uri"},"altText":{"type":"string"},"mediaStatus":{"type":"string","enum":["available","unavailable"]},"unavailableReason":{"type":"string","enum":["platform_withheld"]}}}},"mediaProductType":{"type":"string"},"isAiGenerated":{"type":"boolean"},"isSharedToFeed":{"type":"boolean"},"mediaAudioType":{"type":"string"}}},"AnalyticsListResponse":{"type":"object","properties":{"overview":{"$ref":"#/components/schemas/AnalyticsOverview"},"posts":{"type":"array","items":{"type":"object","properties":{"_id":{"type":"string"},"pozyPostId":{"type":["string","null"]},"content":{"type":"string"},"scheduledFor":{"type":"string","format":"date-time"},"publishedAt":{"type":"string","format":"date-time"},"status":{"type":"string"},"analytics":{"$ref":"#/components/schemas/PostAnalytics"},"platforms":{"type":"array","items":{"$ref":"#/components/schemas/PlatformAnalytics"}},"platform":{"type":"string"},"platformPostUrl":{"type":"string","format":"uri"},"isExternal":{"type":"boolean"},"isAd":{"type":"boolean"},"profileId":{"type":["string","null"]},"thumbnailUrl":{"type":"string","format":"uri"},"mediaType":{"type":"string","enum":["image","video","gif","document","carousel","text"]},"mediaItems":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["image","video"]},"url":{"type":"string","format":"uri"},"thumbnail":{"type":"string","format":"uri"},"altText":{"type":"string"}}}},"mediaProductType":{"type":"string"},"isAiGenerated":{"type":"boolean"},"isSharedToFeed":{"type":"boolean"},"mediaAudioType":{"type":"string"}}}},"pagination":{"$ref":"#/components/schemas/Pagination"},"accounts":{"type":"array","items":{"$ref":"#/components/schemas/SocialAccount"}},"hasAnalyticsAccess":{"type":"boolean"}}},"AnalyticsDeltaEntry":{"type":"object","required":["postId","accountId","profileId","platform","platformPostId","publishedAt","syncedAt","isDeleted","metrics"],"properties":{"postId":{"type":"string"},"accountId":{"type":"string"},"profileId":{"type":"string"},"platform":{"type":"string"},"platformPostId":{"type":"string"},"publishedAt":{"type":"string","format":"date-time"},"syncedAt":{"type":"string","format":"date-time"},"isDeleted":{"type":"boolean"},"metrics":{"type":"object","required":["impressions","reach","likes","comments","shares","saves","sends","clicks","views","follows","igReelsAvgWatchTime","igReelsVideoViewTotalTime","reposts","reelsSkipRate","completionRate","profileViews","websiteClicks","impressionSources","audienceTypes","audienceCountries"],"properties":{"impressions":{"type":"integer"},"reach":{"type":"integer"},"likes":{"type":"integer"},"comments":{"type":"integer"},"shares":{"type":"integer"},"saves":{"type":"integer"},"sends":{"type":"integer"},"clicks":{"type":"integer"},"views":{"type":"integer"},"follows":{"type":"integer"},"igReelsAvgWatchTime":{"type":"integer"},"igReelsVideoViewTotalTime":{"type":"integer"},"reposts":{"type":"integer"},"reelsSkipRate":{"type":"number"},"completionRate":{"type":"number"},"profileViews":{"type":"integer"},"websiteClicks":{"type":"integer"},"impressionSources":{"type":"object","additionalProperties":{"type":"number"}},"audienceTypes":{"type":"object","additionalProperties":{"type":"number"}},"audienceCountries":{"type":"object","additionalProperties":{"type":"number"}},"replays":{"type":"integer"},"retentionCurve":{"type":"object","additionalProperties":{"type":"number"}}}}}},"AnalyticsDeltaResponse":{"type":"object","required":["data","nextCursor","hasMore"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/AnalyticsDeltaEntry"}},"nextCursor":{"type":"string"},"hasMore":{"type":"boolean"}}},"LinkedInAggregateAnalyticsTotalResponse":{"type":"object","properties":{"accountId":{"type":"string"},"platform":{"type":"string"},"accountType":{"type":"string"},"username":{"type":"string"},"aggregation":{"type":"string","enum":["TOTAL"]},"dateRange":{"type":["object","null"],"properties":{"startDate":{"type":"string","format":"date"},"endDate":{"type":"string","format":"date"}}},"analytics":{"type":"object","properties":{"impressions":{"type":"integer"},"reach":{"type":"integer"},"reactions":{"type":"integer"},"comments":{"type":"integer"},"shares":{"type":"integer"},"saves":{"type":"integer"},"sends":{"type":"integer"},"engagementRate":{"type":"number"}}},"note":{"type":"string"},"lastUpdated":{"type":"string","format":"date-time"}}},"LinkedInAggregateAnalyticsDailyResponse":{"type":"object","properties":{"accountId":{"type":"string"},"platform":{"type":"string"},"accountType":{"type":"string"},"username":{"type":"string"},"aggregation":{"type":"string","enum":["DAILY"]},"dateRange":{"type":["object","null"],"properties":{"startDate":{"type":"string","format":"date"},"endDate":{"type":"string","format":"date"}}},"analytics":{"type":"object","properties":{"impressions":{"type":"array","items":{"type":"object","properties":{"date":{"type":"string","format":"date"},"count":{"type":"integer"}}}},"reactions":{"type":"array","items":{"type":"object","properties":{"date":{"type":"string","format":"date"},"count":{"type":"integer"}}}},"comments":{"type":"array","items":{"type":"object","properties":{"date":{"type":"string","format":"date"},"count":{"type":"integer"}}}},"shares":{"type":"array","items":{"type":"object","properties":{"date":{"type":"string","format":"date"},"count":{"type":"integer"}}}},"saves":{"type":"array","items":{"type":"object","properties":{"date":{"type":"string","format":"date"},"count":{"type":"integer"}}}},"sends":{"type":"array","items":{"type":"object","properties":{"date":{"type":"string","format":"date"},"count":{"type":"integer"}}}}}},"skippedMetrics":{"type":"array","items":{"type":"string"}},"note":{"type":"string"},"lastUpdated":{"type":"string","format":"date-time"}}},"PostsListResponse":{"type":"object","properties":{"posts":{"type":"array","items":{"$ref":"#/components/schemas/Post"}},"pagination":{"allOf":[{"$ref":"#/components/schemas/Pagination"},{"type":"object","properties":{"nextCursor":{"type":["string","null"]}}}]}}},"PostGetResponse":{"type":"object","properties":{"post":{"$ref":"#/components/schemas/Post"}}},"TikTokSmartPlusReviewStatus":{"type":"string","enum":["approved","partially_approved","rejected","unknown"]},"TikTokSmartPlusAdLevelReview":{"type":["object","null"],"properties":{"reviewStatus":{"$ref":"#/components/schemas/TikTokSmartPlusReviewStatus"},"rawReviewStatus":{"type":["string","null"]},"rejectReasons":{"type":"array","items":{"type":"string"}},"passedLocations":{"type":"array","items":{"type":"string"}},"appealStatus":{"type":["string","null"]},"appealRejectReasons":{"type":"array","items":{"type":"string"}},"rejections":{"type":"array","items":{"$ref":"#/components/schemas/TikTokReviewRejection"}}}},"TikTokSmartPlusMaterialReview":{"type":"object","properties":{"adMaterialId":{"type":"string"},"materialType":{"type":["string","null"],"enum":["spark_post","video","carousel","catalog_carousel",null]},"tiktokItemId":{"type":["string","null"]},"videoId":{"type":["string","null"]},"name":{"type":["string","null"]},"operationStatus":{"type":["string","null"]},"reviewStatus":{"$ref":"#/components/schemas/TikTokSmartPlusReviewStatus"},"rawReviewStatus":{"type":["string","null"]},"rejectReasons":{"type":"array","items":{"type":"string"}},"passedLocations":{"type":"array","items":{"type":"string"}},"rejections":{"type":"array","items":{"$ref":"#/components/schemas/TikTokReviewRejection"}}}},"TikTokReviewRejection":{"type":"object","properties":{"reasons":{"type":"array","items":{"type":"string"}},"suggestion":{"type":["string","null"]},"forbiddenPlacements":{"type":"array","items":{"type":"string"}},"forbiddenAges":{"type":"array","items":{"type":"string"}},"forbiddenLocations":{"type":"array","items":{"type":"string"}},"content":{"type":["object","null"],"properties":{"type":{"type":["string","null"]},"text":{"type":["string","null"]},"imageId":{"type":["string","null"]},"videoId":{"type":["string","null"]},"musicId":{"type":["string","null"]}}}}},"TikTokDryRunVerdict":{"type":"object","required":["dryRun","canPublish","tiktok"],"properties":{"dryRun":{"type":"boolean"},"canPublish":{"type":"boolean"},"tiktok":{"type":"array","items":{"type":"object","required":["accountId","canPublish","reason"],"properties":{"accountId":{"type":"string"},"canPublish":{"type":"boolean"},"alreadyPostedToday":{"type":"boolean"},"reason":{"type":"string"}}}}}},"PostCreateResponse":{"type":"object","properties":{"message":{"type":"string"},"post":{"$ref":"#/components/schemas/Post"},"warnings":{"type":"array","items":{"type":"string"}}}},"PostUpdateResponse":{"type":"object","properties":{"message":{"type":"string"},"post":{"$ref":"#/components/schemas/Post"},"warnings":{"type":"array","items":{"type":"string"}}}},"PostPublishIncompleteResponse":{"type":"object","properties":{"post":{"$ref":"#/components/schemas/Post"},"message":{"type":"string"},"error":{"type":"string"},"platformResults":{"type":"array","items":{"type":"object","required":["platform","status","error"],"properties":{"platform":{"type":"string"},"status":{"type":"string"},"error":{"type":["string","null"]}}}},"warnings":{"type":"array","items":{"type":"string"}}}},"PostDeleteResponse":{"type":"object","properties":{"message":{"type":"string"}}},"PostRetryResponse":{"type":"object","properties":{"message":{"type":"string"},"post":{"$ref":"#/components/schemas/Post"}}},"ProfilesListResponse":{"type":"object","properties":{"profiles":{"type":"array","items":{"$ref":"#/components/schemas/Profile"}},"total":{"type":"integer"},"skip":{"type":"integer"},"limit":{"type":"integer"}}},"ProfileCreateResponse":{"type":"object","properties":{"message":{"type":"string"},"profile":{"$ref":"#/components/schemas/Profile"}}},"ProfileGetResponse":{"type":"object","properties":{"profile":{"$ref":"#/components/schemas/Profile"}}},"ProfileUpdateResponse":{"type":"object","properties":{"message":{"type":"string"},"profile":{"$ref":"#/components/schemas/Profile"}}},"ProfileDeleteResponse":{"type":"object","properties":{"message":{"type":"string"}}},"AccountsListResponse":{"type":"object","required":["accounts","hasAnalyticsAccess"],"properties":{"accounts":{"type":"array","items":{"$ref":"#/components/schemas/SocialAccount"}},"hasAnalyticsAccess":{"type":"boolean"},"pagination":{"oneOf":[{"$ref":"#/components/schemas/Pagination"},{"$ref":"#/components/schemas/AccountCursorPagination"}]},"profileTotals":{"type":"object","additionalProperties":{"type":"integer"}},"statusCounts":{"type":"object","required":["all","disconnected"],"properties":{"all":{"type":"integer"},"disconnected":{"type":"integer"}}}}},"AccountCursorPagination":{"type":"object","required":["limit","nextCursor"],"properties":{"limit":{"type":"integer"},"nextCursor":{"type":["string","null"]}}},"FollowerStatsResponse":{"type":"object","properties":{"accounts":{"type":"array","items":{"$ref":"#/components/schemas/AccountWithFollowerStats"}},"stats":{"type":"object","additionalProperties":{"type":"array","items":{"type":"object","properties":{"date":{"type":"string","format":"date"},"followers":{"type":"number"}}}}},"dateRange":{"type":"object","properties":{"from":{"type":"string","format":"date-time"},"to":{"type":"string","format":"date-time"}}},"granularity":{"type":"string"},"pagination":{"$ref":"#/components/schemas/AccountCursorPagination"}}},"UploadedFile":{"type":"object","properties":{"type":{"type":"string","enum":["image","video","document"]},"url":{"type":"string","format":"uri"},"filename":{"type":"string"},"size":{"type":"integer"},"mimeType":{"type":"string"}}},"MediaUploadResponse":{"type":"object","properties":{"files":{"type":"array","items":{"$ref":"#/components/schemas/UploadedFile"}}}},"UploadTokenResponse":{"type":"object","properties":{"token":{"type":"string"},"uploadUrl":{"type":"string","format":"uri"},"expiresAt":{"type":"string","format":"date-time"},"status":{"type":"string","enum":["pending","completed","expired"]}}},"UploadTokenStatusResponse":{"type":"object","properties":{"token":{"type":"string"},"status":{"type":"string","enum":["pending","completed","expired"]},"files":{"type":"array","items":{"$ref":"#/components/schemas/UploadedFile"}},"createdAt":{"type":"string","format":"date-time"},"expiresAt":{"type":"string","format":"date-time"},"completedAt":{"type":["string","null"],"format":"date-time"}}},"QueueSlotsResponse":{"type":"object","properties":{"exists":{"type":"boolean"},"schedule":{"$ref":"#/components/schemas/QueueSchedule"},"nextSlots":{"type":"array","items":{"type":"string","format":"date-time"}}}},"QueueUpdateResponse":{"type":"object","properties":{"success":{"type":"boolean"},"schedule":{"$ref":"#/components/schemas/QueueSchedule"},"nextSlots":{"type":"array","items":{"type":"string","format":"date-time"}},"reshuffledCount":{"type":"integer"},"skippedDailyLimit":{"type":"integer"},"isNewQueue":{"type":"boolean"}}},"QueueDeleteResponse":{"type":"object","properties":{"success":{"type":"boolean"},"deleted":{"type":"boolean"},"deletedCount":{"type":"integer"},"message":{"type":"string"}}},"QueuePreviewResponse":{"type":"object","properties":{"profileId":{"type":"string"},"queueId":{"type":"string"},"queueName":{"type":"string"},"count":{"type":"integer"},"slots":{"type":"array","items":{"type":"string","format":"date-time"}}}},"QueueNextSlotResponse":{"type":"object","properties":{"profileId":{"type":"string"},"nextSlot":{"type":"string","format":"date-time"},"timezone":{"type":"string"},"queueId":{"type":"string"},"queueName":{"type":"string"}}},"User":{"type":"object","properties":{"_id":{"type":"string"},"email":{"type":"string"},"name":{"type":"string"},"role":{"type":"string"},"disabledResourceGroups":{"type":"array","items":{"type":"string"}},"createdAt":{"type":"string","format":"date-time"}}},"UsersListResponse":{"type":"object","properties":{"users":{"type":"array","items":{"$ref":"#/components/schemas/User"}}}},"UserGetResponse":{"type":"object","properties":{"user":{"$ref":"#/components/schemas/User"}}},"AdsListResponse":{"type":"object","properties":{"ads":{"type":"array","items":{"$ref":"#/components/schemas/Ad"}},"pagination":{"$ref":"#/components/schemas/Pagination"},"backfillPending":{"type":"boolean"}}},"AdsAlert":{"type":"object","properties":{"id":{"type":"string"},"kind":{"type":"string","enum":["ad_rejected","delivery_issue","payment","budget_limited","spend_no_results","connection_lost","sync_failing"]},"severity":{"type":"string","enum":["error","warning","info"]},"title":{"type":"string"},"message":{"type":"string"},"platform":{"type":"string"},"platformAdAccountId":{"type":"string"},"entity":{"type":"object","properties":{"level":{"type":"string","enum":["ad_account","campaign","ad_set","ad"]},"id":{"type":"string"},"name":{"type":["string","null"]}}},"adId":{"type":"string"},"accountId":{"type":"string"},"currency":{"type":["string","null"]},"detectedAt":{"type":"string","format":"date-time"},"fix":{"type":"object","properties":{"label":{"type":"string"},"url":{"type":"string","format":"uri-reference"}}},"dismissed":{"type":"boolean"}}},"AdTreeResponse":{"type":"object","properties":{"campaigns":{"type":"array","items":{"$ref":"#/components/schemas/AdTreeCampaign"}},"pagination":{"$ref":"#/components/schemas/Pagination"},"syncedAt":{"type":["string","null"],"format":"date-time"},"previousRange":{"type":"object","properties":{"fromDate":{"type":"string","format":"date"},"toDate":{"type":"string","format":"date"}}},"backfillPending":{"type":"boolean"}}},"AdsTimelineResponse":{"type":"object","properties":{"backfillPending":{"type":"boolean"},"previousRows":{"type":"array","items":{"type":"object","additionalProperties":true}},"previousRange":{"type":"object","properties":{"fromDate":{"type":"string","format":"date"},"toDate":{"type":"string","format":"date"}}},"rows":{"type":"array","items":{"type":"object","properties":{"date":{"type":"string","format":"date"},"currency":{"type":["string","null"]},"spend":{"type":"number"},"impressions":{"type":"integer"},"reach":{"type":"integer"},"clicks":{"type":"integer"},"engagement":{"type":"integer"},"ctr":{"type":"number"},"cpc":{"type":"number"},"cpm":{"type":"number"},"conversions":{"type":"number"},"allConversions":{"type":"number"},"costPerConversion":{"type":"number"},"actions":{"type":"object","additionalProperties":{"type":"number"}},"actionValues":{"type":"object","additionalProperties":{"type":"number"}},"purchaseValue":{"type":"number"},"roas":{"type":"number"}}}}}},"AdNegativeKeywordList":{"type":"object","properties":{"id":{"type":"string","pattern":"^\\d+$"},"resourceName":{"type":"string"},"name":{"type":"string"},"memberCount":{"type":"integer"},"referenceCount":{"type":"integer"}}},"AdNegativeKeywordListKeyword":{"type":"object","properties":{"criterionId":{"type":"string","pattern":"^\\d+$"},"text":{"type":"string"},"matchType":{"type":"string","enum":["broad","phrase","exact"]}}},"CampaignAnalyticsResponse":{"type":"object","properties":{"backfillPending":{"type":"boolean"},"campaign":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":["string","null"]},"platform":{"type":"string"},"status":{"type":["string","null"]},"budget":{"anyOf":[{"$ref":"#/components/schemas/AdCampaignBudget"},{"type":"null"}]},"currency":{"type":["string","null"]}}},"analytics":{"type":"object","properties":{"summary":{"allOf":[{"$ref":"#/components/schemas/AdMetrics"},{"type":"object","properties":{"searchImpressionShare":{"type":["number","null"]},"searchBudgetLostImpressionShare":{"type":["number","null"]},"searchRankLostImpressionShare":{"type":["number","null"]},"searchTopImpressionShare":{"type":["number","null"]},"searchAbsoluteTopImpressionShare":{"type":["number","null"]}}}]},"impressionShareCache":{"type":"object","properties":{"cachedAt":{"type":["string","null"],"format":"date-time"},"stale":{"type":"boolean"}}},"daily":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/AdMetrics"},{"type":"object","properties":{"date":{"type":"string","format":"date"}}}]}},"breakdowns":{"type":"object","additionalProperties":{"type":"array","items":{"type":"object"}}},"unsupportedBreakdowns":{"type":"array","items":{"type":"string"}},"breakdownHints":{"type":"object","additionalProperties":{"type":"string"}},"breakdownErrors":{"type":"array","items":{"type":"object","properties":{"breakdown":{"type":"string"},"message":{"type":"string"}}}},"breakdownDroppedMetrics":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"breakdownsRange":{"type":"object","properties":{"fromDate":{"type":"string","format":"date"},"toDate":{"type":"string","format":"date"}}}}}}},"AdAnalyticsResponse":{"type":"object","properties":{"backfillPending":{"type":"boolean"},"ad":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"platform":{"type":"string"},"status":{"type":"string"},"currency":{"type":["string","null"]}}},"analytics":{"type":"object","properties":{"summary":{"$ref":"#/components/schemas/AdMetrics"},"daily":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/AdMetrics"},{"type":"object","properties":{"date":{"type":"string","format":"date"}}}]}},"breakdowns":{"type":"object","additionalProperties":{"type":"array","items":{"type":"object"}}},"unsupportedBreakdowns":{"type":"array","items":{"type":"string"}},"breakdownHints":{"type":"object","additionalProperties":{"type":"string"}},"breakdownErrors":{"type":"array","items":{"type":"object","properties":{"breakdown":{"type":"string"},"message":{"type":"string"}}}},"breakdownDroppedMetrics":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"breakdownsRange":{"type":"object","properties":{"fromDate":{"type":"string","format":"date"},"toDate":{"type":"string","format":"date"}}}}}}},"AdMetrics":{"type":"object","properties":{"spend":{"type":"number"},"impressions":{"type":"integer"},"reach":{"type":"integer"},"clicks":{"type":"integer"},"ctr":{"type":"number"},"cpc":{"type":"number"},"cpm":{"type":"number"},"engagement":{"type":"integer"},"conversions":{"type":"number"},"allConversions":{"type":"number"},"costPerConversion":{"type":"number"},"actions":{"type":"object","additionalProperties":{"type":"integer"}},"actionValues":{"type":"object","additionalProperties":{"type":"number"}},"purchaseValue":{"type":"number"},"roas":{"type":"number"},"costPerAction":{"type":"object","additionalProperties":{"type":"number"}},"outboundClicks":{"type":"integer"},"outboundClicksCtr":{"type":"number"},"inlineLinkClicks":{"type":"integer"},"inlineLinkClickCtr":{"type":"number"},"uniqueClicks":{"type":"integer"},"uniqueCtr":{"type":"number"},"videoPlayActions":{"type":"integer"},"video30SecWatchedActions":{"type":"integer"},"videoThruplayWatchedActions":{"type":"integer"},"videoP25WatchedActions":{"type":"integer"},"videoP50WatchedActions":{"type":"integer"},"videoP75WatchedActions":{"type":"integer"},"videoP95WatchedActions":{"type":"integer"},"videoP100WatchedActions":{"type":"integer"},"video2SecWatchedActions":{"type":"integer"},"video6SecWatchedActions":{"type":"integer"},"video6SecFocusedViews":{"type":"integer"},"videoAvgTimeWatchedActions":{"type":"number"},"costPerThruplay":{"type":"number"},"funnel":{"$ref":"#/components/schemas/AdFunnelCounts"},"engagementBreakdown":{"$ref":"#/components/schemas/AdEngagementCounts"},"lastSyncedAt":{"type":"string","format":"date-time"}}},"AdFunnelCounts":{"type":"object","properties":{"landingPageViews":{"type":"integer"},"contentViews":{"type":"integer"},"searches":{"type":"integer"},"wishlistAdds":{"type":"integer"},"cartAdds":{"type":"integer"},"checkoutsInitiated":{"type":"integer"},"paymentInfoAdds":{"type":"integer"},"purchases":{"type":"integer"},"leads":{"type":"integer"},"registrationsCompleted":{"type":"integer"},"appInstalls":{"type":"integer"},"messagingConversationsStarted":{"type":"integer"},"messagingFirstReplies":{"type":"integer"}}},"AdEngagementCounts":{"type":"object","properties":{"postEngagement":{"type":"integer"},"pageEngagement":{"type":"integer"},"reactions":{"type":"integer"},"comments":{"type":"integer"},"shares":{"type":"integer"},"saves":{"type":"integer"},"pageLikes":{"type":"integer"},"videoViews":{"type":"integer"},"linkClicks":{"type":"integer"}}},"AdDailyMetrics":{"allOf":[{"$ref":"#/components/schemas/AdMetrics"},{"type":"object","properties":{"date":{"type":"string","format":"date"}}}]},"AdStatus":{"type":"string","enum":["active","paused","pending_review","rejected","completed","cancelled","error"]},"AdActivationStatus":{"type":"string","enum":["ACTIVE","PAUSED"]},"AdReviewStatus":{"type":"string","enum":["in_review","approved","rejected","with_issues"]},"BusinessCenter":{"type":"object","properties":{"bcId":{"type":"string"},"name":{"type":"string"},"advertiserCount":{"type":["integer","null"]}}},"ValueRuleCriterion":{"type":"object","additionalProperties":false,"required":["criteriaType","operator","criteriaValues","criteriaValueTypes"],"properties":{"id":{"type":"string"},"criteriaType":{"type":"string","enum":["AGE","GENDER","OS_TYPE","DEVICE_PLATFORM","LOCATION","PLACEMENT","OMNI_CHANNEL","AUDIENCE_LABEL"]},"operator":{"type":"string","enum":["CONTAINS"]},"criteriaValues":{"type":"array","minItems":1,"items":{"type":"string"}},"criteriaValueTypes":{"type":"array","minItems":1,"items":{"type":"string"}}}},"ValueRule":{"type":"object","additionalProperties":false,"required":["name","adjustSign","adjustValue","criteria"],"properties":{"id":{"type":"string"},"name":{"type":"string","minLength":1,"maxLength":255},"adjustSign":{"type":"string","enum":["INCREASE","DECREASE"]},"adjustValue":{"type":"integer","minimum":1,"maximum":1000},"status":{"type":"string"},"criteria":{"type":"array","minItems":1,"maxItems":4,"items":{"$ref":"#/components/schemas/ValueRuleCriterion"}}}},"ValueRuleSet":{"type":"object","additionalProperties":false,"required":["id","name","rules"],"properties":{"id":{"type":"string"},"name":{"type":"string"},"rules":{"type":"array","items":{"$ref":"#/components/schemas/ValueRule"}}}},"BidStrategy":{"type":"string","enum":["LOWEST_COST_WITHOUT_CAP","LOWEST_COST_WITH_BID_CAP","COST_CAP","LOWEST_COST_WITH_MIN_ROAS"]},"GoogleAdsHierarchyClient":{"type":"object","properties":{"customerId":{"type":"string"},"name":{"type":["string","null"]},"currency":{"type":["string","null"]},"timeZone":{"type":["string","null"]},"manager":{"type":"boolean"},"testAccount":{"type":"boolean"},"hidden":{"type":"boolean"},"level":{"type":"integer"},"status":{"type":["string","null"]},"parentCustomerId":{"type":["string","null"]},"managerLinkId":{"type":["string","null"]},"linkStatus":{"type":["string","null"],"enum":["ACTIVE","PENDING",null]}}},"GoogleAdsManagerLink":{"type":"object","properties":{"managerCustomerId":{"type":"string"},"clientCustomerId":{"type":"string"},"managerLinkId":{"type":["string","null"]},"status":{"type":"string","enum":["PENDING","ACTIVE","REFUSED","CANCELED","INACTIVE"]},"validateOnly":{"type":"boolean"}}},"GoogleAdsAccessRole":{"type":"string","enum":["ADMIN","STANDARD","READ_ONLY","EMAIL_ONLY"]},"GoogleAdsUserAccessInvitation":{"type":"object","properties":{"invitationId":{"type":"string"},"emailAddress":{"type":"string"},"accessRole":{"type":"string","enum":["ADMIN","STANDARD","READ_ONLY","EMAIL_ONLY","UNKNOWN"]},"status":{"type":"string","enum":["PENDING","DECLINED","EXPIRED","UNKNOWN"]},"createdAt":{"type":["string","null"]}}},"GoogleAdsUserAccessInvitationResult":{"type":"object","properties":{"customerId":{"type":"string"},"emailAddress":{"type":"string"},"accessRole":{"$ref":"#/components/schemas/GoogleAdsAccessRole"},"status":{"type":"string","enum":["PENDING","PENDING_APPROVAL"]},"invitationId":{"type":["string","null"]},"multiPartyAuthReviewId":{"type":["string","null"]},"validateOnly":{"type":"boolean"}}},"GoogleAdsUserInvitationApproval":{"type":"object","properties":{"multiPartyAuthReviewId":{"type":"string"},"emailAddress":{"type":["string","null"]},"accessRole":{"type":"string","enum":["ADMIN","STANDARD","READ_ONLY","EMAIL_ONLY","UNKNOWN"]},"requestUserEmail":{"type":["string","null"]},"createdAt":{"type":["string","null"]}}},"GoogleTargetImpressionShare":{"type":"object","additionalProperties":false,"required":["location","percent","maxCpc"],"properties":{"location":{"type":"string","enum":["ANYWHERE_ON_PAGE","TOP_OF_PAGE","ABSOLUTE_TOP_OF_PAGE"]},"percent":{"type":"number","exclusiveMinimum":0,"maximum":100},"maxCpc":{"type":"number","exclusiveMinimum":0}}},"GoogleManualCpc":{"type":"object","additionalProperties":false,"required":["maxCpc"],"properties":{"maxCpc":{"type":"number","exclusiveMinimum":0}}},"GoogleNetworkSettings":{"type":"object","additionalProperties":false,"minProperties":1,"properties":{"searchPartners":{"type":"boolean"},"displayNetwork":{"type":"boolean"}}},"PortfolioBidStrategy":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"type":{"type":"string","enum":["TARGET_CPA","TARGET_ROAS","MAXIMIZE_CONVERSIONS","MAXIMIZE_CONVERSION_VALUE","TARGET_IMPRESSION_SHARE"]},"status":{"type":"string"},"campaignCount":{"type":"integer"},"clicks":{"type":"integer"},"cost":{"type":"number"},"costPerConversion":{"type":"number"},"impressions":{"type":"integer"},"averageCpc":{"type":"number"},"conversions":{"type":"number"},"targetCpa":{"type":["number","null"]},"targetRoas":{"type":["number","null"]},"targetImpressionShare":{"oneOf":[{"$ref":"#/components/schemas/GoogleTargetImpressionShare"},{"type":"null"}]}}},"CampaignBidding":{"type":"object","properties":{"channel":{"type":"string","enum":["SEARCH","DISPLAY"]},"biddingStrategyType":{"type":"string"},"bidSpec":{"type":["object","null"],"properties":{"bidStrategy":{"$ref":"#/components/schemas/BidStrategy"},"bidAmount":{"type":"number"},"roasAverageFloor":{"type":"number"},"portfolioBidStrategyId":{"type":"string"}}},"portfolio":{"type":["object","null"],"properties":{"id":{"type":"string"},"name":{"type":"string"}}},"cachedAt":{"type":["string","null"],"format":"date-time"},"stale":{"type":"boolean"}}},"AdCampaignBudget":{"allOf":[{"$ref":"#/components/schemas/AdBudget"},{"type":"object","properties":{"amountMicros":{"type":"string","pattern":"^\\d+$"},"explicitlyShared":{"type":["boolean","null"]},"resourceName":{"type":["string","null"]},"deliveryMethod":{"type":["string","null"]}}}]},"AdBudget":{"type":"object","required":["amount","type"],"properties":{"amount":{"type":"number"},"type":{"type":"string","enum":["daily","lifetime"]}}},"AdPromotedObject":{"type":"object","properties":{"pixelId":{"type":"string"},"customEventType":{"type":"string"},"customEventStr":{"type":"string"},"pageId":{"type":"string"},"applicationId":{"type":"string"},"objectStoreUrl":{"type":"string","format":"uri"},"customConversionId":{"type":"string"},"productCatalogId":{"type":"string"},"productSetId":{"type":"string"},"offlineConversionDataSetId":{"type":"string"},"whatsappPhoneNumber":{"type":"string"}},"additionalProperties":false},"TargetingSpec":{"type":"object","properties":{"userOs":{"type":"array","minItems":1,"items":{"type":"string","minLength":1}},"userDevice":{"type":"array","minItems":1,"items":{"type":"string","minLength":1}},"countries":{"type":"array","items":{"type":"string"}},"regions":{"type":"array","items":{"oneOf":[{"type":"string"},{"type":"object","required":["key"],"properties":{"key":{"type":"string"},"name":{"type":"string"}}}]}},"cities":{"type":"array","items":{"oneOf":[{"type":"string"},{"type":"object","required":["key"],"properties":{"key":{"type":"string"},"name":{"type":"string"},"radius":{"type":"number"},"distanceUnit":{"type":"string","enum":["mile","kilometer"]}}}]}},"zips":{"type":"array","items":{"type":"object","required":["key"],"properties":{"key":{"type":"string"},"name":{"type":"string"}}}},"metros":{"type":"array","items":{"type":"object","required":["key"],"properties":{"key":{"type":"string"},"name":{"type":"string"}}}},"countryGroups":{"type":"array","items":{"type":"string","enum":["africa","asia","europe","north_america","south_america","oceania","central_america","caribbean","eea","euro_area","nafta","mercosur","afta","apec","gcc","cisfta","emerging_markets","itunes_app_store","android_free_store","android_paid_store"]}},"customLocations":{"type":"array","items":{"type":"object","required":["latitude","longitude","radius","distanceUnit"],"properties":{"latitude":{"type":"number","minimum":-90,"maximum":90},"longitude":{"type":"number","minimum":-180,"maximum":180},"radius":{"type":"number"},"distanceUnit":{"type":"string","enum":["mile","kilometer"]},"name":{"type":"string"},"address":{"type":"string"}}}},"excludedLocations":{"type":"object","properties":{"countries":{"type":"array","items":{"type":"string"}},"countryGroups":{"type":"array","items":{"type":"string","enum":["africa","asia","europe","north_america","south_america","oceania","central_america","caribbean","eea","euro_area","nafta","mercosur","afta","apec","gcc","cisfta","emerging_markets","itunes_app_store","android_free_store","android_paid_store"]}},"regions":{"type":"array","items":{"type":"object","required":["key"],"properties":{"key":{"type":"string"},"name":{"type":"string"}}}},"cities":{"type":"array","items":{"type":"object","required":["key"],"properties":{"key":{"type":"string"},"radius":{"type":"number"},"distanceUnit":{"type":"string","enum":["mile","kilometer"]}}}},"zips":{"type":"array","items":{"type":"object","required":["key"],"properties":{"key":{"type":"string"},"name":{"type":"string"}}}},"places":{"type":"array","items":{"type":"object","required":["key"],"properties":{"key":{"type":"string"}}}},"neighborhoods":{"type":"array","items":{"type":"object","required":["key"],"properties":{"key":{"type":"string"}}}},"customLocations":{"type":"array","items":{"type":"object","required":["latitude","longitude","radius","distanceUnit"],"properties":{"latitude":{"type":"number","minimum":-90,"maximum":90},"longitude":{"type":"number","minimum":-180,"maximum":180},"radius":{"type":"number"},"distanceUnit":{"type":"string","enum":["mile","kilometer"]},"name":{"type":"string"},"address":{"type":"string"}}}}}},"ageMin":{"type":"integer","minimum":13,"maximum":100},"ageMax":{"type":"integer","minimum":13,"maximum":100},"gender":{"type":"string","enum":["all","male","female"]},"incomeTier":{"type":"string","enum":["top_5","top_10","top_10_25","top_25_50"]},"languages":{"type":"array","items":{"type":"string"}},"interests":{"type":"array","items":{"type":"object","required":["id"],"properties":{"id":{"type":"string"},"name":{"type":"string"}}}},"behaviors":{"type":"array","items":{"type":"object","required":["id"],"properties":{"id":{"type":"string"},"name":{"type":"string"}}}},"workPositions":{"type":"array","items":{"type":"object","required":["id"],"properties":{"id":{"type":"string"},"name":{"type":"string"}}}},"workEmployers":{"type":"array","items":{"type":"object","required":["id"],"properties":{"id":{"type":"string"},"name":{"type":"string"}}}},"workIndustries":{"type":"array","items":{"type":"object","required":["id"],"properties":{"id":{"type":"string"},"name":{"type":"string"}}}},"industries":{"type":"array","items":{"type":"string"}},"companySizes":{"type":"array","items":{"type":"string"}},"seniorities":{"type":"array","items":{"type":"string"}},"jobFunctions":{"type":"array","items":{"type":"string"}},"skills":{"type":"array","items":{"type":"string"}},"audienceInclude":{"type":"array","items":{"type":"string"}},"audienceExclude":{"type":"array","items":{"type":"string"}},"communities":{"type":"array","items":{"type":"string","minLength":1}},"excludedCommunities":{"type":"array","items":{"type":"string","minLength":1}},"conversationKeywords":{"type":"array","items":{"type":"string","minLength":1}},"excludedConversationKeywords":{"type":"array","items":{"type":"string","minLength":1}}}},"MetaPlacementAssets":{"type":"object","required":["rules"],"properties":{"defaultImageUrl":{"type":"string","format":"uri"},"defaultVideoUrl":{"type":"string","format":"uri"},"defaultThumbnailUrl":{"type":"string","format":"uri"},"rules":{"type":"array","minItems":1,"maxItems":10,"items":{"type":"object","required":["placements"],"properties":{"imageUrl":{"type":"string","format":"uri"},"videoUrl":{"type":"string","format":"uri"},"thumbnailUrl":{"type":"string","format":"uri"},"headline":{"type":"string","minLength":1,"maxLength":255},"body":{"type":"string","minLength":1},"description":{"type":"string","minLength":1,"maxLength":255},"placements":{"type":"object","properties":{"publisherPlatforms":{"type":"array","items":{"type":"string","enum":["facebook","instagram","threads","messenger","audience_network","whatsapp"]}},"facebookPositions":{"type":"array","items":{"type":"string","enum":["feed","right_hand_column","marketplace","story","search","instream_video","facebook_reels","facebook_reels_overlay","profile_feed","notification"]}},"instagramPositions":{"type":"array","items":{"type":"string","enum":["stream","story","explore","explore_home","reels","profile_feed","ig_search","profile_reels"]}},"messengerPositions":{"type":"array","items":{"type":"string","enum":["messenger_home","sponsored_messages","story"]}},"audienceNetworkPositions":{"type":"array","items":{"type":"string","enum":["classic","rewarded_video"]}},"threadsPositions":{"type":"array","items":{"type":"string","enum":["threads_stream"]}},"whatsappPositions":{"type":"array","items":{"type":"string","enum":["status"]}},"devicePlatforms":{"type":"array","items":{"type":"string","enum":["mobile","desktop"]}}}}}}}}},"MetaCreativeFeatures":{"type":"object","additionalProperties":{"type":"string","enum":["OPT_IN","OPT_OUT"]}},"MetaPromotion":{"type":["object","null"]},"GoogleSitelink":{"type":"object","required":["text","linkUrl"],"properties":{"text":{"type":"string","minLength":1,"maxLength":25},"linkUrl":{"type":"string","format":"uri"},"description1":{"type":"string","minLength":1,"maxLength":35},"description2":{"type":"string","minLength":1,"maxLength":35}}},"GoogleStructuredSnippet":{"type":"object","required":["header","values"],"properties":{"header":{"type":"string","enum":["Amenities","Brands","Courses","Degree programs","Destinations","Featured hotels","Insurance coverage","Models","Neighborhoods","Service catalog","Shows","Styles","Types"]},"values":{"type":"array","minItems":3,"maxItems":10,"items":{"type":"string","minLength":1,"maxLength":25}}}},"GoogleAssetUpdate":{"type":"object","required":["assetResourceName"],"properties":{"assetResourceName":{"type":"string","pattern":"^customers/\\d+/assets/\\d+$"},"sitelinkAsset":{"type":"object","properties":{"linkText":{"type":"string","minLength":1,"maxLength":25},"description1":{"type":"string","maxLength":35},"description2":{"type":"string","maxLength":35},"linkUrl":{"type":"string","format":"uri"}},"minProperties":1},"finalUrls":{"type":"array","items":{"type":"string","format":"uri"},"minItems":1},"calloutAsset":{"type":"object","required":["calloutText"],"properties":{"calloutText":{"type":"string","minLength":1,"maxLength":25}}},"structuredSnippetAsset":{"$ref":"#/components/schemas/GoogleStructuredSnippet"}}},"GoogleLocationTargetingType":{"type":"string","enum":["presence","presence_or_interest"]},"GoogleDemandGenInput":{"type":"object","additionalProperties":false,"required":["finalUrl","businessName","headlines","descriptions","images"],"properties":{"adGroupName":{"type":"string","maxLength":255},"finalUrl":{"type":"string","format":"uri"},"businessName":{"type":"string","maxLength":25},"headlines":{"type":"array","minItems":1,"maxItems":5,"items":{"type":"string","maxLength":40}},"longHeadlines":{"type":"array","minItems":1,"maxItems":5,"items":{"type":"string","maxLength":90}},"descriptions":{"type":"array","minItems":1,"maxItems":5,"items":{"type":"string","maxLength":90}},"callToAction":{"type":"string","maxLength":25},"images":{"type":"object","additionalProperties":false,"required":["logo"],"properties":{"landscape":{"type":"array","minItems":1,"maxItems":20,"items":{"type":"string","format":"uri"}},"square":{"type":"array","minItems":1,"maxItems":20,"items":{"type":"string","format":"uri"}},"portrait":{"type":"array","minItems":1,"maxItems":20,"items":{"type":"string","format":"uri"}},"logo":{"type":"array","minItems":1,"maxItems":5,"items":{"type":"string","format":"uri"}}}},"youtubeVideoIds":{"type":"array","minItems":1,"maxItems":5,"items":{"type":"string","pattern":"^[A-Za-z0-9_-]{11}$"}},"carouselCards":{"type":"array","minItems":2,"maxItems":10,"items":{"type":"object","additionalProperties":false,"required":["headline","images"],"properties":{"headline":{"type":"string","maxLength":40},"finalUrl":{"type":"string","format":"uri"},"callToAction":{"type":"string","maxLength":25},"images":{"type":"object","additionalProperties":false,"minProperties":1,"properties":{"landscape":{"type":"string","format":"uri"},"square":{"type":"string","format":"uri"},"portrait":{"type":"string","format":"uri"}}}}}},"channels":{"type":"array","minItems":1,"items":{"type":"string","enum":["youtube_in_stream","youtube_in_feed","youtube_shorts","discover","gmail","display"]}},"audience":{"$ref":"#/components/schemas/GoogleDemandGenAudience"},"audienceId":{"type":"string"}}},"GoogleDemandGenAudience":{"type":"object","additionalProperties":false,"minProperties":1,"properties":{"userLists":{"type":"array","minItems":1,"maxItems":20,"items":{"type":"string"}},"userInterests":{"type":"array","minItems":1,"maxItems":20,"items":{"type":"string"}},"customAudiences":{"type":"array","minItems":1,"maxItems":20,"items":{"type":"string"}},"ageRanges":{"type":"array","minItems":1,"maxItems":6,"items":{"type":"object","required":["min"],"properties":{"min":{"type":"integer","enum":[18,25,35,45,55,65]},"max":{"type":"integer","enum":[24,34,44,54,64]}}}},"genders":{"type":"array","minItems":1,"maxItems":3,"items":{"type":"string","enum":["male","female","undetermined"]}}}},"GoogleDemandGenUpdate":{"type":"object","additionalProperties":false,"minProperties":1,"properties":{"finalUrl":{"type":"string","format":"uri"},"businessName":{"type":"string","maxLength":25},"headlines":{"type":"array","minItems":1,"maxItems":5,"items":{"type":"string","maxLength":40}},"longHeadlines":{"type":"array","minItems":1,"maxItems":5,"items":{"type":"string","maxLength":90}},"descriptions":{"type":"array","minItems":1,"maxItems":5,"items":{"type":"string","maxLength":90}},"callToAction":{"type":"string","maxLength":25},"images":{"type":"object","additionalProperties":false,"minProperties":1,"properties":{"landscape":{"type":"array","minItems":1,"maxItems":20,"items":{"type":"string","format":"uri"}},"square":{"type":"array","minItems":1,"maxItems":20,"items":{"type":"string","format":"uri"}},"portrait":{"type":"array","minItems":1,"maxItems":20,"items":{"type":"string","format":"uri"}},"logo":{"type":"array","minItems":1,"maxItems":5,"items":{"type":"string","format":"uri"}}}},"youtubeVideoIds":{"type":"array","minItems":1,"maxItems":5,"items":{"type":"string","pattern":"^[A-Za-z0-9_-]{11}$"}},"channels":{"type":"array","minItems":1,"items":{"type":"string","enum":["youtube_in_stream","youtube_in_feed","youtube_shorts","discover","gmail","display"]}},"audience":{"$ref":"#/components/schemas/GoogleDemandGenAudience"},"audienceId":{"type":"string"}}},"GooglePmaxAssetGroupInput":{"type":"object","additionalProperties":false,"required":["finalUrl","headlines","longHeadline","descriptions","businessName","images"],"properties":{"name":{"type":"string","minLength":1,"maxLength":128},"finalUrl":{"type":"string","format":"uri","pattern":"^https?://"},"headlines":{"type":"array","minItems":3,"maxItems":15,"uniqueItems":true,"items":{"type":"string","minLength":1,"maxLength":30}},"longHeadline":{"type":"string","minLength":1,"maxLength":90},"descriptions":{"type":"array","minItems":2,"maxItems":5,"uniqueItems":true,"items":{"type":"string","minLength":1,"maxLength":90}},"businessName":{"type":"string","minLength":1,"maxLength":25},"images":{"type":"object","additionalProperties":false,"required":["landscape","square","logo"],"properties":{"landscape":{"type":"array","minItems":1,"maxItems":20,"items":{"type":"string","format":"uri","pattern":"^https?://"}},"square":{"type":"array","minItems":1,"maxItems":20,"items":{"type":"string","format":"uri","pattern":"^https?://"}},"logo":{"type":"array","minItems":1,"maxItems":5,"items":{"type":"string","format":"uri","pattern":"^https?://"}}}},"youtubeVideoId":{"type":"string","pattern":"^[A-Za-z0-9_-]{11}$"}}},"GooglePmaxAssetGroupUpdate":{"type":"object","additionalProperties":false,"minProperties":1,"properties":{"finalUrl":{"type":"string","format":"uri","pattern":"^https?://"},"headlines":{"type":"array","minItems":3,"maxItems":15,"uniqueItems":true,"items":{"type":"string","minLength":1,"maxLength":30}},"longHeadline":{"type":"string","minLength":1,"maxLength":90},"descriptions":{"type":"array","minItems":2,"maxItems":5,"uniqueItems":true,"items":{"type":"string","minLength":1,"maxLength":90}},"businessName":{"type":"string","minLength":1,"maxLength":25},"images":{"type":"object","additionalProperties":false,"minProperties":1,"properties":{"landscape":{"type":"array","minItems":1,"maxItems":20,"items":{"type":"string","format":"uri","pattern":"^https?://"}},"square":{"type":"array","minItems":1,"maxItems":20,"items":{"type":"string","format":"uri","pattern":"^https?://"}},"logo":{"type":"array","minItems":1,"maxItems":5,"items":{"type":"string","format":"uri","pattern":"^https?://"}}}},"youtubeVideoIds":{"type":"array","minItems":1,"maxItems":5,"items":{"type":"string","pattern":"^[A-Za-z0-9_-]{11}$"}}}},"GooglePmaxAssetGroup":{"type":"object","required":["id","resourceName","campaignId","name","status","finalUrls","finalMobileUrls","path1","path2","adStrength","primaryStatus","primaryStatusReasons","assets"],"properties":{"id":{"type":"string"},"resourceName":{"type":"string"},"campaignId":{"type":"string"},"name":{"type":"string"},"status":{"type":"string"},"finalUrls":{"type":"array","items":{"type":"string","format":"uri"}},"finalMobileUrls":{"type":"array","items":{"type":"string","format":"uri"}},"path1":{"type":["string","null"]},"path2":{"type":["string","null"]},"adStrength":{"type":["string","null"]},"primaryStatus":{"type":["string","null"]},"primaryStatusReasons":{"type":"array","items":{"type":"string"}},"assets":{"type":"array","items":{"type":"object","required":["resourceName","fieldType","status"],"properties":{"resourceName":{"type":"string"},"fieldType":{"type":"string"},"status":{"type":"string"},"text":{"type":"string"},"imageUrl":{"type":"string","format":"uri"},"youtubeVideoId":{"type":"string"}}}}}},"GooglePmaxAssetGroupDetail":{"allOf":[{"$ref":"#/components/schemas/GooglePmaxAssetGroup"},{"type":"object","required":["listingGroupFilters"],"properties":{"listingGroupFilters":{"type":"array","items":{"$ref":"#/components/schemas/GoogleListingGroupFilterNode"}}}}]},"GoogleListingGroupFilterNode":{"type":"object","required":["id","resourceName","parentResourceName","type","listingSource","dimension"],"properties":{"id":{"type":"string"},"resourceName":{"type":"string"},"parentResourceName":{"type":["string","null"]},"type":{"type":"string","enum":["SUBDIVISION","UNIT_INCLUDED","UNIT_EXCLUDED"]},"listingSource":{"type":"string"},"dimension":{"type":["object","null"]}}},"GoogleAssetGroupAssetLink":{"type":"object","required":["fieldType"],"properties":{"fieldType":{"type":"string"},"asset":{"type":"string"},"text":{"type":"string","maxLength":90},"imageUrl":{"type":"string","format":"uri"},"youtubeVideoId":{"type":"string","pattern":"^[A-Za-z0-9_-]{11}$"}}},"GoogleAssetGroupAssetUnlink":{"type":"object","required":["fieldType","asset"],"properties":{"fieldType":{"type":"string"},"asset":{"type":"string"}}},"GoogleListingGroupDimension":{"type":"object","properties":{"productBrand":{"type":"object","properties":{"value":{"type":"string"}}},"productCategory":{"type":"object","required":["level"],"properties":{"categoryId":{"type":"string"},"level":{"type":"string","enum":["LEVEL1","LEVEL2","LEVEL3","LEVEL4","LEVEL5"]}}},"productType":{"type":"object","required":["level"],"properties":{"value":{"type":"string"},"level":{"type":"string","enum":["LEVEL1","LEVEL2","LEVEL3","LEVEL4","LEVEL5"]}}},"productItemId":{"type":"object","properties":{"value":{"type":"string"}}},"productCondition":{"type":"object","properties":{"condition":{"type":"string","enum":["NEW","REFURBISHED","USED"]}}},"productChannel":{"type":"object","properties":{"channel":{"type":"string","enum":["ONLINE","LOCAL"]}}},"productCustomAttribute":{"type":"object","required":["index"],"properties":{"value":{"type":"string"},"index":{"type":"string","enum":["INDEX0","INDEX1","INDEX2","INDEX3","INDEX4"]}}}}},"GoogleListingGroupNode":{"type":"object","required":["dimension"],"properties":{"dimension":{"$ref":"#/components/schemas/GoogleListingGroupDimension"},"excluded":{"type":"boolean"},"children":{"type":"array","minItems":2,"items":{"$ref":"#/components/schemas/GoogleListingGroupNode"}}}},"GoogleListingGroupTree":{"type":"object","properties":{"children":{"type":"array","minItems":2,"items":{"$ref":"#/components/schemas/GoogleListingGroupNode"}}}},"GoogleRecommendationMetrics":{"type":"object","properties":{"impressions":{"type":"number"},"clicks":{"type":"number"},"cost":{"type":"number"},"conversions":{"type":"number"},"conversionsValue":{"type":"number"},"videoViews":{"type":"number"}}},"GoogleRecommendation":{"type":"object","required":["resourceName","id","type","dismissed","campaignId","campaignIds","adGroupId","campaignBudgetId","impact","details"],"properties":{"resourceName":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"dismissed":{"type":"boolean"},"campaignId":{"type":["string","null"]},"campaignIds":{"type":"array","items":{"type":"string"}},"adGroupId":{"type":["string","null"]},"campaignBudgetId":{"type":["string","null"]},"impact":{"type":["object","null"],"properties":{"base":{"$ref":"#/components/schemas/GoogleRecommendationMetrics"},"potential":{"$ref":"#/components/schemas/GoogleRecommendationMetrics"}}},"details":{"type":["object","null"]}}},"GoogleRecommendationResult":{"type":"object","required":["resourceName","status"],"properties":{"resourceName":{"type":"string"},"status":{"type":"string","enum":["applied","dismissed","failed"]},"error":{"type":"string"}}},"GoogleRsaHeadline":{"type":"object","required":["text"],"properties":{"text":{"type":"string","minLength":1,"maxLength":30},"pinnedField":{"type":"string","enum":["HEADLINE_1","HEADLINE_2","HEADLINE_3"]}}},"GoogleRsaDescription":{"type":"object","required":["text"],"properties":{"text":{"type":"string","minLength":1,"maxLength":90},"pinnedField":{"type":"string","enum":["DESCRIPTION_1","DESCRIPTION_2"]}}},"InstagramVideoFallback":{"type":"object","required":["kind","linkedToOriginalPost","videoId","platformError"],"properties":{"kind":{"type":"string","enum":["instagram_video_reuploaded","instagram_video_rehosted_copy"]},"linkedToOriginalPost":{"type":"boolean"},"videoId":{"type":"string"},"platformError":{"type":"object","required":["message"],"properties":{"code":{"type":"integer"},"subcode":{"type":"integer"},"message":{"type":"string"},"fbtraceId":{"type":"string"}}}}},"Ad":{"type":"object","properties":{"_id":{"type":"string"},"name":{"type":"string"},"platform":{"type":"string","enum":["facebook","instagram","tiktok","linkedin","pinterest","google","twitter","openai","reddit"]},"profileId":{"type":"string"},"status":{"allOf":[{"$ref":"#/components/schemas/AdStatus"}]},"configuredStatus":{"type":["string","null"]},"reviewStatus":{"allOf":[{"$ref":"#/components/schemas/AdReviewStatus"}]},"adType":{"type":"string","enum":["boost","standalone"]},"creativeType":{"type":["string","null"],"enum":["carousel","video","document","image",null]},"goal":{"type":"string","enum":["engagement","traffic","awareness","video_views","lead_generation","lead_conversion","conversions","app_promotion","catalog_sales","page_likes","page_visits","job_applicants"]},"isExternal":{"type":"boolean"},"synced":{"type":"boolean"},"budget":{"type":["object","null"],"properties":{"amount":{"type":"number"},"type":{"type":"string","enum":["daily","lifetime"]},"daily":{"type":"number"},"lifetime":{"type":"number"},"pacing":{"type":"string"}}},"metrics":{"anyOf":[{"$ref":"#/components/schemas/AdMetrics"},{"type":"null"}]},"platformAdId":{"type":"string"},"platformAdAccountId":{"type":"string"},"platformCampaignId":{"type":"string"},"platformAdSetId":{"type":"string"},"campaignName":{"type":"string"},"adSetName":{"type":"string"},"platformObjective":{"type":["string","null"]},"optimizationGoal":{"type":["string","null"]},"costType":{"type":["string","null"]},"servingStatuses":{"type":"array","items":{"type":"string"}},"platformAdAccountName":{"type":["string","null"]},"platformCreatedAt":{"type":["string","null"],"format":"date-time"},"bidStrategy":{"anyOf":[{"$ref":"#/components/schemas/BidStrategy"},{"type":"null"}]},"bidAmount":{"type":["number","null"]},"roasAverageFloor":{"type":["number","null"]},"promotedObject":{"type":["object","null"],"properties":{"custom_event_type":{"type":"string"},"pixel_id":{"type":"string"},"page_id":{"type":"string"},"application_id":{"type":"string"},"product_set_id":{"type":"string"}}},"creative":{"type":["object","null"],"properties":{"assetGroup":{"$ref":"#/components/schemas/GooglePmaxAssetGroupInput"},"assetGroupResourceName":{"type":"string"},"headlines":{"type":"array","maxItems":15,"items":{"oneOf":[{"type":"string"},{"$ref":"#/components/schemas/GoogleRsaHeadline"}]}},"descriptions":{"type":"array","maxItems":4,"items":{"oneOf":[{"type":"string"},{"$ref":"#/components/schemas/GoogleRsaDescription"}]}},"headline":{"type":"string"},"bodies":{"type":"array","items":{"type":"string"}},"description":{"type":"string"},"callToAction":{"type":"string"},"leadGenFormId":{"type":"string"},"imageHash":{"type":"string"},"urlTags":{"type":["string","null"]},"finalUrls":{"type":"array","minItems":1,"items":{"type":"string","format":"uri"}},"thumbnailUrl":{"type":["string","null"]},"imageUrl":{"type":"string"},"assetResourceName":{"type":"string"},"assets":{"type":"object","properties":{"marketingImages":{"type":"array","items":{"type":"object","properties":{"resourceName":{"type":"string"}}}},"squareMarketingImages":{"type":"array","items":{"type":"object","properties":{"resourceName":{"type":"string"}}}}}},"videoId":{"type":["string","null"]},"videoUrl":{"type":["string","null"]},"creativeId":{"type":["string","null"]},"creativeFeatures":{"$ref":"#/components/schemas/MetaCreativeFeatures"},"catalog":{"type":"object","properties":{"productSetId":{"type":"string"},"format":{"type":"string","enum":["single_image","carousel_images_multi_items","carousel_images_single_item","carousel_slideshows"]},"formatTransformationSpec":{"type":"array","items":{"type":"object","properties":{"format":{"type":"string"},"data_source":{"type":"array","items":{"type":"string"}}}}}}},"objectType":{"type":"string"},"objectStoryId":{"type":["string","null"]},"effectiveObjectStoryId":{"type":["string","null"]},"pageId":{"type":["string","null"]},"effectiveInstagramMediaId":{"type":["string","null"]},"instagramUserId":{"type":["string","null"]},"instagramPermalinkUrl":{"type":["string","null"]},"mediaUrls":{"type":"array","items":{"type":"string"}},"carouselCards":{"type":"array","items":{"type":"object","properties":{"imageUrl":{"type":"string"},"imageHash":{"type":"string"},"headline":{"type":"string"},"description":{"type":"string"},"linkUrl":{"type":"string"},"callToAction":{"type":"string"},"videoId":{"type":"string"}}}},"isServing":{"type":["boolean","null"]},"adFormat":{"type":["string","null"]},"servingHoldReasons":{"type":"array","items":{"type":"string"}},"body":{"type":"string"},"googleHeadline":{"type":"string"},"googleDescription":{"type":"string"},"youtubeVideoIds":{"type":"array","items":{"type":"string"}},"linkUrl":{"type":"string"},"whatsappPhoneNumber":{"type":"string"},"instagramVideoFallback":{"$ref":"#/components/schemas/InstagramVideoFallback"},"pinterestImageUrl":{"type":"string"},"pinterestTitle":{"type":"string"},"pinterestDescription":{"type":"string"}}},"targeting":{"type":"object"},"schedule":{"type":["object","null"],"properties":{"startDate":{"type":"string","format":"date-time"},"endDate":{"type":"string","format":"date-time"}}},"rejectionReason":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}}},"AdTreeAdSet":{"type":"object","properties":{"platformAdSetId":{"type":"string"},"adSetName":{"type":"string"},"status":{"allOf":[{"$ref":"#/components/schemas/AdStatus"}]},"createdTime":{"type":["string","null"],"format":"date-time"},"adCount":{"type":"integer"},"isSmartPlus":{"type":"boolean"},"budget":{"type":["object","null"],"properties":{"amount":{"type":"number"},"type":{"type":"string","enum":["daily","lifetime"]},"daily":{"type":"number"},"lifetime":{"type":"number"},"pacing":{"type":"string"}}},"adSetBudget":{"type":["object","null"],"properties":{"amount":{"type":"number"},"type":{"type":"string","enum":["daily","lifetime"]},"daily":{"type":"number"},"lifetime":{"type":"number"},"pacing":{"type":"string"}}},"metrics":{"$ref":"#/components/schemas/AdMetrics"},"previousMetrics":{"allOf":[{"$ref":"#/components/schemas/AdMetrics"}]},"optimizationGoal":{"type":["string","null"]},"bidStrategy":{"anyOf":[{"$ref":"#/components/schemas/BidStrategy"},{"type":"null"}]},"bidAmount":{"type":["number","null"]},"roasAverageFloor":{"type":["number","null"]},"costType":{"type":["string","null"]},"servingStatuses":{"type":"array","items":{"type":"string"}},"learningStatus":{"type":["string","null"],"enum":["LEARNING","SUCCESS","FAIL",null]},"promotedObject":{"type":["object","null"],"properties":{"custom_event_type":{"type":"string"},"pixel_id":{"type":"string"},"page_id":{"type":"string"}}},"destinationType":{"type":["string","null"]},"attributionSpec":{"type":["array","null"],"items":{"type":"object","properties":{"eventType":{"type":"string","enum":["CLICK_THROUGH","VIEW_THROUGH","ENGAGED_VIDEO_VIEW"]},"windowDays":{"type":"integer","enum":[1,7,28]}}}},"regionalRegulatedCategories":{"type":["array","null"],"items":{"type":"string"}},"regionalRegulationIdentities":{"type":["object","null"],"additionalProperties":{"type":"string"}},"ads":{"type":"array","items":{"$ref":"#/components/schemas/Ad"}},"daily":{"type":"array","items":{"$ref":"#/components/schemas/AdDailyMetrics"}}}},"AdTreeCampaign":{"type":"object","properties":{"platformCampaignId":{"type":"string"},"platform":{"type":"string","enum":["facebook","instagram","tiktok","linkedin","pinterest","google","twitter","openai","reddit"]},"campaignName":{"type":"string"},"createdTime":{"type":["string","null"],"format":"date-time"},"status":{"allOf":[{"$ref":"#/components/schemas/AdStatus"}]},"reviewStatus":{"anyOf":[{"$ref":"#/components/schemas/AdReviewStatus"},{"type":"null"}]},"platformCampaignStatus":{"type":["string","null"]},"campaignIssuesInfo":{"type":["array","null"],"items":{"type":"object"}},"adCount":{"type":"integer"},"adSetCount":{"type":"integer"},"budget":{"type":["object","null"],"properties":{"amount":{"type":"number"},"type":{"type":"string","enum":["daily","lifetime"]}}},"campaignBudget":{"type":["object","null"],"properties":{"amount":{"type":"number"},"type":{"type":"string","enum":["daily","lifetime"]}}},"budgetLevel":{"type":["string","null"],"enum":["campaign","adset"]},"isBudgetScheduleEnabled":{"type":"boolean","default":false},"currency":{"type":["string","null"]},"metrics":{"$ref":"#/components/schemas/AdMetrics"},"previousMetrics":{"allOf":[{"$ref":"#/components/schemas/AdMetrics"}]},"platformAdAccountId":{"type":"string"},"platformAdAccountName":{"type":["string","null"]},"accountId":{"type":"string"},"profileId":{"type":"string"},"isSmartPlus":{"type":"boolean"},"advertisingChannelType":{"type":["string","null"]},"platformObjective":{"type":["string","null"]},"optimizationGoal":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]},"bidStrategy":{"anyOf":[{"$ref":"#/components/schemas/BidStrategy"},{"type":"null"}]},"bidAmount":{"type":["number","null"]},"roasAverageFloor":{"type":["number","null"]},"promotedObject":{"type":["object","null"],"properties":{"custom_event_type":{"type":"string"},"pixel_id":{"type":"string"},"page_id":{"type":"string"}}},"adSets":{"type":"array","items":{"$ref":"#/components/schemas/AdTreeAdSet"}},"daily":{"type":"array","items":{"$ref":"#/components/schemas/AdDailyMetrics"}}}},"AdCampaign":{"type":"object","properties":{"platformCampaignId":{"type":"string"},"platform":{"type":"string","enum":["facebook","instagram","tiktok","linkedin","pinterest","google","twitter","openai","reddit"]},"campaignName":{"type":"string"},"status":{"allOf":[{"$ref":"#/components/schemas/AdStatus"}]},"reviewStatus":{"anyOf":[{"$ref":"#/components/schemas/AdReviewStatus"},{"type":"null"}]},"platformCampaignStatus":{"type":["string","null"]},"statusReadAt":{"type":["string","null"],"format":"date-time"},"nativeSettings":{"type":"object","additionalProperties":true},"configReadAt":{"type":["string","null"],"format":"date-time"},"campaignIssuesInfo":{"type":["array","null"],"items":{"type":"object"}},"adCount":{"type":"integer"},"budget":{"anyOf":[{"$ref":"#/components/schemas/AdCampaignBudget"},{"type":"null"}]},"campaignBudget":{"anyOf":[{"$ref":"#/components/schemas/AdCampaignBudget"},{"type":"null"}]},"budgetLevel":{"type":["string","null"],"enum":["campaign","adset"]},"isBudgetScheduleEnabled":{"type":"boolean","default":false},"currency":{"type":["string","null"]},"metrics":{"$ref":"#/components/schemas/AdMetrics"},"platformAdAccountId":{"type":"string"},"platformAdAccountName":{"type":["string","null"]},"accountId":{"type":"string"},"profileId":{"type":"string"},"isSmartPlus":{"type":"boolean"},"advertisingChannelType":{"type":["string","null"]},"platformObjective":{"type":["string","null"]},"optimizationGoal":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]},"bidStrategy":{"anyOf":[{"$ref":"#/components/schemas/BidStrategy"},{"type":"null"}]},"bidAmount":{"type":["number","null"]},"roasAverageFloor":{"type":["number","null"]},"promotedObject":{"type":["object","null"],"properties":{"custom_event_type":{"type":"string"},"pixel_id":{"type":"string"},"page_id":{"type":"string"}}},"earliestAd":{"type":"string","format":"date-time"},"latestAd":{"type":"string","format":"date-time"}}},"GoogleAdLabel":{"type":"object","properties":{"id":{"type":"string"},"resourceName":{"type":"string"},"name":{"type":"string"},"status":{"type":"string","enum":["ENABLED","REMOVED","UNKNOWN"]},"backgroundColor":{"type":["string","null"]},"description":{"type":["string","null"]}}},"GoogleAdLabelAssignments":{"type":"object","additionalProperties":false,"required":["accountId"],"properties":{"accountId":{"type":"string"},"adAccountId":{"type":"string","pattern":"^\\d+$"},"customerId":{"type":"string","pattern":"^\\d+$","deprecated":true},"campaignIds":{"type":"array","maxItems":1000,"items":{"type":"string","pattern":"^\\d+$"}},"adSetIds":{"type":"array","maxItems":1000,"items":{"type":"string","pattern":"^\\d+$"}},"adIds":{"type":"array","maxItems":1000,"items":{"type":"string","pattern":"^\\d+~\\d+$"}},"keywordIds":{"type":"array","maxItems":1000,"items":{"type":"string","pattern":"^\\d+~\\d+$"}}}},"GoogleBiddableGoalInput":{"type":"object","additionalProperties":false,"required":["category","origin","biddable"],"properties":{"category":{"type":"string","pattern":"^[A-Z][A-Z0-9_]*$"},"origin":{"type":"string","pattern":"^[A-Z][A-Z0-9_]*$"},"biddable":{"type":"boolean"}}},"GoogleCustomerConversionGoal":{"type":"object","properties":{"category":{"type":"string"},"origin":{"type":"string"},"biddable":{"type":"boolean"},"resourceName":{"type":"string"},"conversionActions":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"status":{"type":"string"},"primaryForGoal":{"type":"boolean"}}}}}},"GoogleCampaignConversionGoals":{"type":"object","properties":{"campaignId":{"type":"string"},"goalConfigLevel":{"type":"string","enum":["CUSTOMER","CAMPAIGN","UNSPECIFIED","UNKNOWN"]},"customConversionGoalId":{"type":["string","null"]},"goals":{"type":"array","items":{"type":"object","properties":{"category":{"type":"string"},"origin":{"type":"string"},"biddable":{"type":"boolean"},"resourceName":{"type":"string"}}}}}},"GoogleCustomConversionGoal":{"type":"object","properties":{"id":{"type":"string"},"resourceName":{"type":"string"},"name":{"type":"string"},"status":{"type":"string"},"conversionActionIds":{"type":"array","items":{"type":"string"}}}},"AdRuleLevel":{"type":"string","enum":["campaign","adset","ad"]},"AdRuleCondition":{"type":"object","required":["metric","window","op","value"],"properties":{"metric":{"type":"string","enum":["spend","impressions","clicks","conversions","ctr","cpc","cpm","cpa","roas","reach","frequency"]},"window":{"type":"string","enum":["today","yesterday","last_3d","last_7d","last_14d","last_30d"]},"op":{"type":"string","enum":[">",">=","<","<="]},"value":{"type":"number","minimum":0}}},"AdRuleConditions":{"type":"object","required":["all"],"properties":{"all":{"type":"array","minItems":1,"maxItems":10,"items":{"$ref":"#/components/schemas/AdRuleCondition"}}}},"AdRuleAction":{"oneOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["notify"]}}},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["pause"]},"maxChangesPerDay":{"type":"integer","minimum":1,"maximum":100}}},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["activate"]},"maxChangesPerDay":{"type":"integer","minimum":1,"maximum":100}}},{"type":"object","required":["type","direction","percent","limit"],"properties":{"type":{"type":"string","enum":["adjust_budget"]},"direction":{"type":"string","enum":["increase","decrease"]},"percent":{"type":"integer","minimum":1,"maximum":100},"limit":{"type":"number","exclusiveMinimum":0},"maxChangesPerDay":{"type":"integer","minimum":1,"maximum":100}}}]},"AdRuleActions":{"type":"array","minItems":1,"items":{"$ref":"#/components/schemas/AdRuleAction"}},"AdRuleSchedule":{"type":"object","required":["everyMinutes"],"properties":{"everyMinutes":{"type":"integer","enum":[60,180,360,720,1440]}}},"AdRule":{"type":"object","required":["id","name","accountId","platform","adAccountId","level","campaignIds","conditions","actions","schedule","cooldownMinutes","enabled","lastRunAt","nextRunAt","createdAt","updatedAt"],"properties":{"id":{"type":"string"},"name":{"type":"string"},"accountId":{"type":"string"},"platform":{"type":"string"},"adAccountId":{"type":"string"},"level":{"$ref":"#/components/schemas/AdRuleLevel"},"campaignIds":{"type":["array","null"],"items":{"type":"string"}},"conditions":{"$ref":"#/components/schemas/AdRuleConditions"},"actions":{"$ref":"#/components/schemas/AdRuleActions"},"schedule":{"$ref":"#/components/schemas/AdRuleSchedule"},"cooldownMinutes":{"type":"integer"},"enabled":{"type":"boolean"},"lastRunAt":{"type":["string","null"],"format":"date-time"},"nextRunAt":{"type":["string","null"],"format":"date-time"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}}},"AdRuleObjectEvaluation":{"type":"object","required":["id","name","campaignId","matched","conditions"],"properties":{"id":{"type":"string"},"name":{"type":"string"},"campaignId":{"type":["string","null"]},"matched":{"type":"boolean"},"conditions":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/AdRuleCondition"},{"type":"object","required":["actual","met"],"properties":{"actual":{"type":["number","null"]},"met":{"type":"boolean"}}}]}}}},"AdRuleEvaluation":{"type":"object","required":["evaluatedAt","today","timezone","timezoneAssumed","currency","matched","objects"],"properties":{"evaluatedAt":{"type":"string","format":"date-time"},"today":{"type":"string","format":"date"},"timezone":{"type":"string"},"timezoneAssumed":{"type":"boolean"},"currency":{"type":["string","null"]},"matched":{"type":"integer"},"objects":{"type":"array","items":{"$ref":"#/components/schemas/AdRuleObjectEvaluation"}}}},"AdRuleRun":{"type":"object","required":["id","ranAt","outcome","objectsEvaluated","actedObjectIds","evaluation","error"],"properties":{"id":{"type":"string"},"ranAt":{"type":"string","format":"date-time"},"outcome":{"type":"string","enum":["triggered","cooldown","no_match","failed"]},"objectsEvaluated":{"type":"integer"},"actedObjectIds":{"type":"array","items":{"type":"string"}},"evaluation":{"type":["object","null"],"properties":{"rule":{"type":"object","properties":{"name":{"type":"string"},"profileId":{"type":"string"},"accountId":{"type":"string"},"platform":{"type":"string"},"platformAdAccountId":{"type":"string"},"level":{"type":"string","enum":["campaign","adset"]}}},"today":{"type":"string","format":"date"},"timezone":{"type":"string"},"timezoneAssumed":{"type":"boolean"},"currency":{"type":["string","null"]},"matched":{"type":"array","items":{"$ref":"#/components/schemas/AdRuleObjectEvaluation"}},"actions":{"type":"array","items":{"type":"object","required":["objectId","type","status"],"properties":{"objectId":{"type":"string"},"type":{"type":"string","enum":["pause","activate","adjust_budget"]},"status":{"type":"string","enum":["done","skipped","failed"]},"reason":{"type":"string"},"previousDailyBudget":{"type":"number"},"newDailyBudget":{"type":"number"}}}},"notification":{"type":"object","required":["status"],"properties":{"status":{"type":"string","enum":["done","failed"]},"reason":{"type":"string"}}}}},"error":{"type":["string","null"]}}},"AdRuleActivityEntry":{"type":"object","required":["id","ranAt","ruleId","ruleName","platform","accountId","adAccountId","level","objectId","objectName","type","status","reason","previousDailyBudget","newDailyBudget","currency"],"properties":{"id":{"type":"string"},"ranAt":{"type":"string","format":"date-time"},"ruleId":{"type":"string"},"ruleName":{"type":"string"},"platform":{"type":"string"},"accountId":{"type":"string"},"adAccountId":{"type":"string"},"level":{"type":"string","enum":["campaign","adset"]},"objectId":{"type":"string"},"objectName":{"type":["string","null"]},"type":{"type":"string","enum":["pause","activate","adjust_budget"]},"status":{"type":"string","enum":["done","skipped","failed"]},"reason":{"type":["string","null"]},"previousDailyBudget":{"type":["number","null"]},"newDailyBudget":{"type":["number","null"]},"currency":{"type":["string","null"]}}},"AdKeyword":{"type":"object","properties":{"id":{"type":"string"},"platformCriterionId":{"type":"string"},"resourceName":{"type":"string"},"accountId":{"type":"string"},"profileId":{"type":"string"},"platform":{"type":"string","enum":["google"]},"adAccountId":{"type":"string"},"campaignId":{"type":"string"},"campaignName":{"type":["string","null"]},"campaignStatus":{"type":["string","null"]},"adSetId":{"type":"string"},"adSetName":{"type":["string","null"]},"adSetStatus":{"type":["string","null"]},"keyword":{"type":"string"},"matchType":{"type":"string","enum":["exact","phrase","broad","unknown"]},"status":{"type":"string","enum":["active","paused"]},"negative":{"type":"boolean"},"qualityScore":{"type":["integer","null"]},"quality":{"type":"object","properties":{"score":{"type":["integer","null"]},"expectedCtr":{"type":["string","null"],"enum":["BELOW_AVERAGE","AVERAGE","ABOVE_AVERAGE",null]},"adRelevance":{"type":["string","null"],"enum":["BELOW_AVERAGE","AVERAGE","ABOVE_AVERAGE",null]},"landingPageExperience":{"type":["string","null"],"enum":["BELOW_AVERAGE","AVERAGE","ABOVE_AVERAGE",null]}}},"syncedAt":{"type":["string","null"],"format":"date-time"},"metrics":{"type":["object","null"],"properties":{"windowDays":{"type":"integer"},"clicks":{"type":"integer"},"impressions":{"type":"integer"},"cost":{"type":"number"},"conversions":{"type":"number"},"firstPageCpc":{"type":["number","null"]},"firstPositionCpc":{"type":["number","null"]}}}}},"AdScheduleWindow":{"type":"object","properties":{"criterionId":{"type":"string"},"resourceName":{"type":"string"},"dayOfWeek":{"type":"string","enum":["MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY","SUNDAY"]},"startHour":{"type":"integer","minimum":0,"maximum":23},"startMinute":{"type":"integer","enum":[0,15,30,45]},"endHour":{"type":"integer","minimum":0,"maximum":24},"endMinute":{"type":"integer","enum":[0,15,30,45]},"bidModifier":{"type":["number","null"]}}},"KeywordEntry":{"oneOf":[{"type":"string","minLength":1,"maxLength":80},{"type":"object","required":["text"],"properties":{"text":{"type":"string","minLength":1,"maxLength":80},"matchType":{"type":"string","enum":["exact","phrase","broad"]}}}]},"EventDestination":{"type":"object","properties":{"id":{"type":"string"},"profileId":{"type":"string"},"accountId":{"type":"string"},"destinationId":{"type":"string"},"eventNames":{"type":["array","null"],"items":{"type":"string"}},"createdAt":{"type":"string","format":"date-time"}}},"ConversionEvent":{"type":"object","required":["eventName","eventTime","eventId","user"],"properties":{"eventName":{"type":"string"},"eventTime":{"type":"integer"},"eventId":{"type":"string"},"value":{"type":"number"},"currency":{"type":"string"},"user":{"type":"object","properties":{"email":{"type":"string"},"phone":{"type":"string"},"firstName":{"type":"string"},"lastName":{"type":"string"},"externalId":{"type":"string"},"ipAddress":{"type":"string"},"userAgent":{"type":"string"},"country":{"type":"string"},"city":{"type":"string"},"state":{"type":"string"},"zip":{"type":"string"},"dob":{"type":"string"},"gender":{"type":"string"},"leadId":{"type":"string"},"clickIds":{"type":"object","properties":{"fbc":{"type":"string"},"fbp":{"type":"string"},"gclid":{"type":"string"},"gbraid":{"type":"string"},"wbraid":{"type":"string"},"li_fat_id":{"type":"string"},"epik":{"type":"string"},"rdt_cid":{"type":"string"},"rdt_uuid":{"type":"string"}}}}},"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"price":{"type":"number"},"quantity":{"type":"integer"},"category":{"type":"string"}}}},"sourceUrl":{"type":"string","format":"uri"},"actionSource":{"type":"string","enum":["web","app","offline","crm","phone_call","system_generated","business_messaging"]},"messaging":{"type":"object","required":["channel"],"properties":{"channel":{"type":"string","enum":["whatsapp","messenger","instagram_direct"]},"wabaId":{"type":"string"},"ctwaClid":{"type":"string"},"pageId":{"type":"string"},"instagramBusinessAccountId":{"type":"string"},"pageScopedUserId":{"type":"string"},"instagramScopedUserId":{"type":"string"}}},"platformData":{"type":"object","additionalProperties":true}}},"ConversionDestination":{"type":"object","required":["id","name"],"properties":{"id":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"},"status":{"type":"string","enum":["active","inactive"]},"adAccountId":{"type":"string"}}},"ConversionAction":{"type":"object","required":["id","name","type","status","category","tagSnippets"],"properties":{"id":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"},"status":{"type":"string"},"category":{"type":"string"},"origin":{"type":"string"},"primaryForGoal":{"type":"boolean"},"defaultValue":{"type":"number"},"defaultCurrency":{"type":"string"},"alwaysUseDefaultValue":{"type":"boolean"},"countingType":{"type":"string"},"clickThroughLookbackWindowDays":{"type":"integer"},"viewThroughLookbackWindowDays":{"type":"integer"},"tagSnippets":{"type":"array","items":{"type":"object","required":["type"],"properties":{"type":{"type":"string"},"pageFormat":{"type":"string"},"globalSiteTag":{"type":"string"},"eventSnippet":{"type":"string"}}}}}},"CtwaSingleResponse":{"type":"object","required":["adType","ad","message"],"properties":{"adType":{"type":"string","enum":["single"]},"ad":{"type":"object"},"message":{"type":"string"},"warnings":{"type":"array","items":{"type":"string"}}}},"CtwaMultiResponse":{"type":"object","required":["adType","ads","platformCampaignId","platformAdSetId","message"],"properties":{"adType":{"type":"string","enum":["multi"]},"ads":{"type":"array","items":{"type":"object"}},"platformCampaignId":{"type":"string"},"platformAdSetId":{"type":"string"},"message":{"type":"string"},"warnings":{"type":"array","items":{"type":"string"}}}},"CustomConversion":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":["string","null"]},"rule":{"type":["object","null"]},"customEventType":{"type":["string","null"]},"pixelId":{"type":["string","null"]},"isArchived":{"type":"boolean"},"defaultConversionValue":{"type":["number","null"]}}},"CustomConversionResult":{"type":"object","properties":{"adAccountId":{"type":"string"},"customConversionId":{"type":"string"},"reused":{"type":"boolean"},"customConversion":{"$ref":"#/components/schemas/CustomConversion"}}},"Blog":{"type":"object","properties":{"id":{"type":"string"},"platform":{"type":"string","enum":["shopify","wordpress","wix","webflow"]},"title":{"type":"string"},"handle":{"type":"string"}}},"BlogArticle":{"type":"object","properties":{"id":{"type":"string"},"blogId":{"type":"string"},"platform":{"type":"string","enum":["shopify","wordpress","wix","webflow"]},"title":{"type":"string"},"bodyHtml":{"type":["string","null"]},"handle":{"type":"string"},"url":{"type":["string","null"]},"tags":{"type":"array","items":{"type":"string"}},"author":{"type":["string","null"]},"excerpt":{"type":["string","null"]},"image":{"type":["object","null"],"properties":{"url":{"type":"string"},"altText":{"type":["string","null"]}}},"isPublished":{"type":"boolean"},"publishedAt":{"type":["string","null"],"format":"date-time"},"status":{"type":"string","enum":["publish","future","draft","pending","private"]},"publishDate":{"type":["string","null"],"format":"date-time"},"createdAt":{"type":["string","null"],"format":"date-time"},"updatedAt":{"type":["string","null"],"format":"date-time"}}},"ProductImage":{"type":"object","properties":{"url":{"type":"string"},"altText":{"type":["string","null"]}}},"ProductVariant":{"type":"object","properties":{"id":{"type":"string"},"title":{"type":"string"},"sku":{"type":["string","null"]},"barcode":{"type":["string","null"]},"price":{"type":"string"},"compareAtPrice":{"type":["string","null"]},"inventoryQuantity":{"type":["integer","null"]},"availableForSale":{"type":"boolean"},"selectedOptions":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"value":{"type":"string"}}}}}},"Product":{"type":"object","properties":{"id":{"type":"string"},"platform":{"type":"string","enum":["shopify"]},"title":{"type":"string"},"handle":{"type":"string"},"descriptionHtml":{"type":["string","null"]},"vendor":{"type":["string","null"]},"productType":{"type":["string","null"]},"tags":{"type":"array","items":{"type":"string"}},"status":{"type":"string","enum":["active","draft","archived"]},"featuredImage":{"oneOf":[{"$ref":"#/components/schemas/ProductImage"},{"type":"null"}]},"images":{"type":"array","items":{"$ref":"#/components/schemas/ProductImage"}},"options":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"values":{"type":"array","items":{"type":"string"}}}}},"variants":{"type":"array","items":{"$ref":"#/components/schemas/ProductVariant"}},"seo":{"type":"object","properties":{"title":{"type":["string","null"]},"description":{"type":["string","null"]}}},"totalInventory":{"type":["integer","null"]},"onlineStoreUrl":{"type":["string","null"]},"createdAt":{"type":["string","null"],"format":"date-time"},"updatedAt":{"type":["string","null"],"format":"date-time"},"publishedAt":{"type":["string","null"],"format":"date-time"}}},"CommerceMoney":{"type":"object","required":["amount","currency"],"properties":{"amount":{"type":"string"},"currency":{"type":"string"}}},"CommerceCapability":{"type":"string","enum":["products.read","products.create","products.update","products.status","products.price","products.variants","products.images","products.images_remove","collections.read","collections.write","collections.metafields","metafields.read","metafields.write","pages.read","pages.write","inventory.read","inventory.write","channels.read","channels.write","discounts.read","discounts.write","discounts.codes","navigation.read","navigation.write","metaobjects.read","metaobjects.write","markets.read","markets.write","marketing.write","orders.read"]},"CommerceImage":{"type":"object","properties":{"id":{"type":["string","null"]},"url":{"type":"string"},"altText":{"type":["string","null"]}}},"CommerceMetafield":{"type":"object","required":["namespace","key","type","value"],"properties":{"namespace":{"type":"string"},"key":{"type":"string"},"type":{"type":"string"},"value":{"type":"string"}}},"CommercePage":{"type":"object","properties":{"id":{"type":"string"},"accountId":{"type":"string"},"platform":{"type":"string","enum":["shopify"]},"title":{"type":"string"},"handle":{"type":"string"},"bodyHtml":{"type":"string"},"isPublished":{"type":"boolean"},"publishedAt":{"type":["string","null"],"format":"date-time"},"createdAt":{"type":["string","null"],"format":"date-time"},"updatedAt":{"type":["string","null"],"format":"date-time"}}},"CommerceLocation":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"isActive":{"type":"boolean"},"fulfillsOnlineOrders":{"type":"boolean"},"address":{"type":"object","properties":{"line1":{"type":["string","null"]},"line2":{"type":["string","null"]},"city":{"type":["string","null"]},"region":{"type":["string","null"]},"postalCode":{"type":["string","null"]},"countryCode":{"type":["string","null"]},"phone":{"type":["string","null"]}}}}},"CommerceInventoryItem":{"type":"object","properties":{"productId":{"type":"string"},"variantId":{"type":"string"},"sku":{"type":["string","null"]},"tracked":{"type":"boolean"},"levels":{"type":"array","items":{"type":"object","properties":{"locationId":{"type":"string"},"available":{"type":["integer","null"]},"onHand":{"type":["integer","null"]},"committed":{"type":["integer","null"]},"incoming":{"type":["integer","null"]}}}}}},"CommerceChannel":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}}},"CommerceOrderStatus":{"type":"string","enum":["pending_payment","on_hold","awaiting_fulfillment","partially_fulfilled","in_transit","delivered","completed","cancelled"]},"CommerceTaxLine":{"type":"object","properties":{"title":{"type":"string"},"ratePercent":{"type":["number","null"]},"amount":{"$ref":"#/components/schemas/CommerceMoney"}}},"CommerceAddress":{"type":"object","properties":{"firstName":{"type":["string","null"]},"lastName":{"type":["string","null"]},"company":{"type":["string","null"]},"phone":{"type":["string","null"]},"line1":{"type":["string","null"]},"line2":{"type":["string","null"]},"city":{"type":["string","null"]},"region":{"type":["string","null"]},"postalCode":{"type":["string","null"]},"countryCode":{"type":["string","null"]}}},"CommerceOrderChargeLine":{"type":"object","properties":{"id":{"type":"string"},"title":{"type":"string"},"amount":{"$ref":"#/components/schemas/CommerceMoney"},"discountTotal":{"$ref":"#/components/schemas/CommerceMoney"},"taxLines":{"type":"array","items":{"$ref":"#/components/schemas/CommerceTaxLine"}}}},"CommerceOrderVisit":{"type":"object","properties":{"occurredAt":{"type":["string","null"],"format":"date-time"},"landingUrl":{"type":["string","null"]},"referrerUrl":{"type":["string","null"]},"source":{"type":["string","null"]},"sourceType":{"type":["string","null"]},"utm":{"type":["object","null"],"properties":{"source":{"type":["string","null"]},"medium":{"type":["string","null"]},"campaign":{"type":["string","null"]},"term":{"type":["string","null"]},"content":{"type":["string","null"]}}}}},"CommerceOrderAttribution":{"type":"object","properties":{"ready":{"type":"boolean"},"firstVisit":{"oneOf":[{"$ref":"#/components/schemas/CommerceOrderVisit"},{"type":"null"}]},"lastVisit":{"oneOf":[{"$ref":"#/components/schemas/CommerceOrderVisit"},{"type":"null"}]},"customAttributes":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}}}}}},"CommerceOrder":{"type":"object","properties":{"id":{"type":"string"},"accountId":{"type":"string"},"platform":{"type":"string","enum":["shopify","woocommerce"]},"number":{"type":"string"},"status":{"$ref":"#/components/schemas/CommerceOrderStatus"},"platformStatus":{"type":"string"},"paymentStatus":{"oneOf":[{"type":"string","enum":["pending","authorized","partially_paid","paid","partially_refunded","refunded","voided","failed"]},{"type":"null"}]},"platformPaymentStatus":{"type":["string","null"]},"currency":{"type":"string"},"taxesIncluded":{"type":"boolean"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"paidAt":{"type":["string","null"],"format":"date-time"},"cancelledAt":{"type":["string","null"],"format":"date-time"},"cancelReason":{"type":["string","null"]},"subtotal":{"$ref":"#/components/schemas/CommerceMoney"},"discountTotal":{"$ref":"#/components/schemas/CommerceMoney"},"shippingTotal":{"$ref":"#/components/schemas/CommerceMoney"},"taxTotal":{"$ref":"#/components/schemas/CommerceMoney"},"total":{"$ref":"#/components/schemas/CommerceMoney"},"refundedTotal":{"$ref":"#/components/schemas/CommerceMoney"},"discountCodes":{"type":"array","items":{"type":"string"}},"paymentMethods":{"type":"array","items":{"type":"string"}},"customer":{"type":["object","null"],"properties":{"id":{"type":["string","null"]},"email":{"type":["string","null"]},"phone":{"type":["string","null"]},"firstName":{"type":["string","null"]},"lastName":{"type":["string","null"]}}},"billingAddress":{"oneOf":[{"$ref":"#/components/schemas/CommerceAddress"},{"type":"null"}]},"shippingAddress":{"oneOf":[{"$ref":"#/components/schemas/CommerceAddress"},{"type":"null"}]},"buyerNote":{"type":["string","null"]},"attribution":{"$ref":"#/components/schemas/CommerceOrderAttribution"},"lineItems":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"productId":{"type":["string","null"]},"variantId":{"type":["string","null"]},"sku":{"type":["string","null"]},"title":{"type":"string"},"variantTitle":{"type":["string","null"]},"quantity":{"type":"integer"},"unitPrice":{"$ref":"#/components/schemas/CommerceMoney"},"subtotal":{"$ref":"#/components/schemas/CommerceMoney"},"discountTotal":{"$ref":"#/components/schemas/CommerceMoney"},"total":{"$ref":"#/components/schemas/CommerceMoney"},"taxLines":{"type":"array","items":{"$ref":"#/components/schemas/CommerceTaxLine"}}}}},"shippingLines":{"type":"array","items":{"$ref":"#/components/schemas/CommerceOrderChargeLine"}},"feeLines":{"type":"array","items":{"$ref":"#/components/schemas/CommerceOrderChargeLine"}},"taxLines":{"type":"array","items":{"$ref":"#/components/schemas/CommerceTaxLine"}},"refunds":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"createdAt":{"type":["string","null"],"format":"date-time"},"note":{"type":["string","null"]},"amount":{"$ref":"#/components/schemas/CommerceMoney"},"lineItems":{"type":"array","items":{"type":"object","properties":{"lineItemId":{"type":"string"},"quantity":{"type":"integer"},"amount":{"$ref":"#/components/schemas/CommerceMoney"}}}}}}},"fulfillments":{"type":"array","items":{"type":"object","properties":{"carrierName":{"type":["string","null"]},"trackingNumber":{"type":["string","null"]},"trackingUrl":{"type":["string","null"]}}}},"platformData":{"type":["object","null"],"additionalProperties":true}}},"CommerceDiscount":{"type":"object","properties":{"id":{"type":"string"},"accountId":{"type":"string"},"platform":{"type":"string","enum":["shopify"]},"title":{"type":"string"},"method":{"type":"string","enum":["code","automatic"]},"type":{"type":"string","enum":["percentage","fixed_amount","free_shipping","buy_x_get_y","app"]},"codes":{"type":"array","items":{"type":"string"}},"codeCount":{"type":["integer","null"]},"value":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["percentage"]},"percentage":{"type":"number"}}},{"type":"object","properties":{"type":{"type":"string","enum":["fixed_amount"]},"amount":{"$ref":"#/components/schemas/CommerceMoney"},"appliesOnEachItem":{"type":"boolean"}}},{"type":"null"}]},"appliesTo":{"type":["object","null"],"properties":{"type":{"type":"string","enum":["all","products","collections"]},"productIds":{"type":"array","items":{"type":"string"}},"variantIds":{"type":"array","items":{"type":"string"}},"collectionIds":{"type":"array","items":{"type":"string"}}}},"minimum":{"type":["object","null"],"properties":{"type":{"type":"string","enum":["subtotal","quantity"]},"amount":{"$ref":"#/components/schemas/CommerceMoney"},"quantity":{"type":"integer"}}},"usageLimit":{"type":["integer","null"]},"oncePerCustomer":{"type":"boolean"},"usageCount":{"type":"integer"},"startsAt":{"type":"string","format":"date-time"},"endsAt":{"type":["string","null"],"format":"date-time"},"status":{"type":"string","enum":["active","scheduled","expired"]},"platformStatus":{"type":"string"},"summary":{"type":"string"},"platformData":{"type":["object","null"],"additionalProperties":true}}},"CommerceRedirect":{"type":"object","properties":{"id":{"type":"string"},"path":{"type":"string"},"target":{"type":"string"}}},"CommerceMenuItem":{"type":"object","properties":{"id":{"type":["string","null"]},"title":{"type":"string"},"type":{"type":"string","enum":["frontpage","collection","collections","product","catalog","page","blog","article","search","shop_policy","http","metaobject","customer_account_page"]},"url":{"type":["string","null"]},"resourceId":{"type":["string","null"]},"items":{"type":"array","items":{"$ref":"#/components/schemas/CommerceMenuItem"}}}},"CommerceMenuItemInput":{"type":"object","required":["title","type"],"properties":{"title":{"type":"string"},"type":{"type":"string","enum":["frontpage","collection","collections","product","catalog","page","blog","article","search","shop_policy","http","metaobject","customer_account_page"]},"url":{"type":"string"},"resourceId":{"type":"string"},"items":{"type":"array","maxItems":100,"items":{"$ref":"#/components/schemas/CommerceMenuItemInput"}}}},"CommerceMenu":{"type":"object","properties":{"id":{"type":"string"},"handle":{"type":"string"},"title":{"type":"string"},"items":{"type":"array","items":{"$ref":"#/components/schemas/CommerceMenuItem"}}}},"CommerceMetaobjectDefinition":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string"},"name":{"type":"string"},"fields":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"},"required":{"type":"boolean"}}}}}},"CommerceMetaobject":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string"},"handle":{"type":"string"},"displayName":{"type":"string"},"fields":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"type":{"type":"string"},"value":{"type":["string","null"]}}}}}},"CommerceMarket":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"handle":{"type":"string"},"status":{"type":"string","enum":["active","draft"]},"type":{"type":"string"}}},"CommercePriceList":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"currency":{"type":"string"}}},"CommerceStore":{"type":"object","required":["accountId","platform","name","domain","url","currency","country","capabilities","missingCapabilities","grantPermissionsUrl"],"properties":{"accountId":{"type":"string"},"platform":{"type":"string","enum":["shopify","woocommerce"]},"name":{"type":"string"},"domain":{"type":"string"},"url":{"type":["string","null"]},"currency":{"type":"string"},"country":{"type":["string","null"]},"capabilities":{"type":"array","items":{"$ref":"#/components/schemas/CommerceCapability"}},"missingCapabilities":{"type":"array","items":{"$ref":"#/components/schemas/CommerceCapability"}},"grantPermissionsUrl":{"type":["string","null"]}}},"CommerceProductStatus":{"type":"string","enum":["active","draft","pending_review","rejected","inactive","archived","deleted"]},"CommerceVariant":{"type":"object","properties":{"id":{"type":"string"},"title":{"type":"string"},"sku":{"type":["string","null"]},"barcode":{"type":["string","null"]},"price":{"$ref":"#/components/schemas/CommerceMoney"},"compareAtPrice":{"oneOf":[{"$ref":"#/components/schemas/CommerceMoney"},{"type":"null"}]},"inventoryQuantity":{"type":["integer","null"]},"availableForSale":{"type":["boolean","null"]},"options":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"value":{"type":"string"}}}}}},"CommerceProduct":{"type":"object","properties":{"id":{"type":"string"},"accountId":{"type":"string"},"platform":{"type":"string","enum":["shopify"]},"title":{"type":"string"},"descriptionHtml":{"type":["string","null"]},"handle":{"type":["string","null"]},"vendor":{"type":["string","null"]},"productType":{"type":["string","null"]},"tags":{"type":"array","items":{"type":"string"}},"status":{"$ref":"#/components/schemas/CommerceProductStatus"},"platformStatus":{"type":"string"},"featuredImage":{"oneOf":[{"$ref":"#/components/schemas/CommerceImage"},{"type":"null"}]},"images":{"type":"array","items":{"$ref":"#/components/schemas/CommerceImage"}},"options":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"values":{"type":"array","items":{"type":"string"}}}}},"variants":{"type":"array","items":{"$ref":"#/components/schemas/CommerceVariant"}},"totalInventory":{"type":["integer","null"]},"url":{"type":["string","null"]},"seo":{"type":"object","properties":{"title":{"type":["string","null"]},"description":{"type":["string","null"]}}},"createdAt":{"type":["string","null"],"format":"date-time"},"updatedAt":{"type":["string","null"],"format":"date-time"},"publishedAt":{"type":["string","null"],"format":"date-time"},"platformData":{"type":["object","null"],"additionalProperties":true}}},"WebhookPayloadCommerceProduct":{"type":"object","properties":{"test":{"type":"boolean"},"id":{"type":"string"},"event":{"type":"string","enum":["commerce.product.created","commerce.product.updated","commerce.product.deleted"]},"timestamp":{"type":"string","format":"date-time"},"store":{"type":"object","properties":{"accountId":{"type":"string"},"platform":{"type":"string","enum":["shopify","woocommerce"]},"shopId":{"type":["string","null"]}}},"resource":{"type":"object","properties":{"type":{"type":"string","enum":["product"]},"id":{"type":"string"},"status":{"oneOf":[{"$ref":"#/components/schemas/CommerceProductStatus"},{"type":"null"}]},"platformStatus":{"type":["string","null"]}}}}},"WebhookPayloadCommerceOrder":{"type":"object","properties":{"test":{"type":"boolean"},"id":{"type":"string"},"event":{"type":"string","enum":["commerce.order.created","commerce.order.updated","commerce.order.refunded"]},"timestamp":{"type":"string","format":"date-time"},"store":{"type":"object","properties":{"accountId":{"type":"string"},"platform":{"type":"string","enum":["shopify","woocommerce"]},"shopId":{"type":["string","null"]}}},"resource":{"type":"object","properties":{"type":{"type":"string","enum":["order"]},"id":{"type":"string"},"status":{"oneOf":[{"$ref":"#/components/schemas/CommerceOrderStatus"},{"type":"null"}]},"platformStatus":{"type":["string","null"]}}}}},"WebhookPayloadContactTag":{"type":"object","required":["id","event","timestamp","contact","tag","source"],"properties":{"test":{"type":"boolean"},"id":{"type":"string"},"profiles":{"$ref":"#/components/schemas/WebhookProfiles"},"event":{"type":"string","enum":["contact.tag_added","contact.tag_removed"]},"timestamp":{"type":"string","format":"date-time"},"contact":{"type":"object","properties":{"id":{"type":"string"}}},"tag":{"type":"string"},"source":{"type":"string","enum":["api","workflow","automation"]}}},"WebhookPayloadContactFieldChanged":{"type":"object","required":["id","event","timestamp","contact","field","previousValue","value","source"],"properties":{"test":{"type":"boolean"},"id":{"type":"string"},"profiles":{"$ref":"#/components/schemas/WebhookProfiles"},"event":{"type":"string","enum":["contact.field_changed"]},"timestamp":{"type":"string","format":"date-time"},"contact":{"type":"object","properties":{"id":{"type":"string"}}},"field":{"type":"string"},"previousValue":{},"value":{},"source":{"type":"string","enum":["api","workflow","automation"]}}},"WebhookPayloadSequenceEnrollment":{"type":"object","required":["id","event","timestamp","sequence","contact","enrollment"],"properties":{"test":{"type":"boolean"},"id":{"type":"string"},"profiles":{"$ref":"#/components/schemas/WebhookProfiles"},"event":{"type":"string","enum":["sequence.enrolled","sequence.exited"]},"timestamp":{"type":"string","format":"date-time"},"sequence":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}}},"contact":{"type":"object","properties":{"id":{"type":"string"}}},"enrollment":{"type":"object","properties":{"id":{"type":"string"}}},"exitReason":{"type":"string","enum":["completed","replied","manual","failed","unsubscribed"]}}},"WebhookPayloadWorkflowRun":{"type":"object","required":["id","event","timestamp","workflow","execution","conversation","contact","trigger"],"properties":{"test":{"type":"boolean"},"id":{"type":"string"},"profiles":{"$ref":"#/components/schemas/WebhookProfiles"},"event":{"type":"string","enum":["workflow.run.started","workflow.run.completed","workflow.run.failed"]},"timestamp":{"type":"string","format":"date-time"},"workflow":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":["string","null"]}}},"execution":{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string","enum":["running","waiting","completed","exited","failed"]}}},"conversation":{"type":["object","null"],"properties":{"id":{"type":"string"}}},"contact":{"type":["object","null"],"properties":{"id":{"type":"string"}}},"trigger":{"type":"object","properties":{"type":{"type":["string","null"]},"text":{"type":"string"}}},"error":{"type":"string"}}},"WebhookPayloadSupportRun":{"type":"object","required":["id","event","timestamp","run"],"properties":{"test":{"type":"boolean"},"id":{"type":"string"},"event":{"type":"string","enum":["support.run.completed","support.run.failed"]},"timestamp":{"type":"string","format":"date-time"},"run":{"$ref":"#/components/schemas/SupportRun"}}},"SupportRunUsage":{"type":"object","required":["inputTokens","outputTokens","cacheReadTokens","cacheWriteTokens"],"properties":{"inputTokens":{"type":"integer"},"outputTokens":{"type":"integer"},"cacheReadTokens":{"type":"integer"},"cacheWriteTokens":{"type":"integer"}}},"SupportRunDiagnosis":{"type":"object","required":["category","cause","fixSteps","docsLinks","whoMustAct"],"properties":{"category":{"type":"string","enum":["account_connection","content_rejected","rate_limited","platform_issue","pozy_issue","billing","configuration","how_to","other"]},"cause":{"type":["string","null"]},"fixSteps":{"type":"array","items":{"type":"string"}},"docsLinks":{"type":"array","items":{"type":"string"}},"whoMustAct":{"type":"string","enum":["integrator","end_user","pozy","platform","none"]}}},"SupportRun":{"type":"object","required":["runId","threadId","status","stopReason","question","answer","diagnosis","usage","costUsd","maxCostUsd","createdAt","startedAt","finishedAt","supportTicket"],"properties":{"runId":{"type":"string"},"threadId":{"type":"string"},"status":{"type":"string","enum":["queued","running","completed","needs_human","failed"]},"stopReason":{"type":["string","null"],"enum":["answered","human_review","cost_cap","deadline","max_iterations","error","expired",null]},"question":{"type":["string","null"]},"answer":{"type":["string","null"]},"diagnosis":{"anyOf":[{"$ref":"#/components/schemas/SupportRunDiagnosis"},{"type":"null"}]},"usage":{"$ref":"#/components/schemas/SupportRunUsage"},"costUsd":{"type":"number"},"maxCostUsd":{"type":"number"},"createdAt":{"type":"string","format":"date-time"},"startedAt":{"type":["string","null"],"format":"date-time"},"finishedAt":{"type":["string","null"],"format":"date-time"},"supportTicket":{"type":["object","null"],"required":["openedAt"],"properties":{"openedAt":{"type":"string","format":"date-time"}}},"pollAfterSeconds":{"type":"integer"}}},"CommerceCollection":{"type":"object","properties":{"id":{"type":"string"},"accountId":{"type":"string"},"platform":{"type":"string","enum":["shopify","woocommerce"]},"title":{"type":"string"},"handle":{"type":["string","null"]},"descriptionHtml":{"type":["string","null"]},"image":{"oneOf":[{"$ref":"#/components/schemas/CommerceImage"},{"type":"null"}]},"sortOrder":{"type":"string","enum":["manual","best_selling","alpha_asc","alpha_desc","price_asc","price_desc","created","created_desc","most_relevant"]},"productCount":{"type":["integer","null"]},"seo":{"type":"object","properties":{"title":{"type":["string","null"]},"description":{"type":["string","null"]}}},"updatedAt":{"type":["string","null"],"format":"date-time"},"platformData":{"type":["object","null"],"additionalProperties":true}}},"CommerceCatalogSync":{"type":"object","properties":{"id":{"type":"string"},"accountId":{"type":"string"},"catalogPlatform":{"type":"string","enum":["meta"]},"catalogAccountId":{"type":"string"},"catalogId":{"type":"string"},"runStatus":{"type":"string","enum":["pending","running","succeeded","failed"]},"lastRunStartedAt":{"type":["string","null"],"format":"date-time"},"lastRunFinishedAt":{"type":["string","null"],"format":"date-time"},"lastError":{"type":["string","null"]},"itemsSent":{"type":"integer"},"itemsSkipped":{"type":"integer"},"itemsDeleted":{"type":"integer"},"createdAt":{"type":"string","format":"date-time"}}},"BusinessAgentSettings":{"type":"object","required":["agent_id","channel","rollout"],"properties":{"agent_id":{"type":"string"},"channel":{"type":"string"},"rollout":{"type":"object","required":["enabled"],"properties":{"enabled":{"type":"boolean"}}},"handoff":{"type":["object","null"],"properties":{"enabled":{"type":"boolean"},"message":{"type":"string"},"message_selection":{"type":"string","enum":["DEFAULT","AGENT","CUSTOM"]}}},"followup":{"type":["object","null"],"properties":{"enabled":{"type":"boolean"},"followup_interval_in_seconds":{"type":"integer","enum":[0,300,900,1800,3600,7200,28800,86400]},"message":{"type":"string"}}},"ai_audience":{"type":["string","null"],"enum":["EVERYONE","ALLOWLISTED_ONLY",null]},"never_say_phrases":{"type":"array","items":{"type":"string"}}}},"BusinessAgentStatus":{"type":"object","required":["eligible","termsAccepted","onboarded","enabled","agentId","settings","manualSteps","unverifiedSteps"],"properties":{"eligible":{"type":["boolean","null"]},"termsAccepted":{"type":"boolean"},"onboarded":{"type":"boolean"},"enabled":{"type":"boolean"},"agentId":{"type":["string","null"]},"settings":{"oneOf":[{"$ref":"#/components/schemas/BusinessAgentSettings"},{"type":"null"}]},"manualSteps":{"type":"array","items":{"type":"object","required":["step","url","description"],"properties":{"step":{"type":"string","enum":["accept_terms"]},"url":{"type":"string","format":"uri"},"description":{"type":"string"}}}},"unverifiedSteps":{"type":"array","items":{"type":"object","required":["step","url","description"],"properties":{"step":{"type":"string","enum":["attach_payment_method"]},"url":{"type":"string","format":"uri"},"description":{"type":"string"}}}}}},"BusinessAgentAllowlistEntry":{"type":"object","required":["id"],"properties":{"id":{"type":"string"},"consumer_phone_number":{"type":"string"}}},"BusinessAgentBusinessInformation":{"type":"object","properties":{"payment_method":{"type":"string"},"return_policy":{"type":"string"},"purchase_info":{"type":"string"},"delivery_and_shipping":{"type":"string"},"business_description":{"type":"string"},"contact_info":{"type":["object","null"],"properties":{"email":{"type":"string"},"hours_of_operation":{"type":"string"},"address":{"type":"string"}}}}},"BusinessAgentFaqInput":{"type":"object","required":["question","answer"],"properties":{"question":{"type":"string","maxLength":1000},"answer":{"type":"string","maxLength":8000},"metadata":{"type":"object","additionalProperties":{"type":"string"}}}},"BusinessAgentFaq":{"allOf":[{"$ref":"#/components/schemas/BusinessAgentFaqInput"},{"type":"object","required":["id"],"properties":{"id":{"type":"string"},"created_at":{"type":"integer"}}}]},"BusinessAgentWebsiteInput":{"type":"object","required":["url"],"properties":{"url":{"type":"string","format":"uri"},"included_sub_domains":{"type":"array","items":{"type":"string"}},"included_url_patterns":{"type":"array","items":{"type":"string"}},"excluded_sub_domains":{"type":"array","items":{"type":"string"}},"excluded_url_patterns":{"type":"array","items":{"type":"string"}},"single_urls":{"type":"array","items":{"type":"string","format":"uri"}}}},"BusinessAgentWebsite":{"allOf":[{"$ref":"#/components/schemas/BusinessAgentWebsiteInput"},{"type":"object","required":["id"],"properties":{"id":{"type":"string"},"crawl_status":{"type":"string"},"crawl_error":{"type":"string"},"pages_crawled":{"type":"integer"},"last_crawled_at":{"type":"integer"},"created_at":{"type":"integer"}}}]},"BusinessAgentKnowledgeFile":{"type":"object","required":["id","file_name"],"properties":{"id":{"type":"string"},"file_name":{"type":"string"}}},"BusinessAgentSkillInput":{"type":"object","required":["skill"],"properties":{"title":{"type":"string","maxLength":64,"pattern":"^[a-z0-9]+(?:-[a-z0-9]+)*$"},"description":{"type":"string","maxLength":1024},"skill":{"type":"string","maxLength":20000}}},"BusinessAgentSkill":{"allOf":[{"$ref":"#/components/schemas/BusinessAgentSkillInput"},{"type":"object","required":["id"],"properties":{"id":{"type":"string"},"channel":{"type":"string"},"created_at":{"type":"integer"},"status":{"type":"string","enum":["active","pending_review","blocked"]}}}]},"BusinessAgentUiSkillInput":{"type":"object","required":["component_type","status","instruction"],"properties":{"title":{"type":"string"},"component_type":{"type":"string","enum":["carousel_quick_reply","carousel_url","cta_url","flow","image","interactive_list","interactive_reply_buttons","location","location_request"]},"status":{"type":"string","enum":["enabled","disabled"]},"instruction":{"type":"string"},"flow_id":{"type":"integer"}}},"BusinessAgentUiSkill":{"allOf":[{"$ref":"#/components/schemas/BusinessAgentUiSkillInput"},{"type":"object","required":["id"],"properties":{"id":{"type":"string"},"created_at":{"type":"integer"},"updated_at":{"type":"integer"}}}]},"BusinessAgentApiKeyConfig":{"type":"object","properties":{"headers":{"$ref":"#/components/schemas/BusinessAgentApiKeyParams"},"query_params":{"$ref":"#/components/schemas/BusinessAgentApiKeyParams"},"body_params":{"$ref":"#/components/schemas/BusinessAgentApiKeyParams"}}},"BusinessAgentApiKeyParams":{"type":"array","items":{"type":"object","required":["field_name","value"],"properties":{"field_name":{"type":"string"},"value":{"type":"string"},"prefix":{"type":"string"}}}},"BusinessAgentOAuthClientCredentials":{"type":"object","required":["token_url","client_id","client_secret"],"properties":{"token_url":{"type":"string","format":"uri"},"scopes_to_request":{"type":"array","items":{"type":"string"}},"token_request_content_type":{"type":"string"},"client_id":{"type":"string"},"client_secret":{"type":"string"}}},"BusinessAgentConnectorInput":{"type":"object","required":["name","base_url","auth_type"],"properties":{"name":{"type":"string"},"description":{"type":"string"},"base_url":{"type":"string","format":"uri"},"connector_protocol":{"type":"string"},"auth_type":{"type":"string","enum":["OAUTH2_CLIENT_CREDENTIALS","API_KEY","NONE"]},"auth_config":{"type":"object","properties":{"oauth2_client_credentials":{"$ref":"#/components/schemas/BusinessAgentOAuthClientCredentials"},"api_key":{"$ref":"#/components/schemas/BusinessAgentApiKeyConfig"}}},"user_auth_injection_config":{"type":"object","required":["location","field_name"],"properties":{"location":{"type":"string"},"field_name":{"type":"string"},"prefix":{"type":"string"}}},"requires_certificate":{"type":"boolean"}}},"BusinessAgentConnector":{"allOf":[{"$ref":"#/components/schemas/BusinessAgentConnectorInput"},{"type":"object","required":["id"],"properties":{"id":{"type":"string"},"mcp_tool_sync":{"type":"object","additionalProperties":true},"mtls_config":{"type":"object","additionalProperties":true},"connection_status":{"type":"object","properties":{"status":{"type":"string"},"error_message":{"type":"string"}}}}}]},"BusinessAgentConnectorToolInput":{"type":"object","required":["name","description","request_definition"],"properties":{"name":{"type":"string"},"description":{"type":"string"},"request_definition":{"type":"object","additionalProperties":true},"user_auth_required":{"type":"boolean"},"user_auth_action_config":{"type":"object","additionalProperties":true},"transformation_spec":{"type":"object","additionalProperties":true}}},"BusinessAgentConnectorTool":{"allOf":[{"$ref":"#/components/schemas/BusinessAgentConnectorToolInput"},{"type":"object","required":["id"],"properties":{"id":{"type":"string"}}}]},"BusinessAgentBudget":{"type":"object","required":["unit_type","time_window","max_budget"],"properties":{"budget_id":{"type":"string"},"unit_type":{"type":"string","enum":["token","ai_turn"]},"time_window":{"type":"string","enum":["one_day","seven_days","fourteen_days","thirty_days"]},"max_budget":{"type":"integer","minimum":1}}},"BusinessAgentTestMessageResponse":{"type":"object","required":["message_id","agent_response","conversation_id"],"properties":{"message_id":{"type":"string"},"agent_response":{"type":"string"},"conversation_id":{"type":"string"},"timestamp":{"type":"integer"},"handoff_reason":{"type":"string"},"no_response_reason":{"type":"string"},"quick_replies":{"type":"array","items":{"type":"string"}},"product_variant_ids":{"type":"array","items":{"type":"string"}}}},"BusinessAgentEventStatus":{"type":"object","required":["status","event_type","created_at","updated_at"],"properties":{"status":{"type":"string","enum":["request_received","processing","sent","failed","skipped","success"]},"event_type":{"type":"string"},"error_message":{"type":"string"},"skipped_reason":{"type":"string"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"}}},"StorePixelInstall":{"type":"object","properties":{"storeAccountId":{"type":"string"},"platform":{"type":"string","enum":["shopify","wordpress","wix","webflow"]},"tagPlatform":{"type":"string"},"siteTagId":{"type":"string"},"installed":{"type":"boolean"},"shopDomain":{"type":"string"},"installedTagId":{"type":["string","null"]},"tags":{"type":"array","items":{"type":"object","properties":{"platform":{"type":"string"},"siteTagId":{"type":"string"},"widgetId":{"type":"string"},"sidebarId":{"type":"string"},"active":{"type":"boolean"}}}},"webPixelId":{"type":["string","null"]},"siteUrl":{"type":["string","null"]},"publishRequired":{"type":"boolean"},"method":{"type":"string","enum":["wordpress_widget"]},"widgetId":{"type":["string","null"]},"sidebarId":{"type":["string","null"]}}},"TrackingTagInstallBlockedReason":{"type":"string","enum":["insufficient_permissions","scripts_stripped","wordpress_com_plan","no_widget_areas","widgets_api_unavailable"]},"TrackingTag":{"type":"object","required":["id","name","platform","kind","status"],"properties":{"id":{"type":"string"},"siteTagId":{"type":"string"},"events":{"type":"array","items":{"$ref":"#/components/schemas/TrackingTagEvent"}},"name":{"type":"string"},"platform":{"type":"string","enum":["metaads","openaiads","tiktokads","googleads","xads","linkedinads","pinterestads","whopads"]},"kind":{"type":"string","enum":["pixel","tag","insight_tag"]},"status":{"type":"string","enum":["active","inactive"]},"code":{"type":"string"},"lastFiredTime":{"type":["integer","null"]},"isUnavailable":{"type":"boolean"},"installed":{"type":"boolean"},"creationTime":{"type":"integer"},"automaticMatchingFields":{"type":"array","items":{"type":"string","enum":["em","ph","fn","ln","ge","db","ct","st","zp","country","external_id"]}},"ownerBusinessId":{"type":["string","null"]},"ownerAdAccountId":{"type":"string"},"autoTagging":{"type":"boolean"}}},"TrackingTagEvent":{"type":"object","required":["id","name"],"properties":{"id":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"},"siteEvent":{"type":"string","enum":["page_view","view_content","add_to_cart","search","initiate_checkout","add_payment_info","purchase"]},"siteEventId":{"type":"string"},"status":{"type":"string"},"defaultValue":{"type":"number"},"currency":{"type":"string"},"clickWindowDays":{"type":"integer"},"viewWindowDays":{"type":"integer"},"urlContains":{"type":"string"},"alwaysUseDefaultValue":{"type":"boolean"},"primary":{"type":"boolean"},"countingType":{"type":"string","enum":["one","every"]}}},"TrackingTagEventInput":{"type":"object","properties":{"adAccountId":{"type":"string"},"name":{"type":"string","minLength":1,"maxLength":200},"type":{"type":"string"},"siteEvent":{"type":"string","enum":["page_view","view_content","add_to_cart","search","initiate_checkout","add_payment_info","purchase"]},"enabled":{"type":"boolean"},"defaultValue":{"type":"number","minimum":0},"currency":{"type":"string"},"clickWindowDays":{"type":"integer","minimum":1,"maximum":365},"viewWindowDays":{"type":"integer","minimum":0,"maximum":365},"urlContains":{"type":"string","minLength":1,"maxLength":500}}},"TrackingTagUser":{"type":"object","required":["id","tasks"],"properties":{"id":{"type":"string"},"name":{"type":"string"},"tasks":{"type":"array","items":{"type":"string"}}}},"TrackingTagPartner":{"type":"object","required":["id"],"properties":{"id":{"type":"string"},"name":{"type":"string"}}},"TrackingTagDiagnostic":{"type":"object","required":["key","title","result"],"properties":{"key":{"type":"string"},"title":{"type":"string"},"description":{"type":"string"},"result":{"type":"string"},"actionUrl":{"type":"string"},"alwaysUseDefaultValue":{"type":"boolean"},"primary":{"type":"boolean"},"countingType":{"type":"string","enum":["one","every"]}}},"SharedAdAccount":{"type":"object","required":["id"],"properties":{"id":{"type":"string"},"name":{"type":"string"},"businessId":{"type":"string"}}}}},"webhooks":{"post.scheduled":{"post":{"summary":"Post scheduled event","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookPayloadPost"}}}},"responses":{"200":{"description":"Acknowledged"}}}},"post.published":{"post":{"summary":"Post published event","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookPayloadPost"}}}},"responses":{"200":{"description":"Acknowledged"}}}},"post.failed":{"post":{"summary":"Post failed event","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookPayloadPost"}}}},"responses":{"200":{"description":"Acknowledged"}}}},"post.partial":{"post":{"summary":"Post partial event","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookPayloadPost"}}}},"responses":{"200":{"description":"Acknowledged"}}}},"post.cancelled":{"post":{"summary":"Post cancelled event","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookPayloadPost"}}}},"responses":{"200":{"description":"Acknowledged"}}}},"post.recycled":{"post":{"summary":"Post recycled event","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookPayloadPost"}}}},"responses":{"200":{"description":"Acknowledged"}}}},"post.platform.published":{"post":{"summary":"Post platform published event","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookPayloadPostPlatform"}}}},"responses":{"200":{"description":"Acknowledged"}}}},"post.platform.failed":{"post":{"summary":"Post platform failed event","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookPayloadPostPlatform"}}}},"responses":{"200":{"description":"Acknowledged"}}}},"post.platform.deleted":{"post":{"summary":"Post platform deleted event","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookPayloadPostPlatform"}}}},"responses":{"200":{"description":"Acknowledged"}}}},"post.tiktok.url_resolved":{"post":{"summary":"TikTok post URL resolved event","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookPayloadPostPlatform"}}}},"responses":{"200":{"description":"Acknowledged"}}}},"account.connected":{"post":{"summary":"Account connected event","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookPayloadAccountConnected"}}}},"responses":{"200":{"description":"Acknowledged"}}}},"account.rate_limited":{"post":{"summary":"Mailbox sending cooldown started","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookPayloadAccountRateLimited"}}}},"responses":{"200":{"description":"Acknowledged"}}}},"calendar.event.created":{"post":{"summary":"Calendar event created","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookPayloadCalendarEvent"}}}},"responses":{"200":{"description":"Acknowledged"}}}},"calendar.event.updated":{"post":{"summary":"Calendar event updated","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookPayloadCalendarEvent"}}}},"responses":{"200":{"description":"Acknowledged"}}}},"calendar.event.deleted":{"post":{"summary":"Calendar event deleted","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookPayloadCalendarEvent"}}}},"responses":{"200":{"description":"Acknowledged"}}}},"file.created":{"post":{"summary":"File created","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookPayloadFile"}}}},"responses":{"200":{"description":"Acknowledged"}}}},"file.updated":{"post":{"summary":"File updated","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookPayloadFile"}}}},"responses":{"200":{"description":"Acknowledged"}}}},"file.picked":{"post":{"summary":"Files picked","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookPayloadFilePicked"}}}},"responses":{"200":{"description":"Acknowledged"}}}},"file.deleted":{"post":{"summary":"File deleted","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookPayloadFile"}}}},"responses":{"200":{"description":"Acknowledged"}}}},"contact.updated":{"post":{"summary":"Contact updated","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookPayloadContact"}}}},"responses":{"200":{"description":"Acknowledged"}}}},"contact.deleted":{"post":{"summary":"Contact deleted","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookPayloadContact"}}}},"responses":{"200":{"description":"Acknowledged"}}}},"account.disconnected":{"post":{"summary":"Account disconnected event","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookPayloadAccountDisconnected"}}}},"responses":{"200":{"description":"Acknowledged"}}}},"account.permissions_changed":{"post":{"summary":"Account permissions changed event","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookPayloadAccountPermissionsChanged"}}}},"responses":{"200":{"description":"Acknowledged"}}}},"account.ads.initial_sync_completed":{"post":{"summary":"Ads initial sync completed event","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookPayloadAccountAdsInitialSyncCompleted"}}}},"responses":{"200":{"description":"Acknowledged"}}}},"account.ads.sync_failed":{"post":{"summary":"Ads sync failed event","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookPayloadAccountAdsSyncFailed"}}}},"responses":{"200":{"description":"Acknowledged"}}}},"account.ads.sync_recovered":{"post":{"summary":"Ads sync recovered event","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookPayloadAccountAdsSyncRecovered"}}}},"responses":{"200":{"description":"Acknowledged"}}}},"analytics.synced":{"post":{"summary":"Analytics synced event","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookPayloadAnalyticsSynced"}}}},"responses":{"200":{"description":"Acknowledged"}}}},"post.tracking_completed":{"post":{"summary":"Post tracking completed event","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookPayloadPostTrackingCompleted"}}}},"responses":{"200":{"description":"Acknowledged"}}}},"post.authenticity_changed":{"post":{"summary":"Post authenticity changed event","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookPayloadPostAuthenticityChanged"}}}},"responses":{"200":{"description":"Acknowledged"}}}},"message.received":{"post":{"summary":"Message received event","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookPayloadMessage"}}}},"responses":{"200":{"description":"Acknowledged"}}}},"conversation.control_changed":{"post":{"summary":"Conversation control changed event","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookPayloadConversationControlChanged"}}}},"responses":{"200":{"description":"Acknowledged"}}}},"conversation.started":{"post":{"summary":"Conversation started event","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookPayloadConversationStarted"}}}},"responses":{"200":{"description":"Acknowledged"}}}},"call.received":{"post":{"summary":"Call received event","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookPayloadCallReceived"}}}},"responses":{"200":{"description":"Acknowledged"}}}},"call.ended":{"post":{"summary":"Call ended event","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookPayloadCallEnded"}}}},"responses":{"200":{"description":"Acknowledged"}}}},"call.failed":{"post":{"summary":"Call failed event","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookPayloadCallFailed"}}}},"responses":{"200":{"description":"Acknowledged"}}}},"call.permission_request":{"post":{"summary":"Call permission request reply event","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookPayloadCallPermissionRequest"}}}},"responses":{"200":{"description":"Acknowledged"}}}},"message.sent":{"post":{"summary":"Message sent event","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookPayloadMessageSent"}}}},"responses":{"200":{"description":"Acknowledged"}}}},"message.edited":{"post":{"summary":"Message edited event","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookPayloadMessageEdited"}}}},"responses":{"200":{"description":"Acknowledged"}}}},"message.deleted":{"post":{"summary":"Message deleted event","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookPayloadMessageDeleted"}}}},"responses":{"200":{"description":"Acknowledged"}}}},"message.delivered":{"post":{"summary":"Message delivered event","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookPayloadMessageDeliveryStatus"}}}},"responses":{"200":{"description":"Acknowledged"}}}},"message.read":{"post":{"summary":"Message read event","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookPayloadMessageDeliveryStatus"}}}},"responses":{"200":{"description":"Acknowledged"}}}},"message.played":{"post":{"summary":"Message played event","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookPayloadMessageDeliveryStatus"}}}},"responses":{"200":{"description":"Acknowledged"}}}},"message.failed":{"post":{"summary":"Message delivery failed event","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookPayloadMessageDeliveryStatus"}}}},"responses":{"200":{"description":"Acknowledged"}}}},"reaction.received":{"post":{"summary":"Reaction received event","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookPayloadReaction"}}}},"responses":{"200":{"description":"Acknowledged"}}}},"referral.received":{"post":{"summary":"Referral received event","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookPayloadReferral"}}}},"responses":{"200":{"description":"Acknowledged"}}}},"comment.received":{"post":{"summary":"Comment received event","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookPayloadComment"}}}},"responses":{"200":{"description":"Acknowledged"}}}},"review.new":{"post":{"summary":"Review new event","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookPayloadReviewNew"}}}},"responses":{"200":{"description":"Acknowledged"}}}},"review.updated":{"post":{"summary":"Review updated event","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookPayloadReviewUpdated"}}}},"responses":{"200":{"description":"Acknowledged"}}}},"review.deleted":{"post":{"summary":"Review deleted event","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookPayloadReviewDeleted"}}}},"responses":{"200":{"description":"Acknowledged"}}}},"review.restored":{"post":{"summary":"Review restored event","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookPayloadReviewRestored"}}}},"responses":{"200":{"description":"Acknowledged"}}}},"post.external.created":{"post":{"summary":"External post created event","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookPayloadExternalPost"}}}},"responses":{"200":{"description":"Acknowledged"}}}},"post.external.updated":{"post":{"summary":"External post updated event","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookPayloadExternalPost"}}}},"responses":{"200":{"description":"Acknowledged"}}}},"post.external.deleted":{"post":{"summary":"External post deleted event","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookPayloadExternalPost"}}}},"responses":{"200":{"description":"Acknowledged"}}}},"lead.received":{"post":{"summary":"Lead received event","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookPayloadLead"}}}},"responses":{"200":{"description":"Acknowledged"}}}},"ad.status_changed":{"post":{"summary":"Ad status changed event","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookPayloadAdStatusChanged"}}}},"responses":{"200":{"description":"Acknowledged"}}}},"ad.review.approved":{"post":{"summary":"Ad review approved event","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookPayloadAdReview"}}}},"responses":{"200":{"description":"Acknowledged"}}}},"ad.review.rejected":{"post":{"summary":"Ad review rejected event","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookPayloadAdReview"}}}},"responses":{"200":{"description":"Acknowledged"}}}},"ad.delivery_issue":{"post":{"summary":"Ad delivery issue event","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookPayloadAdDeliveryIssue"}}}},"responses":{"200":{"description":"Acknowledged"}}}},"campaign.budget.depleted":{"post":{"summary":"Campaign budget depleted event","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookPayloadCampaignBudgetDepleted"}}}},"responses":{"200":{"description":"Acknowledged"}}}},"ad_account.status_changed":{"post":{"summary":"Ad account status changed event","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookPayloadAdAccountStatusChanged"}}}},"responses":{"200":{"description":"Acknowledged"}}}},"ad.video.processed":{"post":{"summary":"Ad video processed event","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookPayloadAdVideoProcessed"}}}},"responses":{"200":{"description":"Acknowledged"}}}},"ad_rule.triggered":{"post":{"summary":"Ad rule triggered event","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookPayloadAdRuleTriggered"}}}},"responses":{"200":{"description":"Acknowledged"}}}},"whatsapp.template.status_updated":{"post":{"summary":"WhatsApp template status updated event","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookPayloadWhatsAppTemplateStatusUpdated"}}}},"responses":{"200":{"description":"Acknowledged"}}}},"whatsapp.template.category_updated":{"post":{"summary":"WhatsApp template category updated event","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookPayloadWhatsAppTemplateCategoryUpdated"}}}},"responses":{"200":{"description":"Acknowledged"}}}},"whatsapp.account.quality_updated":{"post":{"summary":"WhatsApp quality rating or messaging limit changed","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookPayloadWhatsAppAccountQualityUpdated"}}}},"responses":{"200":{"description":"Acknowledged"}}}},"whatsapp.account.status_updated":{"post":{"summary":"WhatsApp Business Account restricted or reinstated","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookPayloadWhatsAppAccountStatusUpdated"}}}},"responses":{"200":{"description":"Acknowledged"}}}},"whatsapp.account.alert_received":{"post":{"summary":"WhatsApp account alert received","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookPayloadWhatsAppAccountAlertReceived"}}}},"responses":{"200":{"description":"Acknowledged"}}}},"whatsapp.contact.identity_changed":{"post":{"summary":"WhatsApp contact identity changed event","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookPayloadWhatsAppContactIdentityChanged"}}}},"responses":{"200":{"description":"Acknowledged"}}}},"whatsapp.account.name_status_updated":{"post":{"summary":"WhatsApp display-name review outcome event","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookPayloadWhatsAppAccountNameStatusUpdated"}}}},"responses":{"200":{"description":"Acknowledged"}}}},"whatsapp.automatic_event":{"post":{"summary":"WhatsApp automatic event detected","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"test":{"type":"boolean"},"id":{"type":"string"},"profiles":{"$ref":"#/components/schemas/WebhookProfiles"},"event":{"type":"string","enum":["whatsapp.automatic_event"]},"timestamp":{"type":"string","format":"date-time"},"accountId":{"type":"string"},"conversationId":{"type":"string"},"platformMessageId":{"type":"string"},"eventName":{"type":"string"},"ctwaClid":{"type":"string"},"customData":{"type":"object","properties":{"currency":{"type":"string"},"value":{"type":"number"}}},"detectedAt":{"type":"string","format":"date-time"}}}}}},"responses":{"200":{"description":"Acknowledged"}}}},"whatsapp.number.activated":{"post":{"summary":"WhatsApp number activated event","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"test":{"type":"boolean"},"id":{"type":"string"},"profiles":{"$ref":"#/components/schemas/WebhookProfiles"},"event":{"type":"string","enum":["whatsapp.number.activated"]},"timestamp":{"type":"string","format":"date-time"},"number":{"type":"object","properties":{"id":{"type":"string"},"phoneNumber":{"type":"string"},"country":{"type":"string"},"profileId":{"type":"string"}}}}}}}},"responses":{"200":{"description":"Acknowledged"}}}},"whatsapp.number.declined":{"post":{"summary":"WhatsApp number declined event","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"test":{"type":"boolean"},"id":{"type":"string"},"profiles":{"$ref":"#/components/schemas/WebhookProfiles"},"event":{"type":"string","enum":["whatsapp.number.declined"]},"timestamp":{"type":"string","format":"date-time"},"number":{"type":"object","properties":{"id":{"type":"string"},"phoneNumber":{"type":"string"},"country":{"type":"string"},"profileId":{"type":"string"}}},"reason":{"type":["string","null"]}}}}}},"responses":{"200":{"description":"Acknowledged"}}}},"whatsapp.number.action_required":{"post":{"summary":"WhatsApp number action required event","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"test":{"type":"boolean"},"id":{"type":"string"},"profiles":{"$ref":"#/components/schemas/WebhookProfiles"},"event":{"type":"string","enum":["whatsapp.number.action_required"]},"timestamp":{"type":"string","format":"date-time"},"reason":{"type":"string"},"requirements":{"type":"array","items":{"type":"object","properties":{"requirementId":{"type":"string"},"label":{"type":"string"},"status":{"type":"string","enum":["approved","pending","declined"]}}}},"reviewedAt":{"type":"string","format":"date-time"},"number":{"type":"object","properties":{"id":{"type":"string"},"phoneNumber":{"type":"string"},"country":{"type":"string"},"profileId":{"type":"string"}}}}}}}},"responses":{"200":{"description":"Acknowledged"}}}},"whatsapp.number.verification_required":{"post":{"summary":"WhatsApp number verification-required event","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"test":{"type":"boolean"},"id":{"type":"string"},"profiles":{"$ref":"#/components/schemas/WebhookProfiles"},"event":{"type":"string","enum":["whatsapp.number.verification_required"]},"timestamp":{"type":"string","format":"date-time"},"number":{"type":"object","properties":{"id":{"type":"string"},"phoneNumber":{"type":"string"},"country":{"type":"string"},"profileId":{"type":"string"}}},"verificationUrl":{"type":"string"}}}}}},"responses":{"200":{"description":"Acknowledged"}}}},"whatsapp.number.suspended":{"post":{"summary":"WhatsApp number suspended event","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"test":{"type":"boolean"},"id":{"type":"string"},"profiles":{"$ref":"#/components/schemas/WebhookProfiles"},"event":{"type":"string","enum":["whatsapp.number.suspended"]},"timestamp":{"type":"string","format":"date-time"},"number":{"type":"object","properties":{"id":{"type":"string"},"phoneNumber":{"type":"string"},"country":{"type":"string"},"profileId":{"type":"string"}}},"reason":{"type":["string","null"]}}}}}},"responses":{"200":{"description":"Acknowledged"}}}},"whatsapp.number.reactivated":{"post":{"summary":"WhatsApp number reactivated event","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"test":{"type":"boolean"},"id":{"type":"string"},"profiles":{"$ref":"#/components/schemas/WebhookProfiles"},"event":{"type":"string","enum":["whatsapp.number.reactivated"]},"timestamp":{"type":"string","format":"date-time"},"number":{"type":"object","properties":{"id":{"type":"string"},"phoneNumber":{"type":"string"},"country":{"type":"string"},"profileId":{"type":"string"}}}}}}}},"responses":{"200":{"description":"Acknowledged"}}}},"whatsapp.number.released":{"post":{"summary":"WhatsApp number released event","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"test":{"type":"boolean"},"id":{"type":"string"},"profiles":{"$ref":"#/components/schemas/WebhookProfiles"},"event":{"type":"string","enum":["whatsapp.number.released"]},"timestamp":{"type":"string","format":"date-time"},"number":{"type":"object","properties":{"id":{"type":"string"},"phoneNumber":{"type":"string"},"country":{"type":"string"},"profileId":{"type":"string"}}},"reason":{"type":["string","null"]}}}}}},"responses":{"200":{"description":"Acknowledged"}}}},"whatsapp.number.kyc_submitted":{"post":{"summary":"WhatsApp number KYC submitted event","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"test":{"type":"boolean"},"id":{"type":"string"},"profiles":{"$ref":"#/components/schemas/WebhookProfiles"},"event":{"type":"string","enum":["whatsapp.number.kyc_submitted","verification.approved","verification.failed"]},"timestamp":{"type":"string","format":"date-time"},"number":{"type":"object","properties":{"id":{"type":"string"},"phoneNumber":{"type":"string"},"country":{"type":"string"},"profileId":{"type":"string"}}}}}}}},"responses":{"200":{"description":"Acknowledged"}}}},"phone_number.stock_available":{"post":{"summary":"Phone-number stock available event","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookPayloadPhoneNumberStockAvailable"}}}},"responses":{"200":{"description":"Acknowledged"}}}},"verification.approved":{"post":{"summary":"Verification approved event","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"test":{"type":"boolean"},"id":{"type":"string"},"event":{"type":"string","enum":["verification.approved"]},"timestamp":{"type":"string","format":"date-time"},"verification":{"type":"object","properties":{"verificationId":{"type":"string"},"channel":{"type":"string","enum":["sms","whatsapp"]},"to":{"type":"string"}}}}}}}},"responses":{"200":{"description":"Acknowledged"}}}},"verification.failed":{"post":{"summary":"Verification failed event","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"test":{"type":"boolean"},"id":{"type":"string"},"event":{"type":"string","enum":["verification.failed"]},"timestamp":{"type":"string","format":"date-time"},"verification":{"type":"object","properties":{"verificationId":{"type":"string"},"channel":{"type":"string","enum":["sms","whatsapp"]},"to":{"type":"string"}}},"reason":{"type":"string","enum":["max_attempts_reached"]}}}}}},"responses":{"200":{"description":"Acknowledged"}}}},"commerce.product.created":{"post":{"summary":"Commerce product created event","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookPayloadCommerceProduct"}}}},"responses":{"200":{"description":"Acknowledged"}}}},"commerce.product.updated":{"post":{"summary":"Commerce product updated event","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookPayloadCommerceProduct"}}}},"responses":{"200":{"description":"Acknowledged"}}}},"commerce.product.deleted":{"post":{"summary":"Commerce product deleted event","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookPayloadCommerceProduct"}}}},"responses":{"200":{"description":"Acknowledged"}}}},"commerce.order.created":{"post":{"summary":"Commerce order created event","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookPayloadCommerceOrder"}}}},"responses":{"200":{"description":"Acknowledged"}}}},"commerce.order.updated":{"post":{"summary":"Commerce order updated event","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookPayloadCommerceOrder"}}}},"responses":{"200":{"description":"Acknowledged"}}}},"commerce.order.refunded":{"post":{"summary":"Commerce order refunded event","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookPayloadCommerceOrder"}}}},"responses":{"200":{"description":"Acknowledged"}}}},"sms.registration.action_required":{"post":{"summary":"SMS registration action required event","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"test":{"type":"boolean"},"id":{"type":"string"},"profiles":{"$ref":"#/components/schemas/WebhookProfiles"},"event":{"type":"string","enum":["sms.registration.action_required"]},"timestamp":{"type":"string","format":"date-time"},"registration":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["standard_10dlc","sole_prop_10dlc","toll_free"]},"displayName":{"type":["string","null"]},"status":{"type":"string"},"profileId":{"type":"string"}}},"reason":{"type":"string","enum":["changes_requested","otp_required","carrier_info_required"]},"message":{"type":"string"}}}}}},"responses":{"200":{"description":"Acknowledged"}}}},"sms.registration.status_updated":{"post":{"summary":"SMS registration status updated event","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"test":{"type":"boolean"},"id":{"type":"string"},"profiles":{"$ref":"#/components/schemas/WebhookProfiles"},"event":{"type":"string","enum":["sms.registration.status_updated"]},"timestamp":{"type":"string","format":"date-time"},"registration":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["standard_10dlc","sole_prop_10dlc","toll_free"]},"displayName":{"type":["string","null"]},"status":{"type":"string"},"profileId":{"type":"string"}}},"status":{"type":"string","enum":["changes_requested","requested","pending","approved","rejected","deactivated"]},"reason":{"type":"string"}}}}}},"responses":{"200":{"description":"Acknowledged"}}}},"branded_calling.identity.status_updated":{"post":{"summary":"Caller identity status updated event","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"test":{"type":"boolean"},"id":{"type":"string"},"event":{"type":"string","enum":["branded_calling.identity.status_updated"]},"timestamp":{"type":"string","format":"date-time"},"identity":{"type":"object","properties":{"id":{"type":"string"},"displayName":{"type":"string"},"status":{"type":"string"}}},"status":{"type":"string","enum":["requested","changes_requested","rejected","pending_email_verification","in_review","verified","suspended","expired","permanently_rejected"]},"reason":{"type":"string"}}}}}},"responses":{"200":{"description":"Acknowledged"}}}},"branded_calling.identity.action_required":{"post":{"summary":"Caller identity action required event","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"test":{"type":"boolean"},"id":{"type":"string"},"event":{"type":"string","enum":["branded_calling.identity.action_required"]},"timestamp":{"type":"string","format":"date-time"},"identity":{"type":"object","properties":{"id":{"type":"string"},"displayName":{"type":"string"},"status":{"type":"string"}}},"reason":{"type":"string","enum":["changes_requested","email_code","rejected","infringement_claim","expired"]},"message":{"type":"string"}}}}}},"responses":{"200":{"description":"Acknowledged"}}}},"branded_calling.number.status_updated":{"post":{"summary":"Branded number status updated event","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"test":{"type":"boolean"},"id":{"type":"string"},"event":{"type":"string","enum":["branded_calling.number.status_updated"]},"timestamp":{"type":"string","format":"date-time"},"identity":{"type":"object","properties":{"id":{"type":"string"},"displayName":{"type":"string"}}},"number":{"type":"object","properties":{"phoneNumberId":{"type":"string"},"phoneNumber":{"type":"string"},"status":{"type":"string","enum":["submitted","in_review","verified","unsuccessful","suspended","expired","permanently_rejected"]}}},"reason":{"type":"string"}}}}}},"responses":{"200":{"description":"Acknowledged"}}}},"rcs.agent.status_updated":{"post":{"summary":"RCS agent status updated event","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"test":{"type":"boolean"},"id":{"type":"string"},"profiles":{"$ref":"#/components/schemas/WebhookProfiles"},"event":{"type":"string","enum":["rcs.agent.status_updated"]},"timestamp":{"type":"string","format":"date-time"},"agent":{"type":"object","properties":{"id":{"type":"string"},"displayName":{"type":"string"},"profileId":{"type":"string"},"accountId":{"type":["string","null"]}}},"status":{"type":"string","enum":["changes_requested","brand_vetting","agent_review","testing","launch_review","launching","live","rejected","deactivated"]},"reason":{"type":"string"}}}}}},"responses":{"200":{"description":"Acknowledged"}}}},"api.changelog.published":{"post":{"summary":"API changelog entry published event","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookPayloadApiChangelogPublished"}}}},"responses":{"200":{"description":"Acknowledged"}}}},"contact.tag_added":{"post":{"summary":"Contact tag added event","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookPayloadContactTag"}}}},"responses":{"200":{"description":"Acknowledged"}}}},"contact.tag_removed":{"post":{"summary":"Contact tag removed event","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookPayloadContactTag"}}}},"responses":{"200":{"description":"Acknowledged"}}}},"contact.field_changed":{"post":{"summary":"Contact field changed event","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookPayloadContactFieldChanged"}}}},"responses":{"200":{"description":"Acknowledged"}}}},"sequence.enrolled":{"post":{"summary":"Sequence enrolled event","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookPayloadSequenceEnrollment"}}}},"responses":{"200":{"description":"Acknowledged"}}}},"sequence.exited":{"post":{"summary":"Sequence exited event","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookPayloadSequenceEnrollment"}}}},"responses":{"200":{"description":"Acknowledged"}}}},"workflow.run.started":{"post":{"summary":"Workflow run started event","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookPayloadWorkflowRun"}}}},"responses":{"200":{"description":"Acknowledged"}}}},"workflow.run.completed":{"post":{"summary":"Workflow run completed event","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookPayloadWorkflowRun"}}}},"responses":{"200":{"description":"Acknowledged"}}}},"workflow.run.failed":{"post":{"summary":"Workflow run failed event","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookPayloadWorkflowRun"}}}},"responses":{"200":{"description":"Acknowledged"}}}},"support.run.completed":{"post":{"summary":"Support Assistant finished event","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookPayloadSupportRun"}}}},"responses":{"200":{"description":"Acknowledged"}}}},"support.run.failed":{"post":{"summary":"Support Assistant failed event","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookPayloadSupportRun"}}}},"responses":{"200":{"description":"Acknowledged"}}}},"campaign_submission.received":{"post":{"summary":"Campaign submission received event","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookPayloadCampaignSubmission"}}}},"responses":{"200":{"description":"Acknowledged"}}}},"campaign_submission.flagged":{"post":{"summary":"Campaign submission flagged event","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookPayloadCampaignSubmission"}}}},"responses":{"200":{"description":"Acknowledged"}}}},"campaign_submission.pending_review":{"post":{"summary":"Campaign submission pending review event","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookPayloadCampaignSubmission"}}}},"responses":{"200":{"description":"Acknowledged"}}}},"campaign_submission.approved":{"post":{"summary":"Campaign submission approved event","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookPayloadCampaignSubmission"}}}},"responses":{"200":{"description":"Acknowledged"}}}},"campaign_submission.rejected":{"post":{"summary":"Campaign submission rejected event","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookPayloadCampaignSubmission"}}}},"responses":{"200":{"description":"Acknowledged"}}}},"creator_campaign.closed":{"post":{"summary":"Creator campaign closed event","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookPayloadCreatorCampaign"}}}},"responses":{"200":{"description":"Acknowledged"}}}},"campaign_payout.payable":{"post":{"summary":"Campaign payout payable event","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookPayloadCampaignPayout"}}}},"responses":{"200":{"description":"Acknowledged"}}}},"campaign_payout.settled":{"post":{"summary":"Campaign payout settled event","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookPayloadCampaignPayout"}}}},"responses":{"200":{"description":"Acknowledged"}}}},"campaign_payout.failed":{"post":{"summary":"Campaign payout failed event","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookPayloadCampaignPayout"}}}},"responses":{"200":{"description":"Acknowledged"}}}},"campaign_participant.joined":{"post":{"summary":"Campaign participant joined event","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookPayloadCampaignParticipant"}}}},"responses":{"200":{"description":"Acknowledged"}}}},"campaign_participant.suspended":{"post":{"summary":"Campaign participant suspended event","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookPayloadCampaignParticipant"}}}},"responses":{"200":{"description":"Acknowledged"}}}},"campaign_participant.removed":{"post":{"summary":"Campaign participant removed event","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookPayloadCampaignParticipant"}}}},"responses":{"200":{"description":"Acknowledged"}}}},"creator_campaign.budget_exhausted":{"post":{"summary":"Creator campaign budget exhausted event","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookPayloadCreatorCampaign"}}}},"responses":{"200":{"description":"Acknowledged"}}}},"webhook.test":{"post":{"summary":"Webhook test event","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookPayloadTest"}}}},"responses":{"200":{"description":"Acknowledged"}}}}}}