Skip to main content
PATCH
/
api
/
public
/
coworker
/
profile
{
  "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

​
FullName
string
The customer’s display name.
​
NickName
string | null
Optional informal name displayed in some community contexts.
​
Gender
string
Gender identifier. Used for salutation generation.
​
DateOfBirth
string | null
ISO 8601 date of birth (e.g. "1990-06-15").
​
MobilePhone
string | null
Mobile phone number in any format.
​
LandLine
string | null
Landline phone number.
​
Address
string
Street address.
​
PostCode
string
Postal or ZIP code.
​
CityName
string
City name.
​
State
string
State or region.
​
CountryId
number
Numeric country identifier. Obtain valid IDs from GET /api/public/countries.

​
Billing Information

​
BillingName
string
Name to appear on invoices.
​
BillingEmail
string
Email address for invoice delivery.
​
BillingAddress
string | null
Billing street address.
​
BillingPostCode
string | null
Billing postal code.
​
BillingCityName
string | null
Billing city.
​
BillingState
string | null
Billing state or region.
​
BillingCountryId
number
Numeric country identifier for the billing address.
​
TaxIDNumber
string
VAT or tax identification number printed on invoices.

​
Professional Profile

​
Position
string | null
Job title displayed on the public directory profile.
​
CompanyName
string
Company name displayed on the public directory profile.
​
BusinessArea
string | null
Industry or area of work.
​
ProfileSummary
string | null
Free-text professional bio. Supports Markdown. Displayed on the public directory profile when ProfileIsPublic is true.
​
ProfileWebsite
string | null
Personal or company website URL.
​
ProfileIsPublic
boolean
When true, the customer’s profile is listed in the member directory.
​
ProfileTags
string
Comma-separated skill or interest tags shown on the directory profile.

​
Social Media

​
Twitter
string | null
Twitter profile URL or handle.
​
Linkedin
string | null
LinkedIn profile URL.
​
Github
string | null
GitHub profile URL or username.
​
Instagram
string | null
Instagram profile URL or handle.
​
Facebook
string | null
Facebook profile URL.
​
Skype
string | null
Skype username.
​
Telegram
string | null
Telegram username.

​
Notification Preferences

​
OnHelpDeskMsg
boolean
When true, the customer receives email notifications for new help desk replies.
​
OnNewWallPost
boolean
When true, the customer receives email notifications for new community board posts.
​
OnNewBlogComment
boolean
When true, the customer receives email notifications for new blog comments.
​
OnNewEventComment
boolean
When true, the customer receives email notifications for new event comments.
​
ReceiveCommunityDigest
boolean
When true, the customer receives a periodic community activity digest email.
​
SignUpToNewsletter
boolean
When true, the customer is opted in to the space’s newsletter.

​
Credentials

​
OldPassword
string
The customer’s current password. Required when changing the password.
​
NewPassword
string
The new password to set. Must satisfy the location’s password policy.
​
RepeatNewPassword
string
Must match NewPassword exactly. Validated server-side.

​
Response

Returns an ActionConfirmation envelope.
​
WasSuccessful
boolean
true when the profile was updated successfully.
​
Value
string | null
Usually null on success.
​
Status
number
HTTP-style status code mirrored in the body. 200 on success.
​
Message
string | null
Human-readable message. Usually null on success.
​
Errors
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

ContextSource 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

​
401 Unauthorized
error
The bearer token is missing, expired, or invalid.
​
400 Bad Request
error
One or more fields failed validation (e.g. password mismatch, invalid CountryId). Check Errors in the response body.
MethodEndpointDescription
GET/login/me?Retrieve the current user session and notification preferences
GET/en/profile?_resource=CoworkerRetrieve the full customer profile for editing
GET/api/public/coworkers/profilesList all customer profiles for the session
POST/en/profile/GenerateOpenAiProfileGenerate an AI-written professional profile summary