FlowSms

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/FlowSms",
  "title": "FlowSms",
  "type": "object",
  "properties": {
    "body": {
      "type": "string"
    },
    "image_id": {
      "description": "The id of an ImageAsset. If provided, this will take precedence over a dynamic_image.",
      "type": "string",
      "example": "123",
      "nullable": true
    },
    "dynamic_image": {
      "description": "A dynamic image asset to include in the SMS message.",
      "type": "string",
      "example": "{{ person|lookup:'image_url' }}",
      "nullable": true
    },
    "shorten_links": {
      "type": "boolean",
      "example": true,
      "default": true
    },
    "include_contact_card": {
      "type": "boolean",
      "default": false
    },
    "add_org_prefix": {
      "type": "boolean",
      "example": true,
      "default": true
    },
    "add_info_link": {
      "type": "boolean",
      "example": true,
      "default": true
    },
    "add_opt_out_language": {
      "type": "boolean",
      "default": false
    },
    "smart_sending_enabled": {
      "type": "boolean",
      "example": true,
      "default": true
    },
    "sms_quiet_hours_enabled": {
      "type": "boolean",
      "example": true,
      "default": true
    },
    "transactional": {
      "type": "boolean",
      "default": false
    },
    "add_tracking_params": {
      "type": "boolean",
      "default": false
    },
    "custom_tracking_params": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/UtmParam"
      },
      "nullable": true
    },
    "template_id": {
      "type": "string",
      "nullable": true
    },
    "additional_filters": {
      "type": "object",
      "nullable": true,
      "properties": {
        "condition_groups": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "conditions": {
                "type": "array",
                "items": {
                  "oneOf": [
                    {
                      "$ref": "#/components/schemas/ProfilePropertyCondition"
                    },
                    {
                      "$ref": "#/components/schemas/ProfileHasGroupMembershipCondition"
                    },
                    {
                      "$ref": "#/components/schemas/ProfileNoGroupMembershipCondition"
                    },
                    {
                      "$ref": "#/components/schemas/ProfileRegionCondition"
                    },
                    {
                      "$ref": "#/components/schemas/ProfilePostalCodeDistanceCondition"
                    },
                    {
                      "$ref": "#/components/schemas/ProfilePredictiveAnalyticsDateCondition"
                    },
                    {
                      "$ref": "#/components/schemas/ProfilePredictiveAnalyticsStringCondition"
                    },
                    {
                      "$ref": "#/components/schemas/ProfilePredictiveAnalyticsNumericCondition"
                    },
                    {
                      "$ref": "#/components/schemas/ProfileMarketingConsentCondition"
                    },
                    {
                      "$ref": "#/components/schemas/FlowsProfileMetricCondition"
                    },
                    {
                      "$ref": "#/components/schemas/ProfileRandomSampleCondition"
                    },
                    {
                      "$ref": "#/components/schemas/ProfileHasCustomObjectCondition"
                    },
                    {
                      "$ref": "#/components/schemas/ProfilePermissionsCondition"
                    },
                    {
                      "$ref": "#/components/schemas/ProfileHasNotReceivedSmsMessageCondition"
                    }
                  ]
                }
              }
            },
            "required": [
              "conditions"
            ]
          }
        }
      },
      "required": [
        "condition_groups"
      ]
    },
    "name": {
      "type": "string",
      "nullable": true
    },
    "id": {
      "description": "Not allowed on create.",
      "type": "string",
      "nullable": true
    }
  },
  "required": [
    "body"
  ]
}