Use the campaigns tool to campaigns to create, manage, and report on a single marketing campaign using multiple assets in one place. For example, you can create a campaign using marketing emails and social posts and raise awareness of a new product or an event. To use the campaigns tool and its corresponding endpoints, you'll need a Marketing Hub Professional or Enterprise subscription. 

You can use campaign endpoints to create, read, update, and delete marketing campaign data. For example, you can use these endpoints to create and manage HubSpot campaigns from your external applications. You can also transfer campaign data to external data warehouses for analytics.

You can also create, read, update, and delete multiple campaigns with the associated batch endpoints, click the Endpoints tab at the top of this article for a full list of endpoints and the associated parameters available.

The following scopes are required to use the campaigns API, based on the endpoints you're using:

• marketing.campaigns.read: provides access to view details about marketing campaigns and their associated assets.
• marketing.campaigns.write: grants access to create, delete, and modify marketing campaigns.
• marketing.campaigns.revenue.read: provides access to view revenue details and deal amounts attributed to a marketing campaign.

To create a campaign, make a POST request to /marketing/v3/campaigns.

Create a campaign with the given properties and return the campaign object, including the campaignGuid and created properties. For example, to create a new campaign, you would make a POST request with the following request body.  

To retrieve the details of an existing campaign, make a GET request to /marketing/v3/campaigns/{campaignGuid}.

This endpoint will return the campaign information. Depending on the query parameters used, this can also be used to return information about the assets and the corresponding assets' metrics. When using this endpoint, you can use the following query parameters. 

• properties: a comma-separated list of the properties to be returned in the response. For example, hs_name, hs_campaign_status, hs_notes. If any of the specified properties has an empty value on the requested object, it will be ignored and not returned in response. If the parameter is empty, the response will include an empty properties map.
  
• startDate: the start date to fetch asset metrics, formatted as YYYY-MM-DD. This is used to fetch the metrics associated with the assets for a specified period.  If no date is specified, no asset metrics will be retrieved.    
  
• endDate: the end date to fetch asset metrics, formatted as YYYY-MM-DD. This is used to fetch the metrics associated with the assets for a specified period. If no date is specified, no asset metrics will be retrieved.
  

For example, if you made a POST request with /marketing/v3/campaigns/edb9b6c3-d2e2-4ca8-8396-832262aed0d4?properties=hs_name,hs_start_date, this would result in the following response body:

To retrieve the assets associated with a campaign make a GET request to /marketing/v3/campaigns/{campaignId}/assets/{assetType}.

This endpoint lists all assets of the campaign by asset type. The assetType parameter is required, and each request can only fetch assets of a single type. The following are required:

• campaignGuid: the UUID of the campaign.
  
• assetType: the type of asset to be fetched.
  

You can use the following query parameters with the endpoint:

• after: a cursor for pagination. If provided, the results will start after the given cursor. For example, you can use the value NTI1Cg%3D%3D.  
  
• limit: define the maximum number of results to return. The allowed values range from 1 to 100. If no limit is specified, it will be set to 10 assets by default.
• startDate: the start date to fetch asset metrics, formatted as YYYY-MM-DD. This is used to fetch the metrics associated with the assets for a specified period. If no date is specified, no asset metrics will be retrieved.   
  
• endDate: the end date to fetch asset metrics, formatted as YYYY-MM-DD. This is used to fetch the metrics associated with the assets for a specified period. If no date is specified, no asset metrics will be retrieved.

To associate an asset with a campaign make a PUT request to /marketing/v3/campaigns/{campaignGuid}/assets/{assetType}/{assetId}.

To remove an asset from a campaign make a DELETE request to /marketing/v3/campaigns/{campaignGuid}/assets/{assetType}/{assetId}.

You can use the endpoints above to create and remove associations for the following asset types. For other asset types, learn how to associate assets and content with a campaign in HubSpot.   

• FORM
• OBJECT_LIST
• EXTERNAL_WEB_URL

To perform a partial update of a campaign identified by the specified campaignGuid, make a PATCH request to /marketing/v3/campaigns/{campaignGuid}.

You can use the following properties to update your campaign. The provided property values will be overwritten. If your request includes read-only or non-existent properties, you will encounter a 400 error. Learn more about which properties can be used. 

To delete a campaign, make a DELETE request to /marketing/v3/campaigns?.

This call will always return a 204 No Content response, regardless of whether the campaignGuid provided corresponds to an existing campaign or not.

To search for campaigns based on query parameters, make a GET request to /marketing/v3/campaigns/{campaignGuid}.

When using this endpoint, you can use the following query parameters. 

• name: return all campaigns whose names contain the specified substring. This allows partial matching of campaign names, returning all campaigns that include the given substring in their name. If this parameter is not provided, the search will return all campaigns.
  
• sort: the field by which to sort the results. Allowed values are hs_name, createdAt, updatedAt. An optional '-' before the property name will denote descending order. For example, you can use -CREATED_AT to sort your campaigns from newest to oldest. If this is not specified, the list of campaigns will be sorted in alphabetical order by campaign name.  
  
• after: a cursor for pagination. If provided, the results will start after the given cursor. For example, you can use the value NTI1Cg%3D%3D.  
  
• limit: define the maximum number of results to return. The allowed values range from 1 to 100. If no limit is specified, it will be set to 50 campaigns by default. 
• properties: a comma-separated list of the properties to be returned in the response. For example, hs_name, hs_campaign_status, hs_notes. If any of the specified properties has an empty value on the requested object, it will be ignored and not returned in response. If the parameter is empty, the response will include an empty properties map.