Looking for a REST API? The Ad Manager API (Beta) is now available.

type InvalidEmailError (v202411)

AI-generated Key Takeaways

InvalidEmailError is a type of ApiError that occurs when an email attribute has an invalid format.
This error can be encountered in several services including ContactService, NetworkService, OrderService, PublisherQueryLanguageService, and UserService.
The error includes fields like fieldPath, fieldPathElements, trigger, and errorString inherited from ApiError, along with a specific reason indicating the invalid format or an unknown issue.

Service

CompanyService ContactService NetworkService OrderService PublisherQueryLanguageService UserService

Inheritance

ApiError

▼

ApiVersionError AuthenticationError CollectionSizeError CommonError CompanyCreditStatusError CompanyError CrossSellError CustomFieldValueError ExchangeSignupApiError FeatureError InternalApiError InvalidEmailError InvalidUrlError InventoryClientApiError LabelEntityAssociationError McmError NetworkError NotNullError NullError ParseError PermissionError PublisherQueryLanguageConte... PublisherQueryLanguageSynta... QuotaError RegExError RequiredCollectionError RequiredError RequiredNumberError ServerError SiteError StatementError StringFormatError StringLengthError TeamError TypeError UniqueError

Caused by supplying a value for an email attribute that is not a valid email address.

Field
`ApiError` (inherited)
`fieldPath`	`xsd:string` The OGNL field path to identify cause of error.
`fieldPathElements`	`FieldPathElement[]` A parsed copy of the field path. For example, the field path "operations[1].operand" corresponds to this list: {FieldPathElement(field = "operations", index = 1), FieldPathElement(field = "operand", index = null)}.
`trigger`	`xsd:string` The data that caused the error.
`errorString`	`xsd:string` A simple string representation of the error and reason.
`InvalidEmailError`
`reason`	`InvalidEmailError.Reason` Enumerations `INVALID_FORMAT` The value is not a valid email address. `UNKNOWN` The value returned if the actual value is not exposed by the requested API version.