WorkOS · Schema

EmailChange

AuthenticationIdentity ProviderSSOSAMLOIDCSCIMDirectory SyncAuthorizationFGAAudit LogsMFAB2B SaaSAgentsMCP

Properties

Name	Type	Description
object	string	Distinguishes the email change object.
user	object
new_email	string	The new email address the user is changing to.
expires_at	string	The timestamp when the email change code expires.
created_at	string	The timestamp when the email change challenge was created.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/EmailChange",
  "title": "EmailChange",
  "type": "object",
  "properties": {
    "object": {
      "type": "string",
      "description": "Distinguishes the email change object.",
      "const": "email_change"
    },
    "user": {
      "$ref": "#/components/schemas/UserlandUser"
    },
    "new_email": {
      "type": "string",
      "description": "The new email address the user is changing to.",
      "example": "[email protected]"
    },
    "expires_at": {
      "format": "date-time",
      "type": "string",
      "description": "The timestamp when the email change code expires.",
      "example": "2026-01-15T12:00:00.000Z"
    },
    "created_at": {
      "format": "date-time",
      "type": "string",
      "description": "The timestamp when the email change challenge was created.",
      "example": "2026-01-15T12:00:00.000Z"
    }
  },
  "required": [
    "object",
    "user",
    "new_email",
    "expires_at",
    "created_at"
  ]
}