WildApricot · JSON Structure

Wildapricot Email Draft Structure

EmailDraft schema from WildApricot Admin API

Type: object Properties: 16

Membership ManagementAssociationsNonprofitEventsPayments

EmailDraft is a JSON Structure definition published by WildApricot, describing 16 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

Id Url CreatedDate Type Subject Body ReplyToName ReplyToAddress EventId Creator IsLinkTrackingAllowed Recipients LastChangedDate Modifier IsScheduled ScheduledDate

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/wildapricot/refs/heads/main/json-structure/wildapricot-email--draft-structure.json",
  "description": "EmailDraft schema from WildApricot Admin API",
  "type": "object",
  "properties": {
    "Id": {
      "type": "int32",
      "description": "Unique email draft identifier."
    },
    "Url": {
      "$ref": "#/components/schemas/ResourceUrl"
    },
    "CreatedDate": {
      "type": "string",
      "description": "Date and time when the draft was created."
    },
    "Type": {
      "$ref": "#/components/schemas/EmailDraftType"
    },
    "Subject": {
      "type": "string",
      "description": "Value for email subject. It may contain macros, which will be replaced before delivery.\n"
    },
    "Body": {
      "type": "string",
      "description": "Value for email body. Usually it is HTML content with macros, which will be replaced before delivery.\n"
    },
    "ReplyToName": {
      "type": "string",
      "description": "Display name for reply to"
    },
    "ReplyToAddress": {
      "type": "string",
      "description": "Email address to use as reply to."
    },
    "EventId": {
      "type": "int32",
      "description": "Event identifier for which the draft has been started (if any)."
    },
    "Creator": {
      "$ref": "#/components/schemas/ShortContact"
    },
    "IsLinkTrackingAllowed": {
      "type": "boolean",
      "description": "Indicates if email tracking is enabled for this email."
    },
    "Recipients": {
      "$ref": "#/components/schemas/EmailRecipients"
    },
    "LastChangedDate": {
      "type": "string",
      "description": "Date and time when the draft was last modified."
    },
    "Modifier": {
      "$ref": "#/components/schemas/ShortContact"
    },
    "IsScheduled": {
      "type": "boolean",
      "description": "Indicates if draft delivery is scheduled for a particular date. See ScheduledDate value."
    },
    "ScheduledDate": {
      "type": "string",
      "description": "Date and time when the draft will be sent."
    }
  },
  "name": "EmailDraft"
}