How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Pomo Campaigns API

The campaigns API from Pomo — 116 operation(s) for campaigns.

Pomo Campaigns API is one of 100 APIs that Pomo publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Campaigns. The published artifact set on APIs.io includes an OpenAPI specification, an API reference, API documentation, authentication docs, and rate-limit docs.

This API exposes 120 operations across 116 paths, and defines 80 schemas. It is described by OpenAPI 3.2.0, at version 0.1.0.

Requests are made against a single base URL, https://api.usepomo.ai.

120 operations 116 paths 80 schemas 13 DELETE48 GET1 PATCH50 POST8 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
0.1.0
Base URL
https://api.usepomo.ai
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Pomo Campaigns API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (HTTPBearer).

Paths & Operations 120

Across 116 paths, the API surfaces 120 operations — 13 DELETE, 48 GET, 1 PATCH, 50 POST, 8 PUT. Each is listed below with its method, path, parameters, and response codes.

campaigns 120
POST
/api/campaigns/external/sync
Sync External Campaigns
sync_external_campaigns_api_campaigns_external_sync_post body → 200422
GET
/api/campaigns/external/{platform}/{remote_campaign_id}
Get External Campaign Document
get_external_campaign_document_api_campaigns_external__platform___remote_campaign_id__get 4 params → 200422
PATCH
/api/campaigns/external/{platform}/{remote_campaign_id}
Patch External Campaign Document
patch_external_campaign_document_api_campaigns_external__platform___remote_campaign_id__patch 4 params body → 200422
GET
/api/campaigns/external-media/{document_id}/{media_key}
Get External Campaign Media
get_external_campaign_media_api_campaigns_external_media__document_id___media_key__get 2 params → 200422
POST
/api/campaigns/external/{platform}/{remote_campaign_id}/sync
Sync External Campaign Document
sync_external_campaign_document_api_campaigns_external__platform___remote_campaign_id__sync_post 4 params → 200422
GET
/api/campaigns/optimization-activity
Get Optimization Activity
get_optimization_activity_api_campaigns_optimization_activity_get 3 params → 200422
GET
/api/campaigns/optimization-summary
Get Optimization Summary
get_optimization_summary_api_campaigns_optimization_summary_get → 200
POST
/api/campaigns/{campaign_public_id}/optimizations/rollback
Rollback Campaign Optimizations
rollback_campaign_optimizations_api_campaigns__campaign_public_id__optimizations_rollback_post 1 param body → 200422
POST
/api/campaigns/{campaign_public_id}/optimizations/{action_id}/rollback
Rollback Campaign Optimization
rollback_campaign_optimization_api_campaigns__campaign_public_id__optimizations__action_id__rollback_post 2 params → 200422
GET
/api/campaigns/{campaign_public_id}/optimization-activity
Get Campaign Optimization Activity
get_campaign_optimization_activity_api_campaigns__campaign_public_id__optimization_activity_get 4 params → 200422
GET
/api/campaigns/{campaign_public_id}/perf-history
Get Campaign Perf History
get_campaign_perf_history_api_campaigns__campaign_public_id__perf_history_get 2 params → 200422
POST
/api/campaigns/email/edit-image
Edit Campaign Image
edit_campaign_image_api_campaigns_email_edit_image_post body → 200422
POST
/api/campaigns/email/edit-content
Edit Campaign Content
edit_campaign_content_api_campaigns_email_edit_content_post body → 200422
DELETE
/api/campaigns/email/delete-image
Delete Campaign Image
delete_campaign_image_api_campaigns_email_delete_image_delete 3 params → 200422
POST
/api/campaigns/email/upload-image
Upload Email Campaign Image General
upload_email_campaign_image_general_api_campaigns_email_upload_image_post body → 200422
POST
/api/campaigns/email/upload-campaign-image
Upload Campaign Image
upload_campaign_image_api_campaigns_email_upload_campaign_image_post body → 200422
POST
/api/campaigns/email/upload-campaign-images
Upload Campaign Images
upload_campaign_images_api_campaigns_email_upload_campaign_images_post body → 200422
GET
/api/campaigns/email
Fetch All Email Campaigns
fetch_all_email_campaigns_api_campaigns_email_get 2 params → 200422
POST
/api/campaigns/email
Create Email Campaign
create_email_campaign_api_campaigns_email_post body → 201422
DELETE
/api/campaigns/email/{campaign_id}
Delete Email Campaign
delete_email_campaign_api_campaigns_email__campaign_id__delete 1 param → 200422
DELETE
/api/campaigns/email/{campaign_id}/idea/{idea_number}
Delete Email Campaign Idea
delete_email_campaign_idea_api_campaigns_email__campaign_id__idea__idea_number__delete 2 params → 200422
GET
/api/campaigns/email/count
Get Email Campaigns Count
get_email_campaigns_count_api_campaigns_email_count_get → 200
POST
/api/campaigns/email/associate-consumer-group
Associate Consumer Group With Email Campaign
associate_consumer_group_with_email_campaign_api_campaigns_email_associate_consumer_group_post body → 200422
GET
/api/campaigns/email/list-associated-consumer-groups/{campaign_id}/{idea_number}
List Associated Consumer Groups
list_associated_consumer_groups_api_campaigns_email_list_associated_consumer_groups__campaign_id___idea_number__get 2 params → 200422
DELETE
/api/campaigns/email/remove-consumer-group-association/{association_id}
Remove Consumer Group Association
remove_consumer_group_association_api_campaigns_email_remove_consumer_group_association__association_id__delete 1 param → 200422
POST
/api/campaigns/email/{email_campaign_id}/image
Add Email Campaign Image
add_email_campaign_image_api_campaigns_email__email_campaign_id__image_post 1 param body → 201422
POST
/api/campaigns/social-post/edit-content
Edit Social Post Content
edit_social_post_content_api_campaigns_social_post_edit_content_post body → 200422
POST
/api/campaigns/social-post/direct-edit-social-post
Direct Edit Social Post
direct_edit_social_post_api_campaigns_social_post_direct_edit_social_post_post body → 200422
DELETE
/api/campaigns/social-post/delete-social-post
Delete Social Post
delete_social_post_api_campaigns_social_post_delete_social_post_delete 2 params → 200422
POST
/api/campaigns/social-post/edit-social-post-image
Edit Social Post Image
edit_social_post_image_api_campaigns_social_post_edit_social_post_image_post body → 200422
POST
/api/campaigns/social-post/upload-social-post-image
Upload Social Post Image
upload_social_post_image_api_campaigns_social_post_upload_social_post_image_post body → 200422
GET
/api/campaigns/social-post/social-post-campaigns
Fetch All Social Post Campaigns
fetch_all_social_post_campaigns_api_campaigns_social_post_social_post_campaigns_get 9 params → 200422
DELETE
/api/campaigns/social-post/social-post-campaign/{campaign_id}
Delete Social Post Campaign
delete_social_post_campaign_api_campaigns_social_post_social_post_campaign__campaign_id__delete 1 param → 200422
DELETE
/api/campaigns/social-post/social-post-campaign/{campaign_id}/idea/{idea_number}
Delete Social Post Campaign Idea
delete_social_post_campaign_idea_api_campaigns_social_post_social_post_campaign__campaign_id__idea__idea_number__delete 2 params → 200422
GET
/api/campaigns/social-post/social-post-campaigns-count
Get Social Post Campaigns Count
get_social_post_campaigns_count_api_campaigns_social_post_social_post_campaigns_count_get → 200
GET
/api/campaigns/social-post/{campaign_id}/{idea_number}/posts
Get Campaign Posts
get_campaign_posts_api_campaigns_social_post__campaign_id___idea_number__posts_get 4 params → 200422
POST
/api/campaigns/social-post/generate-variation
Generate Social Post Variation
generate_social_post_variation_api_campaigns_social_post_generate_variation_post body → 201422
POST
/api/campaigns/social-post
Create Social Post Campaign
create_social_post_campaign_api_campaigns_social_post_post body → 201422
POST
/api/campaigns/social-post/schedule/preflight
Preflight Social Post Schedule
preflight_social_post_schedule_api_campaigns_social_post_schedule_preflight_post body → 200422
POST
/api/campaigns/social-post/schedule
Upsert Social Post Schedule
upsert_social_post_schedule_api_campaigns_social_post_schedule_post body → 200422
GET
/api/campaigns/social-post/schedule/{campaign_id}/{idea_number}/{variation}
Get Social Post Schedule
get_social_post_schedule_api_campaigns_social_post_schedule__campaign_id___idea_number___variation__get 3 params → 200422
DELETE
/api/campaigns/social-post/schedule/{schedule_id}
Cancel Social Post Schedule
cancel_social_post_schedule_api_campaigns_social_post_schedule__schedule_id__delete 1 param → 200422
GET
/api/campaigns/social-post/list-schedules
List Social Post Schedules
list_social_post_schedules_api_campaigns_social_post_list_schedules_get 5 params → 200422
POST
/api/campaigns/social-post/schedule/dispatch-due
Dispatch Due Social Post Schedules For Company
dispatch_due_social_post_schedules_for_company_api_campaigns_social_post_schedule_dispatch_due_post 1 param → 200422
POST
/api/campaigns/social-post/schedule-campaign/{campaign_id}/{idea_number}
Schedule Social Post Campaign
schedule_social_post_campaign_api_campaigns_social_post_schedule_campaign__campaign_id___idea_number__post 2 params body → 200422
GET
/api/campaigns/social-post/campaign-schedule/{campaign_id}/{idea_number}
Get Social Post Campaign Schedule
get_social_post_campaign_schedule_api_campaigns_social_post_campaign_schedule__campaign_id___idea_number__get 3 params → 200422
DELETE
/api/campaigns/social-post/cancel-schedule/{schedule_id}
Cancel Social Post Campaign Schedule
cancel_social_post_campaign_schedule_api_campaigns_social_post_cancel_schedule__schedule_id__delete 1 param → 200422
POST
/api/campaigns/online-ads/google-display/create
Create Google Display Campaign
create_google_display_campaign_api_campaigns_online_ads_google_display_create_post body → 201422
POST
/api/campaigns/online-ads/google-search/create
Create Google Search Campaign
create_google_search_campaign_api_campaigns_online_ads_google_search_create_post body → 201422
POST
/api/campaigns/online-ads/meta-feed/create
Create Meta Feed Campaign
create_meta_feed_campaign_api_campaigns_online_ads_meta_feed_create_post body → 201422
POST
/api/campaigns/online-ads/meta-stories-reels/create
Create Meta Stories Reels Campaign
create_meta_stories_reels_campaign_api_campaigns_online_ads_meta_stories_reels_create_post body → 201422
POST
/api/campaigns/online-ads/amazon-sponsored-products/create
Create Amazon Sponsored Products Campaign
create_amazon_sponsored_products_campaign_api_campaigns_online_ads_amazon_sponsored_products_create_post body → 201422
POST
/api/campaigns/online-ads/amazon-sponsored-brands/create
Create Amazon Sponsored Brands Campaign
create_amazon_sponsored_brands_campaign_api_campaigns_online_ads_amazon_sponsored_brands_create_post body → 201422
POST
/api/campaigns/online-ads/amazon-sponsored-display/create
Create Amazon Sponsored Display Campaign
create_amazon_sponsored_display_campaign_api_campaigns_online_ads_amazon_sponsored_display_create_post body → 201422
POST
/api/campaigns/online-ads/tiktok/create
Create Tiktok Campaign
create_tiktok_campaign_api_campaigns_online_ads_tiktok_create_post body → 201422
GET
/api/campaigns/online-ads/google-search-campaigns
Get Google Search Campaigns
get_google_search_campaigns_api_campaigns_online_ads_google_search_campaigns_get 2 params → 200422
GET
/api/campaigns/online-ads/google-search-campaign/{campaign_id}
Get Google Search Campaign
get_google_search_campaign_api_campaigns_online_ads_google_search_campaign__campaign_id__get 1 param → 200422
PUT
/api/campaigns/online-ads/google-search/update-campaign
Update Google Search Campaign
update_google_search_campaign_api_campaigns_online_ads_google_search_update_campaign_put body → 200422
POST
/api/campaigns/online-ads/google-search/generate-variation/{ad_id}
Generate Google Search Variation
generate_google_search_variation_api_campaigns_online_ads_google_search_generate_variation__ad_id__post 1 param → 200422
GET
/api/campaigns/online-ads/google-display-campaigns
Get Google Display Campaigns
get_google_display_campaigns_api_campaigns_online_ads_google_display_campaigns_get 2 params → 200422
GET
/api/campaigns/online-ads/google-display-campaign/{campaign_id}
Get Google Display Campaign
get_google_display_campaign_api_campaigns_online_ads_google_display_campaign__campaign_id__get 1 param → 200422
PUT
/api/campaigns/online-ads/google-display/update-campaign
Update Google Display Campaign
update_google_display_campaign_api_campaigns_online_ads_google_display_update_campaign_put body → 200422
POST
/api/campaigns/online-ads/google-display/generate-variation/{ad_id}
Generate Google Display Variation
generate_google_display_variation_api_campaigns_online_ads_google_display_generate_variation__ad_id__post 1 param → 200422
POST
/api/campaigns/online-ads/google-display/edit-image
Edit Google Display Image
edit_google_display_image_api_campaigns_online_ads_google_display_edit_image_post → 410
POST
/api/campaigns/online-ads/google-display/upload-image
Upload Google Display Image
upload_google_display_image_api_campaigns_online_ads_google_display_upload_image_post → 410
POST
/api/campaigns/online-ads/google-video
Create Google Video Ad Campaign
create_google_video_ad_campaign_api_campaigns_online_ads_google_video_post body → 200422
GET
/api/campaigns/online-ads/google-video
Get Google Video Campaigns
get_google_video_campaigns_api_campaigns_online_ads_google_video_get 2 params → 200422
GET
/api/campaigns/online-ads/google-video/all
Get Google Video Ad Campaigns
get_google_video_ad_campaigns_api_campaigns_online_ads_google_video_all_get → 200
GET
/api/campaigns/online-ads/google-video/{ad_id}
Get Google Video Ad Campaign
get_google_video_ad_campaign_api_campaigns_online_ads_google_video__ad_id__get 1 param → 200422
DELETE
/api/campaigns/online-ads/google-video/campaign/{campaign_id}
Delete Google Video Ad Campaign
delete_google_video_ad_campaign_api_campaigns_online_ads_google_video_campaign__campaign_id__delete 1 param → 200422
POST
/api/campaigns/online-ads/google-video/generate-variation/{ad_id}
Create Google Video Ad Variation
create_google_video_ad_variation_api_campaigns_online_ads_google_video_generate_variation__ad_id__post 1 param → 200422
PUT
/api/campaigns/online-ads/google-video/update-campaign
Update Google Video Ad Campaign
update_google_video_ad_campaign_api_campaigns_online_ads_google_video_update_campaign_put body → 200422
GET
/api/campaigns/online-ads/meta-stories-reels-campaigns
Get Meta Stories Reels Campaigns
get_meta_stories_reels_campaigns_api_campaigns_online_ads_meta_stories_reels_campaigns_get 2 params → 200422
GET
/api/campaigns/online-ads/meta-stories-reels-campaign/{campaign_id}
Get Meta Stories Reels Campaign
get_meta_stories_reels_campaign_api_campaigns_online_ads_meta_stories_reels_campaign__campaign_id__get 1 param → 200422
POST
/api/campaigns/online-ads/meta-stories-reels/create-campaign
Create Meta Stories Reels Campaign
create_meta_stories_reels_campaign_api_campaigns_online_ads_meta_stories_reels_create_campaign_post 12 params body → 200422
PUT
/api/campaigns/online-ads/meta-stories-reels/update-campaign
Update Meta Stories Reels Campaign
update_meta_stories_reels_campaign_api_campaigns_online_ads_meta_stories_reels_update_campaign_put body → 200422
POST
/api/campaigns/online-ads/meta-stories-reels/launch
Launch Meta Stories Reels Campaign
launch_meta_stories_reels_campaign_api_campaigns_online_ads_meta_stories_reels_launch_post body → 200422
GET
/api/campaigns/online-ads/meta-feed-campaigns
Get Meta Feed Campaigns
get_meta_feed_campaigns_api_campaigns_online_ads_meta_feed_campaigns_get 2 params → 200422
GET
/api/campaigns/online-ads/meta-feed-campaign/{campaign_id}
Get Meta Feed Campaign
get_meta_feed_campaign_api_campaigns_online_ads_meta_feed_campaign__campaign_id__get 1 param → 200422
POST
/api/campaigns/online-ads/meta-feed/create-campaign
Create Meta Feed Campaign
create_meta_feed_campaign_api_campaigns_online_ads_meta_feed_create_campaign_post 12 params body → 200422
PUT
/api/campaigns/online-ads/meta-feed/update-campaign
Update Meta Feed Campaign
update_meta_feed_campaign_api_campaigns_online_ads_meta_feed_update_campaign_put body → 200422
POST
/api/campaigns/online-ads/meta-feed/edit-image
Edit Meta Feed Image
edit_meta_feed_image_api_campaigns_online_ads_meta_feed_edit_image_post → 410
POST
/api/campaigns/online-ads/meta-feed/upload-image
Upload Meta Feed Image
upload_meta_feed_image_api_campaigns_online_ads_meta_feed_upload_image_post → 410
POST
/api/campaigns/online-ads/meta-feed/launch
Launch Meta Feed Campaign
launch_meta_feed_campaign_api_campaigns_online_ads_meta_feed_launch_post body → 200422
GET
/api/campaigns/online-ads/linkedin-image-campaigns
Get Linkedin Image Campaigns
get_linkedin_image_campaigns_api_campaigns_online_ads_linkedin_image_campaigns_get 2 params → 200422
GET
/api/campaigns/online-ads/linkedin-image/{campaign_id}
Get Linkedin Image Campaign
get_linkedin_image_campaign_api_campaigns_online_ads_linkedin_image__campaign_id__get 1 param → 200422
GET
/api/campaigns/online-ads/linkedin-image-campaign/{campaign_id}
Get Linkedin Image Campaign
get_linkedin_image_campaign_api_campaigns_online_ads_linkedin_image_campaign__campaign_id__get 1 param → 200422
PUT
/api/campaigns/online-ads/linkedin-image/update-campaign
Update Linkedin Image Campaign
update_linkedin_image_campaign_api_campaigns_online_ads_linkedin_image_update_campaign_put body → 200422
GET
/api/campaigns/online-ads/linkedin-video-campaigns
Get Linkedin Video Campaigns
get_linkedin_video_campaigns_api_campaigns_online_ads_linkedin_video_campaigns_get 2 params → 200422
GET
/api/campaigns/online-ads/linkedin-video/{campaign_id}
Get Linkedin Video Campaign
get_linkedin_video_campaign_api_campaigns_online_ads_linkedin_video__campaign_id__get 1 param → 200422
GET
/api/campaigns/online-ads/linkedin-video-campaign/{campaign_id}
Get Linkedin Video Campaign
get_linkedin_video_campaign_api_campaigns_online_ads_linkedin_video_campaign__campaign_id__get 1 param → 200422
PUT
/api/campaigns/online-ads/linkedin-video/update-campaign
Update Linkedin Video Campaign
update_linkedin_video_campaign_api_campaigns_online_ads_linkedin_video_update_campaign_put body → 200422
POST
/api/campaigns/online-ads/tiktok-video
Create Tiktok Video Ad Campaign
create_tiktok_video_ad_campaign_api_campaigns_online_ads_tiktok_video_post body → 200422
GET
/api/campaigns/online-ads/tiktok-video
Get Tiktok Video Campaigns
get_tiktok_video_campaigns_api_campaigns_online_ads_tiktok_video_get 2 params → 200422
GET
/api/campaigns/online-ads/tiktok-video/all
Get Tiktok Video Ad Campaigns
get_tiktok_video_ad_campaigns_api_campaigns_online_ads_tiktok_video_all_get → 200
GET
/api/campaigns/online-ads/tiktok-video/call-to-actions
Get Tiktok Video Call To Actions
get_tiktok_video_call_to_actions_api_campaigns_online_ads_tiktok_video_call_to_actions_get → 200
GET
/api/campaigns/online-ads/tiktok-video/{campaign_id}
Get Tiktok Video Ad Campaign
get_tiktok_video_ad_campaign_api_campaigns_online_ads_tiktok_video__campaign_id__get 1 param → 200422
DELETE
/api/campaigns/online-ads/tiktok-video/campaign/{campaign_id}
Delete Tiktok Video Ad Campaign
delete_tiktok_video_ad_campaign_api_campaigns_online_ads_tiktok_video_campaign__campaign_id__delete 1 param → 200422
PUT
/api/campaigns/online-ads/tiktok-video/update-campaign
Update Tiktok Video Ad Campaign
update_tiktok_video_ad_campaign_api_campaigns_online_ads_tiktok_video_update_campaign_put body → 200422
POST
/api/campaigns/online-ads/generate-variation
Generate Ad Variation
generate_ad_variation_api_campaigns_online_ads_generate_variation_post body → 201422
GET
/api/campaigns/online-ads/all-campaigns/count
Get All Online Ads Campaigns Count
get_all_online_ads_campaigns_count_api_campaigns_online_ads_all_campaigns_count_get → 200
GET
/api/campaigns/online-ads/top-level
Get Top Level Entities
get_top_level_entities_api_campaigns_online_ads_top_level_get 2 params → 200422
POST
/api/campaigns/images/edit-image/job
Start Campaign Image Edit Job
start_campaign_image_edit_job_api_campaigns_images_edit_image_job_post body → 200422
POST
/api/campaigns/images/select-image
Select Campaign Image
select_campaign_image_api_campaigns_images_select_image_post body → 200422
POST
/api/campaigns/images/select-video
Select Campaign Video
select_campaign_video_api_campaigns_images_select_video_post body → 200422
POST
/api/campaigns/images/batch-select-images
Batch Select Campaign Images
batch_select_campaign_images_api_campaigns_images_batch_select_images_post body → 200422
GET
/api/campaigns/images/campaign/{campaign_type}/{campaign_id}/image-history
Get Campaign Image History
get_campaign_image_history_api_campaigns_images_campaign__campaign_type___campaign_id__image_history_get 2 params → 200422
POST
/api/campaigns/budget-estimate
Budget Estimate
budget_estimate_api_campaigns_budget_estimate_post body → 200422
POST
/api/campaigns/dayparting/campaigns/{campaign_id}/configure
Configure Campaign Dayparting
configure_campaign_dayparting_api_campaigns_dayparting_campaigns__campaign_id__configure_post 1 param body → 200422
GET
/api/campaigns/dayparting/campaigns/{campaign_id}/status
Get Dayparting Status
get_dayparting_status_api_campaigns_dayparting_campaigns__campaign_id__status_get 1 param → 200422
DELETE
/api/campaigns/dayparting/campaigns/{campaign_id}/disable
Disable Dayparting
disable_dayparting_api_campaigns_dayparting_campaigns__campaign_id__disable_delete 1 param → 200422
GET
/api/campaigns/dayparting/meta/{ad_id}/health
Check Meta Rules Health
check_meta_rules_health_api_campaigns_dayparting_meta__ad_id__health_get 1 param → 200422
DELETE
/api/campaigns/dayparting/meta/{ad_id}/cleanup
Cleanup Meta Rules
cleanup_meta_rules_api_campaigns_dayparting_meta__ad_id__cleanup_delete 1 param → 200422
GET
/api/campaigns/dayparting/performance/{campaign_id}
Get Dayparting Performance
get_dayparting_performance_api_campaigns_dayparting_performance__campaign_id__get 2 params → 200422
GET
/api/campaigns/geo/reverse-geocode
Reverse Geocode Campaign Pin
reverse_geocode_campaign_pin_api_campaigns_geo_reverse_geocode_get 3 params → 200422
GET
/api/campaigns/geo/postal-code
Resolve Campaign Postal Code
resolve_campaign_postal_code_api_campaigns_geo_postal_code_get 2 params → 200422
GET
/api/campaigns/queue
Get Campaign Work Queue
get_campaign_work_queue_api_campaigns_queue_get 3 params → 200422
GET
/api/campaigns/dashboard
Get Campaign Dashboard Bundle
get_campaign_dashboard_bundle_api_campaigns_dashboard_get 12 params → 200422
GET
/api/campaigns/all/count
Get All Campaigns Count
get_all_campaigns_count_api_campaigns_all_count_get → 200
GET
/api/campaigns/all/active
Get Active Campaigns
get_active_campaigns_api_campaigns_all_active_get → 200

Schemas 80

The contract defines 80 schemas that model the data the API accepts and returns. The most detailed are AdsCampaignUpdateRequest (55 properties), MetaFeedCampaignUpdateRequest (55 properties), MetaStoriesReelsCampaignUpdateRequest (55 properties), ExternalCampaignPatchRequest (34 properties). Each schema is shown below with its type and property counts.

EmailCampaignResponse
object
32 properties 7 required
Body_edit_campaign_content_api_campaigns_email_edit_content_post
object
4 properties 4 required
ImageSelectionResponse
object
Response schema for image selection
5 properties 5 required
CampaignAppliedOptimization
object
The most recent provider-executed optimization for one campaign. This is the durable, read-only counterpart to pendingrecommendation: the campaign row can keep…
12 properties 3 required
CampaignOptimizationChange
object
One concrete change inside a pending optimization, for a before/after review. Carries the data-backed why (rationale) and the list of literal field/asset edits…
9 properties 1 required
SocialPostVariationRequest
object
2 properties 2 required
TikTokVideoAdRequest
object
12 properties 2 required
CampaignOptimizationSummaryResponse
object
1 property 1 required
PlatformDaypartingConfig
object
4 properties 3 required
GenerateAdVariationRequest
object
3 properties 1 required
SocialScheduleUpsertRequest
object
10 properties 5 required
CampaignResponse
object
Base class for campaign metadata response.
15 properties 3 required
Body_direct_edit_social_post_api_campaigns_social_post_direct_edit_social_post_post
object
4 properties 3 required
ExternalCampaignSyncRequest
object
Authenticated sync settings; profile scope only comes from auth context.
5 properties
CampaignAnalyticsWindow
object
One general DoD/WoW movement for a campaign's headline metric. relativedelta is null when the baseline is ~0 (an honest "new/!comparable", never a fabricated %…
8 properties 1 required
Body_upload_social_post_image_api_campaigns_social_post_upload_social_post_image_post
object
5 properties 3 required
CampaignReverseGeocodeResponse
object
10 properties
EmailCampaignCreate
object
24 properties 2 required
VideoSelectionRequest
object
Request schema for selecting or uploading a replacement video for a campaign.
7 properties 3 required
MetaFeedAdRequest
object
Request model for Meta Feed ads
23 properties 3 required
SocialPostCampaignMediaResponse
object
15 properties 5 required
SocialPostCampaignCreate
object
20 properties 2 required
AiTeamActivityItem
object
11 properties 5 required
DaypartingHealthResponse
object
6 properties 6 required
CampaignOptimizationFieldEdit
object
One concrete field/asset edit, as a clean before - after mapping. Sourced from a single optimizationaction (not the option-level prose), so each row is the lit…
9 properties 2 required
GoogleVideoAdRequest
object
13 properties 2 required
CampaignPerfHistoryPoint
object
One day of the campaign's headline metric, for the expanded-row trend chart. value is null on a day with no spend (an honest gap, not a fabricated zero).
5 properties 1 required
JobResponse
object
Response after submitting a job
4 properties 4 required
Body_upload_email_campaign_image_general_api_campaigns_email_upload_image_post
object
4 properties 3 required
AmazonSponsoredProductsAdRequest
object
Request model for Amazon Sponsored Products ads
21 properties 3 required
CampaignAnalyticsImpact
object
One executed optimization move's measured after-effect on the campaign. outcomestate is measuring until enough post-change days accrue, then the scored verdict…
8 properties
MetaStoriesReelsCampaignUpdateRequest
object
55 properties 2 required
CampaignPostsResponse
object
1 property 1 required
Body_edit_campaign_image_api_campaigns_email_edit_image_post
object
4 properties 4 required
AdsCampaignUpdateResponse
object
Standardized response for ad update operations within a campaign.
5 properties 3 required
DaypartingSlot
object
6 properties 5 required
BaseAdsCampaignRequest
object
Base request model for creating ad campaigns.
19 properties 3 required
BudgetEstimateRequest
object
Input payload for budget estimation.
6 properties 2 required
schemas__campaigns__ads__google__GoogleDisplayAdRequest
object
Request model for Google Display ads
20 properties 3 required
EmailCampaignImageCreate
object
6 properties 2 required
AmazonSponsoredBrandsAdRequest
object
Request model for Amazon Sponsored Brands ads
24 properties 4 required
HTTPValidationError
object
1 property
KeywordWithCpc
object
Model for keyword with CPC data
2 properties 1 required
PostModel
object
10 properties 6 required
ExternalCampaignSyncResponse
object
5 properties 5 required
VideoSelectionResponse
object
Response schema for video selection.
7 properties 6 required
BudgetEstimateResponse
object
Structured response for budget estimate.
4 properties 4 required
ExternalCampaignPatchRequest
object
Sparse portable fields; native provider payloads are never replayed.
34 properties
ValidationError
object
3 properties 3 required
CampaignPerfHistoryResponse
object
9 properties 1 required
CampaignOptimizationRollbackResponse
object
5 properties 5 required
CampaignMediaOperation
object
Campaign Edit Mode media change applied by the outer Save/Sync transaction.
5 properties 3 required
EditImageJobRequest
object
Request body for starting an async campaign image edit job
10 properties 2 required
MetaFeedCampaignUpdateRequest
object
55 properties 2 required
WorkflowStatus
string
Email campaign workflow status values.
EmailCampaignImageResponse
object
9 properties 5 required
AiTeamActivityResponse
object
5 properties 4 required
BudgetRecommendationRange
object
Recommended daily budget range.
3 properties 3 required
CampaignOptimizationRollbackRequest
object
1 property 1 required
ExternalCampaignSyncResult
object
10 properties 10 required
CampaignDaypartingRequest
object
2 properties 2 required
AmazonSponsoredDisplayAdRequest
object
Request model for Amazon Sponsored Display ads
22 properties 3 required
GoogleSearchAdRequest
object
Request model for Google Search ads
20 properties 3 required
CampaignPerfRevision
object
One entry in the campaign's optimization/revision history: what the AI changed, when, and the measured before/after result. Built entirely from data we already…
10 properties 1 required
SocialSchedulePostingIdentity
object
6 properties
CampaignPendingRecommendation
object
A still-open AI-team optimization the user can Accept/Decline from the card. Sourced from an AgentTeamApproval in an OPEN state (pending/deferred/ escalated) w…
12 properties 3 required
AdsCampaignUpdateRequest
object
Request model for updating ad campaign data
55 properties 1 required
CampaignAnalyticsStrip
object
The close-the-loop analytics shown under a campaign row: general DoD/WoW for the headline metric, plus one entry per optimization move's after-effect.
9 properties
CampaignOptimizationSummary
object
A per-campaign rollup of AI-team activity, keyed by the campaign's public id. campaignid is the same public id the dashboard exposes on each card (ads for paid…
11 properties 3 required
ExternalCampaignResourceSelection
object
Explicit provider resource targets for multi-entity campaign edits.
5 properties
Body_edit_social_post_content_api_campaigns_social_post_edit_content_post
object
4 properties 4 required
LocationItem
object
Canonical location input for multi-geo campaigns with one shared budget.
18 properties 2 required
Body_upload_campaign_image_api_campaigns_email_upload_campaign_image_post
object
4 properties 3 required
Body_upload_campaign_images_api_campaigns_email_upload_campaign_images_post
object
4 properties 3 required
SocialPostCampaignResponse
object
25 properties 7 required
CampaignPerfOptimizationMarker
object
An executed AI-team optimization, drawn on the chart so the before/after is visible.
2 properties 2 required
ImageSelectionRequest
object
Request schema for selecting an image variation for a campaign
8 properties 3 required
Body_edit_social_post_image_api_campaigns_social_post_edit_social_post_image_post
object
4 properties 4 required
MetaStoriesReelsAdRequest
object
Request model for Meta Stories & Reels ads
21 properties 3 required
AiTeamActivityCounts
object
5 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

pomo-campaigns-api-openapi.yml Raw ↑

Other APIs Pomo publishes across the network.

Pomo Ab Groups API
Pomo Agent Jobs API
Pomo Agentic Chat API
Pomo Agentic Conversations API
Pomo Agentic Tasks API
Pomo Agentic Teams API
Pomo Agentic User API
Pomo AI Campaign API
Pomo AI Personas API
Pomo AI Policy API
Pomo AI Product Lab API
Pomo AI Testing API
Where this information came from

This is an independent, third-party profile of Pomo Campaigns API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.