Clients
Create a client
Add a client to your Quenza workspace through the API. Quenza sends their invitation email and assigns them to the token's professional.
Creates the client and sends them an invitation email to set up their account, in the language you choose. Until they accept it, their status is pending.
What else happens:
- The client is assigned to the professional who owns the API token.
- The Client Created webhook fires, like for a client you add by hand.
- The client counts towards your plan’s client limit. When all places are taken, the request fails with
422andLimit reached; see Errors.
An email address can belong to only one client in your workspace. Sync clients from your CRM shows what to do when it is taken.
Request body
emailstringRequiredQuenza sends the invitation to this address. It must not belong to another client in your workspace.
Up to 255 characters. A valid email address.
first_namestringRequiredFirst name.
Up to 255 characters.
last_namestringRequiredLast name.
Up to 255 characters.
phonestringor nullPhone number as free text, such as
+31 6 1234 5678, ornull.Up to 50 characters.
genderstringGender.
One of
male,female,other.gender_identitystringor nullHow the client describes their gender, as free text.
Up to 255 characters.
birthdatestringor nullDate of birth as
YYYY-MM-DD, before today.Format
YYYY-MM-DD.timezonestringor nullTime zone as an IANA name, such as
Europe/Amsterdam. Defaults to the time zone of the professional who owns the API token.One of 419 values, listed in the OpenAPI file.
language_codestringor nullLanguage of the invitation and the client app. Defaults to English (
en).One of
de,nl,en,es,fr,it,pt,fi.
Response
201 with the client in data:
idstringThe client’s ID. Use it in the URL of the other client endpoints and to add the client to a group.
emailstringEmail address, unique in your workspace.
first_namestringFirst name.
last_namestringLast name.
statusstringpendinguntil the client accepts the invitation, thenactive.archivedafter you archive the client.One of
active,pending,archived.is_guestbooleanWhether the client is a guest without a login. Clients created through the API are never guests.
timezonestringTime zone as an IANA name, such as
Europe/Amsterdam.phonestringor nullPhone number as free text, such as
+31 6 1234 5678, ornull.genderstringor nullGender, or
null.One of
male,female,other.gender_identitystringor nullHow the client describes their gender, as free text, or
null.birthdatestringor nullDate of birth as
YYYY-MM-DD, ornull.Format
YYYY-MM-DD.invited_atstringor nullWhen the invitation email was sent.
ISO 8601 date and time in UTC.
invitation_accepted_atstringor nullWhen the invitation was accepted, or
nullwhile it is pending.ISO 8601 date and time in UTC.
archived_atstringor nullWhen it was archived, or
null.ISO 8601 date and time in UTC.
created_atstringWhen it was created.
ISO 8601 date and time in UTC.
updated_atstringWhen it was last changed.
ISO 8601 date and time in UTC.
Status codes
Was this article helpful?
Thanks for letting us know.
Thank you. We read every answer and use it to improve this article.