Update an account.

1min
PATCH
This endpoint will provide the ability to update an existing account within the platform and return the account object.
Authentication
Authorization
Bearer
Path Parameters
accountReference
string
*
Header Parameters
X-TokenId
string
X-SessionId
string
X-Version
string
*
Origin
string
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
Description
Account
accountId
integer<int32>
accountReference
string
status
string<None | Active | Suspended | Closed | MWalletInactive>
verified
boolean
email
string
clientUserId
string
*
salutation
string
firstName
string
lastName
string
phoneNumber
string
mobileNumber
string
dateOfBirth
string<date-time>
gender
string<NotKnown | Female | Male>
addresses
FictiveGlobal.Api.Rest.Dtos.v1.Address[]
customParameters
object
sessionToken
string
marketingAllowed
boolean
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.
Curl
JS
Ruby
Python
curl --location --globoff --request PATCH 'https://api.fictive.com/REST/api/accounts/{accountReference}' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '[
  {}
]'
curl --location --globoff --request PATCH 'https://api.fictive.com/REST/api/accounts/{accountReference}' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '[
  {}
]'
Responses
200
400
403
409
412
500
{
  "accountId": 15,
  "accountReference": "accRef",
  "status": "Active",
  "verified": true,
  "email": "Email",
  "clientUserId": "ClientUserId",
  "salutation": "Salutation",
  "firstName": "FirstName",
  "lastName": "LastName",
  "phoneNumber": "PhoneNumber",
  "mobileNumber": "MobileNumber",
  "dateOfBirth": "2021-09-21T05:33:13.1196695",
  "gender": "NotKnown",
  "addresses": [
    {
      "addressType": "Home",
      "houseName": "HouseName",
      "houseNumber": "HouseNumber",
      "street": "Street",
      "townCity": "TownCity",
      "district": "District",
      "state": "State",
      "county": "County",
      "postCode": "PostCode",
      "country": "Country"
    }
  ],
  "customParameters": {
    "ParameterName": "ParameterValue"
  },
  "sessionToken": "a44c2dc229d34986aaec7305b0280a9e",
  "marketingAllowed": true
}
{
  "accountId": 15,
  "accountReference": "accRef",
  "status": "Active",
  "verified": true,
  "email": "Email",
  "clientUserId": "ClientUserId",
  "salutation": "Salutation",
  "firstName": "FirstName",
  "lastName": "LastName",
  "phoneNumber": "PhoneNumber",
  "mobileNumber": "MobileNumber",
  "dateOfBirth": "2021-09-21T05:33:13.1196695",
  "gender": "NotKnown",
  "addresses": [
    {
      "addressType": "Home",
      "houseName": "HouseName",
      "houseNumber": "HouseNumber",
      "street": "Street",
      "townCity": "TownCity",
      "district": "District",
      "state": "State",
      "county": "County",
      "postCode": "PostCode",
      "country": "Country"
    }
  ],
  "customParameters": {
    "ParameterName": "ParameterValue"
  },
  "sessionToken": "a44c2dc229d34986aaec7305b0280a9e",
  "marketingAllowed": true
}
﻿
﻿
Updated 22 Sep 2023
Did this page help you?
Delete account
Trigger email verification