Sign in

v1

latestOpenAPI 3.1.0UNLICENSED2026-07-2613101.1 MB
People

Update a persona

Updates the details of the specified persona.

patch/personas/{personaId}

Path parameters

personaIdstring uuid required

The ID of the persona to work with.

Example:8e214819-5c83-429f-a976-eb127a0a8a88

Query parameters

accountIdstring required

The ID of the account to work with.

Example:F50091

Request body

emailAddressstring nullable
employeeNumberstring nullable
workNumberstring nullable
jobTitlestring nullable
status'active' | 'deactivated'
transactionalEmailPreferenceboolean nullable

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

marketingEmailsPreferenceboolean nullable

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

securityNotificationsPreferenceboolean nullable

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

cardTransactionPushNotificationPreferenceboolean

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

Example request

{
  "emailAddress": "Clint_Moore@gmail.com",
  "employeeNumber": "948947464",
  "workNumber": "(807) 940-7411 x8855",
  "jobTitle": "Human Division Manager",
  "status": "active",
  "transactionalEmailPreference": true,
  "marketingEmailsPreference": true,
  "securityNotificationsPreference": true,
  "cardTransactionPushNotificationPreference": true
}

Response

OK

idstring uuid required
accountIdstring required

The ID of the account to work with.

emailAddressstring nullable required
employeeNumberstring nullable required
workNumberstring nullable required
jobTitlestring nullable required
status'active' | 'deactivated' | 'created' | 'invited' | 'inviteExpired' nullable required
createdByobject nullable
createdByPersonaIdstring uuid nullable required

The ID of the persona to work with.

primaryOwnerOfobject nullable
transactionalEmailPreferenceboolean nullable

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

cardTransactionPushNotificationPreferenceboolean

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

inviteSentDatestring date-time nullable

The date the signup was created or updated. ISO 8601 format. Invites are valid for 14 days.

marketingEmailsboolean required
securityNotificationsboolean required
createdAtstring date-time

The date the Resource was initially created. ISO 8601 format without milliseconds.

updatedAtstring date-time

The date the Resource was last modified. ISO 8601 format without milliseconds.

Example response

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "accountId": "F50091",
  "emailAddress": "Clint_Moore@gmail.com",
  "employeeNumber": "948947464",
  "workNumber": "(807) 940-7411 x8855",
  "jobTitle": "Human Division Manager",
  "status": "active",
  "addresses": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "type": "office",
      "nickName": "office",
      "addressLine1": "Great Building",
      "addressLine2": "Four Maple Street",
      "addressLine3": "Southwark",
      "addressContact": "Brian May",
      "city": "string",
      "postcode": "SE13UB",
      "country": "England",
      "countryCode": "GB",
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z"
    }
  ],
  "createdBy": {},
  "createdByPersonaId": "8e214819-5c83-429f-a976-eb127a0a8a88",
  "primaryOwnerOf": {},
  "teams": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "accountId": "F50091",
      "name": "dolly@parton.com",
      "description": "XYZ123",
      "enabled": true,
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z"
    }
  ],
  "transactionalEmailPreference": true,
  "cardTransactionPushNotificationPreference": true,
  "inviteSentDate": "2018-12-01T14:54:30.000Z",
  "marketingEmails": true,
  "securityNotifications": true,
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z"
}