1. Campaigns
GroundTruth - Public API
  • Welcome
  • Accounts
    • Get Accounts
      GET
    • Create Account
      POST
    • Get Account
      GET
    • Update Account
      PUT
    • Delete Account
      DELETE
    • Get Account Min Cpv Bid Rate
      GET
    • Get Account Pixels
      GET
    • Create Account Pixel
      POST
    • Get Account Pixels Export
      GET
    • Delete Account Pixel
      DELETE
  • Campaigns
    • Get Campaigns
      GET
    • Create Campaign
      POST
    • Get Campaign
      GET
    • Update Campaign
      PUT
    • Delete Campaign
      DELETE
    • Create Ad Package
      POST
  • Ad Groups
    • Create Adgroup
      POST
    • Get Adgroups
      GET
    • Update Adgroup
      PUT
    • Patch Adgroup
      PATCH
    • Delete Adgroup
      DELETE
    • Get Adgroup
      GET
    • Get Adgroup Avails
      GET
    • Post Adgroup Avails
      POST
    • Create Dooh Adgroups
      POST
    • Download Location Filters
      GET
  • Health
    • Get Health
  • Organizations
    • Get Organizations
    • Create Organization
    • Get Organization
    • Update Organization
    • Delete Organization
  • Tenants
    • Get Tenant
    • Update Tenant
  • Direct Mail
    • Get Orders
  • Reporting
    • Get Ctv Ott Performance Campaign
    • Get Ctv Ott Performance Adgroup
    • Get Timeseries Dow Campaign
    • Get Product Insights Campaign
    • Get Product Insights Adgroup
    • Get Product Insights Creative
    • Get Product Insights Campaign Targeting
    • Get Product Insights Campaign Audience
    • Get Product Insights Campaign Adgroups
    • Get Product Insights Campaign Creatives
    • Get Visitation Lag Window Campaign
    • Get Top Locations Campaign
    • Get Top Sv Locations Campaign
    • Get Top Sv Locations Adgroup
    • Get Top Imp Locations Adgroup
    • Get Totals Account
    • Get Totals Organization
    • Post Totals Tenant
    • Get Totals Account V2
    • Get Totals Campaign
    • Get Totals Adgroup
    • Get Demographics Partial Adgroup
    • Get Totals Creative
    • Get Totals Campaign Creatives
    • Get Audio Podcast Topic Metrics Campaign
    • Get Audio Podcast Topic Metrics Adgroup
    • Get Audio Podcast Series Metrics Campaign
    • Get Audio Podcast Series Metrics Adgroup
    • Get Campaign Recommendations
    • Dismiss Recommendation
    • Get Recommendation Count
    • Get Foot Traffic Attribution
    • Get Foot Traffic Attribution Detailed
    • Get Foot Traffic Attribution V2 Order Summary
    • Get Foot Traffic Attribution V2 Detailed
    • Get Mobile Category Campaign
    • Get Mobile Category Adgroup
    • Get Mobile Category All Adgroups
    • Get Demographics Partial Campaign
    • Get Age Gender Distribution Campaign
    • Get Age Gender Distribution Adgroup
    • Get Audience Affinity Creative
    • Get Audience Category Campaign
    • Get Audience Affinity Campaign
    • Get Audience Affinity Campaign Adgroups
    • Get Product Insights Campaign Adgroups
    • Get Audience Affinity Campaign Creatives
    • Get Audience Affinity Campaign V2
    • Get Audience Affinity Campaign Adgroups V2
    • Get Audience Affinity Creative V2
    • Get Audience Affinity Campaign Creatives V2
    • Get Audience Affinity Adgroup
    • Get Audience Affinity Adgroup V2
    • Get Audience Category Campaign All Adgroups
    • Get Audience Category Campaign Creatives
    • Get Audience Category Adgroup
    • Get Audience Category Creative
    • Get Audience Breakdown Campaign
    • Get Audience Breakdown Adgroup
    • Get Audience Breakdown Creative
    • Get Pixel Campaign
    • Get Pixel Adgroup
    • Get Campaign Spend
    • Get Adgroup Spend
    • Get Marketshare Campaign
    • Get Audio Podcast Ad Position Campaign
    • Get Audio Podcast Ad Position Campaign Adgroups
    • Get Audio Streaming Genre Campaign
    • Get Audio Streaming Genre Adgroup
    • Get Audio Streaming Genre Campaign Adgroups
    • Get Daily Metrics Campaign
    • Get Audio Publisher Campaign
    • Get Audio Publisher Adgroup
    • Get Audio Publisher Campaign All Adgroups
    • Get Daily Metrics Adgroup
    • Get Daily Metrics Creative
    • Get Ctv Publisher Adgroup
    • Get Ctv Publisher Campaign
    • Get Ctv Publisher Campaign Adgroups
    • Get Ctv Network Campaign
    • Get Ctv Network Campaign Adgroups
    • Get Ctv Network Adgroup
    • Get Daily Metrics Campaign Adgroups
    • Get Daily Metrics Campaign Creatives
    • Get Dooh Publisher Campaign
    • Get Dooh Venue Type Campaign
    • Get Web Engagement Campaign
  • Miscellaneous
    • Get Version
  • Search
    • Search Tenants
    • Search Organizations
    • Search Accounts
    • Search Campaigns
    • Search Adgroups
    • Search Creatives
    • Search Location Filters
    • Search Audiences
    • Search Neighborhoods
    • Search On Premise Locations
    • Search Drive To Locations
    • Search Location Groups
    • Search Ad Packages
  • Static
    • Get Account Verticals
    • Get Audio Podcast Topics
    • Get Audio Streaming Genres
    • Get Carriers
    • Get Cities
    • Get Ctv Content Categories
    • Get Streaming Video Content Categories
    • Get Streaming Video Premium Ctv Categories
    • Get Dmas
    • Get Publisher Categories
    • Get States
    • Get Iab Categories
  • Users
    • Signup
    • Activate
    • Get Current User
    • Get User
    • Delete User
    • Update User
    • Get Users
    • Invite User
  • Creatives
    • Create Creative
    • Get Creatives
    • Get Creative
    • Update Creative
    • Delete Creative
    • Patch Creative
    • Clone Creative
  • Audiences
    • Get Audience Taxonomy
    • Get Audience Recommendations
  • Jobs
    • Get Jobs
    • Create Campaign Bulk Upload Job
    • Confirm Campaign Bulk Upload Job
    • Create Location Filter Bulk Upload Job
    • Create Campaign Bulk Download Job
    • Confirm Location Filter Bulk Upload Job
    • Cancel Location Filter Bulk Upload Job
    • Get Job
  • Upload
    • Upload
  • Schemas
    • Schemas
      • AccountSearchResults
      • AdSpec
      • ActivateUserModel
      • CTVContentCategoriesModel
      • CTVContentCategoryModel
      • CampaignSearchRequest
      • Body_create_campaign_bulk_upload_jobs_campaign_bulk_upload_post
      • CampaignSearchResults
      • CreateAudienceModel
      • SearchRequest
      • SuccessResponse
      • InviteUserModel
      • BidType
    • AccountMinCPVBidRateModel
    • AccountModel
    • AccountPixelModel
    • AccountPixelsModel
    • AccountSearchResult
    • AccountType
    • AccountVertical
    • AccountVerticalModel
    • AccountVerticalsModel
    • AccountsModel
    • AdPackageModel
    • AdgroupModel
    • AdgroupAvailsResponse
    • AdPackageSearchResult
    • AgeRange
    • AdgroupSearchResult
    • ApplicationCode
    • Audience
    • AdgroupsModel
    • AdgroupSpendModel
    • AudienceModel
    • AdgroupsTodaySpendModel
    • AudienceTaxonomy
    • AdgroupStep
    • AudienceType
    • AppCode
    • AudioPodcastTopicModel
    • AudioPodcastFieldName
    • AudioPodcastTopicsModel
    • AudioPodcastSeriesMetricsAdgroupModel
    • AudienceCategoryAdgroupFieldName
    • AudienceAffinityAdgroupModel
    • AgeGenderDistributionCampaignModel
    • AudioStreamingGenreModel
    • AudioPodcastSeriesMetricsCampaignModel
    • AudienceCategoryAdgroupModel
    • AudienceCategoryCampaignAllAdgroupsModel
    • AudienceAffinityCampaignCreativeFieldName
    • AudioStreamingGenresModel
    • AudioPodcastTopicMetricsAdgroupModel
    • AudienceCategoryCampaignModel
    • AudienceAffinityCampaignModel
    • BestAudiencesModel
    • AudioPodcastTopicMetricsCampaignModel
    • AudienceCategoryCreativeFieldName
    • AudienceAffinityCampaignSummaryModel
    • BestAudiencesSummaryModel
    • AudienceCategoryCreativeModel
    • AudienceAffinityCreativeModel
    • BestStrategiesModel
    • AudienceCategoryFieldName
    • AudienceAffinityFieldName
    • BestStrategiesSummaryModel
    • AudienceBreakdownAdgroupResponseModel
    • BillingSource
    • AudienceRecommendationsModel
    • AudienceBreakdownCampaignResponseModel
    • BudgetLevel
    • BlueprintsPolygonTypes
    • AudienceRecommendationsRequestModel
    • BudgetModel
    • AudienceSearchResult
    • BudgetModel
    • BudgetType
    • BasicAdgroupModel
    • AudienceCategoryCampaignCreativesModel
    • BusinessType
    • AudioPodcastAdPosition
    • AudienceBreakdownCreativeResponseModel
    • AudioPodcastAdPositionCampaignAdgroupsModel
    • AudioPodcastAdPositionCampaignModel
    • CampaignModel
    • CampaignSearchResult
    • Body_upload_upload_post
    • CampaignsModel
    • CitiesModel
    • CityModel
    • Community
    • AudioPublisherAdgroupModel
    • CountryCode
    • AudioPublisherCampaignAllAdgroupsModel
    • CreateAccountModel
    • CTVAppModel
    • AudioPublisherCampaignModel
    • CreateAccountPixelModel
    • CTVPremiumCategoriesModel
    • AudioStreamingGenreAdgroupModel
    • CreateAdgroupModel
    • AudioStreamingGenreCampaignAllAdgroupsModel
    • AudioStreamingGenreCampaignModel
    • CreateCampaignModel
    • CreateCreativeModel
    • CreateOrUpdateOrganizationModel
    • CreativeModel
    • CreativeType
    • CtvOttCampaignPerformanceModel
    • CtvOttCampaignSortByFieldName
    • CtvOttDeviceSummaryModel
    • CtvOttNetworkSummaryModel
    • CreateDoohAdgroupModel
    • CtvOttPublisherSummaryModel
    • CreateDoohAdgroupsModel
    • Body_create_campaign_bulk_upload_job_jobs_campaign_bulk_upload_post
    • CtvOttReportSummaryModel
    • Currency
    • CampaignSpendModel
    • DMAModel
    • DMAsModel
    • DartBillingAccount
    • CreateUpdateAudienceModel
    • CreateUpdateCTVPremiumCategoryModel
    • DetailedAudienceCategory
    • CreateUpdateDriveToLocationModel
    • ErrorModel
    • CreativeStatus
    • CreateUpdateStreamingVideoContentCategoryModel
    • CreateUpdatePublisherCategoryModel
    • ErrorResponseModel
    • Gender
    • CreativesModel
    • CreativeSearchResult
    • CreativeAPI
    • Group
    • HTTPValidationError
    • BillabilityType
    • IncomeRange
    • LocationFilterModel
    • DOOHAdgroupsModel
    • LocationFilterType
    • DOOHCreativeFormat
    • LookalikeAudienceScale
    • DOOHGeoCityModel
    • MediaType
    • DOOHGeoCountyModel
    • MobileCarrierModel
    • DOOHGeoDmaModel
    • MobileCarriersModel
    • DOOHGeoLocationGroupModel
    • CreateUpdateAudioPodcastTopicModel
    • OptimizationStrategy
    • DOOHGeoStateModel
    • CreateUpdateAudioStreamingGenreModel
    • OrderModel
    • DOOHGeoZipcodeModel
    • CreateCampaignBulkDownloadJobRequestModel
    • OrdersModel
    • DOOHLocationGroupDistanceUnits
    • OrganizationModel
    • DOOHPlanDataModel
    • OrganizationsModel
    • DOOHVenueTypeModel
    • PaymentType
    • ProductInsightsCampaignFieldName
    • POIPolygonModel
    • CreativeBlockedStatus
    • CreateLocationFilterTargetBulkUploadJobModel
    • ProductInsightsCampaignModel
    • CreateNeighborhoodModel
    • PublisherCategoriesModel
    • PublisherCategoryModel
    • FootTrafficAttributionFieldName
    • FootTrafficAttributionDefaultFields
    • DOOHPublisherModel
    • Sensitivity
    • FootTrafficAttributionFilterModel
    • SignupModel
    • FootTrafficAttributionGroupByFieldName
    • SignupResponseModel
    • FootTrafficAttributionModel
    • CreateAdPackageModel
    • SortOrder
    • FootTrafficAttributionRequestModel
    • StateModel
    • DriveToLocationModel
    • StatesModel
    • DriveToLocationType
    • Status
    • TargetingTactic
    • IABCategoriesResponseModel
    • TenantModel
    • IABCategoryModel
    • TenantType
    • TimeseriesDowCampaignModel
    • CreateUpdateOnPremiseLocationModel
    • Timezone
    • CreateUpdateAdPackageModel
    • TopSVLocationsCampaignModel
    • TotalsCampaignCreativesModel
    • FootTrafficAttributionDetailedFilterModel
    • CreateUpdateTrackingPixelModel
    • TotalsCampaignModel
    • TopSVLocationsCampaignFieldName
    • FootTrafficAttributionDetailedModel
    • UpdateAccountModel
    • FootTrafficAttributionV2DetailedModel
    • FootTrafficAttributionDetailedRequestModel
    • UpdateCampaignModel
    • FootTrafficAttributionV2OrderSummaryModel
    • UpdateTenantModel
    • UpdateUserModel
    • UserModel
    • UserStatus
    • UsersModel
    • CtvOttAdgroupPerformanceModel
    • CreatedAdPackageModel
    • ValidationError
    • VersionModel
    • JobModel
    • VisitationLagWindowModel
    • RecommendationModel
    • AudienceType
    • RecommendationStatus
    • RecommendationsModel
    • BidType
    • AudienceType
    • CtvPublisherAdgroupModel
    • CtvPublisherCampaignAdgroupsModel
    • CtvNetworkRowModel
    • MobileCategoryAdgroupModel
    • CtvPublisherNetworkModel
    • CtvNetworkSortByFieldName
    • MobileCategoryCampaignAllAdgroupsModel
    • MobileCategoryCampaignModel
    • DailyMetricsAdgroupModel
    • MobileCategoryFieldName
    • DailyMetricsCampaignModel
    • DailyMetricsCreativeModel
    • OrganizationSearchResult
    • DriveToLocationsSearchResult
    • PatchAdgroupModel
    • LocationFilterSearchResult
    • Language
    • RecommendationCountModel
    • JobStatus
    • DailyMetricsCampaignAdgroupsModel
    • RecommendationCountRequestModel
    • JobsModel
    • DailyMetricsCampaignAdgroupsResponseModel
    • DailyMetricsCampaignCreativesModel
    • SearchAccountsRequestModel
    • SearchAccountsResultsModel
    • SearchAdgroupsRequestModel
    • GetDailyMetricsAdgroupResponseModel
    • SearchAdgroupsResultsModel
    • GetDailyMetricsCampaignResponseModel
    • UpdateAdgroupModel
    • SearchCampaignsRequestModel
    • GetDailyMetricsCreativeResponseModel
    • SearchCampaignsResultsModel
    • UpdateCreativeModel
    • SearchCreativesRequestModel
    • SearchCreativesResultsModel
    • SearchOrganizationsResultsModel
    • SearchRequestModel
    • Objective
    • SearchTenantsResultsModel
    • DemographicsPartialAgeModel
    • DemographicsPartialGenderModel
    • PatchCreativeModel
    • DoohPublisherCampaignModel
    • DoohPublisherCampaignSortByFieldName
    • DoohVenueTypeCampaignModel
    • LocationFiltersModel
    • DoohVenueTypeCampaignSortByFieldName
    • StreamingVideoContentCategoriesModel
    • LocationGroupMetadata
    • BidType
    • StreamingVideoContentCategoryModel
    • LocationGroupType
    • SearchAudiencesRequestModel
    • TenantSearchResult
    • SearchAudiencesResultsModel
    • SearchLocationFiltersRequestModel
    • NeighborhoodModel
    • SearchLocationFiltersResultsModel
    • NeighborhoodSearchResult
    • NeighborhoodTargetType
    • NeighborhoodType
    • LocationFilterModel
    • LocationFilterModel
    • OnPremiseLocationSearchResult
    • OnPremiseLocationType
    • GTLandingPagePageOverlayAction
    • OperatingSystem
    • UploadResponseModel
    • LocationGroupResult
    • UploadType
    • MarketShareCampaignModel
    • ImageLandingPage
    • CTVPremiumCategoryModel
    • PixelCampaignFieldName
    • PixelConversionModel
    • CTVPremiumCategoryModel
    • OnPremiseLocationModel
    • SearchDriveToLocationsRequestModel
    • ProductInsightsCampaignAdgroupsModel
    • UploadJobType
    • SearchNeighborhoodsRequestModel
    • ProductInsightsCampaignCreativesModel
    • SearchOnPremiseLocationsRequestModel
    • ProximityMode
    • SuccessResponseModel
    • SearchLocationGroupsRequestModel
    • SearchLocationGroupsResultsModel
    • SearchAdPackagesResultsModel
    • TrackingPixelModel
    • StandardSuperLandingPage
    • TopImpLocationsAdgroupFieldName
    • TopImpLocationsAdgroupMetricName
    • AudioPodcastTopicModel
    • TopImpLocationsAdgroupModel
    • AudioStreamingGenreModel
    • TopLocationsCampaignFieldName
    • TopLocationsCampaignModel
    • PublisherCategoryModel
    • TopLocationsMetricName
    • StreamingVideoContentCategoryModel
    • TopSVLocationsAdgroupModel
    • AudioPodcastTopicModel
    • AudioStreamingGenreModel
    • PublisherCategoryModel
    • TotalsTenantRequestModel
    • StreamingVideoContentCategoryModel
    • WebEngagementCampaignResponseModel
    • LocationGroupMetadata
    • LocationGroupMetadata
  1. Campaigns

Update Campaign

PUT
https://api-public.groundtruth.com/campaigns/{campaign_id}
Updates a campaign

Request

Path Params

Query Params

Body Params application/jsonRequired

Example
{
    "name": "string",
    "budget": 1,
    "budget_level": "campaign",
    "impression_frequency_cap": 1,
    "impression_frequency_cap_hours": 1,
    "salesforce_number": "string",
    "is_cbd_enabled": false,
    "is_political_inventory_enabled": false
}

Request Code Samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request PUT 'https://api-public.groundtruth.com/campaigns/?tenant_id' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "string",
    "budget": 1,
    "budget_level": "campaign",
    "impression_frequency_cap": 1,
    "impression_frequency_cap_hours": 1,
    "salesforce_number": "string",
    "is_cbd_enabled": false,
    "is_political_inventory_enabled": false
}'

Responses

🟢200OK
application/json
Successful Response
Body

Example
{
    "id": 0,
    "account_id": 0,
    "organization_id": 0,
    "tenant_id": 0,
    "name": "string",
    "start_date": "2019-08-24",
    "end_date": "2019-08-24",
    "status": 1,
    "budget": 0,
    "budget_padding": 0,
    "budget_level": "campaign",
    "budget_type": 0,
    "billing_source": 1,
    "is_cbd_enabled": true,
    "bid_type": "CPM",
    "is_auto_reconciliation_enabled": true,
    "account_billing_source_id": 0,
    "impression_frequency_cap": 0,
    "impression_frequency_cap_hours": 0,
    "client_io_name": "string",
    "client_io_number": "string",
    "salesforce_number": "string",
    "created_date": "2019-08-24T14:15:22.123Z",
    "updated_date": "2019-08-24T14:15:22.123Z",
    "is_political_inventory_enabled": true,
    "iab_content_category": "string"
}
🟠400Bad Request
🟠401Unauthorized
🟠403Forbidden
🟠404Record Not Found
🔴500Server Error
Modified at 2026-03-26 20:02:47
Previous
Get Campaign
Next
Delete Campaign