Soenneker.HighLevel.Contacts 11.0.314

Soenneker.HighLevel.Contacts

Upsert, search, retrieve, update, and delete HighLevel contacts through typed request and response models.

Install

dotnet add package Soenneker.HighLevel.Contacts

Register

using Soenneker.HighLevel.Contacts.Registrars;

services.AddHighLevelContactsUtilAsScoped();

The scoped registration keeps the underlying HighLevel client provider singleton, so disposing a scope does not tear down clients reused by later scopes. Use AddHighLevelContactsUtilAsSingleton() when the contact service itself should live for the application lifetime.

Set HighLevel:LogEnabled to true to emit operation-level logs. API keys are supplied per method call, allowing one service instance to work with multiple HighLevel accounts.

Upsert a contact

using Soenneker.HighLevel.Contacts.Abstract;
using Soenneker.HighLevel.OpenApiClient.Models;

var contact = new UpsertContactDto
{
    LocationId = locationId,
    Email = "person@example.com",
    FirstName = "Morgan",
    LastName = "Lee"
};

UpsertContactsSuccessfulResponseDto? response = await contacts.Upsert(
    apiKey,
    contact,
    cancellationToken);

Upsert and Update normalize a non-null email address to lowercase on the supplied model before sending it.

Look up a contact

ContactsByIdSuccessfulResponseDto? byId = await contacts.GetById(
    apiKey,
    contactId,
    cancellationToken);

ContactsSearchSchema? byEmail = await contacts.GetByEmail(
    apiKey,
    "person@example.com",
    locationId,
    cancellationToken);

GetByEmail performs an advanced search limited to one result and returns the first contact, or null when the response contains no match.

Other operations

ContactsSearchSuccessfulResponseDto? matches = await contacts.Search(
    apiKey,
    searchRequest,
    cancellationToken);

UpdateContactsSuccessfulResponseDto? updated = await contacts.Update(
    apiKey,
    contactId,
    updateRequest,
    cancellationToken);

DeleteContactsSuccessfulResponseDto? deleted = await contacts.Delete(
    apiKey,
    contactId,
    cancellationToken);

HighLevel error responses are surfaced as exceptions by the generated client; a nullable result means the API returned no usable response body, not that an error was suppressed.