Rename the authenticated caller

Sets or clears the caller’s own name. A user is one person across every organization they belong to, so the name shows in each of them. A later sign-in names a user who has none from the identity provider, and never replaces a name.

PATCH/v1/me

Authorization

AuthorizationBearer token · headerrequired

Request body

requiredapplication/json

display_namestring | nullrequired

The caller's new name, trimmed of surrounding whitespace, or `null` to clear it.

min length 1 · max length 200

Responses

200Renamed.

organizationMeOrgBodyrequired

Show properties

handlestringrequired

idstring<uuid>required

namestringrequired

roleOrgRoleBodyrequired

What a member may do in the organization. An admin manages members, invitations, and billing; a member does not.

Allowed:adminmember

userMeUserBodyrequired

Show properties

display_namestring | nullrequired

idstring<uuid>required

primary_emailstring | nullrequired

400Malformed body, or a name blank or outside the bound.

errorErrorDetailrequired

What went wrong: a `code` to branch on and a `message` to show. The message is written for a person and may change; the code will not.

Show properties

codeErrorCoderequired

The machine-readable half of an error response, and the field a client branches on. Closed: every error carries exactly one of these.

Allowed:unauthorizedforbiddennot_foundinvalid_requestconflictclient_outdatedprecondition_failedtoo_many_requestsinternal

messagestringrequired

401Missing, malformed, or invalid bearer token.

errorErrorDetailrequired

What went wrong: a `code` to branch on and a `message` to show. The message is written for a person and may change; the code will not.

Show properties

codeErrorCoderequired

The machine-readable half of an error response, and the field a client branches on. Closed: every error carries exactly one of these.

Allowed:unauthorizedforbiddennot_foundinvalid_requestconflictclient_outdatedprecondition_failedtoo_many_requestsinternal

messagestringrequired

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

Bearer tokenRemember on this deviceInclude my values in samples

Bodyapplication/json

display_namestring*The caller's new name, trimmed of surrounding whitespace, or `null` to clear it.

Request

curl -X PATCH "https://api.us.cloud.subako.ai/v1/me" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "display_name": "string"
}'

const response = await fetch("https://api.us.cloud.subako.ai/v1/me", {
  method: "PATCH",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Content-Type": "application/json"
  },
  body: "{\n  \"display_name\": \"string\"\n}"
});

import requests

response = requests.patch(
    "https://api.us.cloud.subako.ai/v1/me",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Content-Type": "application/json"
    },
    data="{\n  \"display_name\": \"string\"\n}",
)

Response

{
  "organization": {
    "handle": "string",
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  },
  "role": "admin",
  "user": {
    "display_name": "string",
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "primary_email": "string"
  }
}

{
  "error": {
    "code": "unauthorized",
    "message": "string"
  }
}

{
  "error": {
    "code": "unauthorized",
    "message": "string"
  }
}