Zendesk Sell is a Ruby client for the Zendesk Sell (Sales CRM) API. This gem provides a robust and modular interface to interact with Zendesk Sell’s resources—such as leads, deals, contacts, companies, tasks, and users—using Faraday for HTTP requests.
Add this line to your application's Gemfile:
gem 'zendesk_sell'Then execute:
bundle installOr install it yourself via:
gem install zendesk_sellThe client uses the SELL_ACCESS_TOKEN environment variable by default. You can also pass the token directly when initializing the client.
Using an Environment Variable
Set your token in your shell or Rails application configuration:
export SELL_ACCESS_TOKEN="your_actual_sell_access_token"client = ZendeskSell::Client.new(access_token: 'your_actual_sell_access_token')The zendesk_sell gem supports the following API endpoints:
- Leads: Manage potential customers and track leads.
- Deals: Create, update, and manage business opportunities.
- Contacts: Access and manage contact information for individuals.
- Companies: Organize and maintain details about companies or organizations.
- Tasks: Manage tasks and activities related to your sales process.
- Users: Retrieve and manage information about users in your Zendesk Sell account.
Below are several examples demonstrating how to use the client with various Zendesk Sell resources.
List All Leads
client = ZendeskSell::Client.new
leads = client.leads.list(page: 1, per_page: 20)
puts leadsList All Deals
deals = client.deals.list(page: 1, per_page: 20)
puts dealsRetrieve a Specific Lead
lead_id = 123
lead = client.leads.find(lead_id)
puts "Lead Details: #{lead}"Retrieve a Specific Contact
contact_id = 456
contact = client.contacts.find(contact_id)
puts "Contact Details: #{contact}"Create a New Lead
new_lead_attributes = {
first_name: "Alice",
last_name: "Smith",
email: "[email protected]",
phone: "+11234567890"
}
created_lead = client.leads.create(new_lead_attributes)
puts "Created Lead: #{created_lead}"Create a New Deal
new_deal_attributes = {
title: "New Business Opportunity",
value: 5000,
currency: "USD"
}
created_deal = client.deals.create(new_deal_attributes)
puts "Created Deal: #{created_deal}"Update an Existing Lead
lead_id = 123
updated_attributes = { name: "Jane Doe", phone: "+1987654321" }
updated_lead = client.leads.update(lead_id, updated_attributes)
puts "Updated Lead: #{updated_lead}"Update a Company
company_id = 789
updated_company_attributes = { name: "Acme Corp", industry: "Technology" }
updated_company = client.companies.update(company_id, updated_company_attributes)
puts "Updated Company: #{updated_company}"Delete a Lead
lead_id = 123
client.leads.delete(lead_id)Delete a Deal
deal_id = 456
client.deals.delete(deal_id)begin
lead = client.leads.find(9999) # Assuming 9999 is an invalid ID
rescue ZendeskSell::Errors::ApiError => e
puts "API Error: #{e.message}"
rescue ZendeskSell::Errors::ConnectionError => e
puts "Connection Error: #{e.message}"
endresults = client.leads.search(
{
"filter" => {
"filter" => {
"attribute" => { "name" => "email" },
"parameter" => { "eq" => "[email protected]" }
}
},
"projection" => [
{ "name" => "id" },
{ "name" => "name" },
{ "name" => "email" }
]
}
)bundle exec rspecBug reports and pull requests are welcome on GitHub at https://github.com/RTJ/zendesk_sell.
License
This gem is available as open source under the terms of the MIT License.