Skip to main content
PATCH
Update the signed-in member

Authorizations

Authorization
string
header
required

A member credential in the Authorization: Bearer header: a member session JWT, a portal JWT whose login is linked to a membership in that company, an opaque member token, or a verified One Auth identity access token for a non-impersonated rep or shopper. The credential alone identifies the member and company.

Body

application/json

The fields of the signed-in member to change. At least one is required. display_name is derived from first_name and last_name and is refused with 422.

first_name
string

The member's first name. Must contain a visible character.

Required string length: 1 - 50
Pattern: \S
Example:

"Dwight"

last_name
string

The member's last name. Must contain a visible character.

Required string length: 1 - 50
Pattern: \S
Example:

"Schrute"

language
string

ISO 639 code of one of the company's active languages.

Minimum string length: 1
Example:

"fr"

country
string

ISO 3166-1 alpha-2 country code.

Pattern: ^[A-Z]{2}$
Example:

"FR"

time_zone
string

IANA time zone identifier. Rails display names ("Eastern Time (US & Canada)") and UTC are refused; use Etc/UTC.

Minimum string length: 1
Example:

"Europe/Paris"

avatar_upload_id
string<uuid>

The upload_id of an image uploaded through POST /media/uploads and stored. It becomes the avatar and is consumed.

Example:

"0199a3f2-5b0d-7c3a-8f09-2a1b0c9d8e7f"

Response

The member after the change.

status
integer
required
data
object
required

The signed-in member. Identity only; counts, lists and credentials each have their own endpoint.

meta
object
required

Envelope metadata present on every response.