Apideck · Schema

Email

IntegrationsUnified API

Properties

Name Type Description
id string Unique identifier for the email address
email string Email address
type string Email type
View JSON Schema on GitHub

JSON Schema

apideck-email-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Email",
  "title": "Email",
  "type": "object",
  "x-apideck-schema-id": "Email",
  "required": [
    "email"
  ],
  "additionalProperties": false,
  "x-apideck-weights": {
    "email": "critical",
    "type": "critical",
    "id": "edge-case"
  },
  "properties": {
    "id": {
      "type": "string",
      "example": "123",
      "description": "Unique identifier for the email address",
      "nullable": true
    },
    "email": {
      "type": "string",
      "format": "email",
      "description": "Email address",
      "example": "[email protected]",
      "minLength": 1,
      "nullable": true
    },
    "type": {
      "type": "string",
      "description": "Email type",
      "x-apideck-enum-id": "emails.type",
      "enum": [
        "primary",
        "secondary",
        "work",
        "personal",
        "billing",
        "other"
      ],
      "example": "primary",
      "nullable": true
    }
  }
}