Pre-release — content may change.

WidgetsWidget Reference

createPersonProfile

Create and edit person profile information including names, contact details, and demographic data

Overview

The createPersonProfile widget provides a complete interface for editing person profile information. This widget includes:

  • Personal information (name, title, etc.)
  • Contact details (addresses, emails, phones, web addresses)
  • Demographic data
  • Custom profile fields
  • Real-time validation

Use this widget to build self-service profile editors, member account centers, or profile completion flows.

Authentication

This widget uses standard JWT API tokens. No widget token is required.

Wicket.widgets.createPersonProfile({
  accessToken: userJwtToken, // Standard JWT token
  personId: personUuid,
  rootEl: container
});

See the Authentication Guide for details on generating JWT tokens.

Parameters

Prop

Type

Required Resources

The requiredResources parameter allows you to enforce that certain contact information is provided:

{
  addresses: "work",              // Require one work address
  phones: ["mobile", "work"],     // Require mobile AND work phone
  emails: "primary"               // Require primary email
}

Events

The widget emits the following events:

WIDGET_LOADED

Fired when the widget has initialized and rendered.

Payload:

Prop

Type

SAVE_SUCCESS

Fired when profile data is successfully saved.

Payload: Same structure as WIDGET_LOADED, with updated values.

DELETE_SUCCESS

Fired when a related resource (address, email, phone, web address) is deleted.

Payload:

Prop

Type

Return Value

Returns a Promise<WidgetLoadResult> that resolves with:

Prop

Type

Example

Wicket.ready(function () {
  var widgetRoot = document.getElementById('root');

  Wicket.widgets.createPersonProfile({
    loadIcons: true,
    accessToken: clientToken,
    apiRoot: apiRoot,
    personId: "abcd-1234-efgh-5678",
    lang: "en",
    extraFields: ["personType"]
  }).then(function (widget) {
     widget.listen(widget.eventTypes.WIDGET_LOADED, function (payload) {
      console.log('widget loaded:', payload);
    });
    widget.listen(widget.eventTypes.SAVE_SUCCESS, function (payload) {
      console.log("save success:", payload);
    });
    widget.listen(widget.eventTypes.DELETE_SUCCESS, function (payload) {
      console.log("delete success:", payload);
    });
  });
});

Try it Live

Configure and test the widget with your Wicket instance.

⚠️ Credentials are stored in your browser's localStorage

My Member Portal
View Embed Code

On this page