Contacts

Organization-wide contact management across all clients. Provides CRUD operations for contacts that can be associated with multiple clients. Includes an endpoint to retrieve all clients associated with a specific contact, enabling tracking of contact relationships across the tenant's client base.

OpenAPI Spec

Guides Operations Schemas

GET List Contacts
Lists all Contacts for the given tenant. Requires: ViewAll on Contacts.
/tenants/{tenant}/contacts
POST Create Contact
Creates a new Contact for the specified tenant. Requires: Create on Contacts.
/tenants/{tenant}/contacts
DELETE Bulk Delete Contacts
Deletes multiple contacts at once, removing any client portal access they have. Contacts still linked to a client are not deleted and are returned in ...
/tenants/{tenant}/contacts
GET Get Contact
Gets a Contact for the specified tenant. Requires: ViewAll on Contacts.
/tenants/{tenant}/contacts/{code}
PUT Update Contact
Updates a Contact for the specified tenant. Requires: Update on Contacts.
/tenants/{tenant}/contacts/{code}
DELETE Delete Contact
Deletes a Contact for the specified tenant. Requires: Delete on Contacts.
/tenants/{tenant}/contacts/{code}
GET List Contact Clients
Returns a list of clients that have the specified contact associated with them Requires: ViewAll on ClientContacts and ViewAll on Clients.
/tenants/{tenant}/contacts/{code}/clients
POST Match Contacts
Given a batch of people - a company's Companies House officers, typically - returns the existing contacts that could be each of them, with how sure we...
/tenants/{tenant}/contacts/match
GET Preview Contact Merge
Shows what this contact would look like with the contacts in `with` (repeated, 1 to 5) merged into it: each field's values, every email and phone numb...
/tenants/{tenant}/contacts/{code}/merge
POST Merge Contacts
Merges the listed contacts into this contact and saves it exactly as `contact` (a full replace). Their client links move to this contact, or combine w...
/tenants/{tenant}/contacts/{code}/merge