Update a person

Updates a given person's details.

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

The ID of the person to work with.

Example: 775596ae-2624-40af-a9dc-9756110a4a04
Request Body schema: application/json

Body

accountId
string

The ID of the account to work with.

firstName
string <= 256 characters
lastName
string <= 256 characters
title
string or null
Enum: "Master" "Mr" "Miss" "Mrs" "Ms" "Mx"
middleInitials
string or null <= 10 characters
dob
string or null

Date of birth

gender
string or null <= 20 characters
nationality
string or null <= 256 characters
countryOfResidence
string or null <= 256 characters
primaryMobileNumber
string or null <= 50 characters
emailTheme
string
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

patch/people/{personId}
Request samples
application/json
{
  • "accountId": "F50091",
  • "firstName": "Dolly",
  • "lastName": "Parton",
  • "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": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "firstName": "Dolly",
  • "lastName": "Parton",
  • "title": "Master",
  • "middleInitials": "R",
  • "dob": "1946-01-19",
  • "gender": "Female",
  • "nationality": "US",
  • "countryOfResidence": "US",
  • "primaryMobileNumber": "+447798121212",
  • "primaryEmailAddress": "test@equalsqa.com",
  • "avatar": {
    },
  • "sendInvite": true,
  • "roleId": "7382d58e-652a-4905-b7c9-bcca1e0e5391",
  • "verifyEmailAddress": true,
  • "verifyMobileNumber": true,
  • "sub": "753487e7-10bc-4e69-b3b2-4da33721ea3e",
  • "hasPeopleCard": true,
  • "card": {
    },
  • "persona": { },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}