Update a person

Updates a given person's details.

SecurityCommonAuth
Request
path Parameters
personId
required
string <uuid> (personId) <= 36 characters

The ID of the person to work with.

Example: 8e214819-5c83-429f-a976-eb127a0a8a88
Request Body schema: application/json
accountId
string

The ID of the account to work with. Including the account ID will return the persona object in the response.

firstName
string <= 256 characters
lastName
string <= 256 characters
title
string or null <= 10 characters
Enum: null "Master" "Mr" "Miss" "Mrs" "Ms" "Mx"
middleInitials
string or null <= 10 characters
dob
string or null <date>
gender
string or null <= 20 characters
nationality
string or null <= 256 characters
countryOfResidence
string or null <= 256 characters
primaryMobileNumber
string <= 50 characters
emailTheme
string <= 32 characters
Enum: "em-light" "em-dark"
transactionalEmailPreference
boolean or null

Indicates whether all the associated personas have opted to receive the emails or not.

Responses
200

OK

400

Bad request

401

Unauthorised

403

Forbidden

404

Not found

405

Method not allowed

415

Unsupported media type

429

Too many requests

500

Internal server error

patch/people/{personId}
Request samples
application/json
{
  • "accountId": "F50091",
  • "firstName": "Sally",
  • "lastName": "Smith",
  • "title": "Mrs",
  • "middleInitials": "R",
  • "dob": "1946-01-19",
  • "gender": "Female",
  • "nationality": "US",
  • "countryOfResidence": "US",
  • "primaryMobileNumber": "+447798121212",
  • "emailTheme": "em-light",
  • "transactionalEmailPreference": true
}
Response samples
application/json
{
  • "id": "288cf796-c1ad-4ffd-9eb9-af210bff0ea0",
  • "productId": "288cf796-c1ad-4ffd-9eb9-af210bff0ea0",
  • "firstName": "Dolly",
  • "lastName": "Parton",
  • "title": "Mrs",
  • "middleInitials": "R",
  • "dob": "1946-01-19",
  • "status": "active",
  • "gender": "Female",
  • "nationality": "US",
  • "countryOfResidence": "US",
  • "primaryMobileNumber": "+447798121212",
  • "primaryEmailAddress": "test@equalsqa.com",
  • "avatar": {
    },
  • "createdAt": "2021-01-30T08:30:00Z",
  • "updatedAt": "2021-01-30T08:30:00Z",
  • "sendInvite": true,
  • "roleId": "288cf796-c1ad-4ffd-9eb9-af210bff0ea0",
  • "verifyEmailAddress": true,
  • "verifyMobileNumber": true,
  • "sub": "288cf796-c1ad-4ffd-9eb9-af210bff0ea0",
  • "hasPeopleCard": true,
  • "emailTheme": "em-light",
  • "preferred2FAMethod": "sms",
  • "card": {
    },
  • "persona": {
    }
}