Skip to main content
PATCH
/
personas
/
{personaId}
Update a persona
curl --request PATCH \
  --url https://api.equalsmoney.com/v2/personas/{personaId} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "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
}
'
{
  "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"
}

Authorizations

​
Authorization
string
header
required

Path Parameters

​
personaId
string<uuid>
required

The ID of the persona to work with.

Maximum string length: 36
Example:

"8e214819-5c83-429f-a976-eb127a0a8a88"

Query Parameters

​
accountId
string
required

The ID of the account to work with.

Example:

"F50091"

Body

application/json

Body

​
emailAddress
string | null
Maximum string length: 256
Example:

"Clint_Moore@gmail.com"

​
employeeNumber
string | null
Maximum string length: 256
Example:

"948947464"

​
workNumber
string | null
Maximum string length: 50
Example:

"(807) 940-7411 x8855"

​
jobTitle
string | null
Maximum string length: 256
Example:

"Human Division Manager"

​
status
enum<string>
Available options:
active,
deactivated
Example:

"active"

​
transactionalEmailPreference
boolean | null

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

​
marketingEmailsPreference
boolean | null

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

​
securityNotificationsPreference
boolean | 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.

Response

200 - application/json

OK

​
id
string<uuid>
required
​
accountId
string
required

The ID of the account to work with.

Example:

"F50091"

​
emailAddress
string | null
required
Maximum string length: 256
Example:

"Clint_Moore@gmail.com"

​
employeeNumber
string | null
required
Maximum string length: 256
Example:

"948947464"

​
workNumber
string | null
required
Maximum string length: 50
Example:

"(807) 940-7411 x8855"

​
jobTitle
string | null
required
Maximum string length: 256
Example:

"Human Division Manager"

​
status
enum<string> | null
required
Available options:
active,
deactivated,
created,
invited,
inviteExpired
Example:

"active"

​
createdByPersonaId
string<uuid> | null
required

The ID of the persona to work with.

Maximum string length: 36
Example:

"8e214819-5c83-429f-a976-eb127a0a8a88"

​
marketingEmails
boolean
required
​
securityNotifications
boolean
required
​
addresses
object[]
​
createdBy
object
​
primaryOwnerOf
object
​
teams
object[]
​
transactionalEmailPreference
boolean | null

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

​
cardTransactionPushNotificationPreference
boolean

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

​
inviteSentDate
string<date-time> | null

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

Example:

"2018-12-01T14:54:30.000Z"

​
createdAt
string<date-time>

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

​
updatedAt
string<date-time>

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