Skip to content

Manage clients, notes and tags

Use this guide to update clients and to manage client notes, tags and tag groups.

For a compact V2 client list, use GET /clients/?fields=id,email. The optional fields parameter selects comma-separated public output names; omission returns the full client representation. Empty, duplicate or unknown names and repeated fields parameters return 400. Values and nulls retain their usual meaning; phone_number is still absent when no phone exists. Filters, company isolation and the pagination envelope, including next_page, are unchanged. If combining field selection with expand[], select every expanded root field as well.

PATCH /clients/{id}/ updates the supported client fields. Email is accepted at creation and is read-only afterward: sending it in a PATCH returns 400. is_email_accepted reports marketing-email consent and can be set at creation or updated independently. Tags and billing venues must belong to the authenticated company. Otherwise the request is rejected before any change is written.

Client notes, tags and tag groups support PATCH and DELETE.

Resource What to know
Notes Creating a note for an unknown client or a client of another company is rejected before any write. Responses expose the date as creation_date.
Tags color is required and must be lowercase hexadecimal in #rrggbb format. The tag group must belong to the authenticated company. Deleting a tag removes its usages.
Tag groups Duplicate names and franchisor-managed groups are rejected without a partial write. Deleting a group deletes its tags.