Class: HubSpotSDK::Resources::CommunicationPreferences

Inherits:
Object
  • Object
show all
Defined in:
lib/hubspot_sdk/resources/communication_preferences.rb,
lib/hubspot_sdk/resources/communication_preferences/statuses.rb,
lib/hubspot_sdk/resources/communication_preferences/definitions.rb,
lib/hubspot_sdk/resources/communication_preferences/statuses/batch.rb

Defined Under Namespace

Classes: Definitions, Statuses

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ CommunicationPreferences

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns a new instance of CommunicationPreferences.

Parameters:



174
175
176
177
178
 
# File 'lib/hubspot_sdk/resources/communication_preferences.rb', line 174

def initialize(client:)
  @client = client
  @definitions = HubSpotSDK::Resources::CommunicationPreferences::Definitions.new(client: client)
  @statuses = HubSpotSDK::Resources::CommunicationPreferences::Statuses.new(client: client)
end

Instance Attribute Details

#definitions ⇒ HubSpotSDK::Resources::CommunicationPreferences::Definitions (readonly)

Returns:



7
8
9
 
# File 'lib/hubspot_sdk/resources/communication_preferences.rb', line 7

def definitions
  @definitions
end

#statuses ⇒ HubSpotSDK::Resources::CommunicationPreferences::Statuses (readonly)

Returns:



10
11
12
 
# File 'lib/hubspot_sdk/resources/communication_preferences.rb', line 10

def statuses
  @statuses
end

Instance Method Details

Some parameter documentations has been truncated, see Models::CommunicationPreferences::CommunicationPreferenceGenerateLinksParams for more details.

Generate communication preference links for a subscriber. This endpoint allows you to create URLs for managing preferences and unsubscribing, tailored to a specific subscriber. It is useful for integrating communication preference management into your applications.

Parameters:

  • channel (Symbol, HubSpotSDK::Models::CommunicationPreferences::LinkGenerationRequest::Channel) —

    Query param

  • subscriber_id_string (String) —

    Body param: A string representing the unique identifier of the subscriber. This

  • business_unit_id (Integer) —

    Query param

  • language (String) —

    Body param: The language in which the generated link should be presented, repres

  • subscription_id (Integer) —

    Body param: The unique identifier for the subscription, represented as an intege

  • request_options (HubSpotSDK::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

See Also:



38
39
40
41
42
43
44
45
46
47
48
49
50
51
 
# File 'lib/hubspot_sdk/resources/communication_preferences.rb', line 38

def generate_links(params)
  query_params = [:channel, :business_unit_id]
  parsed, options =
    HubSpotSDK::CommunicationPreferences::CommunicationPreferenceGenerateLinksParams.dump_request(params)
  query = HubSpotSDK::Internal::Util.encode_query_params(parsed.slice(*query_params))
  @client.request(
    method: :post,
    path: "communication-preferences/2026-03/links/generate",
    query: query.transform_keys(business_unit_id: "businessUnitId"),
    body: parsed.except(*query_params),
    model: HubSpotSDK::CommunicationPreferences::LinkGenerationResponse,
    options: options
  )
end

#get_statuses(subscriber_id_string, channel:, business_unit_id: nil, request_options: {}) ⇒ HubSpotSDK::Models::CommunicationPreferences::ActionResponseWithResultsPublicStatus

Retrieve a contact’s current email subscription preferences.

Parameters:

Returns:

See Also:



65
66
67
68
69
70
71
72
73
74
75
76
 
# File 'lib/hubspot_sdk/resources/communication_preferences.rb', line 65

def get_statuses(subscriber_id_string, params)
  parsed, options =
    HubSpotSDK::CommunicationPreferences::CommunicationPreferenceGetStatusesParams.dump_request(params)
  query = HubSpotSDK::Internal::Util.encode_query_params(parsed)
  @client.request(
    method: :get,
    path: ["communication-preferences/2026-03/statuses/%1$s", subscriber_id_string],
    query: query.transform_keys(business_unit_id: "businessUnitId"),
    model: HubSpotSDK::CommunicationPreferences::ActionResponseWithResultsPublicStatus,
    options: options
  )
end

#get_unsubscribe_all_status(subscriber_id_string, channel:, business_unit_id: nil, verbose: nil, request_options: {}) ⇒ HubSpotSDK::Models::CommunicationPreferences::ActionResponseWithResultsPublicWideStatus

Check whether a contact has unsubscribed from all email subscriptions. If a contact has not opted out of all communications, the response ‘results` array will be empty.

Parameters:

Returns:

See Also:



93
94
95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'lib/hubspot_sdk/resources/communication_preferences.rb', line 93

def get_unsubscribe_all_status(subscriber_id_string, params)
  parsed, options =
    HubSpotSDK::CommunicationPreferences::CommunicationPreferenceGetUnsubscribeAllStatusParams.dump_request(
      params
    )
  query = HubSpotSDK::Internal::Util.encode_query_params(parsed)
  @client.request(
    method: :get,
    path: ["communication-preferences/2026-03/statuses/%1$s/unsubscribe-all", subscriber_id_string],
    query: query.transform_keys(business_unit_id: "businessUnitId"),
    model: HubSpotSDK::CommunicationPreferences::ActionResponseWithResultsPublicWideStatus,
    options: options
  )
end

#unsubscribe_all(subscriber_id_string, channel:, business_unit_id: nil, verbose: nil, request_options: {}) ⇒ HubSpotSDK::Models::CommunicationPreferences::ActionResponseWithResultsPublicStatus

Unsubscribe a contact from all email subscriptions.

Parameters:

Returns:

See Also:



121
122
123
124
125
126
127
128
129
130
131
132
 
# File 'lib/hubspot_sdk/resources/communication_preferences.rb', line 121

def unsubscribe_all(subscriber_id_string, params)
  parsed, options =
    HubSpotSDK::CommunicationPreferences::CommunicationPreferenceUnsubscribeAllParams.dump_request(params)
  query = HubSpotSDK::Internal::Util.encode_query_params(parsed)
  @client.request(
    method: :post,
    path: ["communication-preferences/2026-03/statuses/%1$s/unsubscribe-all", subscriber_id_string],
    query: query.transform_keys(business_unit_id: "businessUnitId"),
    model: HubSpotSDK::CommunicationPreferences::ActionResponseWithResultsPublicStatus,
    options: options
  )
end

#update_status(subscriber_id_string, channel:, status_state:, subscription_id:, legal_basis: nil, legal_basis_explanation: nil, request_options: {}) ⇒ HubSpotSDK::Models::CommunicationPreferences::ActionResponseWithResultsPublicStatus

Some parameter documentations has been truncated, see Models::CommunicationPreferences::CommunicationPreferenceUpdateStatusParams for more details.

Set the subscription status of a specific contact.

Parameters:

Returns:

See Also:



159
160
161
162
163
164
165
166
167
168
169
 
# File 'lib/hubspot_sdk/resources/communication_preferences.rb', line 159

def update_status(subscriber_id_string, params)
  parsed, options =
    HubSpotSDK::CommunicationPreferences::CommunicationPreferenceUpdateStatusParams.dump_request(params)
  @client.request(
    method: :post,
    path: ["communication-preferences/2026-03/statuses/%1$s", subscriber_id_string],
    body: parsed,
    model: HubSpotSDK::CommunicationPreferences::ActionResponseWithResultsPublicStatus,
    options: options
  )
end