Benchmark Email · Schema

Contact

An email contact (subscriber) in Benchmark Email.

Email MarketingCampaignsContactsAutomationTransactional EmailMarketing

Properties

Name Type Description
ContactID integer Unique identifier for the contact.
Email string Email address of the contact.
FirstName string First name of the contact.
LastName string Last name of the contact.
Status string Subscription status of the contact.
SubscribeDate string Date and time when the contact subscribed.
UnsubscribeDate string Date and time when the contact unsubscribed, if applicable.
CustomFields object Custom field values for the contact.
View JSON Schema on GitHub

JSON Schema

contact.json Raw ↑
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/benchmark-email/main/json-schema/contact.json",
  "title": "Contact",
  "description": "An email contact (subscriber) in Benchmark Email.",
  "type": "object",
  "properties": {
    "ContactID": {
      "type": "integer",
      "description": "Unique identifier for the contact."
    },
    "Email": {
      "type": "string",
      "format": "email",
      "description": "Email address of the contact."
    },
    "FirstName": {
      "type": "string",
      "description": "First name of the contact."
    },
    "LastName": {
      "type": "string",
      "description": "Last name of the contact."
    },
    "Status": {
      "type": "string",
      "enum": ["Active", "Unsubscribed", "Bounced", "DNC"],
      "description": "Subscription status of the contact."
    },
    "SubscribeDate": {
      "type": "string",
      "format": "date-time",
      "description": "Date and time when the contact subscribed."
    },
    "UnsubscribeDate": {
      "type": "string",
      "format": "date-time",
      "description": "Date and time when the contact unsubscribed, if applicable."
    },
    "CustomFields": {
      "type": "object",
      "additionalProperties": {
        "type": "string"
      },
      "description": "Custom field values for the contact."
    }
  },
  "required": ["Email"]
}