API Reference
Accounts
Update an account.
2min
PATCH
AUTHENTICATION
Authorization
Bearer
Bearer
PATH PARAMETERS
accountReference
string
*Account reference
HEADER PARAMETERS
X-TokenId
string
The eSuite Token Id
X-SessionId
string
The eSuite Session Id
X-Version
string
*The eSuite Version
Origin
string
The eSuite Origin
BODY PARAMETERS
patchRequest
Microsoft.AspNet.JsonPatch.JsonPatchDocument[FictiveGlobal.Api.Rest.Dtos.v1.Patch.Accounts.AccountsPatchModel]
*value
System.Object
path
string
op
string
from
string
RESPONSES
200
Ok
FictiveGlobal.Api.Rest.Dtos.v2.AccountResult
Account
accountId
integer<int32>
Id of the account
accountReference
string
Account reference
status
string<None | Active | Suspended | Closed | MWalletInactive>
Status of account
verified
boolean
Flag that marks if the account has been verified
email
string
Email of account
clientUserId
string
Client Id of the user
salutation
string
firstName
string
Account first name
lastName
string
Account last name
phoneNumber
string
Account phone number
mobileNumber
string
Account mobile number
dateOfBirth
string<date-time>
Example: 2021-09-21T05:33:13.0102964
Date of birth of the Account
gender
string<NotKnown | Female | Male>
Gender
addresses
FictiveGlobal.Api.Rest.Dtos.v1.Address[]
Addresses of Account
customParameters
object
Example: [object Object]
Custom parameters
sessionToken
string
The session token
marketingAllowed
boolean
Marketing Allowed
400
• Email address format invalid
<br />• Invalid status provided.
<br />• ClientUserId provided exceeds maximum length.
<br />• FirstName provided exceeds maximum length.
<br />• Surname provided exceeds maximum length.
<br />• Phone number provided exceeds maximum length.
<br />• Phone number does not support non-numeric characters.
<br />• Mobile number provided exceeds maximum length.
<br />• Mobile number does not support non-numeric characters.
<br />• DateOfBirth must be a date in the past.
<br />• {parameterName} provided exceeds maximum length.
403
• Unable to manage ClientUserId with the provided authentication.
409
• The email is already in use.
412
• {parameterName} not configured.
500
• Internal Server Error.
Updated 22 Sep 2023
Did this page help you?