- Pubsuite API Introduction
- Getting Started
- Endpoints
- Endpoints / Resources Introduction
- Global Pubsuite Reference Libaries
- Workspace Organisation Users
- Advertiser Accounts
- Advertiser Account Members
- Campaigns
- Phases
- Content
- Distributions
- Publisher Profiles
- Publisher Products
- Data Sources
- Webhooks
- Outbound Events
Update Campaign
Testing
POST
https://api.avidpubsuite.com/v2/campaigns
application/json format.Request
Authorization
Add parameter in header
X-API-Key
Example:
X-API-Key: ********************Header Params
Body Params application/json
Example
{
"campaign_id": 256,
"external_id": "123",
"campaign_status": 12,
"campaign_workflow_id": "commodo ea id culpa pariatur",
"primary_advertiser_account_id": 1737449,
"campaign_title": "New Campaign",
"brand_promoting": "PCB",
"brand_industry_id": 5,
"brand_sub_industry_id": 49,
"campaign_description": "Promoting the Pakistan Cricket Board's upcoming series with exciting content and fan engagement. The campaign focuses on driving awareness and increasing ticket sales for the matches.",
"campaign_objective": "Increase fan engagement, promote ticket sales, and raise awareness about the upcoming series, targeting both local and international cricket fans.",
"campaign_target_audience_summary": "Cricket enthusiasts, sports fans, and youth aged 18-35, both local and international, with a focus on those following the Pakistan Cricket Board and major cricket events.",
"no_content_pieces": 2,
"campaign_gross_cost": 110000,
"campaign_net_cost": 120000,
"media_plan_external_url": "https://drive.google.com/plan123",
"rate_card_external_url": "https://drive.google.com/ratecard456",
"crm_deal_link": "https://crm.example.com/deals/1234",
"tracking_report_info": "Tracking report includes detailed insights into ad performance, audience reach, engagement metrics, and conversion rates for the campaign. It will provide weekly updates and recommendations for optimization.",
"using_utm_tracking": 0,
"utm_info": "utm_source=facebook&utm_medium=cpc&utm_campaign=spring_launch",
"universal_content_requirements": "exercitation in pariatur",
"mandatory_dos": "sit et ipsum",
"mandatory_donts": "occaecat",
"content_look_feel_requests": "Modern and dynamic design with vibrant visuals to showcase the excitement of the cricket series. Focus on action-packed scenes and fan interactions to resonate with a younger, sports-driven audience.",
"additional_audience_targeting_notes": "Target cricket enthusiasts, with a special focus on people who follow the Pakistan Cricket Board’s social media platforms, as well as sports betting audiences.",
"additonal_campaign_notes": "Ensure cross-platform consistency in messaging and creative. Focus on building a sense of community around the series, especially in the lead-up to key matches.",
"potential_up_sell_opportunities": "Offer exclusive behind-the-scenes content and VIP access for fans who purchase premium tickets. Promote special merchandise bundles during the campaign.",
"facebook_profile_to_tag": "PakistanCricketOfficial",
"instagram_profile_to_tag": "pcb_cricket",
"tiktok_profile_to_tag": "pcb_official",
"linkedin_profile_to_tag": "Pakistan-Cricket-Board",
"pinterest_profile_to_tag": "PakistanCricket",
"advertiser_primary_campaign_manager_id": 1,
"advertiser_primary_campaign_manager_email": "manager@example.com",
"advertiser_primary_commercial_manager_id": 4,
"advertiser_primary_commercial_manager_email": "muddaser@avidcollective.com.au",
"billing_company_name": "Cricket Australia",
"billing_company_address": "Melbourne Cricket Ground, Brunton Avenue, Melbourne, VIC, Australia, 3000",
"billing_contact_person": "John Smith",
"billing_contact_email": "john.smith@cricketaustralia.com.au",
"billing_contact_phone": "+61 3 9653 9999",
"purchase_order_number": "CA-2025-1234",
"g_impressions": 68788446,
"e_impressions": 80000000,
"g_article_views": 121221212,
"e_article_views": 150000000,
"g_clicks_to_site": 94502810,
"e_clicks_to_site": 110000000,
"g_video_views": 25791143,
"e_video_views": 30000000,
"custom_fields": {
"salesforce_opportunity_id": 124124,
"salesforce_opportunity_name": "New opportunity",
"adpoint_primary_account_id": 3434634,
"adpoint_order_id": 764575467,
"salesforce_docs_url": "https://salesforce.com/salesforce-docs"
},
"advertiser_accounts": [
{
"external_id": null,
"advertiser_account_id": 24,
"advertiser_account_type": "AL",
"advertiser_account_name": "Alii Advertiser Account",
"custom_fields": {
"adpoint_organisation_id": 2,
"adpoint_account_name": "Global Health News"
}
}
],
"campaign_publisher_titles": [
{
"external_id": null,
"publisher_title_id": 2,
"custom_fields": {
"adpoint_title_id": 18834731
}
}
],
"workspace_campaign_team": [
{
"user_id": 50,
"user_email": "Daniall7@hotmaiiil.com",
"user_first_name": "Meggie",
"user_last_name": "Goodwin",
"role_type": [
1,
3
],
"role_priority": 1,
"custom_fields": {
"full_name": "Team Member Full Name"
}
},
{
"user_id": 52,
"user_email": "managerr@hotmail.com",
"user_first_name": "Meggie",
"user_last_name": "Goodwin",
"role_type": [
3
],
"role_priority": 3,
"custom_fields": {
"full_name": "Team Member Full Name 3"
}
}
],
"campaign_resources": [
{
"user_id": 49,
"user_email": "Myraa@hotmail.com",
"advertiser_account_id": 7246095,
"user_first_name": "Edgar",
"user_last_name": "Fadel",
"permissions": 1,
"custom_fields": {
"adpoint_organisation_id": 1,
"full_name": "Ava Thompson"
}
},
{
"user_id": null,
"user_email": "Maayraa@hotmail.com",
"advertiser_account_id": 7246095,
"user_first_name": "Edgarrrr",
"user_last_name": "Fadellll",
"permissions": 1,
"custom_fields": {
"adpoint_organisation_id": 1,
"full_name": "Ava Thompson"
}
}
],
"campaign_asset_links": [
{
"asset_url": "https://images.pexels.com/photos/584501/pexels-photo-584501.jpeg?cs=srgb&dl=pexels-summer-li-183179-584501.jpg&fm=jpg",
"title": "Cricket Match Highlights",
"description": "Exclusive footage from the latest international cricket match, showcasing key moments, thrilling shots, and standout performances from both teams. A must-watch for every cricket fan."
},
{
"asset_url": "https://images.pexels.com/photos/584501/pexels-photo-584501.jpeg?cs=srgb&dl=pexels-summer-li-183179-584501.jpg&fm=jpg",
"title": "Player Interviews and Behind-the-Scenes",
"description": "Get an insider’s look at the lives of your favorite cricketers with exclusive interviews and behind-the-scenes content from the dressing room and team bus. Unfiltered access to the stars."
}
],
"campaign_media_files": [
],
"campaign_phases": [
{
"id": 219,
"external_id": "1",
"phase_title": "Pre-Series Awareness",
"phase_description": "The first phase of the campaign will focus on creating awareness and building excitement for the upcoming cricket series between Australia and Pakistan. The phase will leverage social media, articles, and teaser videos.",
"phase_pacing": 2,
"key_message": "Get ready for the cricket showdown of the year. Stay tuned for exclusive updates and match previews.",
"earliest_phase_launch_date": "2025-06-01",
"latest_phase_launch_date": "2025-06-01",
"earliest_phase_end_date": "2025-06-15",
"latest_phase_end_date": "2025-06-15",
"g_impressions": 19956220,
"e_impressions": 25000000,
"g_video_views": 33642971,
"e_video_views": 50000000,
"g_article_views": 23421487,
"e_article_views": 30000000,
"g_traffic_to_site": 18703277,
"e_traffic_to_site": 25000000,
"no_of_pieces": 50000000,
"custom_fields": {
"adpoint_burst_name": "Cricket Series 2025 - Awareness"
},
"campaign_contents": [
{
"id": 158,
"external_id": "38932665",
"publisher_title_id": 2,
"content_name": "Heidi Langworth",
"publisher_product_id": null,
"status": 1,
"live_date": "2025-07-01",
"content_description": "Alveus correptius cruentus turba. Quibusdam curia verumtamen patrocinor. Clamo corporis despecto vilis crepusculum caute acerbitas mollitia civitas.",
"content_editor_id": 1,
"content_editor_email": "Nella_Johnson@gmail.com",
"g_impressions": 78511004,
"e_impressions": 28121195,
"g_video_views": 64716349,
"e_video_views": 67811688,
"g_article_views": 65532347,
"e_article_views": 30357114,
"g_traffic_to_site": 88747824,
"e_traffic_to_site": 54398813,
"custom_fields": {
"adpoint_publisher_name": "TechGear Media",
"product_set_id": 101,
"adpoint_avid_serviced_state_id": 3,
"salesforce_concepts": "Awareness, Traffic",
"salesforce_product_goal": "Increase Brand Reach",
"salesforce_product_goal_info": "Expand visibility across tech audiences aged 18-34.",
"adpoint_informative_line": "Running across top-tier tech websites and mobile apps.",
"adpoint_inclusions": "Campaign setup across Facebook, Instagram, and Google Ads Manager.",
"adpoint_required_assets": "High-resolution product images (minimum 1080x1080px)."
},
"content_distributions": [
{
"external_id": "11",
"distribution_type_id": 16,
"publisher_title_id": 3,
"status": 1,
"distirbution_status_slug": "asefwef",
"workflow_id": 1,
"wf_slug": "fvewevgwe",
"distiribution_class": 1,
"distribution_label": "Digital & Social Media Promotion",
"distribution_live_date": "2025-06-01",
"advertiser_review": 0,
"no_of_feedback_allowed": 7240685,
"preview_url": "https://shady-galoshes.name/",
"content_tile": "Exclusive Cricket Highlights & Player Interviews",
"sponsored_tag": "clementia",
"has_destination_link": 35185129,
"count_clicks_as": 3,
"amp_start_date": "2025-06-01",
"amp_start_time": "12:00",
"amp_end_date": "2025-09-01",
"placements_setup": -45551171,
"custom_placements_platforms": 1,
"custom_placements_placements": 31,
"ad_type": 1,
"ad_banner_button": 14,
"ad_banner_display_url": "https://descriptive-challenge.com/",
"ad_banner_description": "Catch the action live as Australia takes on Pakistan in an exciting cricket series. Exclusive highlights, behind-the-scenes footage, and in-depth player interviews await. Don’t miss a moment of the action!",
"ad_body_text": "Join the excitement of the cricket series and stay updated with live scores, highlights, and exclusive content. Follow your favorite players throughout the competition.",
"native_ad_platform": 2,
"display_ad_type": 1,
"custom_fields": {
"adpoint_line_id": 1001,
"adpoint_sales_package": "Tech Launch Bundle",
"adpoint_ad_channel": "Display",
"adpoint_media_channel": "Web",
"adpoint_created_date": "2025-07-01T10:00:00Z",
"adpoint_changed_date": "2025-07-15T15:45:00Z",
"adpoint_amplification": "Organic + Paid",
"adpoint_driving_to_line_no": "1005",
"adpoint_page_post_promoting_line_no": "1008",
"nca_guaranteed_distribution": 1,
"adpoint_line_id_approval_dependency": "1002,1003"
},
"distribution_headline_library": [
{
"ad_banner_headline": "bah without memorise provided when for"
}
],
"distribution_links_library": [
{
"link_type": "1",
"link_label": "https://frilly-exterior.net/",
"original_link": "https://wide-slide.us/",
"hyperlink_text": "https://palatable-knuckle.us/"
},
{
"link_type": "1",
"link_label": "https://frilly-exterior.net/",
"original_link": "https://wide-slide.us/",
"hyperlink_text": "https://palatable-knuckle.us/"
},
{
"link_type": "1",
"link_label": "https://frilly-exterior.net/",
"original_link": "https://wide-slide.us/",
"hyperlink_text": "https://palatable-knuckle.us/"
}
],
"distribution_media_library": [
{
"is_body_media": 0,
"media_label": "Test Media Label",
"file_url": "https://media.4-paws.org/d/b/0/5/db05d79a7b3002447904b841871363190b45b74d/VIER%20PFOTEN_2017-10-20_164-3854x2667-1920x1329.webp",
"media_notes": "Test Notes"
}
],
"distribution_display_assets_library": [
{
"asset_type": "2",
"placement_size": "Ut fugiat eiusmod ut eu fuyuf",
"tag": "carbo",
"media_file_url": "https://media.4-paws.org/d/b/0/5/db05d79a7b3002447904b841871363190b45b74d/VIER%20PFOTEN_2017-10-20_164-3854x2667-1920x1329.webp",
"link_label": "dddddd",
"original_link": "https://pale-bourgeoisie.org/"
},
{
"asset_type": "2",
"placement_size": "Ut fugiat eiusmod ut eu",
"tag": "carbo",
"media_file_url": "https://media.4-paws.org/d/b/0/5/db05d79a7b3002447904b841871363190b45b74d/VIER%20PFOTEN_2017-10-20_164-3854x2667-1920x1329.webp",
"link_label": "fdsasf",
"original_link": "https://pale-bourgeoisie.org/"
}
]
},
{
"external_id": "38932665",
"distribution_type_id": 16,
"publisher_title_id": 3,
"status": 1,
"distirbution_status_slug": "asefwef",
"workflow_id": 1,
"wf_slug": "fvewevgwe",
"distiribution_class": 1,
"distribution_label": "dolor cillum nulla",
"distribution_live_date": "2025-06-01",
"advertiser_review": 0,
"no_of_feedback_allowed": 7240685,
"preview_url": "https://shady-galoshes.name/",
"content_tile": "elit amet Duis aliquip",
"sponsored_tag": "clementia",
"has_destination_link": 35185129,
"count_clicks_as": 3,
"amp_start_date": "2025-5-01",
"amp_start_time": "12:00",
"amp_end_date": "2025-12-01",
"placements_setup": -45551171,
"custom_placements_platforms": 1,
"custom_placements_placements": 31,
"ad_type": 1,
"ad_banner_button": 14,
"ad_banner_display_url": "https://descriptive-challenge.com/",
"ad_banner_description": "Corpus abduco cunabula facere tepidus aedificium. Comparo aspernatur volaticus delicate denuo sponte cometes arma. Teres accendo congregatio. Cometes abeo tyrannus suggero vilis. Venustas cornu eaque corpus utroque deputo arto. Tutamen patria amplexus voveo calcar abbas voro cunabula admiratio possimus. Mollitia cui tubineus thermae aggero.",
"ad_body_text": "laboris dolor pariatur cupidatat veniam",
"native_ad_platform": 2,
"display_ad_type": 1,
"custom_fields": {
"adpoint_line_id": 1002,
"adpoint_sales_package": "Health Boost Program",
"adpoint_ad_channel": "Social",
"adpoint_media_channel": "Facebook",
"adpoint_created_date": "2025-07-05T09:30:00Z",
"adpoint_changed_date": "2025-07-20T12:00:00Z",
"adpoint_amplification": "Paid Only",
"adpoint_driving_to_line_no": "",
"adpoint_page_post_promoting_line_no": "",
"nca_guaranteed_distribution": 0,
"adpoint_line_id_approval_dependency": ""
},
"distribution_headline_library": [
{
"ad_banner_headline": "bah without memorise provided when for"
}
],
"distribution_links_library": [
{
"link_type": "1",
"link_label": "https://frilly-exterior.net/",
"original_link": "https://media.4-paws.org/d/b/0/5/db05d79a7b3002447904b841871363190b45b74d/VIER%20PFOTEN_2017-10-20_164-3854x2667-1920x1329.webp",
"hyperlink_text": "link one"
},
{
"link_type": "1",
"link_label": "https://frilly-exterior.net/",
"original_link": "https://media.4-paws.org/d/b/0/5/db05d79a7b3002447904b841871363190b45b74d/VIER%20PFOTEN_2017-10-20_164-3854x2667-1920x1329.webp",
"hyperlink_text": "link"
}
],
"distribution_media_library": [
{
"is_body_media": 0,
"media_label": "Test Media Label",
"file_url": "https://media.4-paws.org/d/b/0/5/db05d79a7b3002447904b841871363190b45b74d/VIER%20PFOTEN_2017-10-20_164-3854x2667-1920x1329.webp",
"media_notes": "Test Notes"
}
],
"distribution_display_assets_library": [
{
"asset_type": "2",
"placement_size": "size 1",
"tag": "carbo",
"media_file_url": "https://media.4-paws.org/d/b/0/5/db05d79a7b3002447904b841871363190b45b74d/VIER%20PFOTEN_2017-10-20_164-3854x2667-1920x1329.webp",
"link_label": "display asset",
"original_link": "https://pale-bourgeoisie.org/"
}
]
},
{
"external_id": "38932665",
"distribution_type_id": 16,
"publisher_title_id": 3,
"status": 1,
"distirbution_status_slug": "asefwef",
"workflow_id": 1,
"wf_slug": "fvewevgwe",
"distiribution_class": 1,
"distribution_label": "dolor cillum nulla",
"distribution_live_date": "2025-06-01",
"advertiser_review": 0,
"no_of_feedback_allowed": 7240685,
"preview_url": "https://shady-galoshes.name/",
"content_tile": "elit amet Duis aliquip",
"sponsored_tag": "clementia",
"has_destination_link": 35185129,
"count_clicks_as": 3,
"amp_start_date": "2025-06-01",
"amp_start_time": "12:00",
"amp_end_date": "2025-10-01",
"placements_setup": -45551171,
"custom_placements_platforms": 1,
"custom_placements_placements": 31,
"ad_type": 1,
"ad_banner_button": 14,
"ad_banner_display_url": "https://descriptive-challenge.com/",
"ad_banner_description": "Corpus abduco cunabula facere tepidus aedificium. Comparo aspernatur volaticus delicate denuo sponte cometes arma. Teres accendo congregatio. Cometes abeo tyrannus suggero vilis. Venustas cornu eaque corpus utroque deputo arto. Tutamen patria amplexus voveo calcar abbas voro cunabula admiratio possimus. Mollitia cui tubineus thermae aggero.",
"ad_body_text": "laboris dolor pariatur cupidatat veniam",
"native_ad_platform": 2,
"display_ad_type": 1,
"custom_fields": {
"adpoint_line_id": 1003,
"adpoint_sales_package": "Auto Summer Drive",
"adpoint_ad_channel": "Video",
"adpoint_media_channel": "YouTube",
"adpoint_created_date": "2025-06-25T13:20:00Z",
"adpoint_changed_date": "2025-07-10T11:10:00Z",
"adpoint_amplification": "Organic Only",
"adpoint_driving_to_line_no": "1006",
"adpoint_page_post_promoting_line_no": "1009",
"nca_guaranteed_distribution": 1,
"adpoint_line_id_approval_dependency": "1004"
},
"distribution_headline_library": [
{
"ad_banner_headline": "bah without memorise provided when for"
}
],
"distribution_links_library": [
{
"link_type": "1",
"link_label": "https://frilly-exterior.net/",
"original_link": "https://wide-slide.us/",
"hyperlink_text": "https://palatable-knuckle.us/"
},
{
"link_type": "1",
"link_label": "https://frilly-exterior.net/",
"original_link": "https://wide-slide.us/",
"hyperlink_text": "https://palatable-knuckle.us/"
},
{
"link_type": "1",
"link_label": "https://frilly-exterior.net/",
"original_link": "https://wide-slide.us/",
"hyperlink_text": "https://palatable-knuckle.us/"
}
],
"distribution_media_library": [
{
"is_body_media": 0,
"media_label": "Test Media Label Three One",
"file_url": "https://media.4-paws.org/d/b/0/5/db05d79a7b3002447904b841871363190b45b74d/VIER%20PFOTEN_2017-10-20_164-3854x2667-1920x1329.webp",
"media_notes": "Test Notes"
},
{
"is_body_media": 0,
"media_label": "Test Media Label Three Two",
"file_url": "https://media.4-paws.org/d/b/0/5/db05d79a7b3002447904b841871363190b45b74d/VIER%20PFOTEN_2017-10-20_164-3854x2667-1920x1329.webp",
"media_notes": "Test Notes"
}
],
"distribution_display_assets_library": [
{
"asset_type": "2",
"placement_size": "Ut fugiat eiusmod ut eu",
"tag": "carbo",
"media_file_url": "https://transforms.stlzoo.org/production/animals/amur-tiger-01-01.jpg?w=1200&h=1200&auto=compress%2Cformat&fit=crop&dm=1658935145&s=95d03aceddd44dc8271beed46eae30bc",
"link_label": "Display Asset Three",
"original_link": "https://transforms.stlzoo.org/production/animals/amur-tiger-01-01.jpg?w=1200&h=1200&auto=compress%2Cformat&fit=crop&dm=1658935145&s=95d03aceddd44dc8271beed46eae30bc"
},
{
"asset_type": "2",
"placement_size": "Ut fugiat eiusmod ut eu",
"tag": "carbo",
"media_file_url": "https://transforms.stlzoo.org/production/animals/amur-tiger-01-01.jpg?w=1200&h=1200&auto=compress%2Cformat&fit=crop&dm=1658935145&s=95d03aceddd44dc8271beed46eae30bc",
"link_label": "Display Asset Three Two",
"original_link": "https://transforms.stlzoo.org/production/animals/amur-tiger-01-01.jpg?w=1200&h=1200&auto=compress%2Cformat&fit=crop&dm=1658935145&s=95d03aceddd44dc8271beed46eae30bc"
},
{
"asset_type": "2",
"placement_size": "Ut fugiat eiusmod ut eu",
"tag": "carbo",
"media_file_url": "https://transforms.stlzoo.org/production/animals/amur-tiger-01-01.jpg?w=1200&h=1200&auto=compress%2Cformat&fit=crop&dm=1658935145&s=95d03aceddd44dc8271beed46eae30bc",
"link_label": "Distribution Three Three",
"original_link": "https://transforms.stlzoo.org/production/animals/amur-tiger-01-01.jpg?w=1200&h=1200&auto=compress%2Cformat&fit=crop&dm=1658935145&s=95d03aceddd44dc8271beed46eae30bc"
}
]
}
]
}
]
}
]
}Responses
🟢200Success
application/json
Body
Example
{
"success": true,
"message": "string",
"data": {
"campaign": {
"is_reporting_campaign": 0,
"external_id": "string",
"primary_advertiser_account_id": "string",
"campaign_title": "string",
"brand_promoting": "string",
"campaign_status": 0,
"campaign_description": "string",
"campaign_objective": "string",
"no_content_pieces": 0,
"campaign_net_cost": 0,
"tracking_report_info": "string",
"using_utm_tracking": 0,
"utm_info": "string",
"mandatory_donts": "string",
"additional_campaign_notes": "string",
"campaign_target_audience_summary": "string",
"advertiser_primary_campaign_manager_id": 0,
"mandatory_dos": "string",
"content_look_feel_requests": "string",
"media_plan_external_url": "string",
"rate_card_external_url": "string",
"potential_up_sell_opportunities": "string",
"billing_company_name": "string",
"billing_company_address": "string",
"billing_contact_person": "string",
"billing_contact_email": "string",
"billing_contact_phone": "string",
"purchase_order_number": "string",
"campaign_gross_cost": 0,
"g_impressions": 0,
"e_impressions": 0,
"g_article_views": 0,
"e_article_views": 0,
"g_clicks_to_site": 0,
"e_clicks_to_site": 0,
"g_video_views": 0,
"e_video_views": 0,
"deleted_at": "string",
"created_at": "string",
"updated_at": "string",
"brand_industry_id": 0,
"brand_sub_industry_id": 0,
"crm_deal_link": "string",
"primary_commercial_manager": {}
}
}
}