Optimizely · Schema

MessageRequestData

A/B TestingContent ManagementCustomer DataE-CommerceExperimentationFeature FlagsMarketing

Properties

Name	Type	Description
deepLinkName	string	This parameter is deprecated. Use "payload.[name]" instead.
mediaType	string	Media type of the mailing (required only for creation)
subjectForTargetGroup	string	Subject for a specific target group. Set "subject.[targetGroupId]" in request data (only email). Does not work with the "Try it out" feature.
replyToAddress	string	Reply-to address (only email)
archiveEnabled	boolean	Toggle whether a mailing can be archived or not
iconMetaData	string	Icon meta data. Configure "icon.[attribute]". Does not work with the "Try it out" feature.
archivePeriod	string	Period suggesting for how long a mailing should be archived
resetReplyToAddress	boolean	If true, the local part of the reply-to address is reset
resetTargetedSubjects	boolean	If true, all target group subjects are deleted (only email)
replyToName	string	Reply-to mailing name (only email)
resetDeeplinks	boolean	This parameter is deprecated. Use "resetPayload" instead.
resetPayload	boolean	If true, all payload parameters are deleted. All set parameters within this request remain (only Web Push mailings).
name	string	Mailing name
content	string	Mailing content (plain text)
payload	string	Payload parameters for Mobile Push and Web Push. Set "payload.[name]" in request data. Does not work with the "Try it out" feature.
description	string	Mailing description
senderName	string	Mailing sender name (only email)
subject	string	Mailing subject
mediaCode	string	Media code (only email)
expiry	string	Expiry date (only push mailings, use ISO 8601 format without milliseconds, e.g. 2022-03-03T08:45:07+01:00)
image	string	Image for the Web Push message
senderAddress	string	Mailing sender address
clickAction	string	Click action for the Web Push message
pushType	string	Push type
icon	string	Icon for the Web Push message
predecessorNodeId	string	Predecessor node
successorNodeId	string	Successor node

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/optimizely/main/json-schema/optimizely-message-request-data-schema.json",
  "title": "MessageRequestData",
  "x-generated": "2026-10-12",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/optimizely-smart-campaigns-api-openapi.yml#/components/schemas/MessageRequestData",
  "type": "object",
  "properties": {
    "deepLinkName": {
      "type": "string",
      "description": "This parameter is deprecated. Use \"payload.[name]\" instead."
    },
    "mediaType": {
      "type": "string",
      "description": "Media type of the mailing (required only for creation)",
      "enum": [
        "email",
        "sms",
        "push"
      ]
    },
    "subjectForTargetGroup": {
      "type": "string",
      "description": "Subject for a specific target group. Set \"subject.[targetGroupId]\" in request data (only email).<p>Does not work with the \"Try it out\" feature.</p>"
    },
    "replyToAddress": {
      "type": "string",
      "description": "Reply-to address (only email)"
    },
    "archiveEnabled": {
      "type": "boolean",
      "description": "Toggle whether a mailing can be archived or not"
    },
    "iconMetaData": {
      "type": "string",
      "description": "Icon meta data. Configure \"icon.[attribute]\".<p>Does not work with the \"Try it out\" feature.</p>"
    },
    "archivePeriod": {
      "type": "string",
      "description": "Period suggesting for how long a mailing should be archived",
      "enum": [
        "ONE_MONTH",
        "TWO_MONTHS",
        "THREE_MONTHS",
        "SIX_MONTHS",
        "ONE_YEAR",
        "TWO_YEARS"
      ]
    },
    "resetReplyToAddress": {
      "type": "boolean",
      "description": "If true, the local part of the reply-to address is reset"
    },
    "resetTargetedSubjects": {
      "type": "boolean",
      "description": "If true, all target group subjects are deleted (only email)"
    },
    "replyToName": {
      "type": "string",
      "description": "Reply-to mailing name (only email)"
    },
    "resetDeeplinks": {
      "type": "boolean",
      "description": "This parameter is deprecated. Use \"resetPayload\" instead."
    },
    "resetPayload": {
      "type": "boolean",
      "description": "If true, all payload parameters are deleted. All set parameters within this request remain (only Web Push mailings)."
    },
    "name": {
      "type": "string",
      "description": "Mailing name"
    },
    "content": {
      "type": "string",
      "description": "Mailing content (plain text)"
    },
    "payload": {
      "type": "string",
      "description": "Payload parameters for Mobile Push and Web Push. Set \"payload.[name]\" in request data.<p>Does not work with the \"Try it out\" feature.</p>"
    },
    "description": {
      "type": "string",
      "description": "Mailing description"
    },
    "senderName": {
      "type": "string",
      "description": "Mailing sender name (only email)"
    },
    "subject": {
      "type": "string",
      "description": "Mailing subject"
    },
    "mediaCode": {
      "type": "string",
      "description": "Media code (only email)"
    },
    "expiry": {
      "type": "string",
      "description": "Expiry date (only push mailings, use ISO 8601 format without milliseconds, e.g. 2022-03-03T08:45:07+01:00)",
      "format": "date-time"
    },
    "image": {
      "type": "string",
      "description": "Image for the Web Push message"
    },
    "senderAddress": {
      "type": "string",
      "description": "Mailing sender address"
    },
    "clickAction": {
      "type": "string",
      "description": "Click action for the Web Push message"
    },
    "pushType": {
      "type": "string",
      "description": "Push type",
      "enum": [
        "MOBILE",
        "WEB"
      ]
    },
    "icon": {
      "type": "string",
      "description": "Icon for the Web Push message"
    },
    "predecessorNodeId": {
      "type": "string",
      "description": "Predecessor node"
    },
    "successorNodeId": {
      "type": "string",
      "description": "Successor node"
    }
  }
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this

find_json_schemasBrowse and filter every JSON Schema in the catalog.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This JSON Schema

curl "https://apis.io/api/v1/json-schemas/optimizely-message-request-data"

All schemas

curl "https://apis.io/api/v1/json-schemas?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.