patch/clerk/api/client/{id}/

Request

  • The document declares no server URL.
  • Auth: none declared

Path parameters

idstring uuid required

Entity ID

Request body

first_namestring
last_namestring
emailstring
date_of_birthstring nullable
preferred_namestring nullable
phone_numberstring
genderstring nullable
pronounsstring nullable
centrelink_supportboolean
eligibility_notesstring
primary_language_non_englishboolean
primary_languagestring
number_of_dependentsnumber nullable
notesstring
urlstring
ageinteger nullable
full_namestring
contact_notesstring
contact_restrictionstring
requires_interpreterstring
is_aboriginal_or_torres_strait_islanderstring
call_timesstring[]
eligibility_circumstancesstring[]

Response

Successful response.

idstring uuid required
first_namestring required
last_namestring required
emailstring required
date_of_birthstring nullable required
preferred_namestring nullable required
phone_numberstring required
genderstring nullable required
pronounsstring nullable required
centrelink_supportboolean required
eligibility_notesstring required
primary_language_non_englishboolean required
primary_languagestring required
number_of_dependentsnumber nullable required
notesstring required
urlstring required
ageinteger nullable required
full_namestring required
contact_notesstring

Changes

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • breaking

      the request's body type changed from no type to object

    • breaking

      the response's body type changed from no type to object for status

    • warning

      removed subschema #2 from the request body allOf list

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      removed subschema #2 from the response body allOf list for the response status

    • info

      added the optional property to the response with the status

    • info

      response property detail list-of-types was narrowed by removing types array and object from media type application/json of response 400

    • info

      response property detail list-of-types was narrowed by removing types array and object from media type application/json of response 403

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status