Skip to main content
POST
Update a user

Authorizations

api_key
string
header
required

Program API key identifying your integration. Pass as the api_key HTTP header (preferred) or as an api_key field in the JSON request body. Required on every request in addition to the HMAC Authorization header.

Body

application/json
user_id
string
required

Identifier of the target user. Required when the endpoint operates on a specific user.

Example:

"user-8f3a2b1c-0e44-4f2d-9a11-7b23cc90d1ef"

api_key
string

Program API key. Accepted either in the api_key HTTP header or as this body field.

first_name
string

First name.

middle_name
string

Middle name.

last_name
string

Last name.

phone_number
string

Phone number in E.164 format.

Example:

"+12125551234"

postal_code
string

5-digit US ZIP code.

country
string

ISO 3166-1 alpha-2 country code.

state
string

ISO 3166-2 two-letter state/region code.

city
string

City.

address_one
string

Street address line 1.

address_two
string

Street address line 2.

username
string

Chosen username for the user.

date_of_birth
string<date>

Date of birth in YYYY-MM-DD format.

Example:

"1990-04-15"

ssn
string

Social security number. Encrypted at rest.

Response

Success.

status
enum<string>
required
Available options:
success
message
string
required
Example:

"operation completed"

data
object

Endpoint-specific payload; shape varies per operation.