Skip to content

ForceResyncApi.md

Latest commit

 

History

History
79 lines (52 loc) · 2.34 KB

ForceResyncApi.md

File metadata and controls

79 lines (52 loc) · 2.34 KB

MergeCRMClient::ForceResyncApi

All URIs are relative to https://api.merge.dev/api/crm/v1

Method HTTP request Description
sync_status_resync_create POST /sync-status/resync

sync_status_resync_create

<Array> sync_status_resync_create(x_account_token)

Force re-sync of all models. This is available for all organizations via the dashboard. Force re-sync is also available programmatically via API for monthly, quarterly, and highest sync frequency customers on the Core, Professional, or Enterprise plans. Doing so will consume a sync credit for the relevant linked account.

Examples

require 'time'
require 'merge_crm_client'
# setup authorization
MergeCRMClient.configure do |config|
  # Configure API key authorization: tokenAuth
  config.api_key['tokenAuth'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['tokenAuth'] = 'Bearer'
end

api_instance = MergeCRMClient::ForceResyncApi.new
x_account_token = 'x_account_token_example' # String | Token identifying the end user.

begin
  
  result = api_instance.sync_status_resync_create(x_account_token)
  p result
rescue MergeCRMClient::ApiError => e
  puts "Error when calling ForceResyncApi->sync_status_resync_create: #{e}"
end

Using the sync_status_resync_create_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(<Array>, Integer, Hash)> sync_status_resync_create_with_http_info(x_account_token)

begin
  
  data, status_code, headers = api_instance.sync_status_resync_create_with_http_info(x_account_token)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <Array<SyncStatus>>
rescue MergeCRMClient::ApiError => e
  puts "Error when calling ForceResyncApi->sync_status_resync_create_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
x_account_token String Token identifying the end user.

Return type

Array<SyncStatus>

Authorization

tokenAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json