For a given portal, return a list of lead nurturing campaigns.
You will need to call this method to obtain the GUIDs of your existing Lead Nurturing Campaigns, for use in other methods.
| Required Parameters | How to use | Description |
|---|---|---|
| HubSpot OAuth Access Token | access_token=X - Used in the request URL | The HubSpot API key for the portal that you're making the call for. |
| Optional Parameters | How to use | Description |
|---|---|---|
| Exclude Inactive Campaigns | excludeInactive - Used in the request URL | Calls to this API method will, by default, only return lead nurturing campaigns that have at least one active email. If there isn't a campaign that you have active, you won't get any campaigns returned. If you want to get back inactive campaigns from the API, you should include the optional parameter "excludeInactive=1". The default for this parameter is "0". |
Example URL using JSON: https://api.hubapi.com/nurture/v1/campaigns?access_token=demooooo-oooo-oooo-oooo-oooooooooooo
Example JSON output. It's displaying 5 campaigns from the HubSpot demo portal:
[
{
"name": "contactMe",
"guid": "4159b174-8aeb-4746-abdc-9dfe013d47dc"
},
{
"name": "updates",
"guid": "a0b5ef19-aa99-48fc-9a4d-c4c25fe75eda"
},
{
"name": "emailContact",
"guid": "2bb746ad-182f-4a47-a363-5668246f9ce2"
},
{
"name": "Test name",
"guid": "dd9ba8fa-f7b9-4ece-88d6-cd9dc4124872"
},
{
"name": "test cmpan",
"guid": "76a013ab-a3dd-4615-b70a-a9f6dcf60ecd"
}
]
HTTP Methods:
GET
Response Format:
json
Requires Authentication?
Yes
Rate Limited?
Headers