Update Authorized user

Update Authorized User

This endpoint allows you to update the profile details of an authorized user (subProfile) associated with a business customer account. You can modify fields such as the authorized user's name, email address, and department assignment. Submitting updated values ensures that authorized user records remain current and accurate within the platform.

Endpoint

POST /api/subProfiles/update

Authentication

Bearer token required. Obtain via:

POST https://api.banking.netevia.dev/api/auth/v2

Include in header: Authorization: Bearer {token}
Token lifetime: 10 minutes. Refresh via POST /api/auth/refresh.

When to use

Use this endpoint when a business customer needs to correct or update the details of an authorized user on their account — for example, after a name change, an email address update, or a department reassignment. Only business customers can have authorized users (subProfiles); this endpoint is not applicable for personal customer accounts. Ensure that only authenticated and authorized business customers initiate updates to their authorized users' profiles.

Request Body

FieldTypeRequiredDescription
subProfileIdinteger (int32)NoUnique identifier of the authorized user (subProfile) to update
givenNamestringYesFirst name of the authorized user. Max 255 characters
familyNamestringYesLast name of the authorized user. Max 255 characters
emailstring (email)YesEmail address of the authorized user. Max 128 characters
departmentIdinteger (int32)NoID of the department to assign the authorized user to
departmentstringNoDepartment name. Deprecated — use departmentId instead. Max 128 characters
{
  "subProfileId": 4821,
  "givenName": "Maria",
  "familyName": "Gonzalez",
  "email": "[email protected]",
  "departmentId": 12
}

Response

200 OK

A 200 response confirms that the authorized user's profile has been successfully updated. The response body confirms the operation outcome.

FieldTypeDescription
successbooleanIndicates whether the update was completed successfully
messagestringHuman-readable confirmation or error message
{
  "success": true,
  "message": "Authorized user profile updated successfully."
}

Error Codes

CodeWhen it happens
400Missing required fields (givenName, familyName, or email), validation failure (e.g., invalid email format, value exceeds max length), or extra/unrecognized fields in the request body
401Token missing, expired, or invalid
403Authenticated customer does not have permission to update this authorized user
404The specified subProfileId does not exist or does not belong to the authenticated business customer
500Internal server error

Common Mistakes

  • Omitting subProfileId — without it, the platform cannot identify which authorized user to update; always include the correct subProfile identifier
  • Sending an invalid email format for the email field — the value must conform to standard email format (e.g., [email protected])
  • Using the deprecated department string field instead of departmentId — migrate to departmentId to ensure forward compatibility
  • Exceeding field length limits — givenName and familyName max 255 characters, email and department max 128 characters
  • Attempting to update a subProfile that belongs to a different business customer — each authorized user is scoped to the business account that created it

Related Endpoints

  • POST /api/subProfiles/create — Create a new authorized user for a business customer account
  • GET /api/subProfiles — Retrieve a list of authorized users associated with the authenticated business customer
  • POST /api/subProfiles/delete — Remove an authorized user from a business customer account
  • POST /api/auth/v2 — Obtain a Bearer token for authentication

Example

curl -X POST https://api.banking.netevia.dev/api/subProfiles/update \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "subProfileId": 4821,
    "givenName": "Maria",
    "familyName": "Gonzalez",
    "email": "[email protected]",
    "departmentId": 12
  }'
Body Params
int32
string
required
length between 1 and 255
string
required
length between 1 and 255
string | null
string | null
deprecated
int32 | null
string
required
length between 1 and 128
Headers
string
enum
Defaults to application/json

Generated from available request content types

Allowed:
Response
200

Success

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here!