Skip to main content

Endpoint

Overview

This endpoint allows an authenticated user to update their display_name. When a display name is updated:
  • It is sanitized to enforce lowercase, hyphenated format, and safe characters.
  • Any existing email forwarding is disabled and the forwarding address is cleared.
  • If the user previously had email forwarding, their old ImprovMX alias is removed.
An analytics event is also logged for auditing and tracking purposes.

Authentication

This endpoint requires an API key. You can retrieve an API key from your dashboard. Include it in the X-API-KEY header:
For more details, see the Authentication Guide.

Request Body

Rules & Validation

  • The display_name will be:
    • Converted to lowercase.
    • Spaces replaced with hyphens.
    • Non-alphanumeric characters (except hyphens) removed.
  • Must be at least 3 characters long after sanitization.
  • Must be unique across all profiles and not in the reserved names list.
If the input fails these checks, you’ll receive detailed error messages.

Request Examples

cURL

Python

JavaScript (Fetch)

Responses

200 OK

Successfully updated the display name.

400 Bad Request

Invalid or missing input.

401 Unauthorized

Occurs if authentication fails (e.g., missing or invalid API key).

404 Not Found

Profile could not be found (possible stale session).

409 Conflict

The requested display name is reserved or already taken.

500 Internal Server Error

A server-side error occurred.

Need Further Assistance?

If you have any questions or encounter issues, please don’t hesitate to reach out to our support team.