Close

A .NET Core API client for Close, supporting .NET Core 6/7/8. This is not an official project by Close. It's created and maintained by Telzio, because the API client mentioned in Close' docs hasn't been updated in 7+ years.

Usage

The client currently targets .NET Core 6+.

Dependency Injection

Add the client to your service collection and specify your API Key.

builder.Services.AddCloseClient("xxxxxxxxxxxx");

Important: You should never keep your credentials in your source code. Use a secrets manager instead!

Custom Fields

You can specify custom fields for leads, contacts, opportunities, and custom objects by creating your own classes that inherit from these main classes and decorating your properties with [JsonPropertyName("custom.cf_XXXXXXXXXX")]. The client will automatically serialize and deserialize the custom fields for you.

public class AccountCustomObject : CustomObject
{
    [JsonPropertyName("custom.cf_XXXXXXXXXXXXXXXXXXX")]
    public string AccountId { get; set; }

    [JsonPropertyName("custom.cf_YYYYYYYYYYYYYYYYYYY")]
    public string AccountStatus { get; set; }
} 

---

Work In Progress

We are currently working on migrating code from a client library we made internally at Telzio. Below is a list of what's currently implemented and what's in progress.

Leads

• List leads
• Create a new lead
• Retrieve a single lead
• Update an existing lead
• Delete a lead
• Merge two leads

Contacts

• List contacts
• Create a new contact
• Retrieve a single contact
• Update an existing contact
• Delete a contact

Pipelines

• List or filter pipelines
• Create a pipeline
• Retrieve a pipeline
• Update a pipeline
• Delete a pipeline

Opportunities

• List or filter opportunities
• Create an opportunity
• Retrieve an opportunity
• Update an existing opportunity
• Delete an opportunity

Custom Object Instances

• List custom object instances
• Create a custom object instance
• Retrieve a custom object instance
• Update a custom object instance
• Delete a custom object instance

Tasks

• List or filter tasks
• Create a task
• Retrieve a task
• Update an existing task
• Delete a task

Lead Statuses

• List lead statuses for your organization
• Create new status that can be applied to leads
• Rename a lead status
• Delete a lead status

Opportunity Statuses

• List opportunity statuses for your organization
• Create new status tht can be applied to opportunities
• Rename an opportunity status
• Delete an opportunity status

Integration Links

• List integration links
• Create an integration link
• Update an integration link
• Delete an integration link

Event Log

• List Events
• Retrieve Event

Not Yet Implemented

• Groups
• Reporting
• Email Templates
• SMS Templates
• Connected Accounts
• Memberships
• Users
• Organizations
• Roles
• Custom Fields
• Send As
• Sequences
• Dialer
• Smart Views
• Bulk Actions
• Integration Links
• Exports
• Phone Numbers
• Webhook Subscriptions
• Custom Activities