Optimizely · Schema

Recipient

A recipient in a mailing list

A/B TestingContent ManagementCustomer DataE-CommerceExperimentationFeature FlagsMarketing

Properties

Name Type Description
id integer Unique identifier for the recipient
email string Email address of the recipient
first_name string First name of the recipient
last_name string Last name of the recipient
status string Subscription status of the recipient
custom_fields object Custom fields associated with the recipient
created string Timestamp when the recipient was created
last_modified string Timestamp when the recipient was last modified
View JSON Schema on GitHub

JSON Schema

optimizely-recipient-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Recipient",
  "title": "Recipient",
  "type": "object",
  "description": "A recipient in a mailing list",
  "properties": {
    "id": {
      "type": "integer",
      "format": "int64",
      "description": "Unique identifier for the recipient"
    },
    "email": {
      "type": "string",
      "format": "email",
      "description": "Email address of the recipient"
    },
    "first_name": {
      "type": "string",
      "description": "First name of the recipient"
    },
    "last_name": {
      "type": "string",
      "description": "Last name of the recipient"
    },
    "status": {
      "type": "string",
      "description": "Subscription status of the recipient",
      "enum": [
        "active",
        "unsubscribed",
        "bounced"
      ]
    },
    "custom_fields": {
      "type": "object",
      "description": "Custom fields associated with the recipient",
      "additionalProperties": {
        "type": "string"
      }
    },
    "created": {
      "type": "string",
      "format": "date-time",
      "description": "Timestamp when the recipient was created"
    },
    "last_modified": {
      "type": "string",
      "format": "date-time",
      "description": "Timestamp when the recipient was last modified"
    }
  }
}