/netevia/subProfiles/phone


Update Subprofile Phone Number

This endpoint updates the phone number associated with a subprofile (authorized user) on a business customer account. It requires both a country code and a 10-digit phone number. Use this endpoint whenever an authorized user's contact phone number needs to be corrected or changed.

Endpoint

POST /netevia/subProfiles/phone

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 an authorized user (subprofile) of a business customer has changed their phone number or when the phone number on record needs to be corrected. Keeping subprofile contact information current ensures that notifications, verification codes, and account alerts are delivered to the correct number. This is especially important for subprofiles with Full or Custom access levels who may receive security-related communications.

Request Body

FieldTypeRequiredDescription
subProfileIdinteger (int32)NoThe unique identifier of the subprofile whose phone number is being updated
phoneNumberCountryCodestringYesThe 3-character country code for the phone number (e.g., "001" for the United States)
phoneNumberstringYesThe 10-digit phone number (digits only, no dashes or spaces)
{
  "subProfileId": 48291,
  "phoneNumberCountryCode": "001",
  "phoneNumber": "8005550199"
}

Response

200 OK

A 200 response indicates the subprofile phone number was successfully updated. The response body confirms success with no additional fields returned.

{}

Error Codes

CodeWhen it happens
400Missing required fields (phoneNumber or phoneNumberCountryCode), or field length constraints violated (country code must be exactly 3 characters, phone number must be exactly 10 digits)
401Token missing, expired, or invalid
403Insufficient permissions to update subprofile data
404The specified subprofile was not found
500Internal server error

Common Mistakes

  • Providing a phone number with fewer or more than exactly 10 digits — the phoneNumber field enforces a strict 10-character length and will reject values like "800-555-0199" (includes dashes) or "+18005550199" (includes country prefix)
  • Providing a phoneNumberCountryCode that is not exactly 3 characters — use "001" for the US, not "1" or "+1"
  • Omitting subProfileId when multiple subprofiles exist on the account, which may result in an ambiguous or failed update
  • Sending the phone number with formatting characters such as parentheses, spaces, or dashes — only numeric digits are accepted

Related Endpoints

  • POST /netevia/subProfiles — Create a new subprofile (authorized user) for a business customer
  • GET /netevia/subProfiles — Retrieve all subprofiles associated with a business customer account
  • PUT /netevia/subProfiles — Update general subprofile information
  • POST /netevia/subProfiles/email — Update the email address for a subprofile

Example

curl -X POST https://api.banking.netevia.dev/netevia/subProfiles/phone \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "subProfileId": 48291,
    "phoneNumberCountryCode": "001",
    "phoneNumber": "8005550199"
  }'
Body Params
int32
string
required
length between 3 and 3
string
required
length between 10 and 10
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!