Update a persona

Updates the details of the specified persona.

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

The ID of the persona to work with.

Example: 8e214819-5c83-429f-a976-eb127a0a8a88
query Parameters
accountId
required
string (accountId)

The ID of the account to work with.

Example: accountId=F50091
Request Body schema: application/json
emailAddress
string or null <= 256 characters
employeeNumber
string or null <= 256 characters
workNumber
string or null <= 50 characters
jobTitle
string or null <= 256 characters
status
string <= 256 characters
Enum: "active" "deactivated"
transactionalEmailPreference
boolean or null

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

marketingEmailsPreference
boolean or null

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

securityNotificationsPreference
boolean or null

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

cardTransactionPushNotificationPreference
boolean

User preference for receiving push notifications for each individual card transaction.

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/personas/{personaId}
Request samples
application/json
{
  • "emailAddress": "john.doe@example.com",
  • "employeeNumber": "948947464",
  • "workNumber": "(807) 940-7411 x8855",
  • "jobTitle": "Human Division Manager",
  • "status": "active",
  • "transactionalEmailPreference": true,
  • "marketingEmailsPreference": true,
  • "securityNotificationsPreference": true,
  • "cardTransactionPushNotificationPreference": false
}
Response samples
application/json
{
  • "id": "96df2fd7-b2fa-4f0c-ba69-502246776f99",
  • "emailAddress": "john.doe@example.com",
  • "employeeNumber": "948947464",
  • "workNumber": "(807) 940-7411 x8855",
  • "jobTitle": "Human Division Manager",
  • "createdByPersonaId": "1b5c012d-8d3f-404b-8767-22af0004d383",
  • "status": "active",
  • "transactionalEmailPreference": true,
  • "cardTransactionPushNotificationPreference": false,
  • "inviteSentDate": "2018-12-01T14:54:30.000Z",
  • "createdAt": "2018-12-01T14:54:30.000Z",
  • "updatedAt": "2021-07-13T19:30:45.000Z"
}