Connectwise::ContactsApi

All URIs are relative to https://api-na.myconnectwise.net/v4_6_release/apis/3.0

Method	HTTP request	Description
company_contacts_count_get	GET /company/contacts/count
company_contacts_get	GET /company/contacts
company_contacts_id_delete	DELETE /company/contacts/{id}
company_contacts_id_get	GET /company/contacts/{id}
company_contacts_id_image_get	GET /company/contacts/{id}/image
company_contacts_id_patch	PATCH /company/contacts/{id}
company_contacts_id_portal_security_get	GET /company/contacts/{id}/portalSecurity
company_contacts_id_put	PUT /company/contacts/{id}
company_contacts_post	POST /company/contacts
company_contacts_request_password_post	POST /company/contacts/requestPassword
company_contacts_validate_portal_credentials_post	POST /company/contacts/validatePortalCredentials

company_contacts_count_get

Count company_contacts_count_get(opts)

Get Contacts Count

Example

# load the gem
require 'connectwise-ruby-sdk'
# setup authorization
Connectwise.configure do |config|
  # Configure HTTP basic authorization: BasicAuth
  config.username = 'YOUR USERNAME'
  config.password = 'YOUR PASSWORD'
end

api_instance = Connectwise::ContactsApi.new

opts = { 
  conditions: "conditions_example" # String | 
}

begin
  result = api_instance.company_contacts_count_get(opts)
  p result
rescue Connectwise::ApiError => e
  puts "Exception when calling ContactsApi->company_contacts_count_get: #{e}"
end

Parameters

Name	Type	Description	Notes
conditions	String		[optional]

Return type

Count

Authorization

BasicAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

company_contacts_get

Array<Contact> company_contacts_get(opts)

Get Contacts

Example

# load the gem
require 'connectwise-ruby-sdk'
# setup authorization
Connectwise.configure do |config|
  # Configure HTTP basic authorization: BasicAuth
  config.username = 'YOUR USERNAME'
  config.password = 'YOUR PASSWORD'
end

api_instance = Connectwise::ContactsApi.new

opts = { 
  conditions: "conditions_example" # String | 
  order_by: "order_by_example", # String | 
  page: 56, # Integer | 
  page_size: 56 # Integer | 
}

begin
  result = api_instance.company_contacts_get(opts)
  p result
rescue Connectwise::ApiError => e
  puts "Exception when calling ContactsApi->company_contacts_get: #{e}"
end

Parameters

Name	Type	Notes
conditions	String	[optional]
order_by	String	[optional]
page	Integer	[optional]
page_size	Integer	[optional]

Return type

Array<Contact>

Authorization

BasicAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

company_contacts_id_delete

company_contacts_id_delete(id, opts)

Delete Contact By Id

Example

# load the gem
require 'connectwise-ruby-sdk'
# setup authorization
Connectwise.configure do |config|
  # Configure HTTP basic authorization: BasicAuth
  config.username = 'YOUR USERNAME'
  config.password = 'YOUR PASSWORD'
end

api_instance = Connectwise::ContactsApi.new

id = 56 # Integer | 

opts = { 
  transfer_contact_id: 56 # Integer | 
}

begin
  api_instance.company_contacts_id_delete(id, opts)
rescue Connectwise::ApiError => e
  puts "Exception when calling ContactsApi->company_contacts_id_delete: #{e}"
end

Parameters

Name	Type	Description	Notes
id	Integer
transfer_contact_id	Integer		[optional]

Return type

nil (empty response body)

Authorization

BasicAuth

HTTP request headers

Content-Type: Not defined
Accept: Not defined

company_contacts_id_get

Contact company_contacts_id_get(id)

Get Contact By Id

Example

# load the gem
require 'connectwise-ruby-sdk'
# setup authorization
Connectwise.configure do |config|
  # Configure HTTP basic authorization: BasicAuth
  config.username = 'YOUR USERNAME'
  config.password = 'YOUR PASSWORD'
end

api_instance = Connectwise::ContactsApi.new

id = 56 # Integer | 


begin
  result = api_instance.company_contacts_id_get(id)
  p result
rescue Connectwise::ApiError => e
  puts "Exception when calling ContactsApi->company_contacts_id_get: #{e}"
end

Parameters

Name	Type	Description	Notes
id	Integer

Return type

Contact

Authorization

BasicAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

company_contacts_id_image_get

company_contacts_id_image_get(id, opts)

Get Contact Image

Example

# load the gem
require 'connectwise-ruby-sdk'
# setup authorization
Connectwise.configure do |config|
  # Configure HTTP basic authorization: BasicAuth
  config.username = 'YOUR USERNAME'
  config.password = 'YOUR PASSWORD'
end

api_instance = Connectwise::ContactsApi.new

id = 56 # Integer | 

opts = { 
  use_default_flag: true, # BOOLEAN | 
  last_modified: "last_modified_example" # String | 
}

begin
  api_instance.company_contacts_id_image_get(id, opts)
rescue Connectwise::ApiError => e
  puts "Exception when calling ContactsApi->company_contacts_id_image_get: #{e}"
end

Parameters

Name	Type	Notes
id	Integer
use_default_flag	BOOLEAN	[optional]
last_modified	String	[optional]

Return type

nil (empty response body)

Authorization

BasicAuth

HTTP request headers

Content-Type: Not defined
Accept: application/octet-stream

company_contacts_id_patch

Contact company_contacts_id_patch(id, operations)

Update Contact

Example

# load the gem
require 'connectwise-ruby-sdk'
# setup authorization
Connectwise.configure do |config|
  # Configure HTTP basic authorization: BasicAuth
  config.username = 'YOUR USERNAME'
  config.password = 'YOUR PASSWORD'
end

api_instance = Connectwise::ContactsApi.new

id = 56 # Integer | 

operations = [Connectwise::PatchOperation.new] # Array<PatchOperation> | 


begin
  result = api_instance.company_contacts_id_patch(id, operations)
  p result
rescue Connectwise::ApiError => e
  puts "Exception when calling ContactsApi->company_contacts_id_patch: #{e}"
end

Parameters

Name	Type	Description	Notes
id	Integer
operations	Array<PatchOperation>

Return type

Contact

Authorization

BasicAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

company_contacts_id_portal_security_get

Array<PortalSecurity> company_contacts_id_portal_security_get(id)

Get Portal Security

Example

# load the gem
require 'connectwise-ruby-sdk'
# setup authorization
Connectwise.configure do |config|
  # Configure HTTP basic authorization: BasicAuth
  config.username = 'YOUR USERNAME'
  config.password = 'YOUR PASSWORD'
end

api_instance = Connectwise::ContactsApi.new

id = 56 # Integer | 


begin
  result = api_instance.company_contacts_id_portal_security_get(id)
  p result
rescue Connectwise::ApiError => e
  puts "Exception when calling ContactsApi->company_contacts_id_portal_security_get: #{e}"
end

Parameters

Name	Type	Description	Notes
id	Integer

Return type

Array<PortalSecurity>

Authorization

BasicAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

company_contacts_id_put

Contact company_contacts_id_put(id, contact)

Replace Contact

Example

# load the gem
require 'connectwise-ruby-sdk'
# setup authorization
Connectwise.configure do |config|
  # Configure HTTP basic authorization: BasicAuth
  config.username = 'YOUR USERNAME'
  config.password = 'YOUR PASSWORD'
end

api_instance = Connectwise::ContactsApi.new

id = 56 # Integer | 

contact = Connectwise::Contact.new # Contact | 


begin
  result = api_instance.company_contacts_id_put(id, contact)
  p result
rescue Connectwise::ApiError => e
  puts "Exception when calling ContactsApi->company_contacts_id_put: #{e}"
end

Parameters

Name	Type	Description	Notes
id	Integer
contact	Contact

Return type

Contact

Authorization

BasicAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

company_contacts_post

Contact company_contacts_post(contact)

Create Contact

Example

# load the gem
require 'connectwise-ruby-sdk'
# setup authorization
Connectwise.configure do |config|
  # Configure HTTP basic authorization: BasicAuth
  config.username = 'YOUR USERNAME'
  config.password = 'YOUR PASSWORD'
end

api_instance = Connectwise::ContactsApi.new

contact = Connectwise::Contact.new # Contact | 


begin
  result = api_instance.company_contacts_post(contact)
  p result
rescue Connectwise::ApiError => e
  puts "Exception when calling ContactsApi->company_contacts_post: #{e}"
end

Parameters

Name	Type	Description	Notes
contact	Contact

Return type

Contact

Authorization

BasicAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

company_contacts_request_password_post

company_contacts_request_password_post(request)

Request Password

Example

# load the gem
require 'connectwise-ruby-sdk'
# setup authorization
Connectwise.configure do |config|
  # Configure HTTP basic authorization: BasicAuth
  config.username = 'YOUR USERNAME'
  config.password = 'YOUR PASSWORD'
end

api_instance = Connectwise::ContactsApi.new

request = Connectwise::RequestPasswordRequest.new # RequestPasswordRequest | 


begin
  api_instance.company_contacts_request_password_post(request)
rescue Connectwise::ApiError => e
  puts "Exception when calling ContactsApi->company_contacts_request_password_post: #{e}"
end

Parameters

Name	Type	Description	Notes
request	RequestPasswordRequest

Return type

nil (empty response body)

Authorization

BasicAuth

HTTP request headers

Content-Type: application/json
Accept: Not defined

company_contacts_validate_portal_credentials_post

ValidatePortalResponse company_contacts_validate_portal_credentials_post(request)

Validate Portal Credentials

Example

# load the gem
require 'connectwise-ruby-sdk'
# setup authorization
Connectwise.configure do |config|
  # Configure HTTP basic authorization: BasicAuth
  config.username = 'YOUR USERNAME'
  config.password = 'YOUR PASSWORD'
end

api_instance = Connectwise::ContactsApi.new

request = Connectwise::ValidatePortalRequest.new # ValidatePortalRequest | 


begin
  result = api_instance.company_contacts_validate_portal_credentials_post(request)
  p result
rescue Connectwise::ApiError => e
  puts "Exception when calling ContactsApi->company_contacts_validate_portal_credentials_post: #{e}"
end

Parameters

Name	Type	Description	Notes
request	ValidatePortalRequest

Return type

ValidatePortalResponse

Authorization

BasicAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

Files

ContactsApi.md

Latest commit

History

ContactsApi.md

File metadata and controls

Connectwise::ContactsApi

company_contacts_count_get

Example

Parameters

Return type

Authorization

HTTP request headers

company_contacts_get

Example

Parameters

Return type

Authorization

HTTP request headers

company_contacts_id_delete

Example

Parameters

Return type

Authorization

HTTP request headers

company_contacts_id_get

Example

Parameters

Return type

Authorization

HTTP request headers

company_contacts_id_image_get

Example

Parameters

Return type

Authorization

HTTP request headers

company_contacts_id_patch

Example

Parameters

Return type

Authorization

HTTP request headers

company_contacts_id_portal_security_get

Example

Parameters

Return type

Authorization

HTTP request headers

company_contacts_id_put

Example

Parameters

Return type

Authorization

HTTP request headers

company_contacts_post

Example

Parameters

Return type

Authorization

HTTP request headers

company_contacts_request_password_post

Example

Parameters

Return type

Authorization

HTTP request headers

company_contacts_validate_portal_credentials_post

Example

Parameters

Return type

Authorization

HTTP request headers