Klaviyo · Schema

CampaignPartialUpdateQueryResourceObject

MarketingEmailSMSCustomer DataEcommerceAutomation

Properties

Name Type Description
type object
id string The campaign ID to be retrieved
attributes object
View JSON Schema on GitHub

JSON Schema

klaviyo-campaignpartialupdatequeryresourceobject-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/CampaignPartialUpdateQueryResourceObject",
  "title": "CampaignPartialUpdateQueryResourceObject",
  "type": "object",
  "properties": {
    "type": {
      "$ref": "#/components/schemas/CampaignEnum"
    },
    "id": {
      "description": "The campaign ID to be retrieved",
      "type": "string"
    },
    "attributes": {
      "type": "object",
      "properties": {
        "name": {
          "description": "The campaign name",
          "type": "string",
          "example": "My new campaign",
          "nullable": true
        },
        "audiences": {
          "description": "The audiences to be included and/or excluded from the campaign",
          "$ref": "#/components/schemas/AudiencesUpdate",
          "nullable": true
        },
        "send_options": {
          "description": "Options to use when sending a campaign",
          "nullable": true,
          "oneOf": [
            {
              "$ref": "#/components/schemas/EmailSendOptions"
            },
            {
              "$ref": "#/components/schemas/SMSSendOptions"
            },
            {
              "$ref": "#/components/schemas/PushSendOptions"
            }
          ]
        },
        "tracking_options": {
          "description": "The tracking options associated with the campaign",
          "nullable": true,
          "oneOf": [
            {
              "$ref": "#/components/schemas/CampaignsEmailTrackingOptions"
            },
            {
              "$ref": "#/components/schemas/CampaignsSMSTrackingOptions"
            }
          ]
        },
        "send_strategy": {
          "description": "The send strategy the campaign will send with",
          "nullable": true,
          "oneOf": [
            {
              "$ref": "#/components/schemas/StaticSendStrategy"
            },
            {
              "$ref": "#/components/schemas/ThrottledSendStrategy"
            },
            {
              "$ref": "#/components/schemas/ImmediateSendStrategy"
            },
            {
              "$ref": "#/components/schemas/SmartSendTimeStrategy"
            }
          ]
        }
      }
    }
  },
  "required": [
    "type",
    "id",
    "attributes"
  ]
}