Input fields

dateOfBirth : Date
details : [DetailsInputType]

User details.
email : String
familyName : String
givenName : String
label : String

A free text field to help identifying the customer (e.g. for a job title).
landline : String

Because this field is clearable, null and the empty string are treated differently; passing null or omitting the field leaves the value as-is, but explicitly passing an empty string clears this value.
mobile : String

Because this field is clearable, null and the empty string are treated differently; passing null or omitting the field leaves the value as-is, but explicitly passing an empty string clears this value.
pronouns : String

How the user would like us to address them (e.g. 'she/her', 'they/them'). Because this field is clearable, null and the empty string are treated differently; passing null or omitting the field leaves the value as-is, but explicitly passing an empty string clears this value.
title : String

The user's title.
userId : String

The user for whom to perform the update. This is only needed when using an Organisation role.
The example data in the variables and responses below are autogenerated values designed to resemble real inputs. They do not represent actual customer data, and in some cases may require additional validation.

Example

{ "dateOfBirth": "2023-08-26", "details": DetailsInputType, "email": "doctor-go-before-friend-already", "familyName": "Kirby", "givenName": "Alexandria", "label": "past-friend-occur-involve-find", "landline": "kind-during-seek-agree-may", "mobile": "build-employee-not-foot-method", "pronouns": "Congress-family-ball-lay-human", "title": "sport-white-tend-question-professor", "userId": "23793890" }