Setup

Update a user

Updates the user identified by the user_id path parameter. Only the fields you send are changed; everything else is left as it was.

If you change the mobile number, enroll the new number as an authentication factor afterwards, or one-time passwords keep going to the old one.

patch/users/{user_id}

Request

  • Base URL: https://sandbox.weavr.io/multi
  • URL: https://sandbox.weavr.io/multi/users/{user_id}
  • Auth: HTTP bearer and API key in header api-key

Path parameters

user_idstring required
Example:987654321

The unique identifier for the user.

Headers

idempotency-refstring
Example:transfer-2026-08-07-001

A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.

Request body

namestring

The first name of the user.

surnamestring

The last name of the user.

emailstring email

Email Address of the user

tagstring

The tag field is a custom field that can be used to search and filter.

localestring

BCP47 locale code (e.g. en, en-US). The locale determines which email and SMS user notification templates are used.

brandstring

Brand identifier used to determine the set of email and SMS user notification templates. Must be alphanumeric, up to 25 characters, and contain no spaces.

rolesUserPredefinedRole[]

Optional roles to assign to the user. This uses overwrite behavior - roles included in this list will be assigned, and roles not included will be unassigned. Users cannot update their own roles. For a full description of the permissions associated to each role, see our product documentation.

Example request

{
  "email": "alex@example.com",
  "mobile": {
    "countryCode": "+44",
    "number": "7700900123"
  },
  "dateOfBirth": {
    "year": 1990,
    "month": 1,
    "day": 1
  },
  "tag": "customer-123",
  "locale": "en-GB",
  "brand": "Acme"
}

Response

Success

idstring required

The unique identifier of the user.

namestring required

The first name of the user.

surnamestring required

The last name of the user.

emailstring email required

Email Address of the user

activeboolean required

The state of the user. If the active attribute is false, then the user will not be able to log in.

tagstring

The tag field is a custom field that can be used to search and filter.

countryOfResidencestring
localestring

BCP47 locale code (e.g. en, en-US). The locale determines which email and SMS user notification templates are used.

brandstring

Brand identifier used to determine the set of email and SMS user notification templates. Must be alphanumeric, up to 25 characters, and contain no spaces.

rolesUserPredefinedRole[]

Example response

{
  "id": "987654321",
  "identity": {
    "type": "CONSUMER",
    "id": "123456789"
  },
  "name": "Alex",
  "surname": "Smith",
  "email": "alex@example.com",
  "mobile": {
    "countryCode": "+44",
    "number": "7700900123"
  },
  "active": true,
  "dateOfBirth": {
    "year": 1990,
    "month": 1,
    "day": 1
  },
  "tag": "customer-123",
  "countryOfResidence": "GB",
  "locale": "en-GB",
  "brand": "Acme"
}

Changes

No recorded changes to this operation across all 1 revision of this API.