Options
The module to fetch or update, e.g. Contacts
Option only applies to moduleContacts
.
When enabled, the id field is returned and no new contact is created if there is already a contact with the provided email in HubSpot present.
Option only applies to moduleDeals
.
If enabled, the line items are returned as a field line_items
in the deal object as a JSON array string.
Also adds a field max_updated_time
which is the maximum updated time of all line items and the deal itself.
Tries to look for line items and deal changes.
Field can be also used to updated line items.
Option only applies ifReturn Line Items as Field
is enabled.
Name of the fields in the line item object that should be returned, e.g name, price, hs_discount_percentage, discount, quantity, description
id and hs_lastmodifieddate are always returned.
Empty value will return all fields, but can result in problems with Masstransfer because of the size of the data.
If a relation is needed to be fetched and or updated, the relation IDs can be specified here.
Each relation ID is a pair of relationType
and targetModule
separated by a colon, e.g. deal_to_company:company
.
Multiple relation IDs can be separated by a comma.
This will add a field relation_deal_to_company
to the object, which will have the hubspot ids of the related companies as comma separated string.
This can also be used to update this relation.
Fetch and update subscriptions for a contact. Can only be used in combination with the Contacts
module.
Uses the contacts email address to fetch the subscriptions and allows to update them.
The event type to fetch, e.g. EMAIL_DELIVERED
, all other event types are ignored.
This is only available for specific use cases on request. Generally, the OAuth2 authentication should be used.
Private App Key, see https://developers.hubspot.com/docs/api/private-apps