Clients
Update a client
Change a client's name, email, phone number, birthdate or time zone through the Quenza API. Only the fields you send are changed.
Send only the fields you want to change; the others stay as they are. To clear an optional field, such as the phone number, send null.
The client’s language cannot be changed through the API. A new email address must not belong to another client in your workspace.
Path parameters
clientstringRequiredThe client’s ID, such as
8GJ4D9KQ.
Request body
emailstringNew email address. It must not belong to another client in your workspace.
Up to 255 characters. A valid email address.
first_namestringFirst name.
Up to 255 characters.
last_namestringLast name.
Up to 255 characters.
phonestringor nullPhone number as free text, such as
+31 6 1234 5678, ornull.Up to 50 characters.
genderstringGender, or
nullto clear it.One of
male,female,other.gender_identitystringor nullHow the client describes their gender, as free text, or
nullto clear it.Up to 255 characters.
birthdatestringor nullDate of birth as
YYYY-MM-DD, at most 120 years ago and before today, ornullto clear it.Format
YYYY-MM-DD.timezonestringTime zone as an IANA name, such as
Europe/Amsterdam. Cannot benull.One of 419 values, listed in the OpenAPI file.
Response
200 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.