Hubapi Communication Preferences is the HubSpot API for managing contact subscription status and communication consent preferences.

Provided free and as is, without warranty of any kind — including merchantability, fitness for a particular purpose, and the accuracy or completeness of any result. See the licence. You are responsible for checking what this produces before relying on it.

Hubapi Communication Preferences

Hubapi Communication Preferences is the HubSpot API for managing contact subscription status and communication consent preferences.

Base URL: https://api.hubapi.com
Auth: query:hapikey (pass your key via the apiKey input)

Operations

get_communication_preferences_v3_definitions_get — GET /communication-preferences/v3/definitions — Get subscription definitions
get_communication_preferences_v3_status_email_em — GET /communication-preferences/v3/status/email/{emailAddress} — Get subscription statuses for a contact
post_communication_preferences_v3_subscribe_subs — POST /communication-preferences/v3/subscribe — Subscribe a contact
post_communication_preferences_v3_unsubscribe_un — POST /communication-preferences/v3/unsubscribe — Unsubscribe a contact

Inputs

apiKey — your hubapi-communication-preferences API key
operation — one of the operations above
path parameters when an operation's path contains {...}
query — optional JSON object of query params
body — JSON object for create/update ops

Example

operation: get_communication_preferences_v3_definitions_get
apiKey: <your key>

Publishes

The keys a later task may reference as {{taskName.key}}. Referencing anything not listed here resolves to nothing at run time.

error
operation
result
status

Input Properties

Every property this tool accepts, from its own tool.iml.

Property	Type	Required	Default	Description
`apiKey`	string	yes	—	DEPRECATED — bind an API Key credential to the task with `credentialName` instead. A key pasted here is stored in the workflow definition in clear and appears in every export of it. Still honoured for workflows built before the change.
`operation`	string	yes	—	One of: get_communication_preferences_v3_definitions_get, get_communication_preferences_v3_status_email_em, post_communication_preferences_v3_subscribe_subs, post_communication_preferences_v3_unsubscribe_un
`emailAddress`	string	no	—	Path parameter emailAddress (required by some operations).
`body`	string	no	—	Request body as a JSON object string (for create/update operations).
`query`	string	no	—	Query-string parameters as a JSON object string, e.g. {"limit": 50}. Parsed and url-encoded onto the request.