Validation rules for call-to-action types including distinctness, validity, existence, and completeness checks

Type

CallToActionsTypeMustBeDistinct

Definition	Severity	API	Sample	Mode
Validate that each type (action) is distinct			Link

Example Validation Report

{
  "code": "VALIDATION__CallToActionsTypeMustBeDistinct",
  "severity": "VIOLATION",
  "message": "Each '{{field}}' must be distinct",
  "context": {
    "field": "type"
  },
  "details": {
    "createdDate": "2026-02-10T11:36:02.00Z",
    "submitted": [
      {
        "field": ".0.providers.1",
        "value": "ORDER"
      },
      {
        "field": ".0.providers.2",
        "value": "ORDER"
      }
    ],
    "compared": [],
    "expected": []
  }
}

CallToActionsTypeMustBeValid

Definition	Severity	API	Sample	Mode
Validate that type value is valid

Example Validation Report

{
  "code": "VALIDATION__CallToActionsTypeMustBeValid",
  "severity": "VIOLATION",
  "message": "'type' value '{{value}}' is invalid",
  "context": {
    "value": "foo_bar"
  },
  "details": {
    "createdDate": "2026-02-10T11:36:02.00Z",
    "submitted": [
      {
        "field": ".0",
        "value": "foo_bar"
      }
    ],
    "compared": [],
    "expected": []
  }
}

CallToActionsTypeMustNotBeEmpty

Definition	Severity	API	Sample	Mode
Validate that type is not an empty string

Example Validation Report

{
  "code": "VALIDATION__CallToActionsTypeMustNotBeEmpty",
  "severity": "VIOLATION",
  "message": "Field '{{field}}' is empty",
  "context": {
    "field": "type"
  },
  "details": {
    "createdDate": "2026-02-10T11:36:02.00Z",
    "submitted": [
      {
        "field": ".0"
      }
    ],
    "compared": [],
    "expected": []
  }
}

CallToActionsTypeIsMissing

Definition	Severity	API	Sample	Mode
Validate that a Apple Business action type has a corresponding match in a submittal

Example Validation Report

{
  "code": "VALIDATION__CallToActionsTypeIsMissing",
  "severity": "VIOLATION",
  "message": "'{{value}}' action 'type' is missing. Fetch latest providers using Get CTAs and try again",
  "context": {
    "value": "ORDER"
  },
  "details": {
    "createdDate": "2026-02-10T11:36:02.00Z",
    "compared": [
      {
        "field": "type",
        "value": "ORDER"
      }
    ],
    "expected": [],
    "submitted": []
  }
}

CallToActionsTypeDoesNotExist

Definition	Severity	API	Sample	Mode
Validate that a Apple Business action type has a corresponding match in a submittal

Example Validation Report

{
  "code": "VALIDATION__CallToActionsTypeDoesNotExist",
  "severity": "VIOLATION",
  "message": "'{{value}}' action 'type' does not exist. Fetch latest providers using Get CTAs and try again",
  "context": {
    "value": "TICKETS"
  },
  "details": {
    "createdDate": "2026-02-10T11:36:02.00Z",
    "compared": [
      {
        "field": "type",
        "value": "TICKETS"
      }
    ],
    "expected": [],
    "submitted": []
  }
}