Update a persona

Updates the details of the specified persona.

SecurityCommonAuth

Request

path Parameters

personaId

required

string <uuid> <= 36 characters

The ID of the persona to work with.

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

query Parameters

accountId

required

string

The ID of the account to work with.

Example: accountId=F50091

Request Body schema: application/json

Body

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 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

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

405

Method Not Allowed

415

Unsupported Media Type

422

Unable to process the request

429

Too Many Requests

500

Internal Server Error

patch/personas/{personaId}

Request samples

Payload
curl
JavaScript
Node.js

application/json

{"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 samples

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"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": { },
"primaryOwnerOf": { },
"teams": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"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",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}