Skip to main content
PATCH
Update the current user profile (Beta)

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Profile fields to update. Omitted fields retain their current values.

first_name
string | null

The user's first name.

Maximum string length: 100
Example:

"Alex"

last_name
string | null

The user's last name.

Maximum string length: 100
Example:

"Taylor"

business_name
string | null

Business name associated with the profile.

Maximum string length: 255
Example:

"Example Company"

phone_number
string | null

Contact phone number associated with the profile.

Example:

"+13125550100"

address_1
string | null

First line of the profile address.

Example:

"123 Example Street"

address_2
string | null

Second line of the profile address.

Example:

"Suite 100"

city
string | null

City in the profile address.

Example:

"Chicago"

state
string | null

State or region in the profile address.

Example:

"IL"

zip
string | null

Postal code in the profile address.

Example:

"60601"

country
string | null

Country code in the profile address.

Example:

"US"

got_free_number_at_signup
boolean

Whether the user received a free number at signup.

Example:

false

ui_theme
enum<integer>

User interface theme: 0 for dark or 1 for light.

Available options:
0,
1
Example:

1

low_balance_threshold_amount
number | null

Low-balance notification threshold in the billing currency. The resulting profile must have both a threshold and notification frequency, or neither.

Example:

10

low_balance_notification_frequency
enum<integer> | null

Low-balance notification frequency. Organization sub-users cannot set a non-null frequency. The resulting profile must have both a threshold and frequency, or neither.

Available options:
2,
4,
12,
24,
null
Example:

12

notify_on_invoice_available
boolean

Whether to notify the user when an invoice is available.

Example:

true

notify_on_invoice_payment
boolean

Whether to notify the user when an invoice is paid.

Example:

false

primary_use_case
string

Primary use case for the account.

Example:

"configure sip trunks"

default_numbers_external_pin
string

Default alphanumeric external PIN for phone numbers.

Required string length: 4 - 16
Example:

"1234"

role
string

The user's role.

Example:

"account manager"

company_size
string

Company size reported by the user.

Example:

"11-50"

npac_user
boolean

Whether the user is an NPAC user.

Example:

false

user_subscription_opt_in
boolean

Whether the user opts in to subscriptions.

Example:

false

default_managed_account_allow_custom_pricing
boolean

Default custom-pricing setting for managed accounts.

Example:

false

default_managed_account_rollup_billing
boolean

Default rollup-billing setting for managed accounts.

Example:

false

default_notify_manager_account
boolean

Default setting for notifying the manager account.

Example:

true

port_out_pin_validation
boolean

Whether port-out PIN validation is enabled.

Example:

false

default_managed_account_inherit_emergency_terms_of_service
boolean

Default emergency terms-of-service inheritance setting for managed accounts, where supported.

Example:

false

data_locality
enum<string>

Data locality: USA (United States), DEU (Germany), AUS (Australia), UAE (United Arab Emirates), or CAN (Canada). A change is permitted only if data locality has not previously been changed. A successful change sets data_locality_updated_at and initializes data_locality_migration_status to not_started.

Available options:
USA,
DEU,
AUS,
UAE,
CAN
Example:

"DEU"

use_cases
string[]

Use cases reported by the user.

Example:
onboarding_use_cases_other
string[]

Other onboarding use cases.

Example:
onboarding_project_types
string[]

Onboarding project types.

Example:
onboarding_reasons_for_consideration
string[]

Reasons for considering Telnyx.

Example:
onboarding_industries
string[]

Industries reported during onboarding.

Example:
onboarding_monthly_budget
string[]

Monthly budget ranges reported during onboarding.

Example:
onboarding_referrer
string[]

Referral sources reported during onboarding.

Example:
onboarding_build_method
string[]

Build methods reported during onboarding.

Example:
onboarding_product_interest
string[]

Products of interest reported during onboarding.

Maximum array length: 20
Maximum string length: 255
Example:

Response

The updated user profile.

data
object
required

The authenticated user's profile.