Update member

Update a member; only the fields you send are changed.

Partial update. Identify the member with the x-auth-user header (pagename or username). Omit a field or send it as an empty string to leave it untouched — empty values are never applied. enroller_username sets the member who enrolled them; an empty string leaves the existing enroller in place, which is never cleared. member_email and member_phone_number are the credentials the member signs in with, so they are also applied to their sign-in account. pagename changes the member's primary web address within your domain and must be unique in your company.

Body fields

member_emailstring (email)optional

Sign-in email address; must be unique in your company.

member_first_namestring (≤80)optional

First name.

member_last_namestring (≤80)optional

Last name.

member_phone_numberstring (E.164)optional

Sign-in phone number in international format.

pagenamestring (≤63)optional

Primary web address (slug) for the member. Letters, numbers and dashes only — no spaces, symbols, or leading/trailing dash; 422 when invalid or already taken.

enroller_usernamestring (≤63)optional

Pagename/username of the member who enrolled them (the same value as x-auth-user). Only applied when given; an empty string never clears the enroller.

external_idstring (≤120)optional

Your own reference for this member. Must be unique inside your company; 422 when another member already uses it.

titlestring (≤120)optional

Job title shown on the member page.

Field	Type	Description
member_emailopt	string (email)	Sign-in email address; must be unique in your company.
member_first_nameopt	string (≤80)	First name.
member_last_nameopt	string (≤80)	Last name.
member_phone_numberopt	string (E.164)	Sign-in phone number in international format.
pagenameopt	string (≤63)	Primary web address (slug) for the member. Letters, numbers and dashes only — no spaces, symbols, or leading/trailing dash; 422 when invalid or already taken.
enroller_usernameopt	string (≤63)	Pagename/username of the member who enrolled them (the same value as x-auth-user). Only applied when given; an empty string never clears the enroller.
external_idopt	string (≤120)	Your own reference for this member. Must be unique inside your company; 422 when another member already uses it.
titleopt	string (≤120)	Job title shown on the member page.

Responses

200OKThe member was updated; updated lists each changed field with its previous and new value.

{
  "success": true,
  "updated": [
    { "field": "pagename", "previous_value": "james", "new_value": "john-doe" }
  ],
  "member": {
    "id": "7c4e2a1b-3d5f-4a0e-8b12-9f6c1d2e3a45",
    "pagename": "john-doe",
    "member_email": "john@example.com",
    "member_phone_number": "+10000000000",
    "title": "COO"
  }
}

400Bad requestThe request body is not valid JSON.

{ "success": false, "error": "Body must be valid JSON" }

404Not foundNo member with that id in your company.

{ "success": false, "error": "No member matches "john-doe" in this company." }

422UnprocessableValidation failed; see the issues array.

{
  "success": false,
  "error": "Validation failed",
  "issues": ["pagename: "john-doe" is already taken."]
}

PATCH/api/public/v1/member

member_email

Sign-in email address; must be unique in your company.

member_first_name

First name.

member_last_name

Last name.

member_phone_number

Sign-in phone number in international format.

pagename

Primary web address (slug) for the member. Letters, numbers and dashes only — no spaces, symbols, or leading/trailing dash; 422 when invalid or already taken.

enroller_username

Pagename/username of the member who enrolled them (the same value as x-auth-user). Only applied when given; an empty string never clears the enroller.

external_id

Your own reference for this member. Must be unique inside your company; 422 when another member already uses it.

title

Job title shown on the member page.

ResponseNot sent yet