---
updatedAt: 2026-05-10T13:21:40.000Z
agentTools:
  projectIndex: https://docs.bigmailer.io/llms.txt
---

# Get transactional campaign

Get a transactional campaign.

# OpenAPI definition

```json
{
  "x-types": {
    "CursorDesc": "A cursor for use in pagination. `cursor` defines your place in the list. For instance, if you make a list request and receive 100 objects along with cursor `xyz123`, your subsequent call can include `cursor=xyz123` in order to fetch the next page of the list.",
    "CreatedDesc": "Time at which the object was created. Measured in seconds since the UNIX epoch.",
    "SampleImage": "R0lGODlhAQABAIAAAAAAAP///yH5BAEAAAAALAAAAAABAAEAAAIBRAA7",
    "BrandNameDesc": "Name of the brand",
    "BounceDangerPercentDesc": "An integer percentage (0-100). If a bulk campaign in the brand reaches this threshold percent of bounces, it is paused automatically.",
    "MaxSoftBouncesDesc": "The maximum number of times a contact can soft bounce before it is considered undeliverable. Set to 0 to remove the limit on soft bounces.",
    "BrandURLDesc": "URL of a website associated with the brand",
    "UnsubscribeTextDesc": "A message displayed to contacts on the brand unsubscribe page.",
    "ContactLimitDesc": "The maxmimum number of contacts the brand is allowed to contain.",
    "ConnectionIDDesc": "ID of the connection used to send emails",
    "FromNameDesc": "Default name used in the \"From:\" header in campaigns sent from this brand.",
    "FromEmailDesc": "Default email used in the \"From:\" header in campaigns sent from this brand.",
    "TimeZoneDesc": "IANA timezone for the brand. If set, it overrides the account timezone for brand-specific scheduling and rendering.",
    "BrandLogoDesc": "A base64 encoded JPEG, PNG, or GIF image identified with the brand.",
    "ConnectionNameDesc": "Name of the connection",
    "UserRoleDesc": "The user role determines what actions the user may perform. See our [description of user roles](https://docs.bigmailer.io/docs/user-types-and-permissions).",
    "UserEmailDesc": "User's email address",
    "AllowedBrandsDesc": "A list of brand IDs the user is allowed to access. Only relevant if the role is brand_manager, campaign_manager, campaign_viewer, or template_manager.",
    "InvitationMessageDesc": "A message to include in the invitation email.",
    "HTMLBody": "<html><body><p>hello, world.</p></body></html>",
    "TemplateTypeDesc": "Type of campaigns the template may be used with",
    "SharedWithAccountDesc": "true if the template is shared with all brands in the account. false otherwise.",
    "OperatorDesc": "all if all conditions must match for the segment to match. any if at least one condition must match for the segment to match.",
    "SegmentConditionsDesc": "An array of conditions that the segment must satisfy. See our [description of segment conditions](https://docs.bigmailer.io/docs/segments).",
    "DaysOfWeek": [
      "mon",
      "tue",
      "wed",
      "thu",
      "fri",
      "sat",
      "sun"
    ],
    "DaysOfMonth": [
      1,
      2,
      3,
      4,
      5,
      6,
      7,
      8,
      9,
      10,
      11,
      12,
      13,
      14,
      15,
      16,
      17,
      18,
      19,
      20,
      21,
      22,
      23,
      24,
      25,
      26,
      27,
      28,
      29,
      30,
      31,
      -1
    ],
    "UserRoles": [
      "admin",
      "account_manager",
      "brand_manager",
      "campaign_manager",
      "campaign_viewer",
      "template_manager"
    ],
    "ConnectionTypes": [
      "aws",
      "elastic_email",
      "spark_post",
      "green_arrow",
      "pro"
    ],
    "CampaignStatuses": [
      "draft",
      "pending",
      "in progress",
      "complete",
      "error",
      "paused",
      "archived",
      "active"
    ],
    "CampaignThrottlingTypes": [
      "none",
      "burst"
    ],
    "CampaignThrottlingPeriods": [
      900,
      1800,
      3600,
      7200
    ],
    "TemplateTypes": [
      "email",
      "page"
    ],
    "SegmentOperators": [
      "all",
      "any"
    ],
    "BrandIdParam": {
      "in": "path",
      "name": "brand_id",
      "required": true,
      "schema": {
        "type": "string",
        "format": "uuid"
      }
    },
    "ConnectionIdParam": {
      "in": "path",
      "name": "connection_id",
      "required": true,
      "schema": {
        "type": "string",
        "format": "uuid"
      },
      "description": "ID of the connection"
    },
    "ContactIdParam": {
      "in": "path",
      "name": "contact_id",
      "required": true,
      "schema": {
        "type": "string"
      },
      "description": "ID or email address of the contact"
    },
    "ContactBatchIdParam": {
      "in": "path",
      "name": "batch_id",
      "required": true,
      "schema": {
        "type": "string",
        "format": "uuid"
      },
      "description": "ID of the contact batch"
    },
    "ListIdParam": {
      "in": "path",
      "name": "list_id",
      "required": true,
      "schema": {
        "type": "string",
        "format": "uuid"
      },
      "description": "ID of the list"
    },
    "FieldIdParam": {
      "in": "path",
      "name": "field_id",
      "required": true,
      "schema": {
        "type": "string",
        "format": "uuid"
      },
      "description": "ID of the field"
    },
    "MessageTypeIdParam": {
      "in": "path",
      "name": "message_type_id",
      "required": true,
      "schema": {
        "type": "string",
        "format": "uuid"
      },
      "description": "ID of the message type"
    },
    "TemplateIdParam": {
      "in": "path",
      "name": "template_id",
      "required": true,
      "schema": {
        "type": "string",
        "format": "uuid"
      },
      "description": "ID of the template"
    },
    "SenderIdParam": {
      "in": "path",
      "name": "sender_id",
      "required": true,
      "schema": {
        "type": "string",
        "format": "uuid"
      },
      "description": "ID of the sender"
    },
    "BrandPropertyIdParam": {
      "in": "path",
      "name": "brand_property_id",
      "required": true,
      "schema": {
        "type": "string",
        "format": "uuid"
      },
      "description": "ID of the brand property"
    },
    "SegmentIdParam": {
      "in": "path",
      "name": "segment_id",
      "required": true,
      "schema": {
        "type": "string",
        "format": "uuid"
      },
      "description": "ID of the segment"
    },
    "SuppressionListIdParam": {
      "in": "path",
      "name": "suppression_list_id",
      "required": true,
      "schema": {
        "type": "string",
        "format": "uuid"
      },
      "description": "ID of the suppression list"
    },
    "CampaignIdParam": {
      "in": "path",
      "name": "campaign_id",
      "required": true,
      "schema": {
        "type": "string",
        "format": "uuid"
      },
      "description": "ID of the campaign"
    },
    "UserIdParam": {
      "in": "path",
      "name": "user_id",
      "required": true,
      "schema": {
        "type": "string",
        "format": "uuid"
      },
      "description": "ID of the user"
    },
    "LimitParam": {
      "in": "query",
      "name": "limit",
      "description": "A limit on the number of objects to be returned, between 1 and 100.",
      "schema": {
        "type": "integer",
        "default": 10
      }
    },
    "CursorParam": {
      "in": "query",
      "name": "cursor",
      "description": "A cursor for use in pagination. `cursor` defines your place in the list. For instance, if you make a list request and receive 100 objects along with cursor `xyz123`, your subsequent call can include `cursor=xyz123` in order to fetch the next page of the list.",
      "schema": {
        "type": "string"
      }
    },
    "ListIdFilterParam": {
      "in": "query",
      "name": "list_id",
      "description": "The id of a list. Only contacts in this list are returned.",
      "schema": {
        "type": "string",
        "format": "uuid"
      }
    },
    "MessageTypeTypeParam": {
      "in": "query",
      "name": "type",
      "description": "Limit results to a specific type.",
      "schema": {
        "type": "string",
        "enum": [
          "all",
          "account",
          "user"
        ],
        "default": "user"
      }
    },
    "OpParam": {
      "in": "query",
      "schema": {
        "type": "string",
        "enum": [
          "add",
          "remove",
          "replace"
        ],
        "default": "replace"
      }
    },
    "ValidateParam": {
      "in": "query",
      "name": "validate",
      "description": "Set to true to validate the email for deliverability before adding the contact. Validation credits must be purchased before using this feature. The API does not add the contact and returns an error if the email is undeliverable.",
      "schema": {
        "type": "string",
        "enum": [
          "true",
          "false"
        ],
        "default": "false"
      }
    },
    "HasMoreProp": {
      "description": "Whether or not there are more elements after this set. If `false`, this set comprises the end of the list.",
      "example": true,
      "type": "boolean"
    },
    "CursorProp": {
      "description": "A cursor for use in pagination. `cursor` defines your place in the list. For instance, if you make a list request and receive 100 objects along with cursor `xyz123`, your subsequent call can include `cursor=xyz123` in order to fetch the next page of the list.",
      "example": "K5pwIGH3hgYrhytbDUY5eQ==",
      "type": "string"
    },
    "TotalProp": {
      "description": "The total number of items in the brand or list.",
      "example": 100,
      "type": "integer"
    },
    "SubdomainPattern": "^([A-Za-z0-9](|[A-Za-z0-9-]{0,61}[A-Za-z0-9]))$",
    "FieldValuesExample": [
      {
        "name": "FIRST NAME",
        "string": "Christopher"
      },
      {
        "name": "BIRTHDAY",
        "date": "1981-12-04"
      },
      {
        "name": "EMPLOYEE ID",
        "integer": 12345
      }
    ],
    "BrandExample": {
      "id": "66e60ece-d4e4-4286-8ea6-990cb500aa8e",
      "name": "My Company Ltd",
      "from_name": "Christopher",
      "from_email": "chris@example.com",
      "timezone": "America/New_York",
      "filter_soft_bounces": true,
      "max_soft_bounces": 5,
      "bounce_danger_percent": 15,
      "unsubscribe_text": "Sorry to see you go!",
      "connection_id": "2aef2dd2-ab14-453a-aadc-01f3699ed85a",
      "contact_limit": 50000,
      "num_contacts": 1200,
      "engagement": {
        "num_opened": 480,
        "percent_opened": 0.4,
        "num_clicked": 180,
        "percent_clicked": 0.15
      },
      "url": "http://www.example.com/",
      "created": 1568654293
    },
    "BrandProperties": {
      "id": {
        "description": "ID of the brand",
        "example": "66e60ece-d4e4-4286-8ea6-990cb500aa8e",
        "format": "uuid",
        "type": "string"
      },
      "name": {
        "description": "Name of the brand",
        "example": "My Company Ltd",
        "type": "string"
      },
      "from_name": {
        "description": "Default name used in the \"From:\" header in campaigns sent from this brand.",
        "example": "Christopher",
        "type": "string"
      },
      "from_email": {
        "description": "Default email used in the \"From:\" header in campaigns sent from this brand.",
        "example": "chris@example.com",
        "format": "email",
        "type": "string"
      },
      "timezone": {
        "description": "IANA timezone for the brand. If set, it overrides the account timezone for brand-specific scheduling and rendering.",
        "example": "America/New_York",
        "type": "string"
      },
      "filter_soft_bounces": {
        "description": "true if campaigns sent from this brand should exclude contacts with more than `max_soft_bounces` soft bounces, false otherwise.",
        "example": true,
        "type": "boolean"
      },
      "max_soft_bounces": {
        "description": "if filter_soft_bounces is true, the maximum number of times a contact can soft bounce before it is considered undeliverable.",
        "example": 5,
        "type": "integer"
      },
      "bounce_danger_percent": {
        "description": "An integer percentage (0-100). If a bulk campaign in the brand reaches this threshold percent of bounces, it is paused automatically.",
        "example": 15,
        "type": "integer"
      },
      "unsubscribe_text": {
        "description": "A message displayed to contacts on the brand unsubscribe page.",
        "example": "Sorry to see you go!",
        "type": "string"
      },
      "connection_id": {
        "description": "ID of the connection used to send emails",
        "example": "2aef2dd2-ab14-453a-aadc-01f3699ed85a",
        "format": "uuid",
        "type": "string"
      },
      "contact_limit": {
        "description": "The maxmimum number of contacts the brand is allowed to contain.",
        "example": 50000,
        "type": "integer"
      },
      "num_contacts": {
        "description": "Number of contacts in the brand.",
        "example": 1200,
        "type": "integer"
      },
      "engagement": {
        "description": "Aggregate engagement metrics for contacts in the brand.",
        "type": "object",
        "properties": {
          "num_opened": {
            "description": "Number of contacts in the brand who have opened at least one email.",
            "example": 480,
            "type": "integer"
          },
          "percent_opened": {
            "description": "Fraction of contacts in the brand who have opened at least one email.",
            "example": 0.4,
            "type": "number"
          },
          "num_clicked": {
            "description": "Number of contacts in the brand who have clicked at least one email.",
            "example": 180,
            "type": "integer"
          },
          "percent_clicked": {
            "description": "Fraction of contacts in the brand who have clicked at least one email.",
            "example": 0.15,
            "type": "number"
          }
        }
      },
      "url": {
        "description": "URL of a website associated with the brand",
        "example": "http://www.example.com/",
        "type": "string"
      },
      "created": {
        "description": "Time at which the object was created. Measured in seconds since the UNIX epoch.",
        "example": 1592422352,
        "type": "integer"
      }
    },
    "CreateUpdateBrandExample": {
      "name": "BigMailer Co",
      "from_name": "Chris",
      "from_email": "chris@bigmailer.io",
      "timezone": "America/New_York",
      "bounce_danger_percent": 15,
      "max_soft_bounces": 5,
      "url": "https://www.bigmailer.io/",
      "unsubscribe_text": "Please don't unsubscribe.",
      "contact_limit": 50000,
      "logo": "R0lGODlhAQABAIAAAAAAAP///yH5BAEAAAAALAAAAAABAAEAAAIBRAA7",
      "connection_id": "562f699c-dbd0-4047-907c-218a2b482220"
    },
    "CreateUpdateBrandProperties": {
      "name": {
        "description": "Name of the brand",
        "example": "BigMailer Co",
        "type": "string",
        "minLength": 1,
        "maxLength": 50
      },
      "from_name": {
        "description": "Default name used in the \"From:\" header in campaigns sent from this brand.",
        "example": "Chris",
        "type": "string"
      },
      "from_email": {
        "description": "Default email used in the \"From:\" header in campaigns sent from this brand.",
        "example": "chris@bigmailer.io",
        "type": "string",
        "format": "email"
      },
      "timezone": {
        "description": "IANA timezone for the brand. If set, it overrides the account timezone for brand-specific scheduling and rendering.",
        "example": "America/New_York",
        "type": "string",
        "maxLength": 100
      },
      "bounce_danger_percent": {
        "description": "An integer percentage (0-100). If a bulk campaign in the brand reaches this threshold percent of bounces, it is paused automatically.",
        "example": 15,
        "type": "integer",
        "minimum": 1,
        "maximum": 15,
        "default": 8
      },
      "max_soft_bounces": {
        "description": "The maximum number of times a contact can soft bounce before it is considered undeliverable. Set to 0 to remove the limit on soft bounces.",
        "example": 5,
        "type": "integer",
        "minimum": 0,
        "maximum": 20,
        "default": 12
      },
      "url": {
        "description": "URL of a website associated with the brand",
        "example": "https://www.bigmailer.io/",
        "type": "string",
        "format": "url"
      },
      "unsubscribe_text": {
        "description": "A message displayed to contacts on the brand unsubscribe page.",
        "example": "Sorry to see you go!",
        "type": "string"
      },
      "contact_limit": {
        "description": "The maxmimum number of contacts the brand is allowed to contain.",
        "example": 50000,
        "type": "integer",
        "minimum": 0,
        "maximum": 1000000000,
        "multipleOf": 1000
      },
      "logo": {
        "description": "A base64 encoded JPEG, PNG, or GIF image identified with the brand.",
        "example": "R0lGODlhAQABAIAAAAAAAP///yH5BAEAAAAALAAAAAABAAEAAAIBRAA7",
        "type": "string",
        "format": "byte"
      },
      "connection_id": {
        "description": "ID of the connection used to send emails",
        "example": "562f699c-dbd0-4047-907c-218a2b482220",
        "type": "string",
        "format": "uuid"
      }
    },
    "ConnectionExample": {
      "id": "66e60ece-d4e4-4286-8ea6-990cb500aa8e",
      "type": "aws",
      "name": "AWS us-east-1",
      "created": 1568654293
    },
    "ConnectionProperties": {
      "id": {
        "description": "ID of the connection",
        "example": "66e60ece-d4e4-4286-8ea6-990cb500aa8e",
        "format": "uuid",
        "type": "string"
      },
      "type": {
        "description": "Service type of the connection.",
        "example": "aws",
        "enum": [
          "aws",
          "elastic_email",
          "spark_post",
          "green_arrow",
          "pro"
        ],
        "type": "string"
      },
      "name": {
        "description": "Name of the connection",
        "example": "AWS us-east-1",
        "type": "string"
      },
      "created": {
        "description": "Time at which the object was created. Measured in seconds since the UNIX epoch.",
        "example": 1592422352,
        "type": "integer"
      }
    },
    "ContactExample": {
      "id": "66e60ece-d4e4-4286-8ea6-990cb500aa8e",
      "brand_id": "2aef2dd2-ab14-453a-aadc-01f3699ed85a",
      "email": "chris@bigmailer.io",
      "field_values": [
        {
          "name": "FIRST NAME",
          "string": "Christopher"
        },
        {
          "name": "BIRTHDAY",
          "date": "1981-12-04"
        },
        {
          "name": "EMPLOYEE ID",
          "integer": 12345
        }
      ],
      "list_ids": [
        "b4326936-9e08-4cf9-95fe-c44c8cf4e4ef"
      ],
      "unsubscribe_all": false,
      "unsubscribe_ids": [
        "23f4c393-7556-4317-a38e-e0b0e60e6c8a"
      ],
      "num_soft_bounces": 0,
      "num_hard_bounces": 0,
      "num_complaints": 0,
      "created": 1568654293
    },
    "ContactProperties": {
      "id": {
        "description": "ID of the contact",
        "example": "66e60ece-d4e4-4286-8ea6-990cb500aa8e",
        "format": "uuid",
        "type": "string"
      },
      "brand_id": {
        "description": "ID of the brand the contact is in",
        "example": "2aef2dd2-ab14-453a-aadc-01f3699ed85a",
        "format": "uuid",
        "type": "string"
      },
      "email": {
        "description": "Email address of the contact",
        "example": "chris@bigmailer.io",
        "format": "email",
        "type": "string"
      },
      "field_values": {
        "description": "Field values associated with the contact.\n",
        "example": [
          {
            "name": "FIRST NAME",
            "string": "Christopher"
          },
          {
            "name": "BIRTHDAY",
            "date": "1981-12-04"
          },
          {
            "name": "EMPLOYEE ID",
            "integer": 12345
          }
        ],
        "items": {
          "$ref": "#/components/schemas/FieldValuePayload"
        },
        "type": "array"
      },
      "list_ids": {
        "description": "IDs of the lists the contact is part of.",
        "example": [
          "b4326936-9e08-4cf9-95fe-c44c8cf4e4ef"
        ],
        "items": {
          "example": "b4326936-9e08-4cf9-95fe-c44c8cf4e4ef",
          "format": "uuid",
          "type": "string"
        },
        "type": "array"
      },
      "unsubscribe_all": {
        "description": "true if the contact has unsubscribed from all message types, false otherwise.",
        "example": true,
        "type": "boolean"
      },
      "unsubscribe_ids": {
        "description": "IDs of message types the contact has unsubscribed from.",
        "example": [
          "23f4c393-7556-4317-a38e-e0b0e60e6c8a"
        ],
        "items": {
          "example": "23f4c393-7556-4317-a38e-e0b0e60e6c8a",
          "format": "uuid",
          "type": "string"
        },
        "type": "array"
      },
      "num_soft_bounces": {
        "description": "Number of times a campaign sent to contact's email has soft bounced.",
        "type": "integer",
        "example": 0
      },
      "num_hard_bounces": {
        "description": "Number of times a campaign sent to contact's email has hard bounced.",
        "type": "integer",
        "example": 0
      },
      "num_complaints": {
        "description": "Number of times a campaign sent to contact's email has triggered a complaint.",
        "type": "integer",
        "example": 0
      },
      "created": {
        "description": "Time at which the object was created. Measured in seconds since the UNIX epoch.",
        "example": 1592422352,
        "type": "integer"
      }
    },
    "GetContactBatchExample": {
      "id": "66e60ece-d4e4-4286-8ea6-990cb500aa8e",
      "status": "complete",
      "num_created": 2,
      "num_new_not_created": 0,
      "num_updated": 1,
      "num_validation_credits_used": 2,
      "completed": 1568654294,
      "created": 1568654293,
      "results": [
        {
          "email": "chris@bigmailer.io",
          "id": "66e60ece-d4e4-4286-8ea6-990cb500aa8e",
          "success": true,
          "custom_id": "custom_id_1"
        },
        {
          "email": "test..1@example.com",
          "id": "66e60ece-d4e4-4286-8ea6-990cb500aa7d",
          "success": false,
          "code": "INVALID_EMAIL",
          "message": "Invalid email address",
          "custom_id": "custom_id_2"
        },
        {
          "email": "test2@example.com",
          "id": "66e60ece-d4e4-4286-8ea6-990cb500aa6c",
          "success": true,
          "custom_id": "custom_id_3"
        },
        {
          "email": "test3@example.com",
          "id": "66e60ece-d4e4-4286-8ea6-990cb500aa5b",
          "success": true,
          "custom_id": "custom_id_4"
        }
      ]
    },
    "GetContactBatchProperties": {
      "id": {
        "description": "ID of the contact batch.",
        "example": "66e60ece-d4e4-4286-8ea6-990cb500aa8e",
        "format": "uuid",
        "type": "string"
      },
      "status": {
        "description": "The state of processing for the contact batch.",
        "example": "complete",
        "type": "string",
        "enum": [
          "pending",
          "in progress",
          "complete",
          "error"
        ]
      },
      "num_created": {
        "description": "How many contacts from the batch were created.",
        "type": "integer",
        "example": 1
      },
      "num_new_not_created": {
        "description": "How many contacts from the batch were new but could not be created (due to account exceeding contact limit).",
        "type": "integer",
        "example": 0
      },
      "num_updated": {
        "description": "How many contacts from the batch were updated.",
        "type": "integer",
        "example": 0
      },
      "num_validation_credits_used": {
        "description": "How many validation credits were used processing the batch.",
        "type": "integer",
        "example": 1
      },
      "completed": {
        "description": "Time at which the batch completed processing. Measured in seconds since the UNIX epoch.",
        "example": 1592422353,
        "type": "integer"
      },
      "created": {
        "description": "Time at which the object was created. Measured in seconds since the UNIX epoch.",
        "example": 1592422352,
        "type": "integer"
      },
      "results": {
        "items": {
          "properties": {
            "email": {
              "description": "Email address of the contact.",
              "type": "string",
              "format": "email",
              "example": "chris@bigmailer.io"
            },
            "id": {
              "description": "ID of the contact created or updated.",
              "type": "string",
              "format": "uuid",
              "example": "66e60ece-d4e4-4286-8ea6-990cb500aa8e"
            },
            "custom_id": {
              "description": "Custom ID passed on the contact when the batch was created.",
              "type": "string",
              "example": "custom_id_1"
            },
            "success": {
              "description": "true if the contact was added or updated, false otherwise.",
              "type": "boolean",
              "example": true
            },
            "code": {
              "description": "When success is false, a short text code indicating why the contact could not be added or updated.",
              "type": "string",
              "example": "INVALID_EMAIL"
            },
            "message": {
              "description": "When success is false, an explanation indicating why the contact could not be added or updated.",
              "type": "string",
              "example": "Invalid email address"
            }
          },
          "type": "object"
        },
        "type": "array"
      }
    },
    "ListExample": {
      "id": "66e60ece-d4e4-4286-8ea6-990cb500aa8e",
      "name": "High Engagement Contacts",
      "all": false,
      "num_contacts": 120,
      "engagement": {
        "num_opened": 48,
        "percent_opened": 0.4,
        "num_clicked": 18,
        "percent_clicked": 0.15
      },
      "created": 1568654293
    },
    "ListProperties": {
      "id": {
        "description": "ID of the list",
        "example": "66e60ece-d4e4-4286-8ea6-990cb500aa8e",
        "format": "uuid",
        "type": "string"
      },
      "name": {
        "description": "Name of the list",
        "example": "High Engagement Contacts",
        "type": "string"
      },
      "all": {
        "description": "true if this list is the special system created list containing all contacts within a brand, false otherwise.",
        "example": false,
        "type": "boolean"
      },
      "num_contacts": {
        "description": "Number of contacts in the list.",
        "example": 120,
        "type": "integer"
      },
      "engagement": {
        "description": "Aggregate engagement metrics for contacts in the list.",
        "type": "object",
        "properties": {
          "num_opened": {
            "description": "Number of contacts in the list who have opened at least one email.",
            "example": 48,
            "type": "integer"
          },
          "percent_opened": {
            "description": "Fraction of contacts in the list who have opened at least one email.",
            "example": 0.4,
            "type": "number"
          },
          "num_clicked": {
            "description": "Number of contacts in the list who have clicked at least one email.",
            "example": 18,
            "type": "integer"
          },
          "percent_clicked": {
            "description": "Fraction of contacts in the list who have clicked at least one email.",
            "example": 0.15,
            "type": "number"
          }
        }
      },
      "created": {
        "description": "Time at which the object was created. Measured in seconds since the UNIX epoch.",
        "example": 1592422352,
        "type": "integer"
      }
    },
    "CreateUpdateListExample": {
      "name": "High Engagement Contacts"
    },
    "CreateUpdateListProperties": {
      "name": {
        "description": "Name of the list",
        "example": "High Engagement Contacts",
        "type": "string",
        "minLength": 1,
        "maxLength": 50
      }
    },
    "ListTemplateExample": {
      "id": "66e60ece-d4e4-4286-8ea6-990cb500aa8e",
      "name": "Newsletter",
      "type": "email",
      "shared_with_account": true,
      "created": 1568654293
    },
    "GetTemplateExample": {
      "id": "66e60ece-d4e4-4286-8ea6-990cb500aa8e",
      "name": "Newsletter",
      "type": "email",
      "shared_with_account": true,
      "created": 1568654293,
      "html": "<html><body><p>hello, world.</p></body></html>"
    },
    "CreateUpdateTemplateExample": {
      "name": "Newsletter",
      "type": "email",
      "html": "<html><body><p>hello, world.</p></body></html>",
      "shared_with_account": true
    },
    "CreateUpdateTemplateProperties": {
      "name": {
        "description": "Name of the template",
        "example": "Newsletter",
        "type": "string",
        "minLength": 1,
        "maxLength": 50
      },
      "type": {
        "description": "Type of campaigns the template may be used with",
        "example": "email",
        "type": "string",
        "enum": [
          "email",
          "page"
        ]
      },
      "shared_with_account": {
        "description": "true if the template is shared with all brands in the account. false otherwise.",
        "type": "boolean",
        "example": true
      },
      "html": {
        "description": "HTML body of the template.",
        "type": "string",
        "example": "<html><body><p>hello, world.</p></body></html>"
      }
    },
    "ListTemplateProperties": {
      "id": {
        "description": "ID of the list",
        "example": "66e60ece-d4e4-4286-8ea6-990cb500aa8e",
        "format": "uuid",
        "type": "string"
      },
      "name": {
        "description": "Name of the template",
        "example": "Newsletter",
        "type": "string"
      },
      "type": {
        "description": "Type of campaigns the template may be used with",
        "example": "email",
        "type": "string",
        "enum": [
          "email",
          "page"
        ]
      },
      "shared_with_account": {
        "description": "true if the template is shared with all brands in the account. false otherwise.",
        "type": "boolean",
        "example": true
      },
      "created": {
        "description": "Time at which the object was created. Measured in seconds since the UNIX epoch.",
        "example": 1592422352,
        "type": "integer"
      }
    },
    "GetTemplateProperties": {
      "id": {
        "description": "ID of the list",
        "example": "66e60ece-d4e4-4286-8ea6-990cb500aa8e",
        "format": "uuid",
        "type": "string"
      },
      "name": {
        "description": "Name of the template",
        "example": "Newsletter",
        "type": "string"
      },
      "type": {
        "description": "Type of campaigns the template may be used with",
        "example": "email",
        "type": "string",
        "enum": [
          "email",
          "page"
        ]
      },
      "shared_with_account": {
        "description": "true if the template is shared with all brands in the account. false otherwise.",
        "type": "boolean",
        "example": true
      },
      "created": {
        "description": "Time at which the object was created. Measured in seconds since the UNIX epoch.",
        "example": 1592422352,
        "type": "integer"
      },
      "html": {
        "description": "HTML body of the template.",
        "type": "string",
        "example": "<html><body><p>hello, world.</p></body></html>"
      }
    },
    "CreateUpdateFieldExample": {
      "name": "First Name",
      "merge_tag_name": "FIRST_NAME",
      "sample_value": "Christopher"
    },
    "CreateFieldExample": {
      "name": "First Name",
      "merge_tag_name": "FIRST_NAME",
      "sample_value": "Christopher",
      "type": "text"
    },
    "UpdateFieldExample": {
      "name": "First Name",
      "merge_tag_name": "FIRST_NAME",
      "sample_value": "Christopher"
    },
    "CreateUpdateFieldProperties": {
      "name": {
        "description": "Name of the field",
        "example": "First Name",
        "type": "string",
        "minLength": 1,
        "maxLength": 50,
        "pattern": "^\\s*\\S.*$"
      },
      "merge_tag_name": {
        "description": "Name used to reference a field's value via a template or the API.  For example, if merge_tag_name is FIRST_NAME, the field can be  referenced using `*|FIRST_NAME|*` in a template or  `{\"name\": \"FIRST_NAME\", \"string\": \"\"}` via the API.\n",
        "example": "FIRST_NAME",
        "type": "string",
        "maxLength": 50,
        "pattern": "^\\s*\\S.*$"
      },
      "sample_value": {
        "description": "A value used for the field when sending test campaigns.",
        "example": "Christopher",
        "type": "string",
        "maxLength": 50
      }
    },
    "CreateFieldProperties": {
      "name": {
        "description": "Name of the field",
        "example": "First Name",
        "type": "string",
        "minLength": 1,
        "maxLength": 50,
        "pattern": "^\\s*\\S.*$"
      },
      "merge_tag_name": {
        "description": "Name used to reference a field's value via a template or the API.  For example, if merge_tag_name is FIRST_NAME, the field can be  referenced using `*|FIRST_NAME|*` in a template or  `{\"name\": \"FIRST_NAME\", \"string\": \"\"}` via the API.\n",
        "example": "FIRST_NAME",
        "type": "string",
        "maxLength": 50,
        "pattern": "^\\s*\\S.*$"
      },
      "sample_value": {
        "description": "A value used for the field when sending test campaigns.",
        "example": "Christopher",
        "type": "string",
        "maxLength": 50
      },
      "type": {
        "description": "Type of the field",
        "example": "text",
        "type": "string",
        "enum": [
          "date",
          "integer",
          "text"
        ]
      }
    },
    "UpdateFieldProperties": {
      "name": {
        "description": "Name of the field",
        "example": "First Name",
        "type": "string",
        "minLength": 1,
        "maxLength": 50,
        "pattern": "^\\s*\\S.*$"
      },
      "merge_tag_name": {
        "description": "Name used to reference a field's value via a template or the API.  For example, if merge_tag_name is FIRST_NAME, the field can be  referenced using `*|FIRST_NAME|*` in a template or  `{\"name\": \"FIRST_NAME\", \"string\": \"\"}` via the API.\n",
        "example": "FIRST_NAME",
        "type": "string",
        "maxLength": 50,
        "pattern": "^\\s*\\S.*$"
      },
      "sample_value": {
        "description": "A value used for the field when sending test campaigns.",
        "example": "Christopher",
        "type": "string",
        "maxLength": 50
      }
    },
    "FieldExample": {
      "id": "66e60ece-d4e4-4286-8ea6-990cb500aa8e",
      "name": "First Name",
      "type": "text",
      "merge_tag_name": "FIRST_NAME",
      "sample_value": "Christopher",
      "created": 1568654293
    },
    "FieldProperties": {
      "id": {
        "description": "ID of the field",
        "example": "66e60ece-d4e4-4286-8ea6-990cb500aa8e",
        "format": "uuid",
        "type": "string"
      },
      "name": {
        "description": "Name of the field",
        "example": "First Name",
        "type": "string"
      },
      "type": {
        "description": "Data type of the field.",
        "example": "text",
        "type": "string",
        "enum": [
          "date",
          "email",
          "integer",
          "text"
        ]
      },
      "merge_tag_name": {
        "description": "Name used to reference a field's value via a template or the API. For example, if merge_tag_name is FIRST_NAME, the field can be referenced using `*|FIRST_NAME|*` in a template or `{\"name\": \"FIRST_NAME\", \"string\": \"\"}` via the API.\n",
        "example": "FIRST_NAME",
        "type": "string"
      },
      "sample_value": {
        "description": "A value used for the field when sending test campaigns.",
        "type": "string"
      },
      "created": {
        "description": "Time at which the object was created. Measured in seconds since the UNIX epoch.",
        "example": 1592422352,
        "type": "integer"
      }
    },
    "CreateUpdateSenderExample": {
      "share_type": "all"
    },
    "CreateSenderExample": {
      "share_type": "all",
      "identity": "example.com",
      "identity_type": "domain"
    },
    "UpdateSenderExample": {
      "share_type": "all"
    },
    "CreateUpdateSenderProperties": {
      "share_type": {
        "description": "Set to all to share the sender with all brands. Set to none to use only within the current brand.",
        "example": "all",
        "type": "string",
        "enum": [
          "all",
          "none"
        ]
      }
    },
    "CreateSenderProperties": {
      "share_type": {
        "description": "Set to all to share the sender with all brands. Set to none to use only within the current brand.",
        "example": "all",
        "type": "string",
        "enum": [
          "all",
          "none"
        ]
      },
      "identity": {
        "description": "A domain or email address.",
        "example": "example.com",
        "type": "string",
        "minLength": 1,
        "maxLength": 100
      },
      "identity_type": {
        "description": "The type of identity, either domain or email.",
        "example": "domain",
        "type": "string",
        "enum": [
          "domain",
          "email"
        ]
      }
    },
    "UpdateSenderProperties": {
      "share_type": {
        "description": "Set to all to share the sender with all brands. Set to none to use only within the current brand.",
        "example": "all",
        "type": "string",
        "enum": [
          "all",
          "none"
        ]
      }
    },
    "SenderExample": {
      "id": "66e60ece-d4e4-4286-8ea6-990cb500aa8e",
      "identity_type": "domain",
      "identity": "example.com",
      "bounce_domain": "bounce.example.com",
      "dns_records": {
        "name": "z001._domainkey.example.com",
        "type": "TXT",
        "value": "v=DKIM1; k=rsa; h=sha256; p=MIGfMA0GCSqG"
      },
      "bounce_dns_records": {
        "name": "bounce.example.com",
        "type": "CNAME",
        "value": "mail.example.com"
      },
      "share_type": "all",
      "verified": true,
      "bounce_verified": true,
      "created": 1568654293
    },
    "SenderProperties": {
      "id": {
        "description": "ID of the sender",
        "example": "66e60ece-d4e4-4286-8ea6-990cb500aa8e",
        "format": "uuid",
        "type": "string"
      },
      "identity_type": {
        "description": "The type of the identity (whether it is a domain or email identity).",
        "example": "domain",
        "type": "string",
        "enum": [
          "domain",
          "email"
        ]
      },
      "Identity": {
        "description": "A domain or email address that the brand can send email from.",
        "example": "example.com",
        "type": "string"
      },
      "BounceDomain": {
        "description": "A domain used in the MAIL FROM for this sender.",
        "example": "bounce.example.com",
        "type": "string"
      },
      "DnsRecords": {
        "type": "object",
        "properties": {
          "name": {
            "example": "z001._domainkey.example.com",
            "type": "string"
          },
          "type": {
            "example": "TXT",
            "type": "string",
            "enum": [
              "TXT",
              "CNAME"
            ]
          },
          "value": {
            "example": "v=DKIM1; k=rsa; h=sha256; p=MIGfMA0GCSqG",
            "type": "string"
          }
        }
      },
      "BounceDnsRecords": {
        "type": "object",
        "properties": {
          "name": {
            "example": "bounce.example.com",
            "type": "string"
          },
          "type": {
            "example": "CNAME",
            "type": "string",
            "enum": [
              "TXT",
              "CNAME"
            ]
          },
          "value": {
            "example": "mail.example.com",
            "type": "string"
          }
        }
      },
      "created": {
        "description": "Time at which the object was created. Measured in seconds since the UNIX epoch.",
        "example": 1592422352,
        "type": "integer"
      }
    },
    "CreateUpdateBrandPropertyExample": {
      "name": "Company Name",
      "merge_tag_name": "COMPANY_NAME",
      "is_html": false,
      "string_value": "Widgets Inc."
    },
    "CreateBrandPropertyExample": {
      "name": "Company Name",
      "merge_tag_name": "COMPANY_NAME",
      "is_html": false,
      "string_value": "Widgets Inc."
    },
    "UpdateBrandPropertyExample": {
      "name": "Company Name",
      "merge_tag_name": "COMPANY_NAME",
      "is_html": false,
      "string_value": "Widgets Inc."
    },
    "CreateUpdateBrandPropertyProperties": {
      "name": {
        "description": "Name of the brand property",
        "example": "Company Name",
        "type": "string",
        "minLength": 1,
        "maxLength": 50,
        "pattern": "^\\s*\\S.*$"
      },
      "merge_tag_name": {
        "description": "Name used to reference a brand property's value via a template. For example, if merge_tag_name is COMPANY_NAME, the field can be referenced using `*|COMPANY_NAME|*` in a template.\n",
        "example": "COMPANY_NAME",
        "type": "string",
        "maxLength": 50,
        "pattern": "^\\s*\\S.*$"
      },
      "is_html": {
        "description": "If the value of the property is html or not.",
        "example": true,
        "type": "boolean"
      },
      "string_value": {
        "description": "The value substituted for the tag in a template.",
        "example": "Widgets Inc.",
        "type": "string",
        "maxLength": 100000
      }
    },
    "CreateBrandPropertyProperties": {
      "name": {
        "description": "Name of the brand property",
        "example": "Company Name",
        "type": "string",
        "minLength": 1,
        "maxLength": 50,
        "pattern": "^\\s*\\S.*$"
      },
      "merge_tag_name": {
        "description": "Name used to reference a brand property's value via a template. For example, if merge_tag_name is COMPANY_NAME, the field can be referenced using `*|COMPANY_NAME|*` in a template.\n",
        "example": "COMPANY_NAME",
        "type": "string",
        "maxLength": 50,
        "pattern": "^\\s*\\S.*$"
      },
      "is_html": {
        "description": "If the value of the property is html or not.",
        "example": true,
        "type": "boolean"
      },
      "string_value": {
        "description": "The value substituted for the tag in a template.",
        "example": "Widgets Inc.",
        "type": "string",
        "maxLength": 100000
      }
    },
    "UpdateBrandPropertyProperties": {
      "name": {
        "description": "Name of the brand property",
        "example": "Company Name",
        "type": "string",
        "minLength": 1,
        "maxLength": 50,
        "pattern": "^\\s*\\S.*$"
      },
      "merge_tag_name": {
        "description": "Name used to reference a brand property's value via a template. For example, if merge_tag_name is COMPANY_NAME, the field can be referenced using `*|COMPANY_NAME|*` in a template.\n",
        "example": "COMPANY_NAME",
        "type": "string",
        "maxLength": 50,
        "pattern": "^\\s*\\S.*$"
      },
      "is_html": {
        "description": "If the value of the property is html or not.",
        "example": true,
        "type": "boolean"
      },
      "string_value": {
        "description": "The value substituted for the tag in a template.",
        "example": "Widgets Inc.",
        "type": "string",
        "maxLength": 100000
      }
    },
    "BrandPropertyExample": {
      "id": "66e60ece-d4e4-4286-8ea6-990cb500aa8e",
      "name": "Company Address",
      "merge_tag_name": "COMPANY_ADDRESS",
      "is_html": true,
      "string_value": "123 Main Street<br>New York, NY 12345",
      "created": 1568654293
    },
    "BrandPropertyProperties": {
      "id": {
        "description": "ID of the brand property",
        "example": "66e60ece-d4e4-4286-8ea6-990cb500aa8e",
        "format": "uuid",
        "type": "string"
      },
      "name": {
        "description": "Name of the brand property",
        "example": "Company Address",
        "type": "string"
      },
      "merge_tag_name": {
        "description": "Name used to reference a brand property's value via a template. For example, if merge_tag_name is COMPANY_NAME, the field can be referenced using `*|COMPANY_NAME|*` in a template.\n",
        "example": "COMPANY_NAME",
        "type": "string"
      },
      "is_html": {
        "description": "If the value of the property is html or not.",
        "example": true,
        "type": "boolean"
      },
      "string_value": {
        "description": "The value substituted for the tag in a template.",
        "type": "string"
      },
      "created": {
        "description": "Time at which the object was created. Measured in seconds since the UNIX epoch.",
        "example": 1592422352,
        "type": "integer"
      }
    },
    "MessageTypeExample": {
      "id": "66e60ece-d4e4-4286-8ea6-990cb500aa8e",
      "type": "user",
      "name": "Newsletters",
      "created": 1568654293
    },
    "CreateUpdateMessageTypeExample": {
      "name": "Newsletters"
    },
    "CreateMessageTypeExample": {
      "name": "Newsletters"
    },
    "UpdateMessageTypeExample": {
      "name": "Newsletters"
    },
    "CreateUpdateMessageTypeProperties": {
      "name": {
        "description": "Name of the message type",
        "example": "Newsletters",
        "type": "string",
        "minLength": 1,
        "maxLength": 50,
        "pattern": "^\\s*\\S.*$"
      }
    },
    "MessageTypeProperties": {
      "id": {
        "description": "ID of the message type",
        "example": "66e60ece-d4e4-4286-8ea6-990cb500aa8e",
        "format": "uuid",
        "type": "string"
      },
      "type": {
        "description": "The type of the message type",
        "example": "user",
        "type": "string",
        "enum": [
          "account",
          "all",
          "user"
        ]
      },
      "name": {
        "description": "Name of the message type",
        "example": "Newsletters",
        "type": "string"
      },
      "created": {
        "description": "Time at which the object was created. Measured in seconds since the UNIX epoch.",
        "example": 1592422352,
        "type": "integer"
      }
    },
    "SegmentConditionsExample": [
      {
        "type": "campaign_activity",
        "operator": "clicked"
      },
      {
        "type": "field",
        "id": "66e60ece-d4e4-4286-8ea6-990cb500aa8e",
        "operator": "is greater than",
        "integer_value": 1
      }
    ],
    "SegmentExample": {
      "id": "66e60ece-d4e4-4286-8ea6-990cb500aa8e",
      "name": "Opened Campaign",
      "operator": "all",
      "conditions": [
        {
          "type": "campaign_activity",
          "operator": "clicked"
        },
        {
          "type": "field",
          "id": "66e60ece-d4e4-4286-8ea6-990cb500aa8e",
          "operator": "is greater than",
          "integer_value": 1
        }
      ],
      "created": 1568654293
    },
    "SegmentProperties": {
      "id": {
        "description": "ID of the segment",
        "example": "66e60ece-d4e4-4286-8ea6-990cb500aa8e",
        "format": "uuid",
        "type": "string"
      },
      "name": {
        "description": "Name of the segment",
        "example": "Opened Campaign",
        "type": "string"
      },
      "operator": {
        "description": "all if all conditions must match for the segment to match. any if at least one condition must match for the segment to match.",
        "example": "all",
        "type": "string",
        "enum": [
          "all",
          "any"
        ]
      },
      "conditions": {
        "description": "An array of conditions that the segment must satisfy. See our [description of segment conditions](https://docs.bigmailer.io/docs/segments).",
        "example": [
          {
            "type": "campaign_activity",
            "operator": "clicked"
          },
          {
            "type": "field",
            "id": "66e60ece-d4e4-4286-8ea6-990cb500aa8e",
            "operator": "is greater than",
            "integer_value": 1
          }
        ],
        "type": "array",
        "items": {
          "type": "object"
        }
      },
      "created": {
        "description": "Time at which the object was created. Measured in seconds since the UNIX epoch.",
        "example": 1592422352,
        "type": "integer"
      }
    },
    "CreateUpdateSegmentExample": {
      "name": "Opened Campaign",
      "operator": "all",
      "conditions": [
        {
          "type": "campaign_activity",
          "operator": "clicked"
        },
        {
          "type": "field",
          "id": "66e60ece-d4e4-4286-8ea6-990cb500aa8e",
          "operator": "is greater than",
          "integer_value": 1
        }
      ]
    },
    "CreateUpdateSegmentProperties": {
      "name": {
        "description": "Name of the segment",
        "example": "Opened Campaign",
        "type": "string"
      },
      "operator": {
        "description": "all if all conditions must match for the segment to match. any if at least one condition must match for the segment to match.",
        "example": "all",
        "type": "string",
        "enum": [
          "all",
          "any"
        ]
      },
      "conditions": {
        "description": "An array of conditions that the segment must satisfy. See our [description of segment conditions](https://docs.bigmailer.io/docs/segments).",
        "example": [
          {
            "type": "campaign_activity",
            "operator": "clicked"
          },
          {
            "type": "field",
            "id": "66e60ece-d4e4-4286-8ea6-990cb500aa8e",
            "operator": "is greater than",
            "integer_value": 1
          }
        ],
        "type": "array",
        "items": {
          "type": "object"
        }
      }
    },
    "SuppressionListExample": {
      "id": "66e60ece-d4e4-4286-8ea6-990cb500aa8e",
      "file_name": "suppressed_contacts.csv",
      "file_size": 65536,
      "created": 1568654293
    },
    "SuppressionListProperties": {
      "id": {
        "description": "ID of the suppression list",
        "example": "66e60ece-d4e4-4286-8ea6-990cb500aa8e",
        "format": "uuid",
        "type": "string"
      },
      "file_name": {
        "description": "File name of the suppression list",
        "example": "suppressed_contacts.csv",
        "type": "string"
      },
      "file_size": {
        "description": "Size in bytes of the suppression list",
        "example": 65536,
        "type": "integer"
      },
      "created": {
        "description": "Time at which the object was created. Measured in seconds since the UNIX epoch.",
        "example": 1592422352,
        "type": "integer"
      }
    },
    "CampaignNameExample": {
      "name": "March 2022 Campaign"
    },
    "CampaignNameProperties": {
      "name": {
        "description": "Name of the campaign",
        "example": "March 2022 Campaign",
        "type": "string"
      }
    },
    "CampaignCommonNoNameExample": {
      "id": "66e60ece-d4e4-4286-8ea6-990cb500aa8e",
      "created": 1568654293
    },
    "CampaignCommonNoNameProperties": {
      "id": {
        "description": "ID of the campaign",
        "example": "66e60ece-d4e4-4286-8ea6-990cb500aa8e",
        "format": "uuid",
        "type": "string"
      },
      "created": {
        "description": "Time at which the object was created. Measured in seconds since the UNIX epoch.",
        "example": 1592422352,
        "type": "integer"
      }
    },
    "CampaignCommonExample": {
      "id": "66e60ece-d4e4-4286-8ea6-990cb500aa8e",
      "created": 1568654293,
      "name": "March 2022 Campaign"
    },
    "CampaignCommonProperties": {
      "id": {
        "description": "ID of the campaign",
        "example": "66e60ece-d4e4-4286-8ea6-990cb500aa8e",
        "format": "uuid",
        "type": "string"
      },
      "created": {
        "description": "Time at which the object was created. Measured in seconds since the UNIX epoch.",
        "example": 1592422352,
        "type": "integer"
      },
      "name": {
        "description": "Name of the campaign",
        "example": "March 2022 Campaign",
        "type": "string"
      }
    },
    "CampaignContentListExample": {
      "subject": "The January Newsletter",
      "from": {
        "email": "chris@bigmailer.io",
        "name": "Chris"
      },
      "recipient_name": "*|FIRST_NAME|*",
      "reply_to": {
        "email": "chris@bigmailer.io",
        "name": "Chris"
      },
      "link_params": "utm_campaign=spring_sale&utm_medium=cpc",
      "preview": "Hurry, 50% Off for 2 Days Only!",
      "auto_text": false
    },
    "CampaignContentExample": {
      "subject": "The January Newsletter",
      "from": {
        "email": "chris@bigmailer.io",
        "name": "Chris"
      },
      "recipient_name": "*|FIRST_NAME|*",
      "reply_to": {
        "email": "chris@bigmailer.io",
        "name": "Chris"
      },
      "link_params": "utm_campaign=spring_sale&utm_medium=cpc",
      "preview": "Hurry, 50% Off for 2 Days Only!",
      "auto_text": false,
      "html": "<html><body><p>hello, world.</p></body></html>",
      "text": "This is the text body."
    },
    "CampaignTemplateExample": {
      "template_id": "b4326936-9e08-4cf9-95fe-c44c8cf4e4ef"
    },
    "CampaignContentListProperties": {
      "subject": {
        "description": "Subject line for the campaign",
        "example": "The January Newsletter",
        "type": "string"
      },
      "from": {
        "properties": {
          "email": {
            "description": "From email address",
            "type": "string",
            "format": "email"
          },
          "name": {
            "description": "From name",
            "type": "string"
          }
        },
        "type": "object"
      },
      "recipient_name": {
        "description": "Name of the recipient. Use merge tags to make it more personal and avoid spam filters.",
        "example": "*|FIRST_NAME|*",
        "type": "string"
      },
      "reply_to": {
        "properties": {
          "email": {
            "description": "Reply to email address",
            "type": "string",
            "format": "email"
          },
          "name": {
            "description": "Reply to name",
            "type": "string"
          }
        },
        "type": "object"
      },
      "link_params": {
        "description": "Additional query string parameters to add to all links in the template.",
        "example": "utm_campaign=spring_sale&utm_medium=cpc",
        "type": "string"
      },
      "preview": {
        "description": "Copy shown following your subject line in many email clients.",
        "example": "Hurry, 50% Off for 2 Days Only!",
        "type": "string"
      },
      "auto_text": {
        "description": "True to generate the text body automatically from the HTML body.",
        "example": false,
        "type": "boolean"
      }
    },
    "CampaignContentProperties": {
      "subject": {
        "description": "Subject line for the campaign",
        "example": "The January Newsletter",
        "type": "string"
      },
      "from": {
        "properties": {
          "email": {
            "description": "From email address",
            "type": "string",
            "format": "email"
          },
          "name": {
            "description": "From name",
            "type": "string"
          }
        },
        "type": "object"
      },
      "recipient_name": {
        "description": "Name of the recipient. Use merge tags to make it more personal and avoid spam filters.",
        "example": "*|FIRST_NAME|*",
        "type": "string"
      },
      "reply_to": {
        "properties": {
          "email": {
            "description": "Reply to email address",
            "type": "string",
            "format": "email"
          },
          "name": {
            "description": "Reply to name",
            "type": "string"
          }
        },
        "type": "object"
      },
      "link_params": {
        "description": "Additional query string parameters to add to all links in the template.",
        "example": "utm_campaign=spring_sale&utm_medium=cpc",
        "type": "string"
      },
      "preview": {
        "description": "Copy shown following your subject line in many email clients.",
        "example": "Hurry, 50% Off for 2 Days Only!",
        "type": "string"
      },
      "auto_text": {
        "description": "True to generate the text body automatically from the HTML body.",
        "example": false,
        "type": "boolean"
      },
      "html": {
        "description": "HTML body of the email.",
        "example": "<html><body><p>hello, world.</p></body></html>",
        "type": "string"
      },
      "text": {
        "description": "Text body of the email.",
        "example": "This is the text body.",
        "type": "string"
      }
    },
    "CampaignTemplateProperties": {
      "template_id": {
        "description": "A template id to use to populate the HTML body of the email.",
        "format": "uuid",
        "type": "string"
      }
    },
    "CampaignTrackingExample": {
      "track_opens": true,
      "track_clicks": true,
      "track_text_clicks": true
    },
    "CampaignTrackingProperties": {
      "track_opens": {
        "description": "True to enable open tracking (HTML campaigns only).",
        "example": true,
        "type": "boolean"
      },
      "track_clicks": {
        "description": "True to enable click tracking in HTML links.",
        "example": true,
        "type": "boolean"
      },
      "track_text_clicks": {
        "description": "True to enable click tracking in text links.",
        "example": true,
        "type": "boolean"
      }
    },
    "CampaignSegmentExample": {
      "segment_id": "b4326936-9e08-4cf9-95fe-c44c8cf4e4ef"
    },
    "CampaignSegmentProperties": {
      "segment_id": {
        "description": "ID of a segment used to filter the lists of contacts the campaign is sent to.",
        "example": "b4326936-9e08-4cf9-95fe-c44c8cf4e4ef",
        "type": "string",
        "format": "uuid"
      }
    },
    "CampaignMessageTypeExample": {
      "message_type_id": "b4326936-9e08-4cf9-95fe-c44c8cf4e4ef"
    },
    "CampaignMessageTypeProperties": {
      "message_type_id": {
        "description": "ID of the message type of the campaign.",
        "example": "b4326936-9e08-4cf9-95fe-c44c8cf4e4ef",
        "type": "string",
        "format": "uuid"
      }
    },
    "CampaignListsExample": {
      "list_ids": [
        "b4326936-9e08-4cf9-95fe-c44c8cf4e4ef"
      ],
      "excluded_list_ids": [
        "9b480ee4-cddd-4f11-92d2-15f7d0f18f9c"
      ]
    },
    "CampaignListsProperties": {
      "list_ids": {
        "description": "An array of list ids to send the campaign to.",
        "example": [
          "b4326936-9e08-4cf9-95fe-c44c8cf4e4ef"
        ],
        "items": {
          "example": "b4326936-9e08-4cf9-95fe-c44c8cf4e4ef",
          "format": "uuid",
          "type": "string"
        },
        "type": "array"
      },
      "excluded_list_ids": {
        "description": "An array of list ids to exclude from the campaign. Any contacts on these lists will not be sent the campaign.",
        "example": [
          "9b480ee4-cddd-4f11-92d2-15f7d0f18f9c"
        ],
        "items": {
          "example": "9b480ee4-cddd-4f11-92d2-15f7d0f18f9c",
          "format": "uuid",
          "type": "string"
        },
        "type": "array"
      }
    },
    "CampaignScheduleExample": {
      "scheduled_for": 1704085200
    },
    "CampaignScheduleProperties": {
      "scheduled_for": {
        "description": "Time at which to send the campaign. Measured in seconds since the UNIX epoch. Omit to send the campaign immediately.",
        "example": 1704085200,
        "type": "integer",
        "minimum": 1704085200,
        "maximum": 4102462800
      }
    },
    "CampaignThrottlingExample": {
      "throttling_type": "burst",
      "throttling_amount": 1000,
      "throttling_period": 900
    },
    "CampaignThrottlingProperties": {
      "throttling_type": {
        "description": "Set to `none` to send the campaign as fast as possible. Set to `burst` to send the campaign in small batches over time.",
        "example": "burst",
        "type": "string",
        "enum": [
          "none",
          "burst"
        ]
      },
      "throttling_amount": {
        "description": "Number of emails to send in each per batch. Must be a multiple of 1000. Required if `throttling_type` is `burst`.",
        "example": 1000,
        "type": "integer",
        "multipleOf": 1000,
        "minimum": 1000,
        "maximum": 1000000
      },
      "throttling_period": {
        "description": "Time in seconds between sending each batch of emails. Required if `throttling_type` is `burst`.",
        "example": 900,
        "type": "integer",
        "enum": [
          900,
          1800,
          3600,
          7200
        ]
      }
    },
    "CampaignSuppressionListExample": {
      "suppression_list_id": "b4326936-9e08-4cf9-95fe-c44c8cf4e4ef"
    },
    "CampaignSuppressionListProperties": {
      "suppression_list_id": {
        "description": "ID of a suppression list. Any emails in the suppression list will not be sent the campaign.",
        "example": "b4326936-9e08-4cf9-95fe-c44c8cf4e4ef",
        "type": "string",
        "format": "uuid"
      }
    },
    "CampaignTransactionalListExample": {
      "list_id": "b4326936-9e08-4cf9-95fe-c44c8cf4e4ef"
    },
    "CampaignTransactionalListProperties": {
      "list_id": {
        "description": "ID of a list contacts sent the transactional campaign should be added to.",
        "example": "b4326936-9e08-4cf9-95fe-c44c8cf4e4ef",
        "type": "string",
        "format": "uuid"
      }
    },
    "CampaignReadyExample": {
      "ready": true
    },
    "CampaignMetricsExample": {
      "num_sent": 100,
      "num_rejected": 10,
      "num_clicks": 20,
      "num_total_clicks": 30,
      "num_opens": 50,
      "num_total_opens": 60,
      "num_hard_bounces": 4,
      "num_soft_bounces": 8,
      "num_complaints": 2,
      "num_unsubscribes": 3
    },
    "CampaignMetricsProperties": {
      "num_sent": {
        "description": "Number of emails sent.",
        "example": 100,
        "type": "integer"
      },
      "num_rejected": {
        "description": "Number of emails rejected.",
        "example": 10,
        "type": "integer"
      },
      "num_clicks": {
        "description": "Number of unique clicks.",
        "example": 20,
        "type": "integer"
      },
      "num_total_clicks": {
        "description": "Number of total clicks (non-unique).",
        "example": 30,
        "type": "integer"
      },
      "num_opens": {
        "description": "Number of unique opens.",
        "example": 50,
        "type": "integer"
      },
      "num_total_opens": {
        "description": "Number of total opens (non-unique).",
        "example": 60,
        "type": "integer"
      },
      "num_hard_bounces": {
        "description": "Number of emails sent that hard bounced.",
        "example": 4,
        "type": "integer"
      },
      "num_soft_bounces": {
        "description": "Number of emails sent that soft bounced.",
        "example": 8,
        "type": "integer"
      },
      "num_complaints": {
        "description": "Number of emails sent that complained.",
        "example": 2,
        "type": "integer"
      },
      "num_unsubscribes": {
        "description": "Number of emails sent that unsubscribed.",
        "example": 3,
        "type": "integer"
      }
    },
    "CampaignStatusExample": {
      "status": "draft"
    },
    "CampaignStatusProperties": {
      "status": {
        "description": "Status of the campaign.",
        "example": "draft",
        "type": "string",
        "enum": [
          "draft",
          "pending",
          "in progress",
          "complete",
          "error",
          "paused",
          "archived",
          "active"
        ]
      }
    },
    "CampaignRssExample": {
      "feed_url": "https://www.example.com/rss.xml",
      "hour": 13,
      "minutes": 45,
      "frequency": {
        "daily": {
          "days": [
            "mon",
            "wed",
            "fri"
          ]
        }
      }
    },
    "CampaignRssProperties": {
      "feed_url": {
        "description": "URL of an RSS feed.",
        "type": "string",
        "format": "url",
        "example": "https://www.example.com/rss.xml"
      },
      "hour": {
        "description": "Hour to check the RSS feed for updates. Not used if using the hourly frequency.",
        "type": "integer",
        "minimum": 0,
        "maximum": 23,
        "example": 13
      },
      "minutes": {
        "description": "Minutes to check the RSS feed for updates.",
        "type": "integer",
        "enum": [
          0,
          5,
          10,
          15,
          20,
          25,
          30,
          35,
          40,
          45,
          50,
          55
        ],
        "example": 45
      },
      "frequency": {
        "type": "object",
        "description": "Details of how often to check the RSS feed for updates. Only one of hourly, daily, weekly, and monthly must be present.",
        "properties": {
          "hourly": {
            "type": "object",
            "properties": {
              "days": {
                "type": "array",
                "minItems": 1,
                "maxItems": 7,
                "items": {
                  "description": "Days of the week to check the RSS feed for updates when using the hourly schedule.",
                  "type": "string",
                  "enum": [
                    "mon",
                    "tue",
                    "wed",
                    "thu",
                    "fri",
                    "sat",
                    "sun"
                  ]
                },
                "example": [
                  "mon",
                  "wed",
                  "fri"
                ]
              }
            }
          },
          "daily": {
            "type": "object",
            "properties": {
              "days": {
                "type": "array",
                "minItems": 1,
                "maxItems": 7,
                "items": {
                  "description": "Days of the week to check the RSS feed for updates.",
                  "type": "string",
                  "enum": [
                    "mon",
                    "tue",
                    "wed",
                    "thu",
                    "fri",
                    "sat",
                    "sun"
                  ]
                },
                "example": [
                  "mon",
                  "wed",
                  "fri"
                ]
              }
            }
          },
          "weekly": {
            "type": "object",
            "properties": {
              "day": {
                "description": "Day of the week to check the RSS feed for an update.",
                "type": "string",
                "enum": [
                  "mon",
                  "tue",
                  "wed",
                  "thu",
                  "fri",
                  "sat",
                  "sun"
                ],
                "example": "mon"
              }
            }
          },
          "monthly": {
            "type": "object",
            "properties": {
              "day": {
                "description": "Day of the month to check the RSS feed for an update. Or, -1 to check on the last day of the month.",
                "type": "integer",
                "enum": [
                  1,
                  2,
                  3,
                  4,
                  5,
                  6,
                  7,
                  8,
                  9,
                  10,
                  11,
                  12,
                  13,
                  14,
                  15,
                  16,
                  17,
                  18,
                  19,
                  20,
                  21,
                  22,
                  23,
                  24,
                  25,
                  26,
                  27,
                  28,
                  29,
                  30,
                  31,
                  -1
                ],
                "example": -1
              }
            }
          }
        }
      }
    },
    "CampaignRssScanExample": {
      "feed_url": "https://www.example.com/rss.xml",
      "scanned": 1592422352,
      "scheduled_for": 1592422400
    },
    "CampaignRssScanProperties": {
      "feed_url": {
        "description": "URL of the RSS feed.",
        "type": "string",
        "format": "url",
        "example": "https://www.example.com/rss.xml"
      },
      "scanned": {
        "type": "integer",
        "description": "Time at which the rss feed was checked for updates. Measured in seconds since the UNIX epoch.",
        "example": 1592422352
      },
      "scheduled_for": {
        "type": "integer",
        "description": "Time at which the rss update campaign was scheduled to be sent. Measured in seconds since the UNIX epoch.",
        "example": 1592422352
      }
    },
    "CampaignStartableExample": {
      "started": 1592422402
    },
    "CampaignStartableProperties": {
      "started": {
        "type": "integer",
        "description": "Time at which the campaign started sending. Measured in seconds since the UNIX epoch.",
        "example": 1592422402
      }
    },
    "CampaignSendableExample": {
      "sent": 1592422500
    },
    "CampaignSendableProperties": {
      "sent": {
        "type": "integer",
        "description": "Time at which the campaign sent. Measured in seconds since the UNIX epoch.",
        "example": 1592422500
      }
    },
    "CampaignTestExample": {
      "recipients": [
        "chris@bigmailer.io",
        "pat@bigmailer.io"
      ],
      "feed_url": "https://www.example.com/rss.xml"
    },
    "CampaignTestProperties": {
      "recipients": {
        "description": "List of email recipients for the test campaign.",
        "type": "array",
        "minItems": 1,
        "maxItems": 100,
        "items": {
          "type": "string",
          "format": "email",
          "example": "chris@bigmailer.io"
        },
        "example": [
          "chris@bigmailer.io",
          "pat@bigmailer.io"
        ]
      },
      "feed_url": {
        "description": "Optional RSS feed URL used when testing RSS content.",
        "type": "string",
        "format": "url",
        "example": "https://www.example.com/rss.xml"
      }
    },
    "TestCampaignMetricsExample": {
      "num_sent": 2
    },
    "TestCampaignMetricsProperties": {
      "num_sent": {
        "description": "Number of emails sent for the test campaign.",
        "example": 2,
        "type": "integer"
      }
    },
    "CampaignBulkExample": {
      "sent": 1592422500
    },
    "CampaignBulkProperties": {
      "sent": {
        "type": "integer",
        "description": "Time at which the campaign completed sending. Measured in seconds since the UNIX epoch.",
        "example": 1592422500
      },
      "delayed_until": {
        "type": "integer",
        "description": "Time at which the campaign will resume sending. Measured in seconds since the UNIX epoch.",
        "example": 1592422500
      }
    },
    "BulkCampaignExample": {
      "id": "66e60ece-d4e4-4286-8ea6-990cb500aa8e",
      "created": 1568654293,
      "name": "March 2022 Campaign",
      "subject": "The January Newsletter",
      "from": {
        "email": "chris@bigmailer.io",
        "name": "Chris"
      },
      "recipient_name": "*|FIRST_NAME|*",
      "reply_to": {
        "email": "chris@bigmailer.io",
        "name": "Chris"
      },
      "link_params": "utm_campaign=spring_sale&utm_medium=cpc",
      "preview": "Hurry, 50% Off for 2 Days Only!",
      "auto_text": false,
      "html": "<html><body><p>hello, world.</p></body></html>",
      "text": "This is the text body.",
      "track_opens": true,
      "track_clicks": true,
      "track_text_clicks": true,
      "segment_id": "b4326936-9e08-4cf9-95fe-c44c8cf4e4ef",
      "message_type_id": "b4326936-9e08-4cf9-95fe-c44c8cf4e4ef",
      "list_ids": [
        "b4326936-9e08-4cf9-95fe-c44c8cf4e4ef"
      ],
      "excluded_list_ids": [
        "9b480ee4-cddd-4f11-92d2-15f7d0f18f9c"
      ],
      "scheduled_for": 1704085200,
      "throttling_type": "burst",
      "throttling_amount": 1000,
      "throttling_period": 900,
      "suppression_list_id": "b4326936-9e08-4cf9-95fe-c44c8cf4e4ef",
      "num_sent": 100,
      "num_rejected": 10,
      "num_clicks": 20,
      "num_total_clicks": 30,
      "num_opens": 50,
      "num_total_opens": 60,
      "num_hard_bounces": 4,
      "num_soft_bounces": 8,
      "num_complaints": 2,
      "num_unsubscribes": 3,
      "status": "draft",
      "started": 1592422402,
      "sent": 1592422500
    },
    "BulkCampaignProperties": {
      "id": {
        "description": "ID of the campaign",
        "example": "66e60ece-d4e4-4286-8ea6-990cb500aa8e",
        "format": "uuid",
        "type": "string"
      },
      "created": {
        "description": "Time at which the object was created. Measured in seconds since the UNIX epoch.",
        "example": 1592422352,
        "type": "integer"
      },
      "name": {
        "description": "Name of the campaign",
        "example": "March 2022 Campaign",
        "type": "string"
      },
      "subject": {
        "description": "Subject line for the campaign",
        "example": "The January Newsletter",
        "type": "string"
      },
      "from": {
        "properties": {
          "email": {
            "description": "From email address",
            "type": "string",
            "format": "email"
          },
          "name": {
            "description": "From name",
            "type": "string"
          }
        },
        "type": "object"
      },
      "recipient_name": {
        "description": "Name of the recipient. Use merge tags to make it more personal and avoid spam filters.",
        "example": "*|FIRST_NAME|*",
        "type": "string"
      },
      "reply_to": {
        "properties": {
          "email": {
            "description": "Reply to email address",
            "type": "string",
            "format": "email"
          },
          "name": {
            "description": "Reply to name",
            "type": "string"
          }
        },
        "type": "object"
      },
      "link_params": {
        "description": "Additional query string parameters to add to all links in the template.",
        "example": "utm_campaign=spring_sale&utm_medium=cpc",
        "type": "string"
      },
      "preview": {
        "description": "Copy shown following your subject line in many email clients.",
        "example": "Hurry, 50% Off for 2 Days Only!",
        "type": "string"
      },
      "auto_text": {
        "description": "True to generate the text body automatically from the HTML body.",
        "example": false,
        "type": "boolean"
      },
      "html": {
        "description": "HTML body of the email.",
        "example": "<html><body><p>hello, world.</p></body></html>",
        "type": "string"
      },
      "text": {
        "description": "Text body of the email.",
        "example": "This is the text body.",
        "type": "string"
      },
      "track_opens": {
        "description": "True to enable open tracking (HTML campaigns only).",
        "example": true,
        "type": "boolean"
      },
      "track_clicks": {
        "description": "True to enable click tracking in HTML links.",
        "example": true,
        "type": "boolean"
      },
      "track_text_clicks": {
        "description": "True to enable click tracking in text links.",
        "example": true,
        "type": "boolean"
      },
      "segment_id": {
        "description": "ID of a segment used to filter the lists of contacts the campaign is sent to.",
        "example": "b4326936-9e08-4cf9-95fe-c44c8cf4e4ef",
        "type": "string",
        "format": "uuid"
      },
      "message_type_id": {
        "description": "ID of the message type of the campaign.",
        "example": "b4326936-9e08-4cf9-95fe-c44c8cf4e4ef",
        "type": "string",
        "format": "uuid"
      },
      "list_ids": {
        "description": "An array of list ids to send the campaign to.",
        "example": [
          "b4326936-9e08-4cf9-95fe-c44c8cf4e4ef"
        ],
        "items": {
          "example": "b4326936-9e08-4cf9-95fe-c44c8cf4e4ef",
          "format": "uuid",
          "type": "string"
        },
        "type": "array"
      },
      "excluded_list_ids": {
        "description": "An array of list ids to exclude from the campaign. Any contacts on these lists will not be sent the campaign.",
        "example": [
          "9b480ee4-cddd-4f11-92d2-15f7d0f18f9c"
        ],
        "items": {
          "example": "9b480ee4-cddd-4f11-92d2-15f7d0f18f9c",
          "format": "uuid",
          "type": "string"
        },
        "type": "array"
      },
      "scheduled_for": {
        "description": "Time at which to send the campaign. Measured in seconds since the UNIX epoch. Omit to send the campaign immediately.",
        "example": 1704085200,
        "type": "integer",
        "minimum": 1704085200,
        "maximum": 4102462800
      },
      "throttling_type": {
        "description": "Set to `none` to send the campaign as fast as possible. Set to `burst` to send the campaign in small batches over time.",
        "example": "burst",
        "type": "string",
        "enum": [
          "none",
          "burst"
        ]
      },
      "throttling_amount": {
        "description": "Number of emails to send in each per batch. Must be a multiple of 1000. Required if `throttling_type` is `burst`.",
        "example": 1000,
        "type": "integer",
        "multipleOf": 1000,
        "minimum": 1000,
        "maximum": 1000000
      },
      "throttling_period": {
        "description": "Time in seconds between sending each batch of emails. Required if `throttling_type` is `burst`.",
        "example": 900,
        "type": "integer",
        "enum": [
          900,
          1800,
          3600,
          7200
        ]
      },
      "suppression_list_id": {
        "description": "ID of a suppression list. Any emails in the suppression list will not be sent the campaign.",
        "example": "b4326936-9e08-4cf9-95fe-c44c8cf4e4ef",
        "type": "string",
        "format": "uuid"
      },
      "num_sent": {
        "description": "Number of emails sent.",
        "example": 100,
        "type": "integer"
      },
      "num_rejected": {
        "description": "Number of emails rejected.",
        "example": 10,
        "type": "integer"
      },
      "num_clicks": {
        "description": "Number of unique clicks.",
        "example": 20,
        "type": "integer"
      },
      "num_total_clicks": {
        "description": "Number of total clicks (non-unique).",
        "example": 30,
        "type": "integer"
      },
      "num_opens": {
        "description": "Number of unique opens.",
        "example": 50,
        "type": "integer"
      },
      "num_total_opens": {
        "description": "Number of total opens (non-unique).",
        "example": 60,
        "type": "integer"
      },
      "num_hard_bounces": {
        "description": "Number of emails sent that hard bounced.",
        "example": 4,
        "type": "integer"
      },
      "num_soft_bounces": {
        "description": "Number of emails sent that soft bounced.",
        "example": 8,
        "type": "integer"
      },
      "num_complaints": {
        "description": "Number of emails sent that complained.",
        "example": 2,
        "type": "integer"
      },
      "num_unsubscribes": {
        "description": "Number of emails sent that unsubscribed.",
        "example": 3,
        "type": "integer"
      },
      "status": {
        "description": "Status of the campaign.",
        "example": "draft",
        "type": "string",
        "enum": [
          "draft",
          "pending",
          "in progress",
          "complete",
          "error",
          "paused",
          "archived",
          "active"
        ]
      },
      "started": {
        "type": "integer",
        "description": "Time at which the campaign started sending. Measured in seconds since the UNIX epoch.",
        "example": 1592422402
      },
      "sent": {
        "type": "integer",
        "description": "Time at which the campaign completed sending. Measured in seconds since the UNIX epoch.",
        "example": 1592422500
      },
      "delayed_until": {
        "type": "integer",
        "description": "Time at which the campaign will resume sending. Measured in seconds since the UNIX epoch.",
        "example": 1592422500
      }
    },
    "BulkCampaignListExample": {
      "id": "66e60ece-d4e4-4286-8ea6-990cb500aa8e",
      "created": 1568654293,
      "name": "March 2022 Campaign",
      "subject": "The January Newsletter",
      "from": {
        "email": "chris@bigmailer.io",
        "name": "Chris"
      },
      "recipient_name": "*|FIRST_NAME|*",
      "reply_to": {
        "email": "chris@bigmailer.io",
        "name": "Chris"
      },
      "link_params": "utm_campaign=spring_sale&utm_medium=cpc",
      "preview": "Hurry, 50% Off for 2 Days Only!",
      "auto_text": false,
      "track_opens": true,
      "track_clicks": true,
      "track_text_clicks": true,
      "segment_id": "b4326936-9e08-4cf9-95fe-c44c8cf4e4ef",
      "message_type_id": "b4326936-9e08-4cf9-95fe-c44c8cf4e4ef",
      "list_ids": [
        "b4326936-9e08-4cf9-95fe-c44c8cf4e4ef"
      ],
      "excluded_list_ids": [
        "9b480ee4-cddd-4f11-92d2-15f7d0f18f9c"
      ],
      "scheduled_for": 1704085200,
      "throttling_type": "burst",
      "throttling_amount": 1000,
      "throttling_period": 900,
      "suppression_list_id": "b4326936-9e08-4cf9-95fe-c44c8cf4e4ef",
      "num_sent": 100,
      "num_rejected": 10,
      "num_clicks": 20,
      "num_total_clicks": 30,
      "num_opens": 50,
      "num_total_opens": 60,
      "num_hard_bounces": 4,
      "num_soft_bounces": 8,
      "num_complaints": 2,
      "num_unsubscribes": 3,
      "status": "draft",
      "started": 1592422402,
      "sent": 1592422500
    },
    "BulkCampaignListProperties": {
      "id": {
        "description": "ID of the campaign",
        "example": "66e60ece-d4e4-4286-8ea6-990cb500aa8e",
        "format": "uuid",
        "type": "string"
      },
      "created": {
        "description": "Time at which the object was created. Measured in seconds since the UNIX epoch.",
        "example": 1592422352,
        "type": "integer"
      },
      "name": {
        "description": "Name of the campaign",
        "example": "March 2022 Campaign",
        "type": "string"
      },
      "subject": {
        "description": "Subject line for the campaign",
        "example": "The January Newsletter",
        "type": "string"
      },
      "from": {
        "properties": {
          "email": {
            "description": "From email address",
            "type": "string",
            "format": "email"
          },
          "name": {
            "description": "From name",
            "type": "string"
          }
        },
        "type": "object"
      },
      "recipient_name": {
        "description": "Name of the recipient. Use merge tags to make it more personal and avoid spam filters.",
        "example": "*|FIRST_NAME|*",
        "type": "string"
      },
      "reply_to": {
        "properties": {
          "email": {
            "description": "Reply to email address",
            "type": "string",
            "format": "email"
          },
          "name": {
            "description": "Reply to name",
            "type": "string"
          }
        },
        "type": "object"
      },
      "link_params": {
        "description": "Additional query string parameters to add to all links in the template.",
        "example": "utm_campaign=spring_sale&utm_medium=cpc",
        "type": "string"
      },
      "preview": {
        "description": "Copy shown following your subject line in many email clients.",
        "example": "Hurry, 50% Off for 2 Days Only!",
        "type": "string"
      },
      "auto_text": {
        "description": "True to generate the text body automatically from the HTML body.",
        "example": false,
        "type": "boolean"
      },
      "track_opens": {
        "description": "True to enable open tracking (HTML campaigns only).",
        "example": true,
        "type": "boolean"
      },
      "track_clicks": {
        "description": "True to enable click tracking in HTML links.",
        "example": true,
        "type": "boolean"
      },
      "track_text_clicks": {
        "description": "True to enable click tracking in text links.",
        "example": true,
        "type": "boolean"
      },
      "segment_id": {
        "description": "ID of a segment used to filter the lists of contacts the campaign is sent to.",
        "example": "b4326936-9e08-4cf9-95fe-c44c8cf4e4ef",
        "type": "string",
        "format": "uuid"
      },
      "message_type_id": {
        "description": "ID of the message type of the campaign.",
        "example": "b4326936-9e08-4cf9-95fe-c44c8cf4e4ef",
        "type": "string",
        "format": "uuid"
      },
      "list_ids": {
        "description": "An array of list ids to send the campaign to.",
        "example": [
          "b4326936-9e08-4cf9-95fe-c44c8cf4e4ef"
        ],
        "items": {
          "example": "b4326936-9e08-4cf9-95fe-c44c8cf4e4ef",
          "format": "uuid",
          "type": "string"
        },
        "type": "array"
      },
      "excluded_list_ids": {
        "description": "An array of list ids to exclude from the campaign. Any contacts on these lists will not be sent the campaign.",
        "example": [
          "9b480ee4-cddd-4f11-92d2-15f7d0f18f9c"
        ],
        "items": {
          "example": "9b480ee4-cddd-4f11-92d2-15f7d0f18f9c",
          "format": "uuid",
          "type": "string"
        },
        "type": "array"
      },
      "scheduled_for": {
        "description": "Time at which to send the campaign. Measured in seconds since the UNIX epoch. Omit to send the campaign immediately.",
        "example": 1704085200,
        "type": "integer",
        "minimum": 1704085200,
        "maximum": 4102462800
      },
      "throttling_type": {
        "description": "Set to `none` to send the campaign as fast as possible. Set to `burst` to send the campaign in small batches over time.",
        "example": "burst",
        "type": "string",
        "enum": [
          "none",
          "burst"
        ]
      },
      "throttling_amount": {
        "description": "Number of emails to send in each per batch. Must be a multiple of 1000. Required if `throttling_type` is `burst`.",
        "example": 1000,
        "type": "integer",
        "multipleOf": 1000,
        "minimum": 1000,
        "maximum": 1000000
      },
      "throttling_period": {
        "description": "Time in seconds between sending each batch of emails. Required if `throttling_type` is `burst`.",
        "example": 900,
        "type": "integer",
        "enum": [
          900,
          1800,
          3600,
          7200
        ]
      },
      "suppression_list_id": {
        "description": "ID of a suppression list. Any emails in the suppression list will not be sent the campaign.",
        "example": "b4326936-9e08-4cf9-95fe-c44c8cf4e4ef",
        "type": "string",
        "format": "uuid"
      },
      "num_sent": {
        "description": "Number of emails sent.",
        "example": 100,
        "type": "integer"
      },
      "num_rejected": {
        "description": "Number of emails rejected.",
        "example": 10,
        "type": "integer"
      },
      "num_clicks": {
        "description": "Number of unique clicks.",
        "example": 20,
        "type": "integer"
      },
      "num_total_clicks": {
        "description": "Number of total clicks (non-unique).",
        "example": 30,
        "type": "integer"
      },
      "num_opens": {
        "description": "Number of unique opens.",
        "example": 50,
        "type": "integer"
      },
      "num_total_opens": {
        "description": "Number of total opens (non-unique).",
        "example": 60,
        "type": "integer"
      },
      "num_hard_bounces": {
        "description": "Number of emails sent that hard bounced.",
        "example": 4,
        "type": "integer"
      },
      "num_soft_bounces": {
        "description": "Number of emails sent that soft bounced.",
        "example": 8,
        "type": "integer"
      },
      "num_complaints": {
        "description": "Number of emails sent that complained.",
        "example": 2,
        "type": "integer"
      },
      "num_unsubscribes": {
        "description": "Number of emails sent that unsubscribed.",
        "example": 3,
        "type": "integer"
      },
      "status": {
        "description": "Status of the campaign.",
        "example": "draft",
        "type": "string",
        "enum": [
          "draft",
          "pending",
          "in progress",
          "complete",
          "error",
          "paused",
          "archived",
          "active"
        ]
      },
      "started": {
        "type": "integer",
        "description": "Time at which the campaign started sending. Measured in seconds since the UNIX epoch.",
        "example": 1592422402
      },
      "sent": {
        "type": "integer",
        "description": "Time at which the campaign completed sending. Measured in seconds since the UNIX epoch.",
        "example": 1592422500
      },
      "delayed_until": {
        "type": "integer",
        "description": "Time at which the campaign will resume sending. Measured in seconds since the UNIX epoch.",
        "example": 1592422500
      }
    },
    "CreateUpdateBulkCampaignExample": {
      "name": "March 2022 Campaign",
      "subject": "The January Newsletter",
      "from": {
        "email": "chris@bigmailer.io",
        "name": "Chris"
      },
      "recipient_name": "*|FIRST_NAME|*",
      "reply_to": {
        "email": "chris@bigmailer.io",
        "name": "Chris"
      },
      "link_params": "utm_campaign=spring_sale&utm_medium=cpc",
      "preview": "Hurry, 50% Off for 2 Days Only!",
      "auto_text": false,
      "html": "<html><body><p>hello, world.</p></body></html>",
      "text": "This is the text body.",
      "template_id": "b4326936-9e08-4cf9-95fe-c44c8cf4e4ef",
      "track_opens": true,
      "track_clicks": true,
      "track_text_clicks": true,
      "segment_id": "b4326936-9e08-4cf9-95fe-c44c8cf4e4ef",
      "message_type_id": "b4326936-9e08-4cf9-95fe-c44c8cf4e4ef",
      "list_ids": [
        "b4326936-9e08-4cf9-95fe-c44c8cf4e4ef"
      ],
      "excluded_list_ids": [
        "9b480ee4-cddd-4f11-92d2-15f7d0f18f9c"
      ],
      "scheduled_for": 1704085200,
      "throttling_type": "burst",
      "throttling_amount": 1000,
      "throttling_period": 900,
      "suppression_list_id": "b4326936-9e08-4cf9-95fe-c44c8cf4e4ef",
      "ready": true
    },
    "CreateUpdateBulkCampaignProperties": {
      "name": {
        "description": "Name of the campaign",
        "example": "March 2022 Campaign",
        "type": "string"
      },
      "subject": {
        "description": "Subject line for the campaign",
        "example": "The January Newsletter",
        "type": "string"
      },
      "from": {
        "properties": {
          "email": {
            "description": "From email address",
            "type": "string",
            "format": "email"
          },
          "name": {
            "description": "From name",
            "type": "string"
          }
        },
        "type": "object"
      },
      "recipient_name": {
        "description": "Name of the recipient. Use merge tags to make it more personal and avoid spam filters.",
        "example": "*|FIRST_NAME|*",
        "type": "string"
      },
      "reply_to": {
        "properties": {
          "email": {
            "description": "Reply to email address",
            "type": "string",
            "format": "email"
          },
          "name": {
            "description": "Reply to name",
            "type": "string"
          }
        },
        "type": "object"
      },
      "link_params": {
        "description": "Additional query string parameters to add to all links in the template.",
        "example": "utm_campaign=spring_sale&utm_medium=cpc",
        "type": "string"
      },
      "preview": {
        "description": "Copy shown following your subject line in many email clients.",
        "example": "Hurry, 50% Off for 2 Days Only!",
        "type": "string"
      },
      "auto_text": {
        "description": "True to generate the text body automatically from the HTML body.",
        "example": false,
        "type": "boolean"
      },
      "html": {
        "description": "HTML body of the email.",
        "example": "<html><body><p>hello, world.</p></body></html>",
        "type": "string"
      },
      "text": {
        "description": "Text body of the email.",
        "example": "This is the text body.",
        "type": "string"
      },
      "template_id": {
        "description": "A template id to use to populate the HTML body of the email.",
        "format": "uuid",
        "type": "string"
      },
      "track_opens": {
        "description": "True to enable open tracking (HTML campaigns only).",
        "example": true,
        "type": "boolean"
      },
      "track_clicks": {
        "description": "True to enable click tracking in HTML links.",
        "example": true,
        "type": "boolean"
      },
      "track_text_clicks": {
        "description": "True to enable click tracking in text links.",
        "example": true,
        "type": "boolean"
      },
      "segment_id": {
        "description": "ID of a segment used to filter the lists of contacts the campaign is sent to.",
        "example": "b4326936-9e08-4cf9-95fe-c44c8cf4e4ef",
        "type": "string",
        "format": "uuid"
      },
      "message_type_id": {
        "description": "ID of the message type of the campaign.",
        "example": "b4326936-9e08-4cf9-95fe-c44c8cf4e4ef",
        "type": "string",
        "format": "uuid"
      },
      "list_ids": {
        "description": "An array of list ids to send the campaign to.",
        "example": [
          "b4326936-9e08-4cf9-95fe-c44c8cf4e4ef"
        ],
        "items": {
          "example": "b4326936-9e08-4cf9-95fe-c44c8cf4e4ef",
          "format": "uuid",
          "type": "string"
        },
        "type": "array"
      },
      "excluded_list_ids": {
        "description": "An array of list ids to exclude from the campaign. Any contacts on these lists will not be sent the campaign.",
        "example": [
          "9b480ee4-cddd-4f11-92d2-15f7d0f18f9c"
        ],
        "items": {
          "example": "9b480ee4-cddd-4f11-92d2-15f7d0f18f9c",
          "format": "uuid",
          "type": "string"
        },
        "type": "array"
      },
      "scheduled_for": {
        "description": "Time at which to send the campaign. Measured in seconds since the UNIX epoch. Omit to send the campaign immediately.",
        "example": 1704085200,
        "type": "integer",
        "minimum": 1704085200,
        "maximum": 4102462800
      },
      "throttling_type": {
        "description": "Set to `none` to send the campaign as fast as possible. Set to `burst` to send the campaign in small batches over time.",
        "example": "burst",
        "type": "string",
        "enum": [
          "none",
          "burst"
        ]
      },
      "throttling_amount": {
        "description": "Number of emails to send in each per batch. Must be a multiple of 1000. Required if `throttling_type` is `burst`.",
        "example": 1000,
        "type": "integer",
        "multipleOf": 1000,
        "minimum": 1000,
        "maximum": 1000000
      },
      "throttling_period": {
        "description": "Time in seconds between sending each batch of emails. Required if `throttling_type` is `burst`.",
        "example": 900,
        "type": "integer",
        "enum": [
          900,
          1800,
          3600,
          7200
        ]
      },
      "suppression_list_id": {
        "description": "ID of a suppression list. Any emails in the suppression list will not be sent the campaign.",
        "example": "b4326936-9e08-4cf9-95fe-c44c8cf4e4ef",
        "type": "string",
        "format": "uuid"
      },
      "ready": {
        "description": "Set to true to send or schedule the campaign. The campaign will not be sent or scheduled until activated by setting ready to true.",
        "example": true,
        "type": "boolean"
      }
    },
    "RssCampaignListExample": {
      "id": "66e60ece-d4e4-4286-8ea6-990cb500aa8e",
      "created": 1568654293,
      "name": "March 2022 Campaign",
      "subject": "The January Newsletter",
      "from": {
        "email": "chris@bigmailer.io",
        "name": "Chris"
      },
      "recipient_name": "*|FIRST_NAME|*",
      "reply_to": {
        "email": "chris@bigmailer.io",
        "name": "Chris"
      },
      "link_params": "utm_campaign=spring_sale&utm_medium=cpc",
      "preview": "Hurry, 50% Off for 2 Days Only!",
      "auto_text": false,
      "track_opens": true,
      "track_clicks": true,
      "track_text_clicks": true,
      "segment_id": "b4326936-9e08-4cf9-95fe-c44c8cf4e4ef",
      "message_type_id": "b4326936-9e08-4cf9-95fe-c44c8cf4e4ef",
      "list_ids": [
        "b4326936-9e08-4cf9-95fe-c44c8cf4e4ef"
      ],
      "excluded_list_ids": [
        "9b480ee4-cddd-4f11-92d2-15f7d0f18f9c"
      ],
      "throttling_type": "burst",
      "throttling_amount": 1000,
      "throttling_period": 900,
      "suppression_list_id": "b4326936-9e08-4cf9-95fe-c44c8cf4e4ef",
      "feed_url": "https://www.example.com/rss.xml",
      "hour": 13,
      "minutes": 45,
      "frequency": {
        "daily": {
          "days": [
            "mon",
            "wed",
            "fri"
          ]
        }
      },
      "status": "draft"
    },
    "RssCampaignListProperties": {
      "id": {
        "description": "ID of the campaign",
        "example": "66e60ece-d4e4-4286-8ea6-990cb500aa8e",
        "format": "uuid",
        "type": "string"
      },
      "created": {
        "description": "Time at which the object was created. Measured in seconds since the UNIX epoch.",
        "example": 1592422352,
        "type": "integer"
      },
      "name": {
        "description": "Name of the campaign",
        "example": "March 2022 Campaign",
        "type": "string"
      },
      "subject": {
        "description": "Subject line for the campaign",
        "example": "The January Newsletter",
        "type": "string"
      },
      "from": {
        "properties": {
          "email": {
            "description": "From email address",
            "type": "string",
            "format": "email"
          },
          "name": {
            "description": "From name",
            "type": "string"
          }
        },
        "type": "object"
      },
      "recipient_name": {
        "description": "Name of the recipient. Use merge tags to make it more personal and avoid spam filters.",
        "example": "*|FIRST_NAME|*",
        "type": "string"
      },
      "reply_to": {
        "properties": {
          "email": {
            "description": "Reply to email address",
            "type": "string",
            "format": "email"
          },
          "name": {
            "description": "Reply to name",
            "type": "string"
          }
        },
        "type": "object"
      },
      "link_params": {
        "description": "Additional query string parameters to add to all links in the template.",
        "example": "utm_campaign=spring_sale&utm_medium=cpc",
        "type": "string"
      },
      "preview": {
        "description": "Copy shown following your subject line in many email clients.",
        "example": "Hurry, 50% Off for 2 Days Only!",
        "type": "string"
      },
      "auto_text": {
        "description": "True to generate the text body automatically from the HTML body.",
        "example": false,
        "type": "boolean"
      },
      "track_opens": {
        "description": "True to enable open tracking (HTML campaigns only).",
        "example": true,
        "type": "boolean"
      },
      "track_clicks": {
        "description": "True to enable click tracking in HTML links.",
        "example": true,
        "type": "boolean"
      },
      "track_text_clicks": {
        "description": "True to enable click tracking in text links.",
        "example": true,
        "type": "boolean"
      },
      "segment_id": {
        "description": "ID of a segment used to filter the lists of contacts the campaign is sent to.",
        "example": "b4326936-9e08-4cf9-95fe-c44c8cf4e4ef",
        "type": "string",
        "format": "uuid"
      },
      "message_type_id": {
        "description": "ID of the message type of the campaign.",
        "example": "b4326936-9e08-4cf9-95fe-c44c8cf4e4ef",
        "type": "string",
        "format": "uuid"
      },
      "list_ids": {
        "description": "An array of list ids to send the campaign to.",
        "example": [
          "b4326936-9e08-4cf9-95fe-c44c8cf4e4ef"
        ],
        "items": {
          "example": "b4326936-9e08-4cf9-95fe-c44c8cf4e4ef",
          "format": "uuid",
          "type": "string"
        },
        "type": "array"
      },
      "excluded_list_ids": {
        "description": "An array of list ids to exclude from the campaign. Any contacts on these lists will not be sent the campaign.",
        "example": [
          "9b480ee4-cddd-4f11-92d2-15f7d0f18f9c"
        ],
        "items": {
          "example": "9b480ee4-cddd-4f11-92d2-15f7d0f18f9c",
          "format": "uuid",
          "type": "string"
        },
        "type": "array"
      },
      "throttling_type": {
        "description": "Set to `none` to send the campaign as fast as possible. Set to `burst` to send the campaign in small batches over time.",
        "example": "burst",
        "type": "string",
        "enum": [
          "none",
          "burst"
        ]
      },
      "throttling_amount": {
        "description": "Number of emails to send in each per batch. Must be a multiple of 1000. Required if `throttling_type` is `burst`.",
        "example": 1000,
        "type": "integer",
        "multipleOf": 1000,
        "minimum": 1000,
        "maximum": 1000000
      },
      "throttling_period": {
        "description": "Time in seconds between sending each batch of emails. Required if `throttling_type` is `burst`.",
        "example": 900,
        "type": "integer",
        "enum": [
          900,
          1800,
          3600,
          7200
        ]
      },
      "suppression_list_id": {
        "description": "ID of a suppression list. Any emails in the suppression list will not be sent the campaign.",
        "example": "b4326936-9e08-4cf9-95fe-c44c8cf4e4ef",
        "type": "string",
        "format": "uuid"
      },
      "feed_url": {
        "description": "URL of an RSS feed.",
        "type": "string",
        "format": "url",
        "example": "https://www.example.com/rss.xml"
      },
      "hour": {
        "description": "Hour to check the RSS feed for updates. Not used if using the hourly frequency.",
        "type": "integer",
        "minimum": 0,
        "maximum": 23,
        "example": 13
      },
      "minutes": {
        "description": "Minutes to check the RSS feed for updates.",
        "type": "integer",
        "enum": [
          0,
          5,
          10,
          15,
          20,
          25,
          30,
          35,
          40,
          45,
          50,
          55
        ],
        "example": 45
      },
      "frequency": {
        "type": "object",
        "description": "Details of how often to check the RSS feed for updates. Only one of hourly, daily, weekly, and monthly must be present.",
        "properties": {
          "hourly": {
            "type": "object",
            "properties": {
              "days": {
                "type": "array",
                "minItems": 1,
                "maxItems": 7,
                "items": {
                  "description": "Days of the week to check the RSS feed for updates when using the hourly schedule.",
                  "type": "string",
                  "enum": [
                    "mon",
                    "tue",
                    "wed",
                    "thu",
                    "fri",
                    "sat",
                    "sun"
                  ]
                },
                "example": [
                  "mon",
                  "wed",
                  "fri"
                ]
              }
            }
          },
          "daily": {
            "type": "object",
            "properties": {
              "days": {
                "type": "array",
                "minItems": 1,
                "maxItems": 7,
                "items": {
                  "description": "Days of the week to check the RSS feed for updates.",
                  "type": "string",
                  "enum": [
                    "mon",
                    "tue",
                    "wed",
                    "thu",
                    "fri",
                    "sat",
                    "sun"
                  ]
                },
                "example": [
                  "mon",
                  "wed",
                  "fri"
                ]
              }
            }
          },
          "weekly": {
            "type": "object",
            "properties": {
              "day": {
                "description": "Day of the week to check the RSS feed for an update.",
                "type": "string",
                "enum": [
                  "mon",
                  "tue",
                  "wed",
                  "thu",
                  "fri",
                  "sat",
                  "sun"
                ],
                "example": "mon"
              }
            }
          },
          "monthly": {
            "type": "object",
            "properties": {
              "day": {
                "description": "Day of the month to check the RSS feed for an update. Or, -1 to check on the last day of the month.",
                "type": "integer",
                "enum": [
                  1,
                  2,
                  3,
                  4,
                  5,
                  6,
                  7,
                  8,
                  9,
                  10,
                  11,
                  12,
                  13,
                  14,
                  15,
                  16,
                  17,
                  18,
                  19,
                  20,
                  21,
                  22,
                  23,
                  24,
                  25,
                  26,
                  27,
                  28,
                  29,
                  30,
                  31,
                  -1
                ],
                "example": -1
              }
            }
          }
        }
      },
      "status": {
        "description": "Status of the campaign.",
        "example": "draft",
        "type": "string",
        "enum": [
          "draft",
          "pending",
          "in progress",
          "complete",
          "error",
          "paused",
          "archived",
          "active"
        ]
      }
    },
    "RssCampaignExample": {
      "id": "66e60ece-d4e4-4286-8ea6-990cb500aa8e",
      "created": 1568654293,
      "name": "March 2022 Campaign",
      "subject": "The January Newsletter",
      "from": {
        "email": "chris@bigmailer.io",
        "name": "Chris"
      },
      "recipient_name": "*|FIRST_NAME|*",
      "reply_to": {
        "email": "chris@bigmailer.io",
        "name": "Chris"
      },
      "link_params": "utm_campaign=spring_sale&utm_medium=cpc",
      "preview": "Hurry, 50% Off for 2 Days Only!",
      "auto_text": false,
      "html": "<html><body><p>hello, world.</p></body></html>",
      "text": "This is the text body.",
      "track_opens": true,
      "track_clicks": true,
      "track_text_clicks": true,
      "segment_id": "b4326936-9e08-4cf9-95fe-c44c8cf4e4ef",
      "message_type_id": "b4326936-9e08-4cf9-95fe-c44c8cf4e4ef",
      "list_ids": [
        "b4326936-9e08-4cf9-95fe-c44c8cf4e4ef"
      ],
      "excluded_list_ids": [
        "9b480ee4-cddd-4f11-92d2-15f7d0f18f9c"
      ],
      "throttling_type": "burst",
      "throttling_amount": 1000,
      "throttling_period": 900,
      "suppression_list_id": "b4326936-9e08-4cf9-95fe-c44c8cf4e4ef",
      "feed_url": "https://www.example.com/rss.xml",
      "hour": 13,
      "minutes": 45,
      "frequency": {
        "daily": {
          "days": [
            "mon",
            "wed",
            "fri"
          ]
        }
      },
      "status": "draft"
    },
    "RssCampaignProperties": {
      "id": {
        "description": "ID of the campaign",
        "example": "66e60ece-d4e4-4286-8ea6-990cb500aa8e",
        "format": "uuid",
        "type": "string"
      },
      "created": {
        "description": "Time at which the object was created. Measured in seconds since the UNIX epoch.",
        "example": 1592422352,
        "type": "integer"
      },
      "name": {
        "description": "Name of the campaign",
        "example": "March 2022 Campaign",
        "type": "string"
      },
      "subject": {
        "description": "Subject line for the campaign",
        "example": "The January Newsletter",
        "type": "string"
      },
      "from": {
        "properties": {
          "email": {
            "description": "From email address",
            "type": "string",
            "format": "email"
          },
          "name": {
            "description": "From name",
            "type": "string"
          }
        },
        "type": "object"
      },
      "recipient_name": {
        "description": "Name of the recipient. Use merge tags to make it more personal and avoid spam filters.",
        "example": "*|FIRST_NAME|*",
        "type": "string"
      },
      "reply_to": {
        "properties": {
          "email": {
            "description": "Reply to email address",
            "type": "string",
            "format": "email"
          },
          "name": {
            "description": "Reply to name",
            "type": "string"
          }
        },
        "type": "object"
      },
      "link_params": {
        "description": "Additional query string parameters to add to all links in the template.",
        "example": "utm_campaign=spring_sale&utm_medium=cpc",
        "type": "string"
      },
      "preview": {
        "description": "Copy shown following your subject line in many email clients.",
        "example": "Hurry, 50% Off for 2 Days Only!",
        "type": "string"
      },
      "auto_text": {
        "description": "True to generate the text body automatically from the HTML body.",
        "example": false,
        "type": "boolean"
      },
      "html": {
        "description": "HTML body of the email.",
        "example": "<html><body><p>hello, world.</p></body></html>",
        "type": "string"
      },
      "text": {
        "description": "Text body of the email.",
        "example": "This is the text body.",
        "type": "string"
      },
      "track_opens": {
        "description": "True to enable open tracking (HTML campaigns only).",
        "example": true,
        "type": "boolean"
      },
      "track_clicks": {
        "description": "True to enable click tracking in HTML links.",
        "example": true,
        "type": "boolean"
      },
      "track_text_clicks": {
        "description": "True to enable click tracking in text links.",
        "example": true,
        "type": "boolean"
      },
      "segment_id": {
        "description": "ID of a segment used to filter the lists of contacts the campaign is sent to.",
        "example": "b4326936-9e08-4cf9-95fe-c44c8cf4e4ef",
        "type": "string",
        "format": "uuid"
      },
      "message_type_id": {
        "description": "ID of the message type of the campaign.",
        "example": "b4326936-9e08-4cf9-95fe-c44c8cf4e4ef",
        "type": "string",
        "format": "uuid"
      },
      "list_ids": {
        "description": "An array of list ids to send the campaign to.",
        "example": [
          "b4326936-9e08-4cf9-95fe-c44c8cf4e4ef"
        ],
        "items": {
          "example": "b4326936-9e08-4cf9-95fe-c44c8cf4e4ef",
          "format": "uuid",
          "type": "string"
        },
        "type": "array"
      },
      "excluded_list_ids": {
        "description": "An array of list ids to exclude from the campaign. Any contacts on these lists will not be sent the campaign.",
        "example": [
          "9b480ee4-cddd-4f11-92d2-15f7d0f18f9c"
        ],
        "items": {
          "example": "9b480ee4-cddd-4f11-92d2-15f7d0f18f9c",
          "format": "uuid",
          "type": "string"
        },
        "type": "array"
      },
      "throttling_type": {
        "description": "Set to `none` to send the campaign as fast as possible. Set to `burst` to send the campaign in small batches over time.",
        "example": "burst",
        "type": "string",
        "enum": [
          "none",
          "burst"
        ]
      },
      "throttling_amount": {
        "description": "Number of emails to send in each per batch. Must be a multiple of 1000. Required if `throttling_type` is `burst`.",
        "example": 1000,
        "type": "integer",
        "multipleOf": 1000,
        "minimum": 1000,
        "maximum": 1000000
      },
      "throttling_period": {
        "description": "Time in seconds between sending each batch of emails. Required if `throttling_type` is `burst`.",
        "example": 900,
        "type": "integer",
        "enum": [
          900,
          1800,
          3600,
          7200
        ]
      },
      "suppression_list_id": {
        "description": "ID of a suppression list. Any emails in the suppression list will not be sent the campaign.",
        "example": "b4326936-9e08-4cf9-95fe-c44c8cf4e4ef",
        "type": "string",
        "format": "uuid"
      },
      "feed_url": {
        "description": "URL of an RSS feed.",
        "type": "string",
        "format": "url",
        "example": "https://www.example.com/rss.xml"
      },
      "hour": {
        "description": "Hour to check the RSS feed for updates. Not used if using the hourly frequency.",
        "type": "integer",
        "minimum": 0,
        "maximum": 23,
        "example": 13
      },
      "minutes": {
        "description": "Minutes to check the RSS feed for updates.",
        "type": "integer",
        "enum": [
          0,
          5,
          10,
          15,
          20,
          25,
          30,
          35,
          40,
          45,
          50,
          55
        ],
        "example": 45
      },
      "frequency": {
        "type": "object",
        "description": "Details of how often to check the RSS feed for updates. Only one of hourly, daily, weekly, and monthly must be present.",
        "properties": {
          "hourly": {
            "type": "object",
            "properties": {
              "days": {
                "type": "array",
                "minItems": 1,
                "maxItems": 7,
                "items": {
                  "description": "Days of the week to check the RSS feed for updates when using the hourly schedule.",
                  "type": "string",
                  "enum": [
                    "mon",
                    "tue",
                    "wed",
                    "thu",
                    "fri",
                    "sat",
                    "sun"
                  ]
                },
                "example": [
                  "mon",
                  "wed",
                  "fri"
                ]
              }
            }
          },
          "daily": {
            "type": "object",
            "properties": {
              "days": {
                "type": "array",
                "minItems": 1,
                "maxItems": 7,
                "items": {
                  "description": "Days of the week to check the RSS feed for updates.",
                  "type": "string",
                  "enum": [
                    "mon",
                    "tue",
                    "wed",
                    "thu",
                    "fri",
                    "sat",
                    "sun"
                  ]
                },
                "example": [
                  "mon",
                  "wed",
                  "fri"
                ]
              }
            }
          },
          "weekly": {
            "type": "object",
            "properties": {
              "day": {
                "description": "Day of the week to check the RSS feed for an update.",
                "type": "string",
                "enum": [
                  "mon",
                  "tue",
                  "wed",
                  "thu",
                  "fri",
                  "sat",
                  "sun"
                ],
                "example": "mon"
              }
            }
          },
          "monthly": {
            "type": "object",
            "properties": {
              "day": {
                "description": "Day of the month to check the RSS feed for an update. Or, -1 to check on the last day of the month.",
                "type": "integer",
                "enum": [
                  1,
                  2,
                  3,
                  4,
                  5,
                  6,
                  7,
                  8,
                  9,
                  10,
                  11,
                  12,
                  13,
                  14,
                  15,
                  16,
                  17,
                  18,
                  19,
                  20,
                  21,
                  22,
                  23,
                  24,
                  25,
                  26,
                  27,
                  28,
                  29,
                  30,
                  31,
                  -1
                ],
                "example": -1
              }
            }
          }
        }
      },
      "status": {
        "description": "Status of the campaign.",
        "example": "draft",
        "type": "string",
        "enum": [
          "draft",
          "pending",
          "in progress",
          "complete",
          "error",
          "paused",
          "archived",
          "active"
        ]
      }
    },
    "CreateUpdateRssCampaignExample": {
      "name": "March 2022 Campaign",
      "subject": "The January Newsletter",
      "from": {
        "email": "chris@bigmailer.io",
        "name": "Chris"
      },
      "recipient_name": "*|FIRST_NAME|*",
      "reply_to": {
        "email": "chris@bigmailer.io",
        "name": "Chris"
      },
      "link_params": "utm_campaign=spring_sale&utm_medium=cpc",
      "preview": "Hurry, 50% Off for 2 Days Only!",
      "auto_text": false,
      "html": "<html><body><p>hello, world.</p></body></html>",
      "text": "This is the text body.",
      "template_id": "b4326936-9e08-4cf9-95fe-c44c8cf4e4ef",
      "track_opens": true,
      "track_clicks": true,
      "track_text_clicks": true,
      "segment_id": "b4326936-9e08-4cf9-95fe-c44c8cf4e4ef",
      "message_type_id": "b4326936-9e08-4cf9-95fe-c44c8cf4e4ef",
      "list_ids": [
        "b4326936-9e08-4cf9-95fe-c44c8cf4e4ef"
      ],
      "excluded_list_ids": [
        "9b480ee4-cddd-4f11-92d2-15f7d0f18f9c"
      ],
      "throttling_type": "burst",
      "throttling_amount": 1000,
      "throttling_period": 900,
      "suppression_list_id": "b4326936-9e08-4cf9-95fe-c44c8cf4e4ef",
      "feed_url": "https://www.example.com/rss.xml",
      "hour": 13,
      "minutes": 45,
      "frequency": {
        "daily": {
          "days": [
            "mon",
            "wed",
            "fri"
          ]
        }
      },
      "ready": true
    },
    "CreateUpdateRssCampaignProperties": {
      "name": {
        "description": "Name of the campaign",
        "example": "March 2022 Campaign",
        "type": "string"
      },
      "subject": {
        "description": "Subject line for the campaign",
        "example": "The January Newsletter",
        "type": "string"
      },
      "from": {
        "properties": {
          "email": {
            "description": "From email address",
            "type": "string",
            "format": "email"
          },
          "name": {
            "description": "From name",
            "type": "string"
          }
        },
        "type": "object"
      },
      "recipient_name": {
        "description": "Name of the recipient. Use merge tags to make it more personal and avoid spam filters.",
        "example": "*|FIRST_NAME|*",
        "type": "string"
      },
      "reply_to": {
        "properties": {
          "email": {
            "description": "Reply to email address",
            "type": "string",
            "format": "email"
          },
          "name": {
            "description": "Reply to name",
            "type": "string"
          }
        },
        "type": "object"
      },
      "link_params": {
        "description": "Additional query string parameters to add to all links in the template.",
        "example": "utm_campaign=spring_sale&utm_medium=cpc",
        "type": "string"
      },
      "preview": {
        "description": "Copy shown following your subject line in many email clients.",
        "example": "Hurry, 50% Off for 2 Days Only!",
        "type": "string"
      },
      "auto_text": {
        "description": "True to generate the text body automatically from the HTML body.",
        "example": false,
        "type": "boolean"
      },
      "html": {
        "description": "HTML body of the email.",
        "example": "<html><body><p>hello, world.</p></body></html>",
        "type": "string"
      },
      "text": {
        "description": "Text body of the email.",
        "example": "This is the text body.",
        "type": "string"
      },
      "template_id": {
        "description": "A template id to use to populate the HTML body of the email.",
        "format": "uuid",
        "type": "string"
      },
      "track_opens": {
        "description": "True to enable open tracking (HTML campaigns only).",
        "example": true,
        "type": "boolean"
      },
      "track_clicks": {
        "description": "True to enable click tracking in HTML links.",
        "example": true,
        "type": "boolean"
      },
      "track_text_clicks": {
        "description": "True to enable click tracking in text links.",
        "example": true,
        "type": "boolean"
      },
      "segment_id": {
        "description": "ID of a segment used to filter the lists of contacts the campaign is sent to.",
        "example": "b4326936-9e08-4cf9-95fe-c44c8cf4e4ef",
        "type": "string",
        "format": "uuid"
      },
      "message_type_id": {
        "description": "ID of the message type of the campaign.",
        "example": "b4326936-9e08-4cf9-95fe-c44c8cf4e4ef",
        "type": "string",
        "format": "uuid"
      },
      "list_ids": {
        "description": "An array of list ids to send the campaign to.",
        "example": [
          "b4326936-9e08-4cf9-95fe-c44c8cf4e4ef"
        ],
        "items": {
          "example": "b4326936-9e08-4cf9-95fe-c44c8cf4e4ef",
          "format": "uuid",
          "type": "string"
        },
        "type": "array"
      },
      "excluded_list_ids": {
        "description": "An array of list ids to exclude from the campaign. Any contacts on these lists will not be sent the campaign.",
        "example": [
          "9b480ee4-cddd-4f11-92d2-15f7d0f18f9c"
        ],
        "items": {
          "example": "9b480ee4-cddd-4f11-92d2-15f7d0f18f9c",
          "format": "uuid",
          "type": "string"
        },
        "type": "array"
      },
      "throttling_type": {
        "description": "Set to `none` to send the campaign as fast as possible. Set to `burst` to send the campaign in small batches over time.",
        "example": "burst",
        "type": "string",
        "enum": [
          "none",
          "burst"
        ]
      },
      "throttling_amount": {
        "description": "Number of emails to send in each per batch. Must be a multiple of 1000. Required if `throttling_type` is `burst`.",
        "example": 1000,
        "type": "integer",
        "multipleOf": 1000,
        "minimum": 1000,
        "maximum": 1000000
      },
      "throttling_period": {
        "description": "Time in seconds between sending each batch of emails. Required if `throttling_type` is `burst`.",
        "example": 900,
        "type": "integer",
        "enum": [
          900,
          1800,
          3600,
          7200
        ]
      },
      "suppression_list_id": {
        "description": "ID of a suppression list. Any emails in the suppression list will not be sent the campaign.",
        "example": "b4326936-9e08-4cf9-95fe-c44c8cf4e4ef",
        "type": "string",
        "format": "uuid"
      },
      "feed_url": {
        "description": "URL of an RSS feed.",
        "type": "string",
        "format": "url",
        "example": "https://www.example.com/rss.xml"
      },
      "hour": {
        "description": "Hour to check the RSS feed for updates. Not used if using the hourly frequency.",
        "type": "integer",
        "minimum": 0,
        "maximum": 23,
        "example": 13
      },
      "minutes": {
        "description": "Minutes to check the RSS feed for updates.",
        "type": "integer",
        "enum": [
          0,
          5,
          10,
          15,
          20,
          25,
          30,
          35,
          40,
          45,
          50,
          55
        ],
        "example": 45
      },
      "frequency": {
        "type": "object",
        "description": "Details of how often to check the RSS feed for updates. Only one of hourly, daily, weekly, and monthly must be present.",
        "properties": {
          "hourly": {
            "type": "object",
            "properties": {
              "days": {
                "type": "array",
                "minItems": 1,
                "maxItems": 7,
                "items": {
                  "description": "Days of the week to check the RSS feed for updates when using the hourly schedule.",
                  "type": "string",
                  "enum": [
                    "mon",
                    "tue",
                    "wed",
                    "thu",
                    "fri",
                    "sat",
                    "sun"
                  ]
                },
                "example": [
                  "mon",
                  "wed",
                  "fri"
                ]
              }
            }
          },
          "daily": {
            "type": "object",
            "properties": {
              "days": {
                "type": "array",
                "minItems": 1,
                "maxItems": 7,
                "items": {
                  "description": "Days of the week to check the RSS feed for updates.",
                  "type": "string",
                  "enum": [
                    "mon",
                    "tue",
                    "wed",
                    "thu",
                    "fri",
                    "sat",
                    "sun"
                  ]
                },
                "example": [
                  "mon",
                  "wed",
                  "fri"
                ]
              }
            }
          },
          "weekly": {
            "type": "object",
            "properties": {
              "day": {
                "description": "Day of the week to check the RSS feed for an update.",
                "type": "string",
                "enum": [
                  "mon",
                  "tue",
                  "wed",
                  "thu",
                  "fri",
                  "sat",
                  "sun"
                ],
                "example": "mon"
              }
            }
          },
          "monthly": {
            "type": "object",
            "properties": {
              "day": {
                "description": "Day of the month to check the RSS feed for an update. Or, -1 to check on the last day of the month.",
                "type": "integer",
                "enum": [
                  1,
                  2,
                  3,
                  4,
                  5,
                  6,
                  7,
                  8,
                  9,
                  10,
                  11,
                  12,
                  13,
                  14,
                  15,
                  16,
                  17,
                  18,
                  19,
                  20,
                  21,
                  22,
                  23,
                  24,
                  25,
                  26,
                  27,
                  28,
                  29,
                  30,
                  31,
                  -1
                ],
                "example": -1
              }
            }
          }
        }
      },
      "ready": {
        "description": "Set to true to activate the RSS campaign. RSS campaigns will not be sent until activated by setting ready to true.",
        "example": true,
        "type": "boolean"
      }
    },
    "RssUpdateCampaignListExample": {
      "id": "66e60ece-d4e4-4286-8ea6-990cb500aa8e",
      "created": 1568654293,
      "subject": "The January Newsletter",
      "from": {
        "email": "chris@bigmailer.io",
        "name": "Chris"
      },
      "recipient_name": "*|FIRST_NAME|*",
      "reply_to": {
        "email": "chris@bigmailer.io",
        "name": "Chris"
      },
      "link_params": "utm_campaign=spring_sale&utm_medium=cpc",
      "preview": "Hurry, 50% Off for 2 Days Only!",
      "auto_text": false,
      "track_opens": true,
      "track_clicks": true,
      "track_text_clicks": true,
      "segment_id": "b4326936-9e08-4cf9-95fe-c44c8cf4e4ef",
      "message_type_id": "b4326936-9e08-4cf9-95fe-c44c8cf4e4ef",
      "list_ids": [
        "b4326936-9e08-4cf9-95fe-c44c8cf4e4ef"
      ],
      "excluded_list_ids": [
        "9b480ee4-cddd-4f11-92d2-15f7d0f18f9c"
      ],
      "throttling_type": "burst",
      "throttling_amount": 1000,
      "throttling_period": 900,
      "suppression_list_id": "b4326936-9e08-4cf9-95fe-c44c8cf4e4ef",
      "status": "draft",
      "feed_url": "https://www.example.com/rss.xml",
      "scanned": 1592422352,
      "scheduled_for": 1592422400,
      "started": 1592422402,
      "sent": 1592422500,
      "num_sent": 100,
      "num_rejected": 10,
      "num_clicks": 20,
      "num_total_clicks": 30,
      "num_opens": 50,
      "num_total_opens": 60,
      "num_hard_bounces": 4,
      "num_soft_bounces": 8,
      "num_complaints": 2,
      "num_unsubscribes": 3
    },
    "RssUpdateCampaignListProperties": {
      "id": {
        "description": "ID of the campaign",
        "example": "66e60ece-d4e4-4286-8ea6-990cb500aa8e",
        "format": "uuid",
        "type": "string"
      },
      "created": {
        "description": "Time at which the object was created. Measured in seconds since the UNIX epoch.",
        "example": 1592422352,
        "type": "integer"
      },
      "subject": {
        "description": "Subject line for the campaign",
        "example": "The January Newsletter",
        "type": "string"
      },
      "from": {
        "properties": {
          "email": {
            "description": "From email address",
            "type": "string",
            "format": "email"
          },
          "name": {
            "description": "From name",
            "type": "string"
          }
        },
        "type": "object"
      },
      "recipient_name": {
        "description": "Name of the recipient. Use merge tags to make it more personal and avoid spam filters.",
        "example": "*|FIRST_NAME|*",
        "type": "string"
      },
      "reply_to": {
        "properties": {
          "email": {
            "description": "Reply to email address",
            "type": "string",
            "format": "email"
          },
          "name": {
            "description": "Reply to name",
            "type": "string"
          }
        },
        "type": "object"
      },
      "link_params": {
        "description": "Additional query string parameters to add to all links in the template.",
        "example": "utm_campaign=spring_sale&utm_medium=cpc",
        "type": "string"
      },
      "preview": {
        "description": "Copy shown following your subject line in many email clients.",
        "example": "Hurry, 50% Off for 2 Days Only!",
        "type": "string"
      },
      "auto_text": {
        "description": "True to generate the text body automatically from the HTML body.",
        "example": false,
        "type": "boolean"
      },
      "track_opens": {
        "description": "True to enable open tracking (HTML campaigns only).",
        "example": true,
        "type": "boolean"
      },
      "track_clicks": {
        "description": "True to enable click tracking in HTML links.",
        "example": true,
        "type": "boolean"
      },
      "track_text_clicks": {
        "description": "True to enable click tracking in text links.",
        "example": true,
        "type": "boolean"
      },
      "segment_id": {
        "description": "ID of a segment used to filter the lists of contacts the campaign is sent to.",
        "example": "b4326936-9e08-4cf9-95fe-c44c8cf4e4ef",
        "type": "string",
        "format": "uuid"
      },
      "message_type_id": {
        "description": "ID of the message type of the campaign.",
        "example": "b4326936-9e08-4cf9-95fe-c44c8cf4e4ef",
        "type": "string",
        "format": "uuid"
      },
      "list_ids": {
        "description": "An array of list ids to send the campaign to.",
        "example": [
          "b4326936-9e08-4cf9-95fe-c44c8cf4e4ef"
        ],
        "items": {
          "example": "b4326936-9e08-4cf9-95fe-c44c8cf4e4ef",
          "format": "uuid",
          "type": "string"
        },
        "type": "array"
      },
      "excluded_list_ids": {
        "description": "An array of list ids to exclude from the campaign. Any contacts on these lists will not be sent the campaign.",
        "example": [
          "9b480ee4-cddd-4f11-92d2-15f7d0f18f9c"
        ],
        "items": {
          "example": "9b480ee4-cddd-4f11-92d2-15f7d0f18f9c",
          "format": "uuid",
          "type": "string"
        },
        "type": "array"
      },
      "throttling_type": {
        "description": "Set to `none` to send the campaign as fast as possible. Set to `burst` to send the campaign in small batches over time.",
        "example": "burst",
        "type": "string",
        "enum": [
          "none",
          "burst"
        ]
      },
      "throttling_amount": {
        "description": "Number of emails to send in each per batch. Must be a multiple of 1000. Required if `throttling_type` is `burst`.",
        "example": 1000,
        "type": "integer",
        "multipleOf": 1000,
        "minimum": 1000,
        "maximum": 1000000
      },
      "throttling_period": {
        "description": "Time in seconds between sending each batch of emails. Required if `throttling_type` is `burst`.",
        "example": 900,
        "type": "integer",
        "enum": [
          900,
          1800,
          3600,
          7200
        ]
      },
      "suppression_list_id": {
        "description": "ID of a suppression list. Any emails in the suppression list will not be sent the campaign.",
        "example": "b4326936-9e08-4cf9-95fe-c44c8cf4e4ef",
        "type": "string",
        "format": "uuid"
      },
      "status": {
        "description": "Status of the campaign.",
        "example": "draft",
        "type": "string",
        "enum": [
          "draft",
          "pending",
          "in progress",
          "complete",
          "error",
          "paused",
          "archived",
          "active"
        ]
      },
      "feed_url": {
        "description": "URL of the RSS feed.",
        "type": "string",
        "format": "url",
        "example": "https://www.example.com/rss.xml"
      },
      "scanned": {
        "type": "integer",
        "description": "Time at which the rss feed was checked for updates. Measured in seconds since the UNIX epoch.",
        "example": 1592422352
      },
      "scheduled_for": {
        "type": "integer",
        "description": "Time at which the rss update campaign was scheduled to be sent. Measured in seconds since the UNIX epoch.",
        "example": 1592422352
      },
      "started": {
        "type": "integer",
        "description": "Time at which the campaign started sending. Measured in seconds since the UNIX epoch.",
        "example": 1592422402
      },
      "sent": {
        "type": "integer",
        "description": "Time at which the campaign completed sending. Measured in seconds since the UNIX epoch.",
        "example": 1592422500
      },
      "delayed_until": {
        "type": "integer",
        "description": "Time at which the campaign will resume sending. Measured in seconds since the UNIX epoch.",
        "example": 1592422500
      },
      "num_sent": {
        "description": "Number of emails sent.",
        "example": 100,
        "type": "integer"
      },
      "num_rejected": {
        "description": "Number of emails rejected.",
        "example": 10,
        "type": "integer"
      },
      "num_clicks": {
        "description": "Number of unique clicks.",
        "example": 20,
        "type": "integer"
      },
      "num_total_clicks": {
        "description": "Number of total clicks (non-unique).",
        "example": 30,
        "type": "integer"
      },
      "num_opens": {
        "description": "Number of unique opens.",
        "example": 50,
        "type": "integer"
      },
      "num_total_opens": {
        "description": "Number of total opens (non-unique).",
        "example": 60,
        "type": "integer"
      },
      "num_hard_bounces": {
        "description": "Number of emails sent that hard bounced.",
        "example": 4,
        "type": "integer"
      },
      "num_soft_bounces": {
        "description": "Number of emails sent that soft bounced.",
        "example": 8,
        "type": "integer"
      },
      "num_complaints": {
        "description": "Number of emails sent that complained.",
        "example": 2,
        "type": "integer"
      },
      "num_unsubscribes": {
        "description": "Number of emails sent that unsubscribed.",
        "example": 3,
        "type": "integer"
      }
    },
    "RssUpdateCampaignExample": {
      "id": "66e60ece-d4e4-4286-8ea6-990cb500aa8e",
      "created": 1568654293,
      "name": "March 2022 Campaign",
      "subject": "The January Newsletter",
      "from": {
        "email": "chris@bigmailer.io",
        "name": "Chris"
      },
      "recipient_name": "*|FIRST_NAME|*",
      "reply_to": {
        "email": "chris@bigmailer.io",
        "name": "Chris"
      },
      "link_params": "utm_campaign=spring_sale&utm_medium=cpc",
      "preview": "Hurry, 50% Off for 2 Days Only!",
      "auto_text": false,
      "html": "<html><body><p>hello, world.</p></body></html>",
      "text": "This is the text body.",
      "track_opens": true,
      "track_clicks": true,
      "track_text_clicks": true,
      "segment_id": "b4326936-9e08-4cf9-95fe-c44c8cf4e4ef",
      "message_type_id": "b4326936-9e08-4cf9-95fe-c44c8cf4e4ef",
      "list_ids": [
        "b4326936-9e08-4cf9-95fe-c44c8cf4e4ef"
      ],
      "excluded_list_ids": [
        "9b480ee4-cddd-4f11-92d2-15f7d0f18f9c"
      ],
      "throttling_type": "burst",
      "throttling_amount": 1000,
      "throttling_period": 900,
      "suppression_list_id": "b4326936-9e08-4cf9-95fe-c44c8cf4e4ef",
      "status": "draft",
      "started": 1592422402,
      "sent": 1592422500,
      "feed_url": "https://www.example.com/rss.xml",
      "scanned": 1592422352,
      "scheduled_for": 1592422400,
      "num_sent": 100,
      "num_rejected": 10,
      "num_clicks": 20,
      "num_total_clicks": 30,
      "num_opens": 50,
      "num_total_opens": 60,
      "num_hard_bounces": 4,
      "num_soft_bounces": 8,
      "num_complaints": 2,
      "num_unsubscribes": 3
    },
    "RssUpdateCampaignProperties": {
      "id": {
        "description": "ID of the campaign",
        "example": "66e60ece-d4e4-4286-8ea6-990cb500aa8e",
        "format": "uuid",
        "type": "string"
      },
      "created": {
        "description": "Time at which the object was created. Measured in seconds since the UNIX epoch.",
        "example": 1592422352,
        "type": "integer"
      },
      "name": {
        "description": "Name of the campaign",
        "example": "March 2022 Campaign",
        "type": "string"
      },
      "subject": {
        "description": "Subject line for the campaign",
        "example": "The January Newsletter",
        "type": "string"
      },
      "from": {
        "properties": {
          "email": {
            "description": "From email address",
            "type": "string",
            "format": "email"
          },
          "name": {
            "description": "From name",
            "type": "string"
          }
        },
        "type": "object"
      },
      "recipient_name": {
        "description": "Name of the recipient. Use merge tags to make it more personal and avoid spam filters.",
        "example": "*|FIRST_NAME|*",
        "type": "string"
      },
      "reply_to": {
        "properties": {
          "email": {
            "description": "Reply to email address",
            "type": "string",
            "format": "email"
          },
          "name": {
            "description": "Reply to name",
            "type": "string"
          }
        },
        "type": "object"
      },
      "link_params": {
        "description": "Additional query string parameters to add to all links in the template.",
        "example": "utm_campaign=spring_sale&utm_medium=cpc",
        "type": "string"
      },
      "preview": {
        "description": "Copy shown following your subject line in many email clients.",
        "example": "Hurry, 50% Off for 2 Days Only!",
        "type": "string"
      },
      "auto_text": {
        "description": "True to generate the text body automatically from the HTML body.",
        "example": false,
        "type": "boolean"
      },
      "html": {
        "description": "HTML body of the email.",
        "example": "<html><body><p>hello, world.</p></body></html>",
        "type": "string"
      },
      "text": {
        "description": "Text body of the email.",
        "example": "This is the text body.",
        "type": "string"
      },
      "track_opens": {
        "description": "True to enable open tracking (HTML campaigns only).",
        "example": true,
        "type": "boolean"
      },
      "track_clicks": {
        "description": "True to enable click tracking in HTML links.",
        "example": true,
        "type": "boolean"
      },
      "track_text_clicks": {
        "description": "True to enable click tracking in text links.",
        "example": true,
        "type": "boolean"
      },
      "segment_id": {
        "description": "ID of a segment used to filter the lists of contacts the campaign is sent to.",
        "example": "b4326936-9e08-4cf9-95fe-c44c8cf4e4ef",
        "type": "string",
        "format": "uuid"
      },
      "message_type_id": {
        "description": "ID of the message type of the campaign.",
        "example": "b4326936-9e08-4cf9-95fe-c44c8cf4e4ef",
        "type": "string",
        "format": "uuid"
      },
      "list_ids": {
        "description": "An array of list ids to send the campaign to.",
        "example": [
          "b4326936-9e08-4cf9-95fe-c44c8cf4e4ef"
        ],
        "items": {
          "example": "b4326936-9e08-4cf9-95fe-c44c8cf4e4ef",
          "format": "uuid",
          "type": "string"
        },
        "type": "array"
      },
      "excluded_list_ids": {
        "description": "An array of list ids to exclude from the campaign. Any contacts on these lists will not be sent the campaign.",
        "example": [
          "9b480ee4-cddd-4f11-92d2-15f7d0f18f9c"
        ],
        "items": {
          "example": "9b480ee4-cddd-4f11-92d2-15f7d0f18f9c",
          "format": "uuid",
          "type": "string"
        },
        "type": "array"
      },
      "throttling_type": {
        "description": "Set to `none` to send the campaign as fast as possible. Set to `burst` to send the campaign in small batches over time.",
        "example": "burst",
        "type": "string",
        "enum": [
          "none",
          "burst"
        ]
      },
      "throttling_amount": {
        "description": "Number of emails to send in each per batch. Must be a multiple of 1000. Required if `throttling_type` is `burst`.",
        "example": 1000,
        "type": "integer",
        "multipleOf": 1000,
        "minimum": 1000,
        "maximum": 1000000
      },
      "throttling_period": {
        "description": "Time in seconds between sending each batch of emails. Required if `throttling_type` is `burst`.",
        "example": 900,
        "type": "integer",
        "enum": [
          900,
          1800,
          3600,
          7200
        ]
      },
      "suppression_list_id": {
        "description": "ID of a suppression list. Any emails in the suppression list will not be sent the campaign.",
        "example": "b4326936-9e08-4cf9-95fe-c44c8cf4e4ef",
        "type": "string",
        "format": "uuid"
      },
      "status": {
        "description": "Status of the campaign.",
        "example": "draft",
        "type": "string",
        "enum": [
          "draft",
          "pending",
          "in progress",
          "complete",
          "error",
          "paused",
          "archived",
          "active"
        ]
      },
      "started": {
        "type": "integer",
        "description": "Time at which the campaign started sending. Measured in seconds since the UNIX epoch.",
        "example": 1592422402
      },
      "sent": {
        "type": "integer",
        "description": "Time at which the campaign completed sending. Measured in seconds since the UNIX epoch.",
        "example": 1592422500
      },
      "delayed_until": {
        "type": "integer",
        "description": "Time at which the campaign will resume sending. Measured in seconds since the UNIX epoch.",
        "example": 1592422500
      },
      "feed_url": {
        "description": "URL of the RSS feed.",
        "type": "string",
        "format": "url",
        "example": "https://www.example.com/rss.xml"
      },
      "scanned": {
        "type": "integer",
        "description": "Time at which the rss feed was checked for updates. Measured in seconds since the UNIX epoch.",
        "example": 1592422352
      },
      "scheduled_for": {
        "type": "integer",
        "description": "Time at which the rss update campaign was scheduled to be sent. Measured in seconds since the UNIX epoch.",
        "example": 1592422352
      },
      "num_sent": {
        "description": "Number of emails sent.",
        "example": 100,
        "type": "integer"
      },
      "num_rejected": {
        "description": "Number of emails rejected.",
        "example": 10,
        "type": "integer"
      },
      "num_clicks": {
        "description": "Number of unique clicks.",
        "example": 20,
        "type": "integer"
      },
      "num_total_clicks": {
        "description": "Number of total clicks (non-unique).",
        "example": 30,
        "type": "integer"
      },
      "num_opens": {
        "description": "Number of unique opens.",
        "example": 50,
        "type": "integer"
      },
      "num_total_opens": {
        "description": "Number of total opens (non-unique).",
        "example": 60,
        "type": "integer"
      },
      "num_hard_bounces": {
        "description": "Number of emails sent that hard bounced.",
        "example": 4,
        "type": "integer"
      },
      "num_soft_bounces": {
        "description": "Number of emails sent that soft bounced.",
        "example": 8,
        "type": "integer"
      },
      "num_complaints": {
        "description": "Number of emails sent that complained.",
        "example": 2,
        "type": "integer"
      },
      "num_unsubscribes": {
        "description": "Number of emails sent that unsubscribed.",
        "example": 3,
        "type": "integer"
      }
    },
    "TestCampaignExample": {
      "id": "66e60ece-d4e4-4286-8ea6-990cb500aa8e",
      "created": 1568654293,
      "name": "March 2022 Campaign",
      "subject": "The January Newsletter",
      "from": {
        "email": "chris@bigmailer.io",
        "name": "Chris"
      },
      "recipient_name": "*|FIRST_NAME|*",
      "reply_to": {
        "email": "chris@bigmailer.io",
        "name": "Chris"
      },
      "link_params": "utm_campaign=spring_sale&utm_medium=cpc",
      "preview": "Hurry, 50% Off for 2 Days Only!",
      "auto_text": false,
      "html": "<html><body><p>hello, world.</p></body></html>",
      "text": "This is the text body.",
      "track_opens": true,
      "track_clicks": true,
      "track_text_clicks": true,
      "status": "draft",
      "started": 1592422402,
      "sent": 1592422500,
      "recipients": [
        "chris@bigmailer.io",
        "pat@bigmailer.io"
      ],
      "feed_url": "https://www.example.com/rss.xml",
      "num_sent": 2
    },
    "TestCampaignProperties": {
      "id": {
        "description": "ID of the campaign",
        "example": "66e60ece-d4e4-4286-8ea6-990cb500aa8e",
        "format": "uuid",
        "type": "string"
      },
      "created": {
        "description": "Time at which the object was created. Measured in seconds since the UNIX epoch.",
        "example": 1592422352,
        "type": "integer"
      },
      "name": {
        "description": "Name of the campaign",
        "example": "March 2022 Campaign",
        "type": "string"
      },
      "subject": {
        "description": "Subject line for the campaign",
        "example": "The January Newsletter",
        "type": "string"
      },
      "from": {
        "properties": {
          "email": {
            "description": "From email address",
            "type": "string",
            "format": "email"
          },
          "name": {
            "description": "From name",
            "type": "string"
          }
        },
        "type": "object"
      },
      "recipient_name": {
        "description": "Name of the recipient. Use merge tags to make it more personal and avoid spam filters.",
        "example": "*|FIRST_NAME|*",
        "type": "string"
      },
      "reply_to": {
        "properties": {
          "email": {
            "description": "Reply to email address",
            "type": "string",
            "format": "email"
          },
          "name": {
            "description": "Reply to name",
            "type": "string"
          }
        },
        "type": "object"
      },
      "link_params": {
        "description": "Additional query string parameters to add to all links in the template.",
        "example": "utm_campaign=spring_sale&utm_medium=cpc",
        "type": "string"
      },
      "preview": {
        "description": "Copy shown following your subject line in many email clients.",
        "example": "Hurry, 50% Off for 2 Days Only!",
        "type": "string"
      },
      "auto_text": {
        "description": "True to generate the text body automatically from the HTML body.",
        "example": false,
        "type": "boolean"
      },
      "html": {
        "description": "HTML body of the email.",
        "example": "<html><body><p>hello, world.</p></body></html>",
        "type": "string"
      },
      "text": {
        "description": "Text body of the email.",
        "example": "This is the text body.",
        "type": "string"
      },
      "track_opens": {
        "description": "True to enable open tracking (HTML campaigns only).",
        "example": true,
        "type": "boolean"
      },
      "track_clicks": {
        "description": "True to enable click tracking in HTML links.",
        "example": true,
        "type": "boolean"
      },
      "track_text_clicks": {
        "description": "True to enable click tracking in text links.",
        "example": true,
        "type": "boolean"
      },
      "status": {
        "description": "Status of the campaign.",
        "example": "draft",
        "type": "string",
        "enum": [
          "draft",
          "pending",
          "in progress",
          "complete",
          "error",
          "paused",
          "archived",
          "active"
        ]
      },
      "started": {
        "type": "integer",
        "description": "Time at which the campaign started sending. Measured in seconds since the UNIX epoch.",
        "example": 1592422402
      },
      "sent": {
        "type": "integer",
        "description": "Time at which the campaign sent. Measured in seconds since the UNIX epoch.",
        "example": 1592422500
      },
      "recipients": {
        "description": "List of email recipients for the test campaign.",
        "type": "array",
        "minItems": 1,
        "maxItems": 100,
        "items": {
          "type": "string",
          "format": "email",
          "example": "chris@bigmailer.io"
        },
        "example": [
          "chris@bigmailer.io",
          "pat@bigmailer.io"
        ]
      },
      "feed_url": {
        "description": "Optional RSS feed URL used when testing RSS content.",
        "type": "string",
        "format": "url",
        "example": "https://www.example.com/rss.xml"
      },
      "num_sent": {
        "description": "Number of emails sent for the test campaign.",
        "example": 2,
        "type": "integer"
      }
    },
    "TestCampaignListExample": {
      "id": "66e60ece-d4e4-4286-8ea6-990cb500aa8e",
      "created": 1568654293,
      "name": "March 2022 Campaign",
      "subject": "The January Newsletter",
      "from": {
        "email": "chris@bigmailer.io",
        "name": "Chris"
      },
      "recipient_name": "*|FIRST_NAME|*",
      "reply_to": {
        "email": "chris@bigmailer.io",
        "name": "Chris"
      },
      "link_params": "utm_campaign=spring_sale&utm_medium=cpc",
      "preview": "Hurry, 50% Off for 2 Days Only!",
      "auto_text": false,
      "track_opens": true,
      "track_clicks": true,
      "track_text_clicks": true,
      "status": "draft",
      "started": 1592422402,
      "sent": 1592422500,
      "recipients": [
        "chris@bigmailer.io",
        "pat@bigmailer.io"
      ],
      "feed_url": "https://www.example.com/rss.xml",
      "num_sent": 2
    },
    "TestCampaignListProperties": {
      "id": {
        "description": "ID of the campaign",
        "example": "66e60ece-d4e4-4286-8ea6-990cb500aa8e",
        "format": "uuid",
        "type": "string"
      },
      "created": {
        "description": "Time at which the object was created. Measured in seconds since the UNIX epoch.",
        "example": 1592422352,
        "type": "integer"
      },
      "name": {
        "description": "Name of the campaign",
        "example": "March 2022 Campaign",
        "type": "string"
      },
      "subject": {
        "description": "Subject line for the campaign",
        "example": "The January Newsletter",
        "type": "string"
      },
      "from": {
        "properties": {
          "email": {
            "description": "From email address",
            "type": "string",
            "format": "email"
          },
          "name": {
            "description": "From name",
            "type": "string"
          }
        },
        "type": "object"
      },
      "recipient_name": {
        "description": "Name of the recipient. Use merge tags to make it more personal and avoid spam filters.",
        "example": "*|FIRST_NAME|*",
        "type": "string"
      },
      "reply_to": {
        "properties": {
          "email": {
            "description": "Reply to email address",
            "type": "string",
            "format": "email"
          },
          "name": {
            "description": "Reply to name",
            "type": "string"
          }
        },
        "type": "object"
      },
      "link_params": {
        "description": "Additional query string parameters to add to all links in the template.",
        "example": "utm_campaign=spring_sale&utm_medium=cpc",
        "type": "string"
      },
      "preview": {
        "description": "Copy shown following your subject line in many email clients.",
        "example": "Hurry, 50% Off for 2 Days Only!",
        "type": "string"
      },
      "auto_text": {
        "description": "True to generate the text body automatically from the HTML body.",
        "example": false,
        "type": "boolean"
      },
      "track_opens": {
        "description": "True to enable open tracking (HTML campaigns only).",
        "example": true,
        "type": "boolean"
      },
      "track_clicks": {
        "description": "True to enable click tracking in HTML links.",
        "example": true,
        "type": "boolean"
      },
      "track_text_clicks": {
        "description": "True to enable click tracking in text links.",
        "example": true,
        "type": "boolean"
      },
      "status": {
        "description": "Status of the campaign.",
        "example": "draft",
        "type": "string",
        "enum": [
          "draft",
          "pending",
          "in progress",
          "complete",
          "error",
          "paused",
          "archived",
          "active"
        ]
      },
      "started": {
        "type": "integer",
        "description": "Time at which the campaign started sending. Measured in seconds since the UNIX epoch.",
        "example": 1592422402
      },
      "sent": {
        "type": "integer",
        "description": "Time at which the campaign sent. Measured in seconds since the UNIX epoch.",
        "example": 1592422500
      },
      "recipients": {
        "description": "List of email recipients for the test campaign.",
        "type": "array",
        "minItems": 1,
        "maxItems": 100,
        "items": {
          "type": "string",
          "format": "email",
          "example": "chris@bigmailer.io"
        },
        "example": [
          "chris@bigmailer.io",
          "pat@bigmailer.io"
        ]
      },
      "feed_url": {
        "description": "Optional RSS feed URL used when testing RSS content.",
        "type": "string",
        "format": "url",
        "example": "https://www.example.com/rss.xml"
      },
      "num_sent": {
        "description": "Number of emails sent for the test campaign.",
        "example": 2,
        "type": "integer"
      }
    },
    "CreateTestCampaignExample": {
      "name": "March 2022 Campaign",
      "subject": "The January Newsletter",
      "from": {
        "email": "chris@bigmailer.io",
        "name": "Chris"
      },
      "recipient_name": "*|FIRST_NAME|*",
      "reply_to": {
        "email": "chris@bigmailer.io",
        "name": "Chris"
      },
      "link_params": "utm_campaign=spring_sale&utm_medium=cpc",
      "preview": "Hurry, 50% Off for 2 Days Only!",
      "auto_text": false,
      "html": "<html><body><p>hello, world.</p></body></html>",
      "text": "This is the text body.",
      "track_opens": true,
      "track_clicks": true,
      "track_text_clicks": true,
      "recipients": [
        "chris@bigmailer.io",
        "pat@bigmailer.io"
      ],
      "feed_url": "https://www.example.com/rss.xml"
    },
    "CreateTestCampaignProperties": {
      "name": {
        "description": "Name of the campaign",
        "example": "March 2022 Campaign",
        "type": "string"
      },
      "subject": {
        "description": "Subject line for the campaign",
        "example": "The January Newsletter",
        "type": "string"
      },
      "from": {
        "properties": {
          "email": {
            "description": "From email address",
            "type": "string",
            "format": "email"
          },
          "name": {
            "description": "From name",
            "type": "string"
          }
        },
        "type": "object"
      },
      "recipient_name": {
        "description": "Name of the recipient. Use merge tags to make it more personal and avoid spam filters.",
        "example": "*|FIRST_NAME|*",
        "type": "string"
      },
      "reply_to": {
        "properties": {
          "email": {
            "description": "Reply to email address",
            "type": "string",
            "format": "email"
          },
          "name": {
            "description": "Reply to name",
            "type": "string"
          }
        },
        "type": "object"
      },
      "link_params": {
        "description": "Additional query string parameters to add to all links in the template.",
        "example": "utm_campaign=spring_sale&utm_medium=cpc",
        "type": "string"
      },
      "preview": {
        "description": "Copy shown following your subject line in many email clients.",
        "example": "Hurry, 50% Off for 2 Days Only!",
        "type": "string"
      },
      "auto_text": {
        "description": "True to generate the text body automatically from the HTML body.",
        "example": false,
        "type": "boolean"
      },
      "html": {
        "description": "HTML body of the email.",
        "example": "<html><body><p>hello, world.</p></body></html>",
        "type": "string"
      },
      "text": {
        "description": "Text body of the email.",
        "example": "This is the text body.",
        "type": "string"
      },
      "track_opens": {
        "description": "True to enable open tracking (HTML campaigns only).",
        "example": true,
        "type": "boolean"
      },
      "track_clicks": {
        "description": "True to enable click tracking in HTML links.",
        "example": true,
        "type": "boolean"
      },
      "track_text_clicks": {
        "description": "True to enable click tracking in text links.",
        "example": true,
        "type": "boolean"
      },
      "recipients": {
        "description": "List of email recipients for the test campaign.",
        "type": "array",
        "minItems": 1,
        "maxItems": 100,
        "items": {
          "type": "string",
          "format": "email",
          "example": "chris@bigmailer.io"
        },
        "example": [
          "chris@bigmailer.io",
          "pat@bigmailer.io"
        ]
      },
      "feed_url": {
        "description": "Optional RSS feed URL used when testing RSS content.",
        "type": "string",
        "format": "url",
        "example": "https://www.example.com/rss.xml"
      }
    },
    "TransactionalCampaignExample": {
      "id": "66e60ece-d4e4-4286-8ea6-990cb500aa8e",
      "created": 1568654293,
      "name": "March 2022 Campaign",
      "subject": "The January Newsletter",
      "from": {
        "email": "chris@bigmailer.io",
        "name": "Chris"
      },
      "recipient_name": "*|FIRST_NAME|*",
      "reply_to": {
        "email": "chris@bigmailer.io",
        "name": "Chris"
      },
      "link_params": "utm_campaign=spring_sale&utm_medium=cpc",
      "preview": "Hurry, 50% Off for 2 Days Only!",
      "auto_text": false,
      "html": "<html><body><p>hello, world.</p></body></html>",
      "text": "This is the text body.",
      "track_opens": true,
      "track_clicks": true,
      "track_text_clicks": true,
      "message_type_id": "b4326936-9e08-4cf9-95fe-c44c8cf4e4ef",
      "list_id": "b4326936-9e08-4cf9-95fe-c44c8cf4e4ef",
      "num_sent": 100,
      "num_rejected": 10,
      "num_clicks": 20,
      "num_total_clicks": 30,
      "num_opens": 50,
      "num_total_opens": 60,
      "num_hard_bounces": 4,
      "num_soft_bounces": 8,
      "num_complaints": 2,
      "num_unsubscribes": 3,
      "status": "draft"
    },
    "TransactionalCampaignProperties": {
      "id": {
        "description": "ID of the campaign",
        "example": "66e60ece-d4e4-4286-8ea6-990cb500aa8e",
        "format": "uuid",
        "type": "string"
      },
      "created": {
        "description": "Time at which the object was created. Measured in seconds since the UNIX epoch.",
        "example": 1592422352,
        "type": "integer"
      },
      "name": {
        "description": "Name of the campaign",
        "example": "March 2022 Campaign",
        "type": "string"
      },
      "subject": {
        "description": "Subject line for the campaign",
        "example": "The January Newsletter",
        "type": "string"
      },
      "from": {
        "properties": {
          "email": {
            "description": "From email address",
            "type": "string",
            "format": "email"
          },
          "name": {
            "description": "From name",
            "type": "string"
          }
        },
        "type": "object"
      },
      "recipient_name": {
        "description": "Name of the recipient. Use merge tags to make it more personal and avoid spam filters.",
        "example": "*|FIRST_NAME|*",
        "type": "string"
      },
      "reply_to": {
        "properties": {
          "email": {
            "description": "Reply to email address",
            "type": "string",
            "format": "email"
          },
          "name": {
            "description": "Reply to name",
            "type": "string"
          }
        },
        "type": "object"
      },
      "link_params": {
        "description": "Additional query string parameters to add to all links in the template.",
        "example": "utm_campaign=spring_sale&utm_medium=cpc",
        "type": "string"
      },
      "preview": {
        "description": "Copy shown following your subject line in many email clients.",
        "example": "Hurry, 50% Off for 2 Days Only!",
        "type": "string"
      },
      "auto_text": {
        "description": "True to generate the text body automatically from the HTML body.",
        "example": false,
        "type": "boolean"
      },
      "html": {
        "description": "HTML body of the email.",
        "example": "<html><body><p>hello, world.</p></body></html>",
        "type": "string"
      },
      "text": {
        "description": "Text body of the email.",
        "example": "This is the text body.",
        "type": "string"
      },
      "track_opens": {
        "description": "True to enable open tracking (HTML campaigns only).",
        "example": true,
        "type": "boolean"
      },
      "track_clicks": {
        "description": "True to enable click tracking in HTML links.",
        "example": true,
        "type": "boolean"
      },
      "track_text_clicks": {
        "description": "True to enable click tracking in text links.",
        "example": true,
        "type": "boolean"
      },
      "message_type_id": {
        "description": "ID of the message type of the campaign.",
        "example": "b4326936-9e08-4cf9-95fe-c44c8cf4e4ef",
        "type": "string",
        "format": "uuid"
      },
      "list_id": {
        "description": "ID of a list contacts sent the transactional campaign should be added to.",
        "example": "b4326936-9e08-4cf9-95fe-c44c8cf4e4ef",
        "type": "string",
        "format": "uuid"
      },
      "num_sent": {
        "description": "Number of emails sent.",
        "example": 100,
        "type": "integer"
      },
      "num_rejected": {
        "description": "Number of emails rejected.",
        "example": 10,
        "type": "integer"
      },
      "num_clicks": {
        "description": "Number of unique clicks.",
        "example": 20,
        "type": "integer"
      },
      "num_total_clicks": {
        "description": "Number of total clicks (non-unique).",
        "example": 30,
        "type": "integer"
      },
      "num_opens": {
        "description": "Number of unique opens.",
        "example": 50,
        "type": "integer"
      },
      "num_total_opens": {
        "description": "Number of total opens (non-unique).",
        "example": 60,
        "type": "integer"
      },
      "num_hard_bounces": {
        "description": "Number of emails sent that hard bounced.",
        "example": 4,
        "type": "integer"
      },
      "num_soft_bounces": {
        "description": "Number of emails sent that soft bounced.",
        "example": 8,
        "type": "integer"
      },
      "num_complaints": {
        "description": "Number of emails sent that complained.",
        "example": 2,
        "type": "integer"
      },
      "num_unsubscribes": {
        "description": "Number of emails sent that unsubscribed.",
        "example": 3,
        "type": "integer"
      },
      "status": {
        "description": "Status of the campaign.",
        "example": "draft",
        "type": "string",
        "enum": [
          "draft",
          "pending",
          "in progress",
          "complete",
          "error",
          "paused",
          "archived",
          "active"
        ]
      }
    },
    "TransactionalCampaignListExample": {
      "id": "66e60ece-d4e4-4286-8ea6-990cb500aa8e",
      "created": 1568654293,
      "name": "March 2022 Campaign",
      "subject": "The January Newsletter",
      "from": {
        "email": "chris@bigmailer.io",
        "name": "Chris"
      },
      "recipient_name": "*|FIRST_NAME|*",
      "reply_to": {
        "email": "chris@bigmailer.io",
        "name": "Chris"
      },
      "link_params": "utm_campaign=spring_sale&utm_medium=cpc",
      "preview": "Hurry, 50% Off for 2 Days Only!",
      "auto_text": false,
      "track_opens": true,
      "track_clicks": true,
      "track_text_clicks": true,
      "message_type_id": "b4326936-9e08-4cf9-95fe-c44c8cf4e4ef",
      "list_id": "b4326936-9e08-4cf9-95fe-c44c8cf4e4ef",
      "num_sent": 100,
      "num_rejected": 10,
      "num_clicks": 20,
      "num_total_clicks": 30,
      "num_opens": 50,
      "num_total_opens": 60,
      "num_hard_bounces": 4,
      "num_soft_bounces": 8,
      "num_complaints": 2,
      "num_unsubscribes": 3,
      "status": "draft"
    },
    "TransactionalCampaignListProperties": {
      "id": {
        "description": "ID of the campaign",
        "example": "66e60ece-d4e4-4286-8ea6-990cb500aa8e",
        "format": "uuid",
        "type": "string"
      },
      "created": {
        "description": "Time at which the object was created. Measured in seconds since the UNIX epoch.",
        "example": 1592422352,
        "type": "integer"
      },
      "name": {
        "description": "Name of the campaign",
        "example": "March 2022 Campaign",
        "type": "string"
      },
      "subject": {
        "description": "Subject line for the campaign",
        "example": "The January Newsletter",
        "type": "string"
      },
      "from": {
        "properties": {
          "email": {
            "description": "From email address",
            "type": "string",
            "format": "email"
          },
          "name": {
            "description": "From name",
            "type": "string"
          }
        },
        "type": "object"
      },
      "recipient_name": {
        "description": "Name of the recipient. Use merge tags to make it more personal and avoid spam filters.",
        "example": "*|FIRST_NAME|*",
        "type": "string"
      },
      "reply_to": {
        "properties": {
          "email": {
            "description": "Reply to email address",
            "type": "string",
            "format": "email"
          },
          "name": {
            "description": "Reply to name",
            "type": "string"
          }
        },
        "type": "object"
      },
      "link_params": {
        "description": "Additional query string parameters to add to all links in the template.",
        "example": "utm_campaign=spring_sale&utm_medium=cpc",
        "type": "string"
      },
      "preview": {
        "description": "Copy shown following your subject line in many email clients.",
        "example": "Hurry, 50% Off for 2 Days Only!",
        "type": "string"
      },
      "auto_text": {
        "description": "True to generate the text body automatically from the HTML body.",
        "example": false,
        "type": "boolean"
      },
      "track_opens": {
        "description": "True to enable open tracking (HTML campaigns only).",
        "example": true,
        "type": "boolean"
      },
      "track_clicks": {
        "description": "True to enable click tracking in HTML links.",
        "example": true,
        "type": "boolean"
      },
      "track_text_clicks": {
        "description": "True to enable click tracking in text links.",
        "example": true,
        "type": "boolean"
      },
      "message_type_id": {
        "description": "ID of the message type of the campaign.",
        "example": "b4326936-9e08-4cf9-95fe-c44c8cf4e4ef",
        "type": "string",
        "format": "uuid"
      },
      "list_id": {
        "description": "ID of a list contacts sent the transactional campaign should be added to.",
        "example": "b4326936-9e08-4cf9-95fe-c44c8cf4e4ef",
        "type": "string",
        "format": "uuid"
      },
      "num_sent": {
        "description": "Number of emails sent.",
        "example": 100,
        "type": "integer"
      },
      "num_rejected": {
        "description": "Number of emails rejected.",
        "example": 10,
        "type": "integer"
      },
      "num_clicks": {
        "description": "Number of unique clicks.",
        "example": 20,
        "type": "integer"
      },
      "num_total_clicks": {
        "description": "Number of total clicks (non-unique).",
        "example": 30,
        "type": "integer"
      },
      "num_opens": {
        "description": "Number of unique opens.",
        "example": 50,
        "type": "integer"
      },
      "num_total_opens": {
        "description": "Number of total opens (non-unique).",
        "example": 60,
        "type": "integer"
      },
      "num_hard_bounces": {
        "description": "Number of emails sent that hard bounced.",
        "example": 4,
        "type": "integer"
      },
      "num_soft_bounces": {
        "description": "Number of emails sent that soft bounced.",
        "example": 8,
        "type": "integer"
      },
      "num_complaints": {
        "description": "Number of emails sent that complained.",
        "example": 2,
        "type": "integer"
      },
      "num_unsubscribes": {
        "description": "Number of emails sent that unsubscribed.",
        "example": 3,
        "type": "integer"
      },
      "status": {
        "description": "Status of the campaign.",
        "example": "draft",
        "type": "string",
        "enum": [
          "draft",
          "pending",
          "in progress",
          "complete",
          "error",
          "paused",
          "archived",
          "active"
        ]
      }
    },
    "CreateUpdateTransactionalCampaignExample": {
      "name": "March 2022 Campaign",
      "subject": "The January Newsletter",
      "from": {
        "email": "chris@bigmailer.io",
        "name": "Chris"
      },
      "recipient_name": "*|FIRST_NAME|*",
      "reply_to": {
        "email": "chris@bigmailer.io",
        "name": "Chris"
      },
      "link_params": "utm_campaign=spring_sale&utm_medium=cpc",
      "preview": "Hurry, 50% Off for 2 Days Only!",
      "auto_text": false,
      "html": "<html><body><p>hello, world.</p></body></html>",
      "text": "This is the text body.",
      "template_id": "b4326936-9e08-4cf9-95fe-c44c8cf4e4ef",
      "track_opens": true,
      "track_clicks": true,
      "track_text_clicks": true,
      "message_type_id": "b4326936-9e08-4cf9-95fe-c44c8cf4e4ef",
      "list_id": "b4326936-9e08-4cf9-95fe-c44c8cf4e4ef",
      "ready": true
    },
    "CreateUpdateTransactionalCampaignProperties": {
      "name": {
        "description": "Name of the campaign",
        "example": "March 2022 Campaign",
        "type": "string"
      },
      "subject": {
        "description": "Subject line for the campaign",
        "example": "The January Newsletter",
        "type": "string"
      },
      "from": {
        "properties": {
          "email": {
            "description": "From email address",
            "type": "string",
            "format": "email"
          },
          "name": {
            "description": "From name",
            "type": "string"
          }
        },
        "type": "object"
      },
      "recipient_name": {
        "description": "Name of the recipient. Use merge tags to make it more personal and avoid spam filters.",
        "example": "*|FIRST_NAME|*",
        "type": "string"
      },
      "reply_to": {
        "properties": {
          "email": {
            "description": "Reply to email address",
            "type": "string",
            "format": "email"
          },
          "name": {
            "description": "Reply to name",
            "type": "string"
          }
        },
        "type": "object"
      },
      "link_params": {
        "description": "Additional query string parameters to add to all links in the template.",
        "example": "utm_campaign=spring_sale&utm_medium=cpc",
        "type": "string"
      },
      "preview": {
        "description": "Copy shown following your subject line in many email clients.",
        "example": "Hurry, 50% Off for 2 Days Only!",
        "type": "string"
      },
      "auto_text": {
        "description": "True to generate the text body automatically from the HTML body.",
        "example": false,
        "type": "boolean"
      },
      "html": {
        "description": "HTML body of the email.",
        "example": "<html><body><p>hello, world.</p></body></html>",
        "type": "string"
      },
      "text": {
        "description": "Text body of the email.",
        "example": "This is the text body.",
        "type": "string"
      },
      "template_id": {
        "description": "A template id to use to populate the HTML body of the email.",
        "format": "uuid",
        "type": "string"
      },
      "track_opens": {
        "description": "True to enable open tracking (HTML campaigns only).",
        "example": true,
        "type": "boolean"
      },
      "track_clicks": {
        "description": "True to enable click tracking in HTML links.",
        "example": true,
        "type": "boolean"
      },
      "track_text_clicks": {
        "description": "True to enable click tracking in text links.",
        "example": true,
        "type": "boolean"
      },
      "message_type_id": {
        "description": "ID of the message type of the campaign.",
        "example": "b4326936-9e08-4cf9-95fe-c44c8cf4e4ef",
        "type": "string",
        "format": "uuid"
      },
      "list_id": {
        "description": "ID of a list contacts sent the transactional campaign should be added to.",
        "example": "b4326936-9e08-4cf9-95fe-c44c8cf4e4ef",
        "type": "string",
        "format": "uuid"
      },
      "ready": {
        "description": "Set to true to activate the campaign. The campaign cannot be sent until activated by setting ready to true.",
        "example": true,
        "type": "boolean"
      }
    },
    "UserExample": {
      "id": "66e60ece-d4e4-4286-8ea6-990cb500aa8e",
      "role": "brand_manager",
      "email": "chris@bigmailer.io",
      "is_owner": true,
      "is_activated": true,
      "allowed_brands": [
        "b4326936-9e08-4cf9-95fe-c44c8cf4e4ef"
      ],
      "activated": 1568654394,
      "created": 1568654293
    },
    "UserProperties": {
      "id": {
        "description": "ID of the user",
        "example": "66e60ece-d4e4-4286-8ea6-990cb500aa8e",
        "format": "uuid",
        "type": "string"
      },
      "role": {
        "description": "The user role determines what actions the user may perform. See our [description of user roles](https://docs.bigmailer.io/docs/user-types-and-permissions).",
        "example": "brand_manager",
        "type": "string",
        "enum": [
          "admin",
          "account_manager",
          "brand_manager",
          "campaign_manager",
          "campaign_viewer",
          "template_manager"
        ]
      },
      "email": {
        "description": "User's email address",
        "example": "chris@bigmailer.io",
        "type": "string",
        "format": "email"
      },
      "is_owner": {
        "description": "true if the user is the account owner. An account owner cannot be deleted.",
        "example": true,
        "type": "boolean"
      },
      "is_activated": {
        "description": "true if the user is activated. A user becomes activated by clicking the link in the invitation email.",
        "example": true,
        "type": "boolean"
      },
      "allowed_brands": {
        "description": "A list of brand IDs the user is allowed to access. Only relevant if the role is brand_manager, campaign_manager, campaign_viewer, or template_manager.",
        "example": [
          "b4326936-9e08-4cf9-95fe-c44c8cf4e4ef"
        ],
        "items": {
          "example": "b4326936-9e08-4cf9-95fe-c44c8cf4e4ef",
          "format": "uuid",
          "type": "string"
        },
        "type": "array"
      },
      "activated": {
        "description": "Time at which the user was activated. Measured in seconds since the UNIX epoch.",
        "example": 1592422352,
        "type": "integer"
      },
      "created": {
        "description": "Time at which the object was created. Measured in seconds since the UNIX epoch.",
        "example": 1592422352,
        "type": "integer"
      }
    },
    "CreateUpdateUserExample": {
      "role": "brand_manager",
      "email": "chris@bigmailer.io",
      "allowed_brands": [
        "b4326936-9e08-4cf9-95fe-c44c8cf4e4ef"
      ]
    },
    "CreateUpdateUserProperties": {
      "role": {
        "description": "The user role determines what actions the user may perform. See our [description of user roles](https://docs.bigmailer.io/docs/user-types-and-permissions).",
        "example": "brand_manager",
        "type": "string",
        "enum": [
          "admin",
          "account_manager",
          "brand_manager",
          "campaign_manager",
          "campaign_viewer",
          "template_manager"
        ]
      },
      "email": {
        "description": "User's email address",
        "example": "chris@bigmailer.io",
        "type": "string",
        "format": "email"
      },
      "allowed_brands": {
        "description": "A list of brand IDs the user is allowed to access. Only relevant if the role is brand_manager, campaign_manager, campaign_viewer, or template_manager.",
        "example": [
          "b4326936-9e08-4cf9-95fe-c44c8cf4e4ef"
        ],
        "items": {
          "example": "b4326936-9e08-4cf9-95fe-c44c8cf4e4ef",
          "format": "uuid",
          "type": "string"
        },
        "type": "array"
      }
    },
    "Operation": {
      "security": [
        {
          "APIKey": []
        }
      ]
    },
    "BrandsOperation": {
      "security": [
        {
          "APIKey": []
        }
      ],
      "tags": [
        "Brands"
      ]
    },
    "ConnectionsOperation": {
      "security": [
        {
          "APIKey": []
        }
      ],
      "tags": [
        "Connections"
      ]
    },
    "ContactsOperation": {
      "security": [
        {
          "APIKey": []
        }
      ],
      "tags": [
        "Contacts"
      ]
    },
    "ListsOperation": {
      "security": [
        {
          "APIKey": []
        }
      ],
      "tags": [
        "Lists"
      ]
    },
    "TemplatesOperation": {
      "security": [
        {
          "APIKey": []
        }
      ],
      "tags": [
        "Templates"
      ]
    },
    "FieldsOperation": {
      "security": [
        {
          "APIKey": []
        }
      ],
      "tags": [
        "Fields"
      ]
    },
    "SendersOperation": {
      "security": [
        {
          "APIKey": []
        }
      ],
      "tags": [
        "Senders"
      ]
    },
    "BrandPropertiesOperation": {
      "security": [
        {
          "APIKey": []
        }
      ],
      "tags": [
        "Brand Properties"
      ]
    },
    "MessageTypesOperation": {
      "security": [
        {
          "APIKey": []
        }
      ],
      "tags": [
        "Message Types"
      ]
    },
    "SegmentsOperation": {
      "security": [
        {
          "APIKey": []
        }
      ],
      "tags": [
        "Segments"
      ]
    },
    "SuppressionListsOperation": {
      "security": [
        {
          "APIKey": []
        }
      ],
      "tags": [
        "Campaign Suppression Lists"
      ]
    },
    "TransactionalCampaignsOperation": {
      "security": [
        {
          "APIKey": []
        }
      ],
      "tags": [
        "Transactional Campaigns"
      ]
    },
    "BulkCampaignsOperation": {
      "security": [
        {
          "APIKey": []
        }
      ],
      "tags": [
        "Bulk Campaigns"
      ]
    },
    "RssCampaignsOperation": {
      "security": [
        {
          "APIKey": []
        }
      ],
      "tags": [
        "RSS Campaigns"
      ]
    },
    "TestCampaignsOperation": {
      "security": [
        {
          "APIKey": []
        }
      ],
      "tags": [
        "Test Campaigns"
      ]
    },
    "UsersOperation": {
      "security": [
        {
          "APIKey": []
        }
      ],
      "tags": [
        "Users"
      ]
    },
    "InvalidRequestError": {
      "description": "The request was invalid.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/InvalidRequestError"
          }
        }
      }
    },
    "UnauthorizedError": {
      "description": "The API key does not exist.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/UnauthorizedError"
          }
        }
      }
    },
    "ForbiddenError": {
      "description": "The system understands the request but refuses to authorize it.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/ForbiddenError"
          }
        }
      }
    },
    "PayloadTooLargeError": {
      "description": "The request payload is too large.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/PayloadTooLargeError"
          }
        }
      }
    },
    "TooManyRequestsError": {
      "description": "The client has made too many requests.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/TooManyRequestsError"
          }
        }
      }
    },
    "ServerError": {
      "description": "An unexpected error occurred.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/ServerError"
          }
        }
      }
    },
    "BadGatewayError": {
      "description": "The system is under heavy load or is down temporarily.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/ServerError"
          }
        }
      }
    },
    "UnderMaintenanceError": {
      "description": "The system is under maintenance. Please try again later.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/UnderMaintenanceError"
          }
        }
      }
    },
    "GatewayTimeoutError": {
      "description": "The system timed out processing your request.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/ServerError"
          }
        }
      }
    },
    "StandardErrorResponses": {
      "400": {
        "description": "The request was invalid.",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/InvalidRequestError"
            }
          }
        }
      },
      "401": {
        "description": "The API key does not exist.",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/UnauthorizedError"
            }
          }
        }
      },
      "403": {
        "description": "The system understands the request but refuses to authorize it.",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/ForbiddenError"
            }
          }
        }
      },
      "413": {
        "description": "The request payload is too large.",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/PayloadTooLargeError"
            }
          }
        }
      },
      "429": {
        "description": "The client has made too many requests.",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/TooManyRequestsError"
            }
          }
        }
      },
      "500": {
        "description": "An unexpected error occurred.",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/ServerError"
            }
          }
        }
      },
      "502": {
        "description": "The system is under heavy load or is down temporarily.",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/ServerError"
            }
          }
        }
      },
      "503": {
        "description": "The system is under maintenance. Please try again later.",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/UnderMaintenanceError"
            }
          }
        }
      },
      "504": {
        "description": "The system timed out processing your request.",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/ServerError"
            }
          }
        }
      }
    }
  },
  "paths": {
    "/v1/brands/{brand_id}/transactional-campaigns/{campaign_id}": {
      "get": {
        "security": [
          {
            "APIKey": []
          }
        ],
        "tags": [
          "Transactional Campaigns"
        ],
        "summary": "Get transactional campaign",
        "description": "Get a transactional campaign.",
        "operationId": "getTransactionalCampaign",
        "parameters": [
          {
            "in": "path",
            "name": "brand_id",
            "required": true,
            "schema": {
              "type": "string",
              "format": "uuid"
            },
            "description": "ID of the brand"
          },
          {
            "in": "path",
            "name": "campaign_id",
            "required": true,
            "schema": {
              "type": "string",
              "format": "uuid"
            },
            "description": "ID of the campaign"
          }
        ],
        "responses": {
          "200": {
            "description": "Retrieval was successful",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/GetTransactionalCampaignResult"
                }
              }
            }
          },
          "400": {
            "description": "Invalid request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/InvalidRequestError"
                }
              }
            }
          },
          "401": {
            "description": "The API key does not exist.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/UnauthorizedError"
                }
              }
            }
          },
          "403": {
            "description": "The system understands the request but refuses to authorize it.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ForbiddenError"
                }
              }
            }
          },
          "404": {
            "description": "Campaign does not exist",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ResourceMissingError"
                }
              }
            }
          },
          "413": {
            "description": "The request payload is too large.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PayloadTooLargeError"
                }
              }
            }
          },
          "429": {
            "description": "The client has made too many requests.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/TooManyRequestsError"
                }
              }
            }
          },
          "500": {
            "description": "An unexpected error occurred.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ServerError"
                }
              }
            }
          },
          "502": {
            "description": "The system is under heavy load or is down temporarily.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ServerError"
                }
              }
            }
          },
          "503": {
            "description": "The system is under maintenance. Please try again later.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/UnderMaintenanceError"
                }
              }
            }
          },
          "504": {
            "description": "The system timed out processing your request.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ServerError"
                }
              }
            }
          }
        }
      }
    }
  },
  "x-api-id": "bigmailer-api-v1",
  "servers": [
    {
      "url": "https://api.bigmailer.io"
    }
  ],
  "info": {
    "contact": {
      "email": "chris@bigmailer.io",
      "name": "Christopher Utz"
    },
    "description": "An API to interact with the BigMailer platform.",
    "title": "BigMailer API",
    "version": "1.0.0"
  },
  "components": {
    "securitySchemes": {
      "APIKey": {
        "description": "API Key",
        "in": "header",
        "name": "X-API-Key",
        "type": "apiKey"
      }
    },
    "schemas": {
      "GetTransactionalCampaignResult": {
        "title": "GetTransactionalCampaignResult",
        "description": "Result of getting a transactional campaign",
        "example": {
          "id": "66e60ece-d4e4-4286-8ea6-990cb500aa8e",
          "created": 1568654293,
          "name": "March 2022 Campaign",
          "subject": "The January Newsletter",
          "from": {
            "email": "chris@bigmailer.io",
            "name": "Chris"
          },
          "recipient_name": "*|FIRST_NAME|*",
          "reply_to": {
            "email": "chris@bigmailer.io",
            "name": "Chris"
          },
          "link_params": "utm_campaign=spring_sale&utm_medium=cpc",
          "preview": "Hurry, 50% Off for 2 Days Only!",
          "auto_text": false,
          "html": "<html><body><p>hello, world.</p></body></html>",
          "text": "This is the text body.",
          "track_opens": true,
          "track_clicks": true,
          "track_text_clicks": true,
          "message_type_id": "b4326936-9e08-4cf9-95fe-c44c8cf4e4ef",
          "list_id": "b4326936-9e08-4cf9-95fe-c44c8cf4e4ef",
          "num_sent": 100,
          "num_rejected": 10,
          "num_clicks": 20,
          "num_total_clicks": 30,
          "num_opens": 50,
          "num_total_opens": 60,
          "num_hard_bounces": 4,
          "num_soft_bounces": 8,
          "num_complaints": 2,
          "num_unsubscribes": 3,
          "status": "draft"
        },
        "properties": {
          "id": {
            "description": "ID of the campaign",
            "example": "66e60ece-d4e4-4286-8ea6-990cb500aa8e",
            "format": "uuid",
            "type": "string"
          },
          "created": {
            "description": "Time at which the object was created. Measured in seconds since the UNIX epoch.",
            "example": 1592422352,
            "type": "integer"
          },
          "name": {
            "description": "Name of the campaign",
            "example": "March 2022 Campaign",
            "type": "string"
          },
          "subject": {
            "description": "Subject line for the campaign",
            "example": "The January Newsletter",
            "type": "string"
          },
          "from": {
            "properties": {
              "email": {
                "description": "From email address",
                "type": "string",
                "format": "email"
              },
              "name": {
                "description": "From name",
                "type": "string"
              }
            },
            "type": "object"
          },
          "recipient_name": {
            "description": "Name of the recipient. Use merge tags to make it more personal and avoid spam filters.",
            "example": "*|FIRST_NAME|*",
            "type": "string"
          },
          "reply_to": {
            "properties": {
              "email": {
                "description": "Reply to email address",
                "type": "string",
                "format": "email"
              },
              "name": {
                "description": "Reply to name",
                "type": "string"
              }
            },
            "type": "object"
          },
          "link_params": {
            "description": "Additional query string parameters to add to all links in the template.",
            "example": "utm_campaign=spring_sale&utm_medium=cpc",
            "type": "string"
          },
          "preview": {
            "description": "Copy shown following your subject line in many email clients.",
            "example": "Hurry, 50% Off for 2 Days Only!",
            "type": "string"
          },
          "auto_text": {
            "description": "True to generate the text body automatically from the HTML body.",
            "example": false,
            "type": "boolean"
          },
          "html": {
            "description": "HTML body of the email.",
            "example": "<html><body><p>hello, world.</p></body></html>",
            "type": "string"
          },
          "text": {
            "description": "Text body of the email.",
            "example": "This is the text body.",
            "type": "string"
          },
          "track_opens": {
            "description": "True to enable open tracking (HTML campaigns only).",
            "example": true,
            "type": "boolean"
          },
          "track_clicks": {
            "description": "True to enable click tracking in HTML links.",
            "example": true,
            "type": "boolean"
          },
          "track_text_clicks": {
            "description": "True to enable click tracking in text links.",
            "example": true,
            "type": "boolean"
          },
          "message_type_id": {
            "description": "ID of the message type of the campaign.",
            "example": "b4326936-9e08-4cf9-95fe-c44c8cf4e4ef",
            "type": "string",
            "format": "uuid"
          },
          "list_id": {
            "description": "ID of a list contacts sent the transactional campaign should be added to.",
            "example": "b4326936-9e08-4cf9-95fe-c44c8cf4e4ef",
            "type": "string",
            "format": "uuid"
          },
          "num_sent": {
            "description": "Number of emails sent.",
            "example": 100,
            "type": "integer"
          },
          "num_rejected": {
            "description": "Number of emails rejected.",
            "example": 10,
            "type": "integer"
          },
          "num_clicks": {
            "description": "Number of unique clicks.",
            "example": 20,
            "type": "integer"
          },
          "num_total_clicks": {
            "description": "Number of total clicks (non-unique).",
            "example": 30,
            "type": "integer"
          },
          "num_opens": {
            "description": "Number of unique opens.",
            "example": 50,
            "type": "integer"
          },
          "num_total_opens": {
            "description": "Number of total opens (non-unique).",
            "example": 60,
            "type": "integer"
          },
          "num_hard_bounces": {
            "description": "Number of emails sent that hard bounced.",
            "example": 4,
            "type": "integer"
          },
          "num_soft_bounces": {
            "description": "Number of emails sent that soft bounced.",
            "example": 8,
            "type": "integer"
          },
          "num_complaints": {
            "description": "Number of emails sent that complained.",
            "example": 2,
            "type": "integer"
          },
          "num_unsubscribes": {
            "description": "Number of emails sent that unsubscribed.",
            "example": 3,
            "type": "integer"
          },
          "status": {
            "description": "Status of the campaign.",
            "example": "draft",
            "type": "string",
            "enum": [
              "draft",
              "pending",
              "in progress",
              "complete",
              "error",
              "paused",
              "archived",
              "active"
            ]
          }
        },
        "type": "object"
      },
      "InvalidRequestError": {
        "title": "InvalidRequestError",
        "description": "Object containing error information.",
        "example": {
          "type": "invalid_request_error",
          "message": "Email address is invalid.",
          "param": "email",
          "code": "invalid_format"
        },
        "properties": {
          "type": {
            "description": "The type of error returned.",
            "example": "invalid_request_error",
            "type": "string"
          },
          "message": {
            "description": "A human-readable message providing more details about the error.",
            "example": "Email address is invalid.",
            "type": "string"
          },
          "param": {
            "description": "If the error is parameter-specific, the parameter related to the error. For example, you can use this to display a message near the correct form field.",
            "example": "email",
            "type": "string"
          },
          "code": {
            "description": "For some errors that could be handled programmatically, a short string indicating the error code reported.",
            "example": "invalid_format",
            "type": "string"
          }
        },
        "type": "object"
      },
      "PayloadTooLargeError": {
        "title": "Payload Too Large Error",
        "description": "The request payload is too large.",
        "example": {
          "type": "invalid_request_error",
          "message": "Form data payload is too large.",
          "code": "payload_too_large"
        },
        "properties": {
          "type": {
            "description": "The type of error returned.",
            "example": "invalid_request_error",
            "type": "string"
          },
          "message": {
            "description": "A human-readable message providing more details about the error.",
            "example": "Form data payload is too large.",
            "type": "string"
          },
          "param": {
            "description": "If the error is parameter-specific, the parameter related to the error. For example, you can use this to display a message near the correct form field.",
            "example": "file",
            "type": "string"
          },
          "code": {
            "description": "For some errors that could be handled programmatically, a short string indicating the error code reported.",
            "example": "payload_too_large",
            "type": "string"
          }
        },
        "type": "object"
      },
      "UnauthorizedError": {
        "title": "Unauthorized Error",
        "description": "The API key does not exist.",
        "example": {
          "type": "authentication_error",
          "message": "Unknown API key"
        },
        "properties": {
          "type": {
            "description": "The type of error returned.",
            "example": "authentication_error",
            "type": "string"
          },
          "message": {
            "description": "A human-readable message providing more details about the error.",
            "example": "Unknown API key",
            "type": "string"
          }
        },
        "type": "object"
      },
      "ForbiddenError": {
        "title": "Forbidden Error",
        "description": "The system understands the request but refuses to authorize it.",
        "example": {
          "type": "invalid_request_error",
          "message": "The API is only accessible over HTTPS."
        },
        "properties": {
          "type": {
            "description": "The type of error returned.",
            "example": "invalid_request_error",
            "type": "string"
          },
          "message": {
            "description": "A human-readable message providing more details about the error.",
            "example": "The API is only accessible over HTTPS.",
            "type": "string"
          }
        },
        "type": "object"
      },
      "TooManyRequestsError": {
        "title": "Too Many Requests Error",
        "description": "The client has made too many requests.",
        "example": {
          "type": "rate_limit_error",
          "message": "API request limit has been exceeded."
        },
        "properties": {
          "type": {
            "description": "The type of error returned.",
            "example": "rate_limit_error",
            "type": "string"
          },
          "message": {
            "description": "A human-readable message providing more details about the error.",
            "example": "API request limit has been exceeded.",
            "type": "string"
          }
        },
        "type": "object"
      },
      "ResourceMissingError": {
        "title": "Resource Missing Error",
        "description": "A requested resource does not exist.",
        "example": {
          "type": "invalid_request_error",
          "message": "Item does not exist in this brand.",
          "param": "brand_id",
          "code": "resource_missing"
        },
        "properties": {
          "type": {
            "description": "The type of error returned.",
            "example": "invalid_request_error",
            "type": "string"
          },
          "message": {
            "description": "A human-readable message providing more details about the error.",
            "example": "Item does not exist in this brand.",
            "type": "string"
          },
          "param": {
            "description": "The parameter related to the error.",
            "example": "brand_id",
            "type": "string"
          },
          "code": {
            "description": "Code to aid in handling the error programatically.",
            "example": "resource_missing",
            "type": "string"
          }
        },
        "type": "object"
      },
      "ServerError": {
        "title": "Server Error",
        "description": "The server encountered an unexpected error.",
        "example": {
          "type": "api_error",
          "message": "An unexpected error occurred."
        },
        "properties": {
          "type": {
            "description": "The type of error returned.",
            "example": "api_error",
            "type": "string"
          },
          "message": {
            "description": "A human-readable message providing more details about the error.",
            "example": "An unexpected error occurred.",
            "type": "string"
          }
        },
        "type": "object"
      },
      "UnderMaintenanceError": {
        "title": "Under maintenance error",
        "description": "The system is under maintenance. Please try again later.",
        "example": {
          "type": "server_error",
          "message": "Service temporarily unavailable. Please try again after date in Retry-After header."
        },
        "properties": {
          "type": {
            "description": "The type of error returned.",
            "example": "server_error",
            "type": "string"
          },
          "message": {
            "description": "A human-readable message providing more details about the error.",
            "example": "Service temporarily unavailable. Please try again after date in Retry-After header.",
            "type": "string"
          }
        },
        "type": "object"
      }
    }
  },
  "x-samples-languages": [
    "curl",
    "node",
    "ruby",
    "javascript",
    "python",
    "php"
  ],
  "openapi": "3.1.0"
}
```