Rename this user — pushes to WorkOS and heals proposition prose, same as the Vaadin profile editor

PUT

/api/v1/profile/display-name

const url = 'http://localhost:11044/api/v1/profile/display-name';
const options = {
  method: 'PUT',
  headers: {'X-Embabel-Api-Key': '<X-Embabel-Api-Key>', 'Content-Type': 'application/json'},
  body: '{"name":"example"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request PUT \
  --url http://localhost:11044/api/v1/profile/display-name \
  --header 'Content-Type: application/json' \
  --header 'X-Embabel-Api-Key: <X-Embabel-Api-Key>' \
  --data '{ "name": "example" }'

Authorizations

apiKeyAuth
basicAuth

Request Body^required

The new display name in name, trimmed. It is pushed to WorkOS and proposition prose naming the user is updated to match. Blank is a 400: a display name cannot be cleared

application/json

A new display name, the body of PUT /profile/display-name

object

name

required

The new name, trimmed. Must not be blank. It is pushed to WorkOS, and stored memories that mention the old name are rewritten to the new one

string

Example ^generated

{
  "name": "example"
}

Responses

400

The name is blank. A display name is never cleared by sending an empty one

*/*

A refusal from the account surface. Carries only the reason; the status code is the only other fact and the body does not repeat it

object

error