Class: HubSpotSDK::Resources::WebhooksJournal::Snapshots

Inherits:
Object
  • Object
show all
Defined in:
lib/hubspot_sdk/resources/webhooks_journal/snapshots.rb

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ Snapshots

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 Snapshots.

Parameters:



38
39
40
 
# File 'lib/hubspot_sdk/resources/webhooks_journal/snapshots.rb', line 38

def initialize(client:)
  @client = client
end

Instance Method Details

#create(snapshot_requests:, request_options: {}) ⇒ HubSpotSDK::Models::CrmObjectSnapshotBatchResponse

Some parameter documentations has been truncated, see Models::WebhooksJournal::SnapshotCreateParams for more details.

Create a batch of CRM object snapshots in HubSpot. This endpoint is used to capture the current state of specified CRM objects for later reference or analysis. It requires a JSON payload containing the details of the CRM objects to snapshot. This operation is exempt from daily and ten-secondly rate limits.

Parameters:

Returns:

See Also:



24
25
26
27
28
29
30
31
32
33
 
# File 'lib/hubspot_sdk/resources/webhooks_journal/snapshots.rb', line 24

def create(params)
  parsed, options = HubSpotSDK::WebhooksJournal::SnapshotCreateParams.dump_request(params)
  @client.request(
    method: :post,
    path: "webhooks-journal/snapshots/2026-03/crm",
    body: parsed,
    model: HubSpotSDK::CrmObjectSnapshotBatchResponse,
    options: options
  )
end