Digital Toolkit


Consumer API > API Reference > v0 > User > Details

PATCH /users/{userId}

Allows to partial update the user. The only property supported at this moment is the preferred name. This works as a JSON merge PATCH (, where only the fields available in the request will be updated. Optional fields can be cleared out by sending a null. Examples:

  • Delete the preferred name
{ "preferredName": null }
  • Update the preferred name
{  "preferredName": "Husband" }
  • No changes

Have a Question?
Have a how-to question? Seeing a weird error? Get help on StackOverflow.
Register for the Digital Toolkit Meetup where we answer technical Q&A from the audience.
Last updated Wed May 26 2021