HubSpot all-in-one marketing software helps more than 8,000 companies in 56 countries attract leads and convert them into customers. A pioneer in inbound marketing, HubSpot aims to help its customers make marketing that people actually love.

The connector is using the version "v1" of the HubSpot API.

The documentation of the API can be found in this link

The main flow of the connector is "authentication" ---> HubSpot Login Page ----> "authenticationResponse" ----> Any other process of the connector

Additional Info

Requires Mule Enterprise License

No  

Requires Entitlement

No  

Mule Version

3.7.0 or higher

Configs

Processors

Authenticate

<hubspot:authenticate>

/** This process generates the URL required to authenticate against the service.

Important: in order for the full authentication to work, the callbackUrl in the configuration must be pointing to another flow that has the authenticateResponse process to handle the reception of the token

../../../doc/HubSpot-connector.xml.sample hubspot:authenticate

XML Sample

<hubspot:authenticate userId="userId" />

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

userId

String

This user identifier it is the one that will we used from now on to the successive calls to the process of this connector for this user

x 

callbackUrl

String

Use this callback instead the one in the configuration

 

clientId

String

Use this clientId instead the one in the configuration

 

hubId

String

Use this hubId instead the one in the configuration

 

scope

String

Use this scope instead the one in the configuration

 

headers

Map<String,Object>

This are added implicitly by Studio. The headers of the HTTP inbound, so it can establish a redirect code (302)

x 

Returns

Return Java Type Description

String

The URL where the user will be redirected

Authenticate response

<hubspot:authenticate-response>

This process is the one that handles the response of the authentication process. It should be inside an HTTP inbound which url must be the same that the one pointed by the callbackUrl in the configuration in order to get the access_token provided by the service.

../../../doc/HubSpot-connector.xml.sample hubspot:authenticate-response

XML Sample

<hubspot:authenticate-response inputRequest="#[payload]" />

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

inputRequest

String

The input parameters that came with the response to the authenticate process

x 

Returns

Return Java Type Description

String

The UserID that you provided in the call to the authenticate process and that is the one that the user is going to provide in order than the connector use their

Has user access token

<hubspot:has-user-access-token>

Check if the User has an Access Token. This indicate that this User can start calling the process of the connector without any problems

../../../doc/HubSpot-connector.xml.sample hubspot:has-user-access-token

XML Sample

<hubspot:has-user-access-token userId="userId"  />

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

userId

String

The UserID of the user in the HubSpot service that was obtained from the authenticateResponse process

x 

Returns

Return Java Type Description

boolean

A boolean that indicates if the user has an access token. Id does not check if the token is or not expired

Get all contacts

<hubspot:get-all-contacts>

For a given portal, return all contacts that have been created in the portal. A paginated list of contacts will be returned to you, with a maximum of 100 contacts per page.

API Link: http://developers.hubspot.com/docs/methods/contacts/get_contacts

../../../doc/HubSpot-connector.xml.sample hubspot:get-all-contacts

XML Sample

<hubspot:get-all-contacts userId="userId" />

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

userId

String

The UserID of the user in the HubSpot service that was obtained from the authenticateResponse process

x 

count

String

This parameter lets you specify the amount of contacts to return in your API call. The default for this parameter (if it isn't specified) is 20 contacts. The maximum amount of contacts you can have returned to you via this parameter is 100.

 

contactOffset

String

This parameter will offset the contacts returned to you, based on the unique ID of the contacts in a given portal. Contact unique IDs are assigned by the order that they are created in the system. This means for instance, if you specify a vidOffset offset of 5, and you have 20 contacts in the portal you're working in, the contacts with IDs 6-20 will be returned to you.

 

Returns

Return Java Type Description

ContactList

A ContactList containing all the contacts

Get recent contacts

<hubspot:get-recent-contacts>

For a given portal, return all contacts that have been recently updated or created. A paginated list of contacts will be returned to you, with a maximum of 100 contacts per page, as specified by the "count" parameter.

API link: http://developers.hubspot.com/docs/methods/contacts/get_recently_updated_contacts

../../../doc/HubSpot-connector.xml.sample hubspot:get-recent-contacts

XML Sample

<hubspot:get-recent-contacts userId="userId" />

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

userId

String

The UserID of the user in the HubSpot service that was obtained from the authenticateResponse process

x 

count

String

This parameter lets you specify the amount of contacts to return in your API call. The default for this parameter (if it isn't specified) is 20 contacts. The maximum amount of contacts you can have returned to you via this parameter is 100.

 

timeOffset

String

Used in conjunction with the vidOffset paramter to page through the recent contacts. Every call to this endpoint will return a time-offset value. This value is used in the timeOffset parameter of the next call to get the next page of contacts.

 

contactOffset

String

Used in conjunction with the timeOffset paramter to page through the recent contacts. Every call to this endpoint will return a vid-offset value. This value is used in the vidOffset parameter of the next call to get the next page of contacts.

 

Returns

Return Java Type Description

ContactList

A ContactList containing all the contacts

Get recent contacts paginated

<hubspot:get-recent-contacts-paginated>

This operation masks getRecentContacts with an Iterator that handles the pagination.

../../../doc/HubSpot-connector.xml.sample hubspot:get-recent-contacts-paginated

XML Sample

<hubspot:get-recent-contacts-paginated config-ref="HubSpot" count="20" userId="1" />

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

userId

String

The UserID of the user in the HubSpot service that was obtained from the authenticateResponse process

x 

count

String

This parameter lets you specify the amount of contacts to return in your API call. The default for this parameter (if it isn't specified) is 20 contacts. The maximum amount of contacts you can have returned to you via this parameter is 100.

x 

Returns

Return Java Type Description

Collection<Contact>

A Collection of Contact that is Iterable and handles pagination in the background

Get all contacts updated after

<hubspot:get-all-contacts-updated-after>

This operation masks getRecentContacts recursively filtering all the contacts that were updated after the waterMark

../../../doc/HubSpot-connector.xml.sample hubspot:get-all-contacts-updated-after

XML Sample

<hubspot:get-all-contacts-updated-after userId="userId" waterMark="1261651651" />

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

userId

String

The UserID of the user in the HubSpot service that was obtained from the authenticateResponse process

x 

count

String

This parameter lets you specify the amount of contacts to return in your API call. The default for this parameter (if it isn't specified) is 20 contacts. The maximum amount of contacts you can have returned to you via this parameter is 100.

 

waterMark

Long

The waterMark used to filter the Contacts that were updated after that waterMark

x 

Returns

Return Java Type Description

List<Contact>

A Collection of Contact that is Iterable and handles pagination in the background

Get contact by id

<hubspot:get-contact-by-id>

For a given portal, return information about a single contact by its ID. The contact's unique ID's is stored in a field called 'vid' which stands for 'visitor ID'. This method will also return you much of the HubSpot lead "intelligence" that you may be accustomed to getting from the leads API, as properties in this new API. More of this intelligence will be available as time passes, but this call is where you can expect to find it.

API link: http://developers.hubspot.com/docs/methods/contacts/get_contact

../../../doc/HubSpot-connector.xml.sample hubspot:get-contact-by-id

XML Sample

<hubspot:get-contact-by-id  userId="userId" contactId="contactId" />

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

userId

String

The UserID of the user in the HubSpot service that was obtained from the authenticateResponse process

x 

contactId

String

Unique identifier for a particular contact. In HubSpot's contact system, contact ID's are called "vid".

x 

Returns

Return Java Type Description

Contact

The Contact representation

Get contact by email

<hubspot:get-contact-by-email>

For a given portal, return information about a single contact by its email address.

API link: http://developers.hubspot.com/docs/methods/contacts/get_contact_by_email

../../../doc/HubSpot-connector.xml.sample hubspot:get-contact-by-email

XML Sample

<hubspot:get-contact-by-email  userId="userId" contactEmail="contactEmail" />

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

userId

String

The UserID of the user in the HubSpot service that was obtained from the authenticateResponse process

x 

contactEmail

String

The email address for the contact that you're searching for.

x 

Returns

Return Java Type Description

Contact

The Contact representation

Get contact by user token

<hubspot:get-contact-by-user-token>

For a given portal, return information about a single contact by its User Token (hubspotutk)

API link: http://developers.hubspot.com/docs/methods/contacts/get_contact_by_utk

../../../doc/HubSpot-connector.xml.sample hubspot:get-contact-by-user-token

XML Sample

<hubspot:get-contact-by-user-token  userId="userId" contactUserToken="contactToken" />

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

userId

String

The UserID of the user in the HubSpot service that was obtained from the authenticateResponse process

x 

contactUserToken

String

The user token (HubSpot cookie) for the contact that you're searching for.

x 

Returns

Return Java Type Description

Contact

The Contact representation

Get contacts by query

<hubspot:get-contacts-by-query>

For a given portal, return contacts and some data associated with those contacts by the contact's email address or name. Please note that you should expect this method to only return a small subset of data about the contact. One piece of data that the method will return is the contact ID (vid) that you can then use to look up much more data about that particular contact by its ID.

API link: http://developers.hubspot.com/docs/methods/contacts/search_contacts

../../../doc/HubSpot-connector.xml.sample hubspot:get-contacts-by-query

XML Sample

<hubspot:get-contacts-by-query  userId="userId" query="query" />

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

userId

String

The UserID of the user in the HubSpot service that was obtained from the authenticateResponse process

x 

query

String

The search term for what you're searching for. You can use all of a word or just parts of a word as well. For example, if you we're searching for contacts with "hubspot" in their name or email, searching for "hub" would also return contacts with "hubspot" in their email address.

x 

count

String

This parameter lets you specify the amount of contacts to return in your API call. The default for this parameter (if it isn't specified) is 20 contacts. The maximum amount of contacts you can have returned to you via this parameter is 100.

 

Returns

Return Java Type Description

ContactQuery

A ContactQuery with the contacts

Delete contact

<hubspot:delete-contact>

Archive an existing contact from a particular HubSpot portal. Archiving will not hard delete a contact from a portal, but will remove that contact from the HubSpot user interface.

API link: http://developers.hubspot.com/docs/methods/contacts/delete_contact

../../../doc/HubSpot-connector.xml.sample hubspot:delete-contact

XML Sample

<hubspot:delete-contact  userId="userId" contactId="contactId" />

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

userId

String

The UserID of the user in the HubSpot service that was obtained from the authenticateResponse process

x 

contactId

String

You must pass the Contact's ID that you're archiving in the request URL.

x 

Returns

Return Java Type Description

ContactDeleted

A ContactDeleted representing the data when the contact is deleted

Update contact

<hubspot:update-contact>

Update an existing contact in HubSpot. This method lets you update one of many fields of a contact in HubSpot.

To update a contact, you should make an HTTP POST call to this endpoint with some JSON in the request payload. This JSON should contain properties from the contact that you want to add to or update. See the sample JSON below for an example of this snippet of JSON.

If you are trying to close a contact into a customer via the API, you should be updating the 'lifecyclestage' property and setting the value of this property to 'customer'.

Remember, if a property doesn't yet exist, you can create a new custom property through the API by using the 'Create Property' method.

API link: http://developers.hubspot.com/docs/methods/contacts/update_contact

../../../doc/HubSpot-connector.xml.sample hubspot:update-contact

XML Sample

<hubspot:update-contact  userId="userId" contactId="contactId">
        <hubspot:contact-properties email="user@mulesoft.com" />
    </hubspot:update-contact>

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

userId

String

The UserID of the user in the HubSpot service that was obtained from the authenticateResponse process

x 

contactId

String

You must pass the Contact's ID that you're updating in the request URL

x 

contactProperties

ContactProperties

The properties of the Contact that will have the one to be created

x 

Returns

Return Java Type Description

ContactProperties

The ContactProperties that was provided as input param

Create contact

<hubspot:create-contact>

Create a new contact in HubSpot with a simple HTTP POST to the Contacts API.

API link: http://developers.hubspot.com/docs/methods/contacts/create_contact

../../../doc/HubSpot-connector.xml.sample hubspot:create-contact

XML Sample

<hubspot:create-contact  userId="userId">
        <hubspot:contact-properties email="user@mulesoft.com" />
    </hubspot:create-contact>

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

userId

String

The UserID of the user in the HubSpot service that was obtained from the authenticateResponse process

x 

contactProperties

ContactProperties

The properties that want to modify of an existing contact

x 

Returns

Return Java Type Description

Contact

The Contact newly created

Get contact statistics

<hubspot:get-contact-statistics>

For a given portal, return statistics about that portal's contacts.

API link: http://developers.hubspot.com/docs/methods/contacts/get_contact_statistics

../../../doc/HubSpot-connector.xml.sample hubspot:get-contact-statistics

XML Sample

<hubspot:get-contact-statistics  userId="userId" />

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

userId

String

The UserID of the user in the HubSpot service that was obtained from the authenticateResponse process

x 

Returns

Return Java Type Description

ContactStatistics

A ContactStatistics representation of the response of statistics

Get contacts lists

<hubspot:get-contacts-lists>

For a given portal, return a set of contact lists that you specify with the count parameter. By default, we will only return up to 20 lists to you at a time.

API link: http://developers.hubspot.com/docs/methods/lists/get_lists

../../../doc/HubSpot-connector.xml.sample hubspot:get-contacts-lists

XML Sample

<hubspot:get-contacts-lists  userId="userId" />

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

userId

String

The UserID of the user in the HubSpot service that was obtained from the authenticateResponse process

x 

count

String

An integer that represents the number of lists that you want returned to your call. By default, this call will return 20 lists to you. If you want more or different list returned to you, you'll want to use the "offset" parameter.

 

offset

String

An integer that represents where to start your list pull from. For instance, if you want to return numbered lists: 50-60, your offset should be "50" and your count parameter (seen above) should be 10. You should also note that the returned JSON (seen below) includes a "has-more" field, which lets you know if there are more lists that you can pull. If "has-more" is true, you can use this offset parameter to pull lists that weren't in your initial call.

 

Returns

Return Java Type Description

HubSpotListLists

A HubSpotListLists with the lists

Get contact list by id

<hubspot:get-contact-list-by-id>

For a given portal, return a contact list by its unique ID.

API link: http://developers.hubspot.com/docs/methods/lists/get_list

../../../doc/HubSpot-connector.xml.sample hubspot:get-contact-list-by-id

XML Sample

<hubspot:get-contact-list-by-id  userId="userId" listId="listId" />

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

userId

String

The UserID of the user in the HubSpot service that was obtained from the authenticateResponse process

x 

listId

String

Unique identifier for the list that you're looking for.

x 

Returns

Return Java Type Description

HubSpotList

A HubSpotList with the list

Get dynamic contact lists

<hubspot:get-dynamic-contact-lists>

For a given portal, return a set of dynamic contact lists that you specify with the count parameter.

Dynamic lists are lists that can only be edited by the contacts app - they are meant to update themselves when new contacts are created or are updated, meaning that you can't manually add contacts to dynamic lists.

By default, we will only return 20 lists to you via this API call.

API link: http://developers.hubspot.com/docs/methods/lists/get_dynamic_lists

../../../doc/HubSpot-connector.xml.sample hubspot:get-dynamic-contact-lists

XML Sample

<hubspot:get-dynamic-contact-lists  userId="userId" />

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

userId

String

The UserID of the user in the HubSpot service that was obtained from the authenticateResponse process

x 

count

String

An integer that represents the number of lists that you want returned to your call. By default, this call will return 20 lists to you. If you want more or different list returned to you, you'll want to use the "offset" parameter.

 

offset

String

An integer that represents where to start your list pull from. For instance, if you want to return numbered lists: 50-60, your offset should be "50" and your count parameter (seen above) should be 10. You should also note that the returned JSON (seen below) includes a "has-more" field, which lets you know if there are more lists that you can pull. If "has-more" is true, you can use this offset parameter to pull lists that weren't in your initial call.

 

Returns

Return Java Type Description

HubSpotListLists

A HubSpotListLists with the lists

Get contacts in a list

<hubspot:get-contacts-in-a-list>

For a given portal and a given list, identified by its unique ID, return a list of contacts that are in that list.

API link: http://developers.hubspot.com/docs/methods/lists/get_list_contacts

../../../doc/HubSpot-connector.xml.sample hubspot:get-contacts-in-a-list

XML Sample

<hubspot:get-contacts-in-a-list  userId="userId" listId="listId" />

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

userId

String

The UserID of the user in the HubSpot service that was obtained from the authenticateResponse process

x 

listId

String

Unique identifier for the list that you're looking for.

x 

count

String

This parameter lets you specify the amount of contacts to return in your API call. The default for this parameter (if it isn't specified) is 20 contacts. The maximum amount of contacts you can have returned to you via this parameter is 100.

 

property

String

If you include the "property" parameter, then the properties in the "contact" object in the returned data will only include the property or properties that you request.

 

offset

String

This parameter will offset the contacts returned to you, based on the unique ID of the contacts in a given portal. Contact unique IDs are assigned by the order that they are created in the system. This means for instance, if you specify a vidOffset offset of 5, and you have 20 contacts in the portal you're working in, the contacts with IDs 6-20 will be returned to you.

 

Returns

Return Java Type Description

ContactList

A ContactList whit the contact list

Get email subscriptions

<hubspot:get-email-subscriptions>

For a given portal, return all email subscription types that have been created in the portal.

API link: http://developers.hubspot.com/docs/methods/email/get_subscriptions

../../../doc/HubSpot-connector.xml.sample hubspot:get-email-subscriptions

XML Sample

<hubspot:get-email-subscriptions userId="userId" />

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

userId

String

The UserID of the user in the HubSpot service that was obtained from the authenticateResponse process

x 

hubId

String

(portalId) The HubSpot Portal ID for the portal that you're making the call for. If left empty it will use the one stored in the credentials (authenticate operation)

 

Returns

Return Java Type Description

EmailSubscription

A EmailSubscription with the subscriptions data

Get email subscription status

<hubspot:get-email-subscription-status>

For a given portal, return all email subscription information for the given email address and portal.

API link: http://developers.hubspot.com/docs/methods/email/get_status

../../../doc/HubSpot-connector.xml.sample hubspot:get-email-subscription-status

XML Sample

<hubspot:get-email-subscription-status userId="userId" email="email" />

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

userId

String

The UserID of the user in the HubSpot service that was obtained from the authenticateResponse process

x 

hubId

String

(portalId) The HubSpot Portal ID for the portal that you're making the call for. If left empty it will use the one stored in the credentials (authenticate operation)

 

email

String

The email to check the current status subscription

x 

Returns

Return Java Type Description

EmailSubscriptionStatus

A EmailSubscriptionStatus with the status subscription

Update email subscription status

<hubspot:update-email-subscription-status>

For a given email address and portal, update the email type subscription status. NOTE: it is only possible to opt email addresses OUT of subscription and there is NO UNDO for this operation.

API link: http://developers.hubspot.com/docs/methods/email/update_status

../../../doc/HubSpot-connector.xml.sample hubspot:update-email-subscription-status

XML Sample

<hubspot:update-email-subscription-status userId="userId" email="email">
        <hubspot:statuses ref="statuses" />
    </hubspot:update-email-subscription-status>

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

userId

String

The UserID of the user in the HubSpot service that was obtained from the authenticateResponse process

x 

hubId

String

(portalId) The HubSpot Portal ID for the portal that you're making the call for. If left empty it will use the one stored in the credentials (authenticate operation)

 

email

String

The email to update the current status subscription

x 

statuses

List<EmailSubscriptionStatusStatuses>

A List of EmailSubscriptionStatusStatuses to be modified

x 

Returns

Return Java Type Description

EmailSubscriptionStatusResult

The status of the operation EmailSubscriptionStatusResult

Update email subscription status unsubscribe from all

<hubspot:update-email-subscription-status-unsubscribe-from-all>

For a given email address and portal, update the email type subscription unsuscribing from all emails NOTE: it is only possible to opt email addresses OUT of subscription and there is NO UNDO for this operation.

API link: http://developers.hubspot.com/docs/methods/email/update_status

../../../doc/HubSpot-connector.xml.sample hubspot:update-email-subscription-status-unsubscribe-from-all

XML Sample

<hubspot:update-email-subscription-status-unsubscribe-from-all userId="userId" email="email" />

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

userId

String

The UserID of the user in the HubSpot service that was obtained from the authenticateResponse process

x 

hubId

String

(portalId) The HubSpot Portal ID for the portal that you're making the call for. If left empty it will use the one stored in the credentials (authenticate operation)

 

email

String

The email to update the current status subscription

x 

Returns

Return Java Type Description

EmailSubscriptionStatusResult

The status of the operation EmailSubscriptionStatusResult

Get all custom properties

<hubspot:get-all-custom-properties>

Properties in HubSpot are fields that have been created. By default, there are many fields that come "out of the box" in a HubSpot portal, but users can also create new, custom properties as they please. This method returns all of those properties to you.

API link: https://developers.hubspot.com/docs/methods/contacts/get_properties

../../../doc/HubSpot-connector.xml.sample hubspot:get-all-custom-properties

XML Sample

<hubspot:get-all-custom-properties userId="userId" />

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

userId

String

The UserID of the user in the HubSpot service that was obtained from the authenticateResponse process

x 

Returns

Return Java Type Description

List<CustomContactProperty>

A List of CustomContactProperty

Create custom property

<hubspot:create-custom-property>

Create a new property in HubSpot. Properties in HubSpot are fields that have been created. By default, there are many fields that come "out of the box" in a HubSpot portal, but users can also create new, custom properties as they please.

This method enables you to create a new property. If you try to create a property whose name already exists in the system, you'll get an HTTP 409 exception thrown from the API.

Currently, there is a 1,000 property limit that you can have in any given portal.

API link: https://developers.hubspot.com/docs/methods/contacts/create_property

../../../doc/HubSpot-connector.xml.sample hubspot:create-custom-property

XML Sample

<hubspot:create-custom-property userId="userId">
        <hubspot:contact-property ref="customProperty" />
    </hubspot:create-custom-property>

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

userId

String

The UserID of the user in the HubSpot service that was obtained from the authenticateResponse process

x 

contactProperty

CustomContactProperty

The CustomContactProperty to be created

x 

Returns

Return Java Type Description

CustomContactProperty

The CustomContactProperty created

Update custom property

<hubspot:update-custom-property>

Update an existing property in HubSpot. This method lets you update one of many properties of a contact in HubSpot.T

To update a contact property, you should make an HTTP POST call to this endpoint with some JSON in the request payload. This JSON should contain property attributes that you want to add to or update. See the sample JSON below for an example of this snippet of JSON.

Remember, if a property doesn't yet exist, you can create a new custom property through the API by using the 'Create Property' method.

API link: https://developers.hubspot.com/docs/methods/contacts/update_property

../../../doc/HubSpot-connector.xml.sample hubspot:update-custom-property

XML Sample

<hubspot:update-custom-property userId="userId" propertyName="propertyName">
        <hubspot:contact-property ref="customProperty" />
    </hubspot:update-custom-property>

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

userId

String

The UserID of the user in the HubSpot service that was obtained from the authenticateResponse process

x 

propertyName

String

The name of the Custom Property to be updated

x 

contactProperty

CustomContactProperty

The contactProperty to be created

x 

Returns

Return Java Type Description

CustomContactProperty

The contactProperty recently created

Delete custom property

<hubspot:delete-custom-property>

Delete an existing property in HubSpot. This method lets you delete one of many properties of a contact in HubSpot.

To delete a contact property, you should make an HTTP DELETE call to this endpoint with the name of the property you're deleting in the request URL.

API link: https://developers.hubspot.com/docs/methods/contacts/delete_property

../../../doc/HubSpot-connector.xml.sample hubspot:delete-custom-property

XML Sample

<hubspot:delete-custom-property userId="userId" contactPropertyName="propertyName" />

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

userId

String

The UserID of the user in the HubSpot service that was obtained from the authenticateResponse process

x 

contactPropertyName

String

The name of the custom property to be deleted

x 

Get custom property group

<hubspot:get-custom-property-group>

For a given portal, return all contact property groups that have been created in the portal.

Property groups allow you to more easily manage properties in a given portal. They also let you organize the user interface of the contacts web application in a more flexible way.

There are certain property groups that are in place for each portal by default: 'Contact Information', 'Social Media Information', 'Company Information' and 'Email Inforamtion' are examples.

API link: https://developers.hubspot.com/docs/methods/contacts/get_groups

../../../doc/HubSpot-connector.xml.sample hubspot:get-custom-property-group

XML Sample

<hubspot:get-custom-property-group userId="userId" groupName="groupName" />

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

userId

String

The UserID of the user in the HubSpot service that was obtained from the authenticateResponse process

x 

groupName

String

The name of the group to be retrieved

x 

Returns

Return Java Type Description

CustomContactPropertyGroup

A CustomContactPropertyGroup

Create custom property group

<hubspot:create-custom-property-group>

For a given portal, create a new contact proprerty group.

Property groups allow you to more easily manage properties in a given portal. They also let you organize the user interface of the contacts web application in a more flexible way.

There are certain propery groups that are in place for each portal by default: 'Contact Information', 'Social Media Information', 'Company Information' and 'Email Inforamtion' are examples. This method lets you create your own custom property group in a portal.

API link: https://developers.hubspot.com/docs/methods/contacts/create_group

../../../doc/HubSpot-connector.xml.sample hubspot:create-custom-property-group

XML Sample

<hubspot:create-custom-property-group userId="userId">
        <hubspot:custom-contact-property-group ref="customContactPropertyGroup" />
    </hubspot:create-custom-property-group>

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

userId

String

The UserID of the user in the HubSpot service that was obtained from the authenticateResponse process

x 

customContactPropertyGroup

CustomContactPropertyGroup

A CustomContactPropertyGroup to be created

x 

Returns

Return Java Type Description

CustomContactPropertyGroup

The CustomContactPropertyGroup recently created

Update custom property group

<hubspot:update-custom-property-group>

For a given portal, update a contact property group.

Property groups allow you to more easily manage properties in a given portal. They also let you organize the user interface of the contacts web application in a more flexible way.

There are certain property groups that are in place for each portal by default: 'Contact Information', 'Social Media Information', 'Company Information' and 'Email Inforamtion' are examples. This method lets you update your own custom property group in a portal.

API link: https://developers.hubspot.com/docs/methods/contacts/update_group

../../../doc/HubSpot-connector.xml.sample hubspot:update-custom-property-group

XML Sample

<hubspot:update-custom-property-group userId="userId" groupName="groupName">
        <hubspot:custom-contact-property-group ref="customContactPropertyGroup" />
    </hubspot:update-custom-property-group>

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

userId

String

The UserID of the user in the HubSpot service that was obtained from the authenticateResponse process

x 

groupName

String

The name of the Custom Contact Property Group to be updated

x 

customContactPropertyGroup

CustomContactPropertyGroup

A CustomContactPropertyGroup to be created

x 

Returns

Return Java Type Description

CustomContactPropertyGroup

The CustomContactPropertyGroup recently created

Delete custom property group

<hubspot:delete-custom-property-group>

For a given portal, delete a contact property group based on the name of the group.

Property groups allow you to more easily manage properties in a given portal. They also let you organize the user interface of the contacts web application in a more flexible way.

There are certain property groups that are in place for each portal by default: 'Contact Information', 'Social Media Information', 'Company Information' and 'Email Inforamtion' are examples. This method lets you delete your own custom property group in a portal. You can also create new groups, update existing groups, or just get group and the properties in each group.

API link: https://developers.hubspot.com/docs/methods/contacts/delete_group

../../../doc/HubSpot-connector.xml.sample hubspot:delete-custom-property-group

XML Sample

<hubspot:delete-custom-property-group userId="userId" groupName="groupName" />

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

userId

String

The UserID of the user in the HubSpot service that was obtained from the authenticateResponse process

x 

groupName

String

The name of the group to be deleted

x 

Add existing contact in a list

<hubspot:add-existing-contact-in-a-list>

Add a contact record that has already been created in the system to a contact list.

Please note that you cannot manually add (via this API call) contacts to dynamic lists - they can only be updated by the contacts app.

API link: http://developers.hubspot.com/docs/methods/lists/add_contact_to_list

../../../doc/HubSpot-connector.xml.sample hubspot:add-existing-contact-in-a-list

XML Sample

<hubspot:add-existing-contact-in-a-list  userId="userId" listId="listId" contactId="contactId" />

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

userId

String

The UserID of the user in the HubSpot service that was obtained from the authenticateResponse process

x 

listId

String

You need to include the ID for the list you're adding the lead to. You can search for lists using the get lists method.

x 

contactId

String

The contact ID of the contact that you're adding to the list.

x 

Returns

Return Java Type Description

HubSpotListAddContactToListResponse

A HubSpotListAddContactToListResponse In the "updated" attribute, you'll also get the contact ID of the contact that you've just added to the list

Create contact list

<hubspot:create-contact-list>

Create a new list in a given HubSpot portal to populate with contacts.

API link: http://developers.hubspot.com/docs/methods/lists/create_list

../../../doc/HubSpot-connector.xml.sample hubspot:create-contact-list

XML Sample

<hubspot:create-contact-list  userId="userId">
        <hubspot:list ref="listObj" />
    </hubspot:create-contact-list>

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

userId

String

The UserID of the user in the HubSpot service that was obtained from the authenticateResponse process

x 

list

HubSpotNewList

the new HubSpotNewList to be created. Required fields:name, portalId.

x 

filters

List<HubSpotListFilters>

the list of HubSpotListFilters that the list can have

 

Returns

Return Java Type Description

HubSpotList

The newly created instance of HubSpotList