Klaviyo · Schema

CampaignRecipientEstimationJobResponseObjectResource

MarketingEmailSMSCustomer DataE-CommerceAutomation

Properties

Name Type Description
type object
id string The ID of the campaign used for estimating recipients
attributes object
links object
View JSON Schema on GitHub

JSON Schema

klaviyo-campaignrecipientestimationjobresponseobjectresource-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/CampaignRecipientEstimationJobResponseObjectResource",
  "title": "CampaignRecipientEstimationJobResponseObjectResource",
  "type": "object",
  "properties": {
    "type": {
      "$ref": "#/components/schemas/CampaignRecipientEstimationJobEnum"
    },
    "id": {
      "description": "The ID of the campaign used for estimating recipients",
      "type": "string",
      "example": "01GMRWDSA0ARTAKE1SFX8JGXAY"
    },
    "attributes": {
      "type": "object",
      "properties": {
        "status": {
          "description": "The status of the recipient estimation job",
          "type": "string",
          "enum": [
            "cancelled",
            "complete",
            "processing",
            "queued"
          ]
        }
      },
      "required": [
        "status"
      ]
    },
    "links": {
      "$ref": "#/components/schemas/ObjectLinks"
    }
  },
  "required": [
    "type",
    "id",
    "attributes",
    "links"
  ]
}