Hello,
I’m encountering an issue when using the Campaigns API to fetch properties. Here’s the detailed scenario:
1. Working Configuration:
The following URL works correctly and returns a valid JSON response:
https://api.hubapi.com/marketing/v3/campaigns?limit=100&properties=hs_start_date,hs_end_date,hs_color_hex,hs_notes,hs_audience,hs_goal,hs_owner,hs_currency_code,hs_created_by_user_id,hs_campaign_status,hs_object_id,hs_name,hs_budget_items_sum_amount,hs_spend_items_sum_amount
This configuration includes the basic properties allowed for the Campaign object, and the response is as expected.
2 Problematic Configuration:
However, when I try to include additional properties in the query, such as the following:
hubspot_owner_id, hs_created_at, hs_web_interactive_count, hs_list_count, hs_utm, hs_automation_platform_flows_count, hs_marketing_event_count, hs_form_count, hs_cta_count, hs_external_website_page_count, hs_merged_object_ids, hs_blog_posts_count, hs_landing_pages_count, hs_object_source_detail_3, hs_origin_asset_id, hs_site_pages_count, hubspot_owner_assigneddate, hs_sequence_count, hs_object_source_detail_1, hs_object_source_detail_2, hs_object_source_label, hs_broadcast_count
I receive the following error response:
{
“status”: “error”,
“message”: “Forbidden properties: [hubspot_owner_id, hs_created_at, hs_web_interactive_count, hs_list_count, hs_utm, hs_automation_platform_flows_count, hs_marketing_event_count, hs_form_count, hs_cta_count, hs_external_website_page_count, hs_merged_object_ids, hs_blog_posts_count, hs_landing_pages_count, hs_object_source_detail_3, hs_origin_asset_id, hs_site_pages_count, hubspot_owner_assigneddate, hs_sequence_count, hs_object_source_detail_1, hs_object_source_detail_2, hs_object_source_label, hs_broadcast_count] in the provided property set. Correct ones are [hs_start_date, hs_end_date, hs_color_hex, hs_notes, hs_audience, hs_goal, hs_owner, hs_currency_code, hs_created_by_user_id, hs_campaign_status, hs_object_id, hs_name, hs_budget_items_sum_amount, hs_spend_items_sum_amount] and custom properties you have defined for Campaign.”,
“correlationId”: “d506a19b-7805-45a0-977e-3ad1b0682dc7”,
“context”: {
“forbidden-properties”: [
“[hubspot_owner_id, hs_created_at, hs_web_interactive_count, hs_list_count, hs_utm, hs_automation_platform_flows_count, hs_marketing_event_count, hs_form_count, hs_cta_count, hs_external_website_page_count, hs_merged_object_ids, hs_blog_posts_count, hs_landing_pages_count, hs_object_source_detail_3, hs_origin_asset_id, hs_site_pages_count, hubspot_owner_assigneddate, hs_sequence_count, hs_object_source_detail_1, hs_object_source_detail_2, hs_object_source_label, hs_broadcast_count]”
]
},
“category”: “VALIDATION_ERROR”,
“subCategory”: “CampaignApiError.PROPERTY_SET_CONTAINS_VALUES_FORBIDDEN_FOR_READ”
}
3. Summary of the Issues :
- I am trying to include additional properties to the Campaigns API request, such as those related to sequences, forms, blog posts, and other marketing assets.
- The API documentation does not clearly indicate whether these properties are unsupported or require specific scopes or permissions.
- Based on the error, it seems that these properties are classified as “forbidden”, but no additional guidance is provided on how to access them or if they are even valid for this endpoint.
4. Request for Clarification:
Could you please clarify the following:
- Are the properties listed in the error response (e.g., hubspot_owner_id, hs_created_at, hs_broadcast_count, etc.) supported by the Campaigns API? If so, what scopes or permissions are needed to access them?
- If these properties are not accessible via the Campaigns API, is there an alternative API or method to retrieve such data?
I appreciate any insights or recommendations to resolve this issue.