ConnectWise::MemberNotificationSettingsApi

All URIs are relative to http://na.myconnectwise.net/v4_6_release/apis/3.0

Method	HTTP request	Description
delete_system_members_by_parent_id_notification_settings_by_id	DELETE /system/members/{parentId}/notificationSettings/{id}	Delete MemberNotificationSetting
get_system_members_by_parent_id_notification_settings	GET /system/members/{parentId}/notificationSettings	Get List of MemberNotificationSetting
get_system_members_by_parent_id_notification_settings_by_id	GET /system/members/{parentId}/notificationSettings/{id}	Get MemberNotificationSetting
get_system_members_by_parent_id_notification_settings_count	GET /system/members/{parentId}/notificationSettings/count	Get Count of MemberNotificationSetting
patch_system_members_by_parent_id_notification_settings_by_id	PATCH /system/members/{parentId}/notificationSettings/{id}	Patch MemberNotificationSetting
post_system_members_by_parent_id_notification_settings	POST /system/members/{parentId}/notificationSettings	Post MemberNotificationSetting
put_system_members_by_parent_id_notification_settings_by_id	PUT /system/members/{parentId}/notificationSettings/{id}	Put MemberNotificationSetting

delete_system_members_by_parent_id_notification_settings_by_id

delete_system_members_by_parent_id_notification_settings_by_id(id, parent_id, client_id)

Delete MemberNotificationSetting

Examples

require 'time'
require 'connect_wise'

api_instance = ConnectWise::MemberNotificationSettingsApi.new
id = 56 # Integer | notificationSettingId
parent_id = 56 # Integer | memberId
client_id = 'client_id_example' # String | 

begin
  # Delete MemberNotificationSetting
  api_instance.delete_system_members_by_parent_id_notification_settings_by_id(id, parent_id, client_id)
rescue ConnectWise::ApiError => e
  puts "Error when calling MemberNotificationSettingsApi->delete_system_members_by_parent_id_notification_settings_by_id: #{e}"
end

Using the delete_system_members_by_parent_id_notification_settings_by_id_with_http_info variant

This returns an Array which contains the response data (nil in this case), status code and headers.

<Array(nil, Integer, Hash)> delete_system_members_by_parent_id_notification_settings_by_id_with_http_info(id, parent_id, client_id)

begin
  # Delete MemberNotificationSetting
  data, status_code, headers = api_instance.delete_system_members_by_parent_id_notification_settings_by_id_with_http_info(id, parent_id, client_id)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => nil
rescue ConnectWise::ApiError => e
  puts "Error when calling MemberNotificationSettingsApi->delete_system_members_by_parent_id_notification_settings_by_id_with_http_info: #{e}"
end

Parameters

Name	Type	Description
id	Integer	notificationSettingId
parent_id	Integer	memberId
client_id	String

Return type

nil (empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: Not defined

get_system_members_by_parent_id_notification_settings

<Array> get_system_members_by_parent_id_notification_settings(parent_id, client_id, opts)

Get List of MemberNotificationSetting

Examples

require 'time'
require 'connect_wise'

api_instance = ConnectWise::MemberNotificationSettingsApi.new
parent_id = 56 # Integer | memberId
client_id = 'client_id_example' # String | 
opts = {
  conditions: 'conditions_example', # String | 
  child_conditions: 'child_conditions_example', # String | 
  custom_field_conditions: 'custom_field_conditions_example', # String | 
  order_by: 'order_by_example', # String | 
  fields: 'fields_example', # String | 
  page: 56, # Integer | 
  page_size: 56, # Integer | 
  page_id: 56 # Integer | 
}

begin
  # Get List of MemberNotificationSetting
  result = api_instance.get_system_members_by_parent_id_notification_settings(parent_id, client_id, opts)
  p result
rescue ConnectWise::ApiError => e
  puts "Error when calling MemberNotificationSettingsApi->get_system_members_by_parent_id_notification_settings: #{e}"
end

Using the get_system_members_by_parent_id_notification_settings_with_http_info variant

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

<Array(<Array>, Integer, Hash)> get_system_members_by_parent_id_notification_settings_with_http_info(parent_id, client_id, opts)

begin
  # Get List of MemberNotificationSetting
  data, status_code, headers = api_instance.get_system_members_by_parent_id_notification_settings_with_http_info(parent_id, client_id, opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <Array<MemberNotificationSetting>>
rescue ConnectWise::ApiError => e
  puts "Error when calling MemberNotificationSettingsApi->get_system_members_by_parent_id_notification_settings_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
parent_id	Integer	memberId
client_id	String
conditions	String		[optional]
child_conditions	String		[optional]
custom_field_conditions	String		[optional]
order_by	String		[optional]
fields	String		[optional]
page	Integer		[optional]
page_size	Integer		[optional]
page_id	Integer		[optional]

Return type

Array<MemberNotificationSetting>

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/vnd.connectwise.com+json; version=2025.1

get_system_members_by_parent_id_notification_settings_by_id

get_system_members_by_parent_id_notification_settings_by_id(id, parent_id, client_id, opts)

Get MemberNotificationSetting

Examples

require 'time'
require 'connect_wise'

api_instance = ConnectWise::MemberNotificationSettingsApi.new
id = 56 # Integer | notificationSettingId
parent_id = 56 # Integer | memberId
client_id = 'client_id_example' # String | 
opts = {
  conditions: 'conditions_example', # String | 
  child_conditions: 'child_conditions_example', # String | 
  custom_field_conditions: 'custom_field_conditions_example', # String | 
  order_by: 'order_by_example', # String | 
  fields: 'fields_example', # String | 
  page: 56, # Integer | 
  page_size: 56, # Integer | 
  page_id: 56 # Integer | 
}

begin
  # Get MemberNotificationSetting
  result = api_instance.get_system_members_by_parent_id_notification_settings_by_id(id, parent_id, client_id, opts)
  p result
rescue ConnectWise::ApiError => e
  puts "Error when calling MemberNotificationSettingsApi->get_system_members_by_parent_id_notification_settings_by_id: #{e}"
end

Using the get_system_members_by_parent_id_notification_settings_by_id_with_http_info variant

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

<Array(, Integer, Hash)> get_system_members_by_parent_id_notification_settings_by_id_with_http_info(id, parent_id, client_id, opts)

begin
  # Get MemberNotificationSetting
  data, status_code, headers = api_instance.get_system_members_by_parent_id_notification_settings_by_id_with_http_info(id, parent_id, client_id, opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <MemberNotificationSetting>
rescue ConnectWise::ApiError => e
  puts "Error when calling MemberNotificationSettingsApi->get_system_members_by_parent_id_notification_settings_by_id_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
id	Integer	notificationSettingId
parent_id	Integer	memberId
client_id	String
conditions	String		[optional]
child_conditions	String		[optional]
custom_field_conditions	String		[optional]
order_by	String		[optional]
fields	String		[optional]
page	Integer		[optional]
page_size	Integer		[optional]
page_id	Integer		[optional]

Return type

MemberNotificationSetting

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/vnd.connectwise.com+json; version=2025.1

get_system_members_by_parent_id_notification_settings_count

get_system_members_by_parent_id_notification_settings_count(parent_id, client_id, opts)

Get Count of MemberNotificationSetting

Examples

require 'time'
require 'connect_wise'

api_instance = ConnectWise::MemberNotificationSettingsApi.new
parent_id = 56 # Integer | memberId
client_id = 'client_id_example' # String | 
opts = {
  conditions: 'conditions_example', # String | 
  child_conditions: 'child_conditions_example', # String | 
  custom_field_conditions: 'custom_field_conditions_example', # String | 
  order_by: 'order_by_example', # String | 
  fields: 'fields_example', # String | 
  page: 56, # Integer | 
  page_size: 56, # Integer | 
  page_id: 56 # Integer | 
}

begin
  # Get Count of MemberNotificationSetting
  result = api_instance.get_system_members_by_parent_id_notification_settings_count(parent_id, client_id, opts)
  p result
rescue ConnectWise::ApiError => e
  puts "Error when calling MemberNotificationSettingsApi->get_system_members_by_parent_id_notification_settings_count: #{e}"
end

Using the get_system_members_by_parent_id_notification_settings_count_with_http_info variant

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

<Array(, Integer, Hash)> get_system_members_by_parent_id_notification_settings_count_with_http_info(parent_id, client_id, opts)

begin
  # Get Count of MemberNotificationSetting
  data, status_code, headers = api_instance.get_system_members_by_parent_id_notification_settings_count_with_http_info(parent_id, client_id, opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <Count>
rescue ConnectWise::ApiError => e
  puts "Error when calling MemberNotificationSettingsApi->get_system_members_by_parent_id_notification_settings_count_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
parent_id	Integer	memberId
client_id	String
conditions	String		[optional]
child_conditions	String		[optional]
custom_field_conditions	String		[optional]
order_by	String		[optional]
fields	String		[optional]
page	Integer		[optional]
page_size	Integer		[optional]
page_id	Integer		[optional]

Return type

Count

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/vnd.connectwise.com+json; version=2025.1

patch_system_members_by_parent_id_notification_settings_by_id

patch_system_members_by_parent_id_notification_settings_by_id(id, parent_id, client_id, patch_operation)

Patch MemberNotificationSetting

Examples

require 'time'
require 'connect_wise'

api_instance = ConnectWise::MemberNotificationSettingsApi.new
id = 56 # Integer | notificationSettingId
parent_id = 56 # Integer | memberId
client_id = 'client_id_example' # String | 
patch_operation = [ConnectWise::PatchOperation.new] # Array<PatchOperation> | List of PatchOperation

begin
  # Patch MemberNotificationSetting
  result = api_instance.patch_system_members_by_parent_id_notification_settings_by_id(id, parent_id, client_id, patch_operation)
  p result
rescue ConnectWise::ApiError => e
  puts "Error when calling MemberNotificationSettingsApi->patch_system_members_by_parent_id_notification_settings_by_id: #{e}"
end

Using the patch_system_members_by_parent_id_notification_settings_by_id_with_http_info variant

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

<Array(, Integer, Hash)> patch_system_members_by_parent_id_notification_settings_by_id_with_http_info(id, parent_id, client_id, patch_operation)

begin
  # Patch MemberNotificationSetting
  data, status_code, headers = api_instance.patch_system_members_by_parent_id_notification_settings_by_id_with_http_info(id, parent_id, client_id, patch_operation)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <MemberNotificationSetting>
rescue ConnectWise::ApiError => e
  puts "Error when calling MemberNotificationSettingsApi->patch_system_members_by_parent_id_notification_settings_by_id_with_http_info: #{e}"
end

Parameters

Name	Type	Description
id	Integer	notificationSettingId
parent_id	Integer	memberId
client_id	String
patch_operation	Array<PatchOperation>	List of PatchOperation

Return type

MemberNotificationSetting

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/vnd.connectwise.com+json; version=2025.1

post_system_members_by_parent_id_notification_settings

post_system_members_by_parent_id_notification_settings(parent_id, client_id, member_notification_setting)

Post MemberNotificationSetting

Examples

require 'time'
require 'connect_wise'

api_instance = ConnectWise::MemberNotificationSettingsApi.new
parent_id = 56 # Integer | memberId
client_id = 'client_id_example' # String | 
member_notification_setting = ConnectWise::MemberNotificationSetting.new({notification_type: 'Email', notification_trigger: 'ActivityStatusReq'}) # MemberNotificationSetting | memberNotificationSetting

begin
  # Post MemberNotificationSetting
  result = api_instance.post_system_members_by_parent_id_notification_settings(parent_id, client_id, member_notification_setting)
  p result
rescue ConnectWise::ApiError => e
  puts "Error when calling MemberNotificationSettingsApi->post_system_members_by_parent_id_notification_settings: #{e}"
end

Using the post_system_members_by_parent_id_notification_settings_with_http_info variant

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

<Array(, Integer, Hash)> post_system_members_by_parent_id_notification_settings_with_http_info(parent_id, client_id, member_notification_setting)

begin
  # Post MemberNotificationSetting
  data, status_code, headers = api_instance.post_system_members_by_parent_id_notification_settings_with_http_info(parent_id, client_id, member_notification_setting)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <MemberNotificationSetting>
rescue ConnectWise::ApiError => e
  puts "Error when calling MemberNotificationSettingsApi->post_system_members_by_parent_id_notification_settings_with_http_info: #{e}"
end

Parameters

Name	Type	Description
parent_id	Integer	memberId
client_id	String
member_notification_setting	MemberNotificationSetting	memberNotificationSetting

Return type

MemberNotificationSetting

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/vnd.connectwise.com+json; version=2025.1

put_system_members_by_parent_id_notification_settings_by_id

put_system_members_by_parent_id_notification_settings_by_id(id, parent_id, client_id, member_notification_setting)

Put MemberNotificationSetting

Examples

require 'time'
require 'connect_wise'

api_instance = ConnectWise::MemberNotificationSettingsApi.new
id = 56 # Integer | notificationSettingId
parent_id = 56 # Integer | memberId
client_id = 'client_id_example' # String | 
member_notification_setting = ConnectWise::MemberNotificationSetting.new({notification_type: 'Email', notification_trigger: 'ActivityStatusReq'}) # MemberNotificationSetting | memberNotificationSetting

begin
  # Put MemberNotificationSetting
  result = api_instance.put_system_members_by_parent_id_notification_settings_by_id(id, parent_id, client_id, member_notification_setting)
  p result
rescue ConnectWise::ApiError => e
  puts "Error when calling MemberNotificationSettingsApi->put_system_members_by_parent_id_notification_settings_by_id: #{e}"
end

Using the put_system_members_by_parent_id_notification_settings_by_id_with_http_info variant

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

<Array(, Integer, Hash)> put_system_members_by_parent_id_notification_settings_by_id_with_http_info(id, parent_id, client_id, member_notification_setting)

begin
  # Put MemberNotificationSetting
  data, status_code, headers = api_instance.put_system_members_by_parent_id_notification_settings_by_id_with_http_info(id, parent_id, client_id, member_notification_setting)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <MemberNotificationSetting>
rescue ConnectWise::ApiError => e
  puts "Error when calling MemberNotificationSettingsApi->put_system_members_by_parent_id_notification_settings_by_id_with_http_info: #{e}"
end

Parameters

Name	Type	Description
id	Integer	notificationSettingId
parent_id	Integer	memberId
client_id	String
member_notification_setting	MemberNotificationSetting	memberNotificationSetting

Return type

MemberNotificationSetting

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/vnd.connectwise.com+json; version=2025.1

FilesExpand file tree

MemberNotificationSettingsApi.md

Latest commit

History

MemberNotificationSettingsApi.md

File metadata and controls

ConnectWise::MemberNotificationSettingsApi

delete_system_members_by_parent_id_notification_settings_by_id

Examples

Using the delete_system_members_by_parent_id_notification_settings_by_id_with_http_info variant

Parameters

Return type

Authorization

HTTP request headers

get_system_members_by_parent_id_notification_settings

Examples

Using the get_system_members_by_parent_id_notification_settings_with_http_info variant

Parameters

Return type

Authorization

HTTP request headers

get_system_members_by_parent_id_notification_settings_by_id

Examples

Using the get_system_members_by_parent_id_notification_settings_by_id_with_http_info variant

Parameters

Return type

Authorization

HTTP request headers

get_system_members_by_parent_id_notification_settings_count

Examples

Using the get_system_members_by_parent_id_notification_settings_count_with_http_info variant

Parameters

Return type

Authorization

HTTP request headers

patch_system_members_by_parent_id_notification_settings_by_id

Examples

Using the patch_system_members_by_parent_id_notification_settings_by_id_with_http_info variant

Parameters

Return type

Authorization

HTTP request headers

post_system_members_by_parent_id_notification_settings

Examples

Using the post_system_members_by_parent_id_notification_settings_with_http_info variant

Parameters

Return type

Authorization

HTTP request headers

put_system_members_by_parent_id_notification_settings_by_id

Examples

Using the put_system_members_by_parent_id_notification_settings_by_id_with_http_info variant

Parameters

Return type

Authorization

HTTP request headers