Skip to navigation
REST API EndpointsUsers

Update Contact Info

View as Markdown

Update a user’s contact information.

Available to: All authenticated users (own contact information); organization administrators (any user in their organization)

Environments: Live

Rate Limit: No endpoint-specific limit

Update a user’s name, address, and phone number. Pass the target user’s userId; the call writes the contact information you send to that user’s record. If you don’t set a user’s contact information during onboarding, the user is prompted to enter it on their first login.

Requests with firstName and lastName fields exceeding a combined 60 characters are rejected, despite each field individually allowing up to 64 characters. The same limit applies to jointFirstName and jointLastName.

Two address checks apply to users when all of the following are true: their organization is an evaluation organization, they do not own an unarchived account, and they do not hold an approved trading permission. For these users:

  • Restricted countries are rejected. A submission naming a restricted country in either the primary country or the mailingCountry is rejected, whether or not a separate mailing address is used. This check also runs on updateContactInfoName and updateContactCountry.
  • U.S. ZIP codes are format-checked. When country is US, postCode must be a 5-digit ZIP (12345) or ZIP+4 (12345-6789); a missing or malformed value is rejected. The same applies to the mailing ZIP when a separate mailing address is used and its country is US. The check confirms the format only, not that the ZIP exists or matches the state. This check runs on updateContactInfo only.

When a submission fails both checks, the U.S. ZIP code is checked first, so the ZIP error is returned.

Users who own an account, users who hold an approved trading permission, and users outside an evaluation organization aren’t affected and can submit any valid address.
A rejected submission returns HTTP 200 with errorText set, not an error status. Check errorText to confirm the update succeeded.

Common Failure Scenarios

  • The primary or mailing address names a restricted country, for a user in the group above.
  • country is US and postCode is missing or isn’t a valid 5-digit or ZIP+4 code, for a user in the group above.

Error Messages

MessageResponseTrigger
"Contact information for this country cannot be submitted. Please contact support."200 (in errorText)The primary or mailing country is a restricted country.
"Please enter a valid US ZIP code (e.g. 77056 or 77056-1234)."200 (in errorText)country is US and postCode is missing or not a valid 5-digit or ZIP+4 code.

Authentication

AuthorizationBearer

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

Request

This endpoint expects an object.
userIdlongRequired
firstNamestringRequired<=64 characters
lastNamestringRequired1-64 characters
streetAddress1stringRequired3-61 characters
citystringRequired2-35 characters
countrystringRequired=2 characters
phonestringRequired<=21 characters
streetAddress2stringOptional<=61 characters
statestringOptional2-64 characters
postCodestringOptional4-11 characters
mailingIsDifferentbooleanOptional
mailingStreetAddress1stringOptional<=8192 characters
mailingStreetAddress2stringOptional<=8192 characters
mailingCitystringOptional<=64 characters
mailingStatestringOptional<=64 characters
mailingPostCodestringOptional<=64 characters
mailingCountrystringOptional<=2 characters
approvedIdlongOptional>=0
jointFirstNamestringOptional<=64 characters
jointLastNamestringOptional1-64 characters

Response

UpdateContactInfoResponse
errorTextstringOptional<=8192 characters

Non-empty if the request failed

contactInfoobjectOptional