Validation rules for call-to-action providers including organization permissions, distinctness, matching, and completeness

Organization

OrgTypeNotAllowedToOrderProviders

Definition	Severity	API	Sample	Mode
Validate that only an allowable organization type is able to request to order providers. (Third-party partner is not allowed)

Example Validation Report

{
  "code": "VALIDATION__OrgTypeNotAllowedToOrderProviders",
  "severity": "VIOLATION",
  "message": "Your organization type is not allowed to order providers"
}

Providers

CallToActionsProvidersListMustNotIncludeNulls

Definition	Severity	API	Sample	Mode
Validate that a list does not include null

Example Validation Report

{
  "code": "VALIDATION__CallToActionsProvidersListMustNotIncludeNulls",
  "severity": "VIOLATION",
  "message": "Field '{{field}}' must not be null",
  "context": {
    "field": "providers"
  }
}

CallToActionsProviderMustBeDistinct

Definition	Severity	API	Sample	Mode
Validate that each listed provider object in providers is distinct

Example Validation Report

{
  "code": "VALIDATION__CallToActionsProviderMustBeDistinct",
  "severity": "VIOLATION",
  "message": "Listed provider is duplicate",
  "details": {
    "createdDate": "2026-02-10T11:36:02.00Z",
    "submitted": [
      {
        "field": ".0.providers.3"
      }
    ],
    "compared": [],
    "expected": []
  }
}

CallToActionsProviderMustMatch

Preconditions
Listed type has a corresponding match in Apple Business
Apple Business type has providers

Definition	Severity	API	Sample	Mode
Validate that a listed provider object has a corresponding match in a Apple Business list of providers

Example Validation Report

{
  "code": "VALIDATION__CallToActionsProviderMustMatch",
  "severity": "VIOLATION",
  "message": "Listed provider is not matched. Fetch latest providers using Get CTAs and try again",
  "details": {
    "createdDate": "2026-02-10T11:36:02.00Z",
    "submitted": [
      {
        "field": ".1.providers.0"
      }
    ],
    "compared": [],
    "expected": []
  }
}

CallToActionsProviderIsMissing

Preconditions
Listed type has a corresponding match in Apple Business
Apple Business type has providers

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

Example Validation Report

{
  "code": "VALIDATION__CallToActionsProviderIsMissing",
  "severity": "VIOLATION",
  "message": "Submittal with '{{value}}' action 'type' is missing provider(s). 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": []
  }
}