Skip to content

ValidationExceptionField

Source code in docs_src/capo_partnercentral_marketing/types/validation_exception_field.py
class ValidationExceptionField(TypedDict, closed=True):
    name: "str"
    """The member of the request that failed, as the request names it: `FieldValues` for a template field value, `Layout`, `EmailTarget`, `Identifier`, and so on. It is never a template field id: a template field is always `FieldValues`, with the field in `FieldId`."""
    field_id: NotRequired[
        "capo_partnercentral_marketing.types.template_field_id.TemplateFieldId"
    ]
    """The template field that failed, when `Name` is `FieldValues`; absent otherwise."""
    message: "str"
    """Why this field failed, in prose a partner can be shown directly."""
    code: NotRequired[
        "capo_partnercentral_marketing.types.validation_exception_field_code.ValidationExceptionFieldCode"
    ]
    """Why this field failed, as a value a client branches on. Read this rather than `Message`."""

code instance-attribute

code: NotRequired[ValidationExceptionFieldCode]

Why this field failed, as a value a client branches on. Read this rather than Message.

field_id instance-attribute

field_id: NotRequired[TemplateFieldId]

The template field that failed, when Name is FieldValues; absent otherwise.

message instance-attribute

message: str

Why this field failed, in prose a partner can be shown directly.

name instance-attribute

name: str

The member of the request that failed, as the request names it: FieldValues for a template field value, Layout, EmailTarget, Identifier, and so on. It is never a template field id: a template field is always FieldValues, with the field in FieldId.