Iterable · Schema

UserUpdateRequest

Request body for updating a user profile

Cross-Channel MessagingCustomer EngagementEmailMarketing AutomationPush NotificationsSMS

Properties

Name	Type	Description
email	string	Email address of the user
userId	string	Unique user identifier
dataFields	object	Custom data fields to set on the user profile
preferUserId	boolean	Whether to prefer userId over email for identity resolution
mergeNestedObjects	boolean	Whether to merge nested objects or overwrite them

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/UserUpdateRequest",
  "title": "UserUpdateRequest",
  "type": "object",
  "description": "Request body for updating a user profile",
  "properties": {
    "email": {
      "type": "string",
      "format": "email",
      "description": "Email address of the user"
    },
    "userId": {
      "type": "string",
      "description": "Unique user identifier"
    },
    "dataFields": {
      "type": "object",
      "description": "Custom data fields to set on the user profile",
      "additionalProperties": true
    },
    "preferUserId": {
      "type": "boolean",
      "description": "Whether to prefer userId over email for identity resolution"
    },
    "mergeNestedObjects": {
      "type": "boolean",
      "description": "Whether to merge nested objects or overwrite them"
    }
  }
}