Create a person

Creates a person and adds them to a given account. The email address provided for this person will be used to identify them and cannot be changed later.

If a person with this email address already exists, this request will add the existing person to the account.

SecurityCommonAuth
Request
Request Body schema: application/json
accountId
required
string (accountId)

The ID of the account to work with.

firstName
required
string <= 256 characters
lastName
required
string <= 256 characters
roleName
required
string <= 256 characters

Role name

Enum: "Owner" "Admin" "Payer" "Viewer" "Accountant" "User"
dob
string or null <date>

Date of birth

emailAddress
required
string <email> <= 256 characters
primaryMobileNumber
string or null <= 50 characters
status
string <= 256 characters
Default: "active"
Enum: "active" "deactivated"
employeeNumber
string <= 256 characters
jobTitle
string or null <= 256 characters
notifyEmailTrans
boolean
Default: true

Indicates whether this persona has opted to receive the emails or not.

createdByPersonaId
string <uuid> <= 36 characters

The creator's persona ID.

addToUserPool
boolean
Default: true

Indicates whether or not to create a new user in the Cognito user pool.

sendInvite
boolean
Default: true

Indicates whether or not to send a Cognito invite to the user so that they can complete the sign-up process.

emailTheme
string <= 32 characters
Enum: "em-light" "em-dark"
Responses
201

Created

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

post/people
Request samples
application/json
{
  • "accountId": "F50091",
  • "firstName": "Sally",
  • "lastName": "Smith",
  • "roleName": "Viewer",
  • "dob": "1946-01-19",
  • "emailAddress": "sally.smith@example.com",
  • "primaryMobileNumber": "+447798121212",
  • "status": "active",
  • "employeeNumber": "948947464",
  • "jobTitle": "Human Division Manager",
  • "notifyEmailTrans": true,
  • "createdByPersonaId": "288cf796-c1ad-4ffd-9eb9-af210bff0ea0",
  • "addToUserPool": false,
  • "sendInvite": false,
  • "emailTheme": "em-light"
}
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": {
    }
}