PATCH

api

public

coworker

profile

Update Profile

curl --request PATCH \
  --url https://spaces.nexudus.com/api/public/coworker/profile \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "FullName": "<string>",
  "NickName": {},
  "Gender": "<string>",
  "DateOfBirth": {},
  "MobilePhone": {},
  "LandLine": {},
  "Address": "<string>",
  "PostCode": "<string>",
  "CityName": "<string>",
  "State": "<string>",
  "CountryId": 123,
  "BillingName": "<string>",
  "BillingEmail": "<string>",
  "BillingAddress": {},
  "BillingPostCode": {},
  "BillingCityName": {},
  "BillingState": {},
  "BillingCountryId": 123,
  "TaxIDNumber": "<string>",
  "Position": {},
  "CompanyName": "<string>",
  "BusinessArea": {},
  "ProfileSummary": {},
  "ProfileWebsite": {},
  "ProfileIsPublic": true,
  "ProfileTags": "<string>",
  "Twitter": {},
  "Linkedin": {},
  "Github": {},
  "Instagram": {},
  "Facebook": {},
  "Skype": {},
  "Telegram": {},
  "OnHelpDeskMsg": true,
  "OnNewWallPost": true,
  "OnNewBlogComment": true,
  "OnNewEventComment": true,
  "ReceiveCommunityDigest": true,
  "SignUpToNewsletter": true,
  "OldPassword": "<string>",
  "NewPassword": "<string>",
  "RepeatNewPassword": "<string>"
}
'

import requests

url = "https://spaces.nexudus.com/api/public/coworker/profile"

payload = {
    "FullName": "<string>",
    "NickName": {},
    "Gender": "<string>",
    "DateOfBirth": {},
    "MobilePhone": {},
    "LandLine": {},
    "Address": "<string>",
    "PostCode": "<string>",
    "CityName": "<string>",
    "State": "<string>",
    "CountryId": 123,
    "BillingName": "<string>",
    "BillingEmail": "<string>",
    "BillingAddress": {},
    "BillingPostCode": {},
    "BillingCityName": {},
    "BillingState": {},
    "BillingCountryId": 123,
    "TaxIDNumber": "<string>",
    "Position": {},
    "CompanyName": "<string>",
    "BusinessArea": {},
    "ProfileSummary": {},
    "ProfileWebsite": {},
    "ProfileIsPublic": True,
    "ProfileTags": "<string>",
    "Twitter": {},
    "Linkedin": {},
    "Github": {},
    "Instagram": {},
    "Facebook": {},
    "Skype": {},
    "Telegram": {},
    "OnHelpDeskMsg": True,
    "OnNewWallPost": True,
    "OnNewBlogComment": True,
    "OnNewEventComment": True,
    "ReceiveCommunityDigest": True,
    "SignUpToNewsletter": True,
    "OldPassword": "<string>",
    "NewPassword": "<string>",
    "RepeatNewPassword": "<string>"
}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    FullName: '<string>',
    NickName: {},
    Gender: '<string>',
    DateOfBirth: {},
    MobilePhone: {},
    LandLine: {},
    Address: '<string>',
    PostCode: '<string>',
    CityName: '<string>',
    State: '<string>',
    CountryId: 123,
    BillingName: '<string>',
    BillingEmail: '<string>',
    BillingAddress: {},
    BillingPostCode: {},
    BillingCityName: {},
    BillingState: {},
    BillingCountryId: 123,
    TaxIDNumber: '<string>',
    Position: {},
    CompanyName: '<string>',
    BusinessArea: {},
    ProfileSummary: {},
    ProfileWebsite: {},
    ProfileIsPublic: true,
    ProfileTags: '<string>',
    Twitter: {},
    Linkedin: {},
    Github: {},
    Instagram: {},
    Facebook: {},
    Skype: {},
    Telegram: {},
    OnHelpDeskMsg: true,
    OnNewWallPost: true,
    OnNewBlogComment: true,
    OnNewEventComment: true,
    ReceiveCommunityDigest: true,
    SignUpToNewsletter: true,
    OldPassword: '<string>',
    NewPassword: '<string>',
    RepeatNewPassword: '<string>'
  })
};

fetch('https://spaces.nexudus.com/api/public/coworker/profile', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "WasSuccessful": true,
  "Value": {},
  "Status": 123,
  "Message": {},
  "Errors": "<any>",
  "401 Unauthorized": {},
  "400 Bad Request": {}
}

Update Profile

Partially updates the authenticated customer’s profile. The same endpoint is used across all profile editing pages in the portal — personal information, billing details, notification preferences, account credentials, and the professional (public-facing) profile. Send only the fields you want to change; omitted fields are left unchanged.

Authentication

Requires a valid customer bearer token.

Request Body

Send a JSON object containing only the fields to update. All fields are optional; omitting a field leaves the current value unchanged.

Personal Information

string

The customer’s display name.

string | null

Optional informal name displayed in some community contexts.

string

Gender identifier. Used for salutation generation.

string | null

ISO 8601 date of birth (e.g. "1990-06-15").

string | null

Mobile phone number in any format.

string | null

Landline phone number.

string

Street address.

string

Postal or ZIP code.

string

City name.

string

State or region.

number

Numeric country identifier. Obtain valid IDs from GET /api/public/countries.

Billing Information

string

Name to appear on invoices.

string

Email address for invoice delivery.

string | null

Billing street address.

string | null

Billing postal code.

string | null

Billing city.

string | null

Billing state or region.

number

Numeric country identifier for the billing address.

string

VAT or tax identification number printed on invoices.

Professional Profile

string | null

Job title displayed on the public directory profile.

string

Company name displayed on the public directory profile.

string | null

Industry or area of work.

string | null

Free-text professional bio. Supports Markdown. Displayed on the public directory profile when ProfileIsPublic is true.

string | null

Personal or company website URL.

boolean

When true, the customer’s profile is listed in the member directory.

string

Comma-separated skill or interest tags shown on the directory profile.

string | null

Twitter profile URL or handle.

string | null

LinkedIn profile URL.

string | null

GitHub profile URL or username.

string | null

Instagram profile URL or handle.

string | null

Facebook profile URL.

string | null

Skype username.

string | null

Telegram username.

Notification Preferences

boolean

When true, the customer receives email notifications for new help desk replies.

boolean

When true, the customer receives email notifications for new community board posts.

boolean

When true, the customer receives email notifications for new article comments.

boolean

When true, the customer receives email notifications for new event comments.

boolean

When true, the customer receives a periodic community activity digest email.

When true, the customer is opted in to the space’s newsletter.

Credentials

string

The customer’s current password. Required when changing the password.

string

The new password to set. Must satisfy the location’s password policy.

string

Must match NewPassword exactly. Validated server-side.

Response

Returns an ActionConfirmation envelope.

boolean

true when the profile was updated successfully.

string | null

Usually null on success.

number

HTTP-style status code mirrored in the body. 200 on success.

string | null

Human-readable message. Usually null on success.

any

Validation error object. null on success. Check this when WasSuccessful is false.

Example Response

{
  "WasSuccessful": true,
  "Value": null,
  "Status": 200,
  "Message": null,
  "Errors": null
}

TypeScript Integration

import endpoints from '@/api/endpoints'
import { ActionConfirmation } from '@/types/ActionConfirmation'

const result = await httpClient.patch<ActionConfirmation>(endpoints.profile.patch, {
  FullName: 'Jane Doe',
  Position: 'Product Designer',
  ProfileIsPublic: true,
})

if (result.data.WasSuccessful) {
  // Refresh profile data and show success toast
}

Usage in Portal

Context	Source file
Personal information form (`/profile`)	`src/views/user/PersonalInformationPage.tsx`
Professional profile form (`/profile`)	`src/views/user/ProfessionalProfilePage.tsx`
Billing information form (`/profile`)	`src/views/user/BillingInformationPage.tsx`
Notification preferences (`/profile`)	`src/views/user/NotificationsPage.tsx`
Change password (`/profile`)	`src/views/user/CredentialsPage.tsx`

Error Responses

error

The bearer token is missing, expired, or invalid.

error

One or more fields failed validation (e.g. password mismatch, invalid CountryId). Check Errors in the response body.

Method	Endpoint	Description
`GET`	`/login/me?`	Retrieve the current user session and notification preferences
`GET`	`/en/profile?_resource=Coworker`	Retrieve the full customer profile for editing
`GET`	`/api/public/coworkers/profiles`	List all customer profiles for the session
`POST`	`/en/profile/GenerateOpenAiProfile`	Generate an AI-written professional profile summary

Generate AI ProfileGenerate an AI-written professional profile summary for the authenticated customer based on their existing profile data.

Update Profile

curl --request PATCH \
  --url https://spaces.nexudus.com/api/public/coworker/profile \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "FullName": "<string>",
  "NickName": {},
  "Gender": "<string>",
  "DateOfBirth": {},
  "MobilePhone": {},
  "LandLine": {},
  "Address": "<string>",
  "PostCode": "<string>",
  "CityName": "<string>",
  "State": "<string>",
  "CountryId": 123,
  "BillingName": "<string>",
  "BillingEmail": "<string>",
  "BillingAddress": {},
  "BillingPostCode": {},
  "BillingCityName": {},
  "BillingState": {},
  "BillingCountryId": 123,
  "TaxIDNumber": "<string>",
  "Position": {},
  "CompanyName": "<string>",
  "BusinessArea": {},
  "ProfileSummary": {},
  "ProfileWebsite": {},
  "ProfileIsPublic": true,
  "ProfileTags": "<string>",
  "Twitter": {},
  "Linkedin": {},
  "Github": {},
  "Instagram": {},
  "Facebook": {},
  "Skype": {},
  "Telegram": {},
  "OnHelpDeskMsg": true,
  "OnNewWallPost": true,
  "OnNewBlogComment": true,
  "OnNewEventComment": true,
  "ReceiveCommunityDigest": true,
  "SignUpToNewsletter": true,
  "OldPassword": "<string>",
  "NewPassword": "<string>",
  "RepeatNewPassword": "<string>"
}
'

import requests

url = "https://spaces.nexudus.com/api/public/coworker/profile"

payload = {
    "FullName": "<string>",
    "NickName": {},
    "Gender": "<string>",
    "DateOfBirth": {},
    "MobilePhone": {},
    "LandLine": {},
    "Address": "<string>",
    "PostCode": "<string>",
    "CityName": "<string>",
    "State": "<string>",
    "CountryId": 123,
    "BillingName": "<string>",
    "BillingEmail": "<string>",
    "BillingAddress": {},
    "BillingPostCode": {},
    "BillingCityName": {},
    "BillingState": {},
    "BillingCountryId": 123,
    "TaxIDNumber": "<string>",
    "Position": {},
    "CompanyName": "<string>",
    "BusinessArea": {},
    "ProfileSummary": {},
    "ProfileWebsite": {},
    "ProfileIsPublic": True,
    "ProfileTags": "<string>",
    "Twitter": {},
    "Linkedin": {},
    "Github": {},
    "Instagram": {},
    "Facebook": {},
    "Skype": {},
    "Telegram": {},
    "OnHelpDeskMsg": True,
    "OnNewWallPost": True,
    "OnNewBlogComment": True,
    "OnNewEventComment": True,
    "ReceiveCommunityDigest": True,
    "SignUpToNewsletter": True,
    "OldPassword": "<string>",
    "NewPassword": "<string>",
    "RepeatNewPassword": "<string>"
}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    FullName: '<string>',
    NickName: {},
    Gender: '<string>',
    DateOfBirth: {},
    MobilePhone: {},
    LandLine: {},
    Address: '<string>',
    PostCode: '<string>',
    CityName: '<string>',
    State: '<string>',
    CountryId: 123,
    BillingName: '<string>',
    BillingEmail: '<string>',
    BillingAddress: {},
    BillingPostCode: {},
    BillingCityName: {},
    BillingState: {},
    BillingCountryId: 123,
    TaxIDNumber: '<string>',
    Position: {},
    CompanyName: '<string>',
    BusinessArea: {},
    ProfileSummary: {},
    ProfileWebsite: {},
    ProfileIsPublic: true,
    ProfileTags: '<string>',
    Twitter: {},
    Linkedin: {},
    Github: {},
    Instagram: {},
    Facebook: {},
    Skype: {},
    Telegram: {},
    OnHelpDeskMsg: true,
    OnNewWallPost: true,
    OnNewBlogComment: true,
    OnNewEventComment: true,
    ReceiveCommunityDigest: true,
    SignUpToNewsletter: true,
    OldPassword: '<string>',
    NewPassword: '<string>',
    RepeatNewPassword: '<string>'
  })
};

fetch('https://spaces.nexudus.com/api/public/coworker/profile', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "WasSuccessful": true,
  "Value": {},
  "Status": 123,
  "Message": {},
  "Errors": "<any>",
  "401 Unauthorized": {},
  "400 Bad Request": {}
}

​Update Profile

​Authentication

​Request Body

​Personal Information

​Billing Information

​Professional Profile

​Social Media

​Notification Preferences

​Credentials

​Response

​Example Response

​TypeScript Integration

​Usage in Portal

​Error Responses

​Related Endpoints

Update Profile

Authentication

Request Body

Personal Information

Billing Information

Professional Profile

Social Media

Notification Preferences

Credentials

Response

Example Response

TypeScript Integration

Usage in Portal

Error Responses

Related Endpoints