Skip to navigation
REST API EndpointsUsers

Update Contact Country

View as Markdown

Update a user’s country.

Available to: All authenticated users (own contact information)

Environments: Live

Rate Limit: No endpoint-specific limit

Update the logged-in user’s country. Unlike updateContactInfo, this endpoint acts on the logged-in user’s own record and doesn’t take a target userId.

The restricted-country check applies 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, a submission naming a restricted country is rejected. Because the check also reads the user’s stored mailing country, an update can be rejected when the stored mailing country is a restricted country, even if the submitted country isn’t. This endpoint doesn’t run the U.S. ZIP format check; that check runs on updateContactInfo only.

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 country.
A rejected submission returns HTTP 200 with errorText set, not an error status. Check errorText to confirm the update succeeded.

Error Messages

MessageResponseTrigger
"Contact information for this country cannot be submitted. Please contact support."200 (in errorText)The submitted country, or the user’s stored mailing country, is a restricted country.

Authentication

AuthorizationBearer

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

Request

This endpoint expects an object.
countrystringRequired=2 characters

Response

UpdateContactInfoResponse
errorTextstringOptional<=8192 characters

Non-empty if the request failed

contactInfoobjectOptional