POST /api/v1/campaigns/{id}/attempts/{attemptId}/resolve
Resolve an uncertain provider attempt
A human operator records what the supplier actually did, with evidence. Resolution cannot bypass current creative verification, supplier configuration or financial reconciliation gates.
Authenticated and advertiser scoped. Cross-tenant resource access returns 404. Product/channel entitlements also apply.
Requires an authenticated human with operator:reconcile permission. Delegated agents cannot perform this operator action.
The request schema is generated from the runtime Zod input validator. Cross-field refinements and state-dependent constraints are additionally enforced by the API.
Request
HTTP
POST /api/v1/campaigns/{id}/attempts/{attemptId}/resolveUse the configured API origin. Private requests require a verified Bearer credential; an agent mutation can additionally require exact approval headers. Authentication guide →
| Parameter | Location | Required | Description |
|---|---|---|---|
id | path | Yes | |
attemptId | path | Yes |
Parameter schemas
JSON Schema
[
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "attemptId",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
]Request body contract
{
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"outcome": {
"type": "string",
"enum": [
"applied",
"not-applied"
]
},
"externalRef": {
"type": "string",
"minLength": 1
},
"stagedManifest": {
"type": "object",
"properties": {
"campaign": {
"type": "string",
"minLength": 1
},
"providerAccountRef": {
"type": "string",
"minLength": 1
},
"providerAccountRefAuthority": {
"type": "string",
"enum": [
"provider-validated",
"operator-attested"
]
},
"budget": {
"type": "string",
"minLength": 1
},
"adGroups": {
"type": "array",
"items": {
"type": "string",
"minLength": 1
},
"default": []
},
"adSets": {
"type": "array",
"items": {
"type": "string",
"minLength": 1
},
"default": []
},
"ads": {
"type": "array",
"items": {
"type": "string",
"minLength": 1
},
"default": []
},
"keywords": {
"type": "array",
"items": {
"type": "string",
"minLength": 1
},
"default": []
},
"negativeKeywords": {
"type": "array",
"items": {
"type": "string",
"minLength": 1
},
"default": []
},
"targetingCriteria": {
"type": "array",
"items": {
"type": "string",
"minLength": 1
},
"default": []
},
"configurationDigest": {
"type": "string",
"pattern": "^[a-f0-9]{64}$"
},
"conversionGoalBinding": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"revision": {
"type": "integer",
"exclusiveMinimum": 0,
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"channelCampaignId": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"connectionConfigurationRevision": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"approvedObjectiveDigest": {
"type": "string",
"pattern": "^[a-f0-9]{64}$"
},
"providerAccountRef": {
"type": "string",
"minLength": 1,
"maxLength": 500
},
"goal": {
"type": "object",
"properties": {
"adapterKey": {
"type": "string",
"enum": [
"google-ads",
"microsoft-ads",
"tiktok-ads",
"meta-ads"
]
},
"providerAccountRef": {
"type": "string",
"minLength": 1,
"maxLength": 500
},
"goalRef": {
"type": "string",
"minLength": 1,
"maxLength": 500
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 2000
},
"definition": {
"anyOf": [
{
"type": "object",
"properties": {
"provider": {
"type": "string",
"const": "google-ads"
},
"conversionCustomerRef": {
"type": "string",
"minLength": 1,
"maxLength": 500
},
"customGoalRef": {
"type": "string",
"minLength": 1,
"maxLength": 500
},
"customGoalName": {
"type": "string",
"maxLength": 2000
},
"customGoalStatus": {
"type": "string",
"maxLength": 2000
},
"conversionActionRefs": {
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 500
},
"maxItems": 100
},
"actions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"resourceName": {
"type": "string",
"minLength": 1,
"maxLength": 500
},
"ownerCustomer": {
"type": "string",
"minLength": 1,
"maxLength": 500
},
"name": {
"type": "string",
"maxLength": 2000
},
"status": {
"type": "string",
"maxLength": 2000
},
"type": {
"type": "string",
"maxLength": 2000
},
"origin": {
"type": "string",
"maxLength": 2000
},
"category": {
"type": "string",
"maxLength": 2000
},
"countingType": {
"type": "string",
"maxLength": 2000
},
"primaryForGoal": {
"type": "boolean"
},
"clickThroughLookbackWindowDays": {
"type": "integer",
"minimum": 0
},
"viewThroughLookbackWindowDays": {
"type": "integer",
"minimum": 0
},
"attributionModel": {
"type": "string",
"maxLength": 2000
},
"valueSettings": {
"type": "object",
"properties": {
"alwaysUseDefaultValue": {
"type": "boolean"
},
"defaultCurrencyCode": {
"type": "string",
"maxLength": 2000
},
"defaultValue": {
"type": "string",
"pattern": "^-?\\d+(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$"
}
},
"required": [
"alwaysUseDefaultValue",
"defaultCurrencyCode",
"defaultValue"
],
"additionalProperties": false
}
},
"required": [
"resourceName",
"ownerCustomer",
"name",
"status",
"type",
"origin",
"category",
"countingType",
"primaryForGoal",
"clickThroughLookbackWindowDays",
"viewThroughLookbackWindowDays",
"attributionModel",
"valueSettings"
],
"additionalProperties": false
},
"maxItems": 100
}
},
"required": [
"provider",
"conversionCustomerRef",
"customGoalRef",
"customGoalName",
"customGoalStatus",
"conversionActionRefs",
"actions"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"provider": {
"type": "string",
"const": "microsoft-ads"
},
"goalId": {
"type": "string",
"pattern": "^\\d+$"
},
"type": {
"type": "string",
"enum": [
"Url",
"Event"
]
},
"name": {
"type": "string",
"maxLength": 2000
},
"status": {
"type": "string",
"maxLength": 2000
},
"scope": {
"type": "string",
"maxLength": 2000
},
"tagId": {
"type": "string",
"pattern": "^\\d+$"
},
"countType": {
"type": "string",
"maxLength": 2000
},
"excludeFromBidding": {
"type": "boolean"
},
"goalCategory": {
"type": "string",
"maxLength": 2000
},
"conversionWindowInMinutes": {
"type": "integer",
"minimum": 0
},
"viewThroughConversionWindowInMinutes": {
"type": "integer",
"minimum": 0
},
"attributionModelType": {
"type": "string",
"maxLength": 2000
},
"isEnhancedConversionsEnabled": {
"type": "boolean"
},
"isAutoGoal": {
"type": "boolean"
},
"accountTracking": {
"type": "object",
"properties": {
"msclkidAutoTaggingEnabled": {
"type": "boolean"
},
"includeViewThroughConversions": {
"type": "boolean"
},
"includeAutoBiddingViewThroughConversions": {
"type": "boolean"
}
},
"required": [
"msclkidAutoTaggingEnabled",
"includeViewThroughConversions",
"includeAutoBiddingViewThroughConversions"
],
"additionalProperties": false
},
"revenue": {
"type": "object",
"properties": {
"type": {
"type": "string",
"maxLength": 2000
},
"currencyCode": {
"type": "string",
"maxLength": 2000
},
"value": {
"type": "string",
"maxLength": 2000
}
},
"required": [
"type",
"currencyCode",
"value"
],
"additionalProperties": false
},
"url": {
"anyOf": [
{
"type": "object",
"properties": {
"expression": {
"type": "string",
"maxLength": 2000
},
"operator": {
"type": "string",
"maxLength": 2000
}
},
"required": [
"expression",
"operator"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"event": {
"anyOf": [
{
"type": "object",
"properties": {
"actionExpression": {
"type": "string",
"maxLength": 2000
},
"actionOperator": {
"type": "string",
"maxLength": 2000
},
"categoryExpression": {
"type": "string",
"maxLength": 2000
},
"categoryOperator": {
"type": "string",
"maxLength": 2000
},
"labelExpression": {
"type": "string",
"maxLength": 2000
},
"labelOperator": {
"type": "string",
"maxLength": 2000
},
"value": {
"type": "string",
"maxLength": 2000
},
"valueOperator": {
"type": "string",
"maxLength": 2000
}
},
"required": [
"actionExpression",
"actionOperator",
"categoryExpression",
"categoryOperator",
"labelExpression",
"labelOperator",
"value",
"valueOperator"
],
"additionalProperties": false
},
{
"type": "null"
}
]
}
},
"required": [
"provider",
"goalId",
"type",
"name",
"status",
"scope",
"tagId",
"countType",
"excludeFromBidding",
"goalCategory",
"conversionWindowInMinutes",
"viewThroughConversionWindowInMinutes",
"attributionModelType",
"isEnhancedConversionsEnabled",
"isAutoGoal",
"accountTracking",
"revenue",
"url",
"event"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"provider": {
"type": "string",
"const": "tiktok-ads"
},
"pixel": {
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^\\d+$"
},
"code": {
"type": "string",
"minLength": 1,
"maxLength": 500
},
"name": {
"type": "string",
"maxLength": 2000
},
"setupMode": {
"type": "string",
"enum": [
"STANDARD",
"DEVELOPER"
]
},
"ownership": {
"type": "object",
"properties": {
"relation": {
"anyOf": [
{
"type": "string",
"enum": [
"TRANSFERRED",
"SHARED",
"UNBOUND"
]
},
{
"type": "null"
}
]
},
"ownedByAdvertiser": {
"type": "boolean"
},
"ownerBusinessCenterId": {
"anyOf": [
{
"type": "string",
"pattern": "^\\d+$"
},
{
"type": "null"
}
]
}
},
"required": [
"relation",
"ownedByAdvertiser",
"ownerBusinessCenterId"
],
"additionalProperties": false
},
"manualMatching": {
"type": "object",
"properties": {
"email": {
"type": [
"boolean",
"null"
]
},
"phoneNumber": {
"type": [
"boolean",
"null"
]
}
},
"required": [
"email",
"phoneNumber"
],
"additionalProperties": false
},
"automaticMatching": {
"type": "object",
"properties": {
"email": {
"type": [
"boolean",
"null"
]
},
"phoneNumber": {
"type": [
"boolean",
"null"
]
},
"name": {
"type": [
"boolean",
"null"
]
},
"address": {
"type": [
"boolean",
"null"
]
},
"externalId": {
"type": [
"boolean",
"null"
]
}
},
"required": [
"email",
"phoneNumber",
"name",
"address",
"externalId"
],
"additionalProperties": false
},
"firstPartyCookies": {
"type": [
"boolean",
"null"
]
},
"expandedDataSharing": {
"type": [
"boolean",
"null"
]
}
},
"required": [
"id",
"code",
"name",
"setupMode",
"ownership",
"manualMatching",
"automaticMatching",
"firstPartyCookies",
"expandedDataSharing"
],
"additionalProperties": false
},
"optimizationEvent": {
"type": "string",
"maxLength": 2000
},
"events": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^\\d+$"
},
"code": {
"type": "string",
"minLength": 1,
"maxLength": 500
},
"name": {
"type": "string",
"maxLength": 2000
},
"eventType": {
"type": "string",
"maxLength": 2000
},
"optimizationEvent": {
"type": "string",
"maxLength": 2000
},
"deprecated": {
"type": "boolean"
},
"statisticType": {
"anyOf": [
{
"type": "string",
"maxLength": 2000
},
{
"type": "null"
}
]
},
"currency": {
"anyOf": [
{
"type": "string",
"maxLength": 2000
},
{
"type": "null"
}
]
},
"currencyValue": {
"anyOf": [
{
"type": "string",
"maxLength": 2000
},
{
"type": "null"
}
]
},
"rules": {
"type": "array",
"items": {
"type": "object",
"properties": {
"operator": {
"type": "string",
"maxLength": 2000
},
"trigger": {
"type": "string",
"maxLength": 2000
},
"variable": {
"type": "string",
"maxLength": 2000
},
"value": {
"type": "string",
"maxLength": 2000
}
},
"required": [
"operator",
"trigger",
"variable",
"value"
],
"additionalProperties": false
},
"maxItems": 100
}
},
"required": [
"id",
"code",
"name",
"eventType",
"optimizationEvent",
"deprecated",
"statisticType",
"currency",
"currencyValue",
"rules"
],
"additionalProperties": false
},
"maxItems": 1000
},
"customConversion": {
"anyOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^\\d+$"
},
"name": {
"type": "string",
"maxLength": 2000
},
"description": {
"type": "string",
"maxLength": 2000
},
"eventSourceType": {
"type": "string",
"const": "PIXEL"
},
"eventSourceId": {
"type": "string",
"pattern": "^\\d+$"
},
"optimizationEvent": {
"type": "string",
"maxLength": 2000
},
"rules": {
"type": "array",
"items": {
"type": "object",
"properties": {
"parameter": {
"type": "string",
"maxLength": 2000
},
"operator": {
"type": "string",
"maxLength": 2000
},
"values": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string",
"maxLength": 100
},
"minItems": 1,
"maxItems": 100
},
{
"type": "number",
"minimum": 0,
"maximum": 1000000000
}
]
}
},
"required": [
"parameter",
"operator",
"values"
],
"additionalProperties": false
},
"minItems": 1,
"maxItems": 100
},
"createdAt": {
"anyOf": [
{
"type": "string",
"maxLength": 2000
},
{
"type": "null"
}
]
},
"updatedAt": {
"anyOf": [
{
"type": "string",
"maxLength": 2000
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"name",
"description",
"eventSourceType",
"eventSourceId",
"optimizationEvent",
"rules",
"createdAt",
"updatedAt"
],
"additionalProperties": false
},
{
"type": "null"
}
]
}
},
"required": [
"provider",
"pixel",
"optimizationEvent",
"events",
"customConversion"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"provider": {
"type": "string",
"const": "meta-ads"
},
"accountBusinessId": {
"anyOf": [
{
"type": "string",
"pattern": "^\\d+$"
},
{
"type": "null"
}
]
},
"pixel": {
"anyOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^\\d+$"
},
"name": {
"type": "string",
"maxLength": 2000
},
"ownerAdAccountId": {
"anyOf": [
{
"type": "string",
"pattern": "^\\d+$"
},
{
"type": "null"
}
]
},
"ownerBusinessId": {
"anyOf": [
{
"type": "string",
"pattern": "^\\d+$"
},
{
"type": "null"
}
]
},
"ownership": {
"type": "string",
"enum": [
"ad-account",
"business",
"shared",
"unknown"
]
},
"automaticMatchingFields": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string",
"maxLength": 2000
},
"maxItems": 100
},
{
"type": "null"
}
]
},
"automaticMatchingEnabled": {
"type": [
"boolean",
"null"
]
},
"firstPartyCookieStatus": {
"anyOf": [
{
"type": "string",
"maxLength": 2000
},
{
"type": "null"
}
]
},
"dataUseSetting": {
"anyOf": [
{
"type": "string",
"maxLength": 2000
},
{
"type": "null"
}
]
},
"unavailable": {
"type": [
"boolean",
"null"
]
},
"restrictedToLift": {
"type": [
"boolean",
"null"
]
},
"restrictedToMta": {
"type": [
"boolean",
"null"
]
},
"containsCrmSource": {
"type": [
"boolean",
"null"
]
},
"consolidatedContainer": {
"type": [
"boolean",
"null"
]
},
"configuration": {
"anyOf": [
{
"type": "string",
"maxLength": 50000
},
{
"type": "null"
}
]
},
"autoAssignToAccounts": {
"type": [
"boolean",
"null"
]
}
},
"required": [
"id",
"name",
"ownerAdAccountId",
"ownerBusinessId",
"ownership",
"automaticMatchingFields",
"automaticMatchingEnabled",
"firstPartyCookieStatus",
"dataUseSetting",
"unavailable",
"restrictedToLift",
"restrictedToMta",
"containsCrmSource",
"consolidatedContainer",
"configuration",
"autoAssignToAccounts"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"customConversion": {
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^\\d+$"
},
"accountId": {
"type": "string",
"pattern": "^\\d+$"
},
"businessId": {
"anyOf": [
{
"type": "string",
"pattern": "^\\d+$"
},
{
"type": "null"
}
]
},
"name": {
"type": "string",
"maxLength": 2000
},
"description": {
"anyOf": [
{
"type": "string",
"maxLength": 2000
},
{
"type": "null"
}
]
},
"pixelId": {
"anyOf": [
{
"type": "string",
"pattern": "^\\d+$"
},
{
"type": "null"
}
]
},
"eventSourceId": {
"anyOf": [
{
"type": "string",
"pattern": "^\\d+$"
},
{
"type": "null"
}
]
},
"eventSourceType": {
"anyOf": [
{
"type": "string",
"maxLength": 2000
},
{
"type": "null"
}
]
},
"actionSourceType": {
"anyOf": [
{
"type": "string",
"maxLength": 2000
},
{
"type": "null"
}
]
},
"dataSources": {
"anyOf": [
{
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^\\d+$"
},
"name": {
"anyOf": [
{
"type": "string",
"maxLength": 2000
},
{
"type": "null"
}
]
},
"sourceType": {
"anyOf": [
{
"type": "string",
"maxLength": 2000
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"name",
"sourceType"
],
"additionalProperties": false
},
"maxItems": 100
},
{
"type": "null"
}
]
},
"eventCategory": {
"type": "string",
"maxLength": 2000
},
"rule": {
"anyOf": [
{
"type": "string",
"maxLength": 50000
},
{
"type": "null"
}
]
},
"advancedRule": {
"anyOf": [
{
"type": "string",
"maxLength": 50000
},
{
"type": "null"
}
]
},
"aggregationRule": {
"anyOf": [
{
"type": "string",
"maxLength": 50000
},
{
"type": "null"
}
]
},
"retentionDays": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"defaultConversionValue": {
"anyOf": [
{
"type": "string",
"maxLength": 2000
},
{
"type": "null"
}
]
},
"createdAt": {
"anyOf": [
{
"type": "string",
"maxLength": 2000
},
{
"type": "null"
}
]
},
"archived": {
"type": [
"boolean",
"null"
]
},
"unavailable": {
"type": [
"boolean",
"null"
]
},
"offlineDataSetId": {
"anyOf": [
{
"type": "string",
"pattern": "^\\d+$"
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"accountId",
"businessId",
"name",
"description",
"pixelId",
"eventSourceId",
"eventSourceType",
"actionSourceType",
"dataSources",
"eventCategory",
"rule",
"advancedRule",
"aggregationRule",
"retentionDays",
"defaultConversionValue",
"createdAt",
"archived",
"unavailable",
"offlineDataSetId"
],
"additionalProperties": false
}
},
"required": [
"provider",
"accountBusinessId",
"pixel",
"customConversion"
],
"additionalProperties": false
}
]
},
"definitionDigest": {
"type": "string",
"pattern": "^[a-f0-9]{64}$"
},
"availability": {
"type": "string",
"enum": [
"available",
"unavailable"
]
},
"blockers": {
"type": "array",
"items": {
"type": "string",
"minLength": 1
},
"maxItems": 100
},
"activity": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"unknown",
"active",
"inactive"
]
},
"detail": {
"type": "string",
"minLength": 1
}
},
"required": [
"status",
"detail"
],
"additionalProperties": false
},
"evidenceSource": {
"type": "string",
"enum": [
"provider-read",
"sandbox"
]
}
},
"required": [
"adapterKey",
"providerAccountRef",
"goalRef",
"name",
"definition",
"definitionDigest",
"availability",
"blockers",
"activity",
"evidenceSource"
],
"additionalProperties": false
},
"observedAt": {
"type": "string",
"format": "date-time"
},
"evidenceSource": {
"type": "string",
"enum": [
"provider-read",
"sandbox"
]
},
"tiktokSettings": {
"type": "object",
"properties": {
"clickAttributionWindow": {
"type": "string",
"enum": [
"ONE_DAY",
"SEVEN_DAYS",
"FOURTEEN_DAYS",
"TWENTY_EIGHT_DAYS"
]
},
"viewAttributionWindow": {
"type": "string",
"enum": [
"OFF",
"ONE_DAY",
"SEVEN_DAYS"
]
},
"attributionEventCount": {
"type": "string",
"enum": [
"ONCE",
"EVERY"
]
}
},
"required": [
"clickAttributionWindow",
"viewAttributionWindow",
"attributionEventCount"
],
"additionalProperties": false
},
"metaSettings": {
"type": "object",
"properties": {
"clickAttributionWindow": {
"type": "string",
"enum": [
"ONE_DAY",
"SEVEN_DAYS"
]
},
"viewAttributionWindow": {
"type": "string",
"enum": [
"OFF",
"ONE_DAY"
]
},
"attributionCountType": {
"type": "string",
"enum": [
"ALL_CONVERSIONS",
"FIRST_CONVERSION"
]
}
},
"required": [
"clickAttributionWindow",
"viewAttributionWindow",
"attributionCountType"
],
"additionalProperties": false
}
},
"required": [
"id",
"revision",
"channelCampaignId",
"connectionConfigurationRevision",
"approvedObjectiveDigest",
"providerAccountRef",
"goal",
"observedAt",
"evidenceSource"
],
"additionalProperties": false
}
},
"required": [
"campaign"
],
"additionalProperties": false
},
"creativeRefs": {
"type": "array",
"items": {
"type": "object",
"properties": {
"creativeId": {
"type": "string",
"minLength": 1
},
"externalCreativeRef": {
"type": "string",
"minLength": 1
}
},
"required": [
"creativeId",
"externalCreativeRef"
],
"additionalProperties": false
},
"minItems": 1,
"maxItems": 100
},
"note": {
"type": "string",
"maxLength": 500
}
},
"required": [
"outcome"
],
"additionalProperties": false
}
}
}
}Responses
Reference schemas resolve through the downloadable OpenAPI components. The specification marks unmodeled success payloads; an unrestricted payload is not a promise that arbitrary fields exist.
400Invalid request or unsupported fields
Response contract
{
"description": "Invalid request or unsupported fields",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}401Missing or invalid authentication
Response contract
{
"description": "Missing or invalid authentication",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}403Permission or product scope refused
Response contract
{
"description": "Permission or product scope refused",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}404Route or tenant-scoped resource not found
Response contract
{
"description": "Route or tenant-scoped resource not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}409State, revision, approval, funding or idempotency conflict
Response contract
{
"description": "State, revision, approval, funding or idempotency conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}422Supplier configuration, capability or upstream refusal
Response contract
{
"description": "Supplier configuration, capability or upstream refusal",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}429Rate limit reached; wait before retrying
Response contract
{
"description": "Rate limit reached; wait before retrying",
"headers": {
"x-ratelimit-limit": {
"description": "Maximum requests permitted in the current rate-limit window.",
"schema": {
"type": "integer"
}
},
"x-ratelimit-remaining": {
"description": "Requests remaining in the current window.",
"schema": {
"type": "integer"
}
},
"x-ratelimit-reset": {
"description": "Seconds until the current rate-limit window resets.",
"schema": {
"type": "integer"
}
},
"retry-after": {
"description": "Minimum seconds to wait before retrying.",
"schema": {
"type": "integer"
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}500Internal error; inspect state before retrying a mutation
Response contract
{
"description": "Internal error; inspect state before retrying a mutation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}503Dependency or authentication verifier unavailable
Response contract
{
"description": "Dependency or authentication verifier unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}2XXSuccessful response. Response schema completeness: unmodeled. The request contract is complete; nested service payloads are not yet fully modeled in OpenAPI. Inspect returned fields before generating a typed SDK.
Response contract
{
"description": "Successful response. Response schema completeness: unmodeled. The request contract is complete; nested service payloads are not yet fully modeled in OpenAPI. Inspect returned fields before generating a typed SDK.",
"headers": {
"x-ratelimit-limit": {
"description": "Maximum requests permitted in the current rate-limit window.",
"schema": {
"type": "integer"
}
},
"x-ratelimit-remaining": {
"description": "Requests remaining in the current window.",
"schema": {
"type": "integer"
}
},
"x-ratelimit-reset": {
"description": "Seconds until the current rate-limit window resets.",
"schema": {
"type": "integer"
}
}
},
"content": {
"application/json": {
"schema": {}
}
}
}Operation constraints
Machine-readable metadata
{
"x-response-schema-completeness": "unmodeled",
"x-rate-limit": {
"requests": 300,
"windowMilliseconds": 60000,
"key": "request IP",
"headers": [
"x-ratelimit-limit",
"x-ratelimit-remaining",
"x-ratelimit-reset"
]
},
"x-idempotency": {
"policy": "not-generalized",
"note": "There is no universal Idempotency-Key middleware. Only the documented endpoint mechanisms protect retries."
},
"x-human-only": true,
"x-required-human-permissions": [
"operator:reconcile"
]
}Complete operation
OpenAPI
{
"operationId": "post_api_v1_campaigns_id_attempts_attemptId_resolve",
"summary": "Resolve an uncertain provider attempt",
"description": "A human operator records what the supplier actually did, with evidence. Resolution cannot bypass current creative verification, supplier configuration or financial reconciliation gates.\n\nAuthenticated and advertiser scoped. Cross-tenant resource access returns 404. Product/channel entitlements also apply.\n\nRequires an authenticated human with operator:reconcile permission. Delegated agents cannot perform this operator action.\n\nThe request schema is generated from the runtime Zod input validator. Cross-field refinements and state-dependent constraints are additionally enforced by the API.",
"tags": [
"Campaigns"
],
"security": [
{
"bearerAuth": []
}
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "attemptId",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"outcome": {
"type": "string",
"enum": [
"applied",
"not-applied"
]
},
"externalRef": {
"type": "string",
"minLength": 1
},
"stagedManifest": {
"type": "object",
"properties": {
"campaign": {
"type": "string",
"minLength": 1
},
"providerAccountRef": {
"type": "string",
"minLength": 1
},
"providerAccountRefAuthority": {
"type": "string",
"enum": [
"provider-validated",
"operator-attested"
]
},
"budget": {
"type": "string",
"minLength": 1
},
"adGroups": {
"type": "array",
"items": {
"type": "string",
"minLength": 1
},
"default": []
},
"adSets": {
"type": "array",
"items": {
"type": "string",
"minLength": 1
},
"default": []
},
"ads": {
"type": "array",
"items": {
"type": "string",
"minLength": 1
},
"default": []
},
"keywords": {
"type": "array",
"items": {
"type": "string",
"minLength": 1
},
"default": []
},
"negativeKeywords": {
"type": "array",
"items": {
"type": "string",
"minLength": 1
},
"default": []
},
"targetingCriteria": {
"type": "array",
"items": {
"type": "string",
"minLength": 1
},
"default": []
},
"configurationDigest": {
"type": "string",
"pattern": "^[a-f0-9]{64}$"
},
"conversionGoalBinding": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"revision": {
"type": "integer",
"exclusiveMinimum": 0,
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"channelCampaignId": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"connectionConfigurationRevision": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"approvedObjectiveDigest": {
"type": "string",
"pattern": "^[a-f0-9]{64}$"
},
"providerAccountRef": {
"type": "string",
"minLength": 1,
"maxLength": 500
},
"goal": {
"type": "object",
"properties": {
"adapterKey": {
"type": "string",
"enum": [
"google-ads",
"microsoft-ads",
"tiktok-ads",
"meta-ads"
]
},
"providerAccountRef": {
"type": "string",
"minLength": 1,
"maxLength": 500
},
"goalRef": {
"type": "string",
"minLength": 1,
"maxLength": 500
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 2000
},
"definition": {
"anyOf": [
{
"type": "object",
"properties": {
"provider": {
"type": "string",
"const": "google-ads"
},
"conversionCustomerRef": {
"type": "string",
"minLength": 1,
"maxLength": 500
},
"customGoalRef": {
"type": "string",
"minLength": 1,
"maxLength": 500
},
"customGoalName": {
"type": "string",
"maxLength": 2000
},
"customGoalStatus": {
"type": "string",
"maxLength": 2000
},
"conversionActionRefs": {
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 500
},
"maxItems": 100
},
"actions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"resourceName": {
"type": "string",
"minLength": 1,
"maxLength": 500
},
"ownerCustomer": {
"type": "string",
"minLength": 1,
"maxLength": 500
},
"name": {
"type": "string",
"maxLength": 2000
},
"status": {
"type": "string",
"maxLength": 2000
},
"type": {
"type": "string",
"maxLength": 2000
},
"origin": {
"type": "string",
"maxLength": 2000
},
"category": {
"type": "string",
"maxLength": 2000
},
"countingType": {
"type": "string",
"maxLength": 2000
},
"primaryForGoal": {
"type": "boolean"
},
"clickThroughLookbackWindowDays": {
"type": "integer",
"minimum": 0
},
"viewThroughLookbackWindowDays": {
"type": "integer",
"minimum": 0
},
"attributionModel": {
"type": "string",
"maxLength": 2000
},
"valueSettings": {
"type": "object",
"properties": {
"alwaysUseDefaultValue": {
"type": "boolean"
},
"defaultCurrencyCode": {
"type": "string",
"maxLength": 2000
},
"defaultValue": {
"type": "string",
"pattern": "^-?\\d+(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$"
}
},
"required": [
"alwaysUseDefaultValue",
"defaultCurrencyCode",
"defaultValue"
],
"additionalProperties": false
}
},
"required": [
"resourceName",
"ownerCustomer",
"name",
"status",
"type",
"origin",
"category",
"countingType",
"primaryForGoal",
"clickThroughLookbackWindowDays",
"viewThroughLookbackWindowDays",
"attributionModel",
"valueSettings"
],
"additionalProperties": false
},
"maxItems": 100
}
},
"required": [
"provider",
"conversionCustomerRef",
"customGoalRef",
"customGoalName",
"customGoalStatus",
"conversionActionRefs",
"actions"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"provider": {
"type": "string",
"const": "microsoft-ads"
},
"goalId": {
"type": "string",
"pattern": "^\\d+$"
},
"type": {
"type": "string",
"enum": [
"Url",
"Event"
]
},
"name": {
"type": "string",
"maxLength": 2000
},
"status": {
"type": "string",
"maxLength": 2000
},
"scope": {
"type": "string",
"maxLength": 2000
},
"tagId": {
"type": "string",
"pattern": "^\\d+$"
},
"countType": {
"type": "string",
"maxLength": 2000
},
"excludeFromBidding": {
"type": "boolean"
},
"goalCategory": {
"type": "string",
"maxLength": 2000
},
"conversionWindowInMinutes": {
"type": "integer",
"minimum": 0
},
"viewThroughConversionWindowInMinutes": {
"type": "integer",
"minimum": 0
},
"attributionModelType": {
"type": "string",
"maxLength": 2000
},
"isEnhancedConversionsEnabled": {
"type": "boolean"
},
"isAutoGoal": {
"type": "boolean"
},
"accountTracking": {
"type": "object",
"properties": {
"msclkidAutoTaggingEnabled": {
"type": "boolean"
},
"includeViewThroughConversions": {
"type": "boolean"
},
"includeAutoBiddingViewThroughConversions": {
"type": "boolean"
}
},
"required": [
"msclkidAutoTaggingEnabled",
"includeViewThroughConversions",
"includeAutoBiddingViewThroughConversions"
],
"additionalProperties": false
},
"revenue": {
"type": "object",
"properties": {
"type": {
"type": "string",
"maxLength": 2000
},
"currencyCode": {
"type": "string",
"maxLength": 2000
},
"value": {
"type": "string",
"maxLength": 2000
}
},
"required": [
"type",
"currencyCode",
"value"
],
"additionalProperties": false
},
"url": {
"anyOf": [
{
"type": "object",
"properties": {
"expression": {
"type": "string",
"maxLength": 2000
},
"operator": {
"type": "string",
"maxLength": 2000
}
},
"required": [
"expression",
"operator"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"event": {
"anyOf": [
{
"type": "object",
"properties": {
"actionExpression": {
"type": "string",
"maxLength": 2000
},
"actionOperator": {
"type": "string",
"maxLength": 2000
},
"categoryExpression": {
"type": "string",
"maxLength": 2000
},
"categoryOperator": {
"type": "string",
"maxLength": 2000
},
"labelExpression": {
"type": "string",
"maxLength": 2000
},
"labelOperator": {
"type": "string",
"maxLength": 2000
},
"value": {
"type": "string",
"maxLength": 2000
},
"valueOperator": {
"type": "string",
"maxLength": 2000
}
},
"required": [
"actionExpression",
"actionOperator",
"categoryExpression",
"categoryOperator",
"labelExpression",
"labelOperator",
"value",
"valueOperator"
],
"additionalProperties": false
},
{
"type": "null"
}
]
}
},
"required": [
"provider",
"goalId",
"type",
"name",
"status",
"scope",
"tagId",
"countType",
"excludeFromBidding",
"goalCategory",
"conversionWindowInMinutes",
"viewThroughConversionWindowInMinutes",
"attributionModelType",
"isEnhancedConversionsEnabled",
"isAutoGoal",
"accountTracking",
"revenue",
"url",
"event"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"provider": {
"type": "string",
"const": "tiktok-ads"
},
"pixel": {
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^\\d+$"
},
"code": {
"type": "string",
"minLength": 1,
"maxLength": 500
},
"name": {
"type": "string",
"maxLength": 2000
},
"setupMode": {
"type": "string",
"enum": [
"STANDARD",
"DEVELOPER"
]
},
"ownership": {
"type": "object",
"properties": {
"relation": {
"anyOf": [
{
"type": "string",
"enum": [
"TRANSFERRED",
"SHARED",
"UNBOUND"
]
},
{
"type": "null"
}
]
},
"ownedByAdvertiser": {
"type": "boolean"
},
"ownerBusinessCenterId": {
"anyOf": [
{
"type": "string",
"pattern": "^\\d+$"
},
{
"type": "null"
}
]
}
},
"required": [
"relation",
"ownedByAdvertiser",
"ownerBusinessCenterId"
],
"additionalProperties": false
},
"manualMatching": {
"type": "object",
"properties": {
"email": {
"type": [
"boolean",
"null"
]
},
"phoneNumber": {
"type": [
"boolean",
"null"
]
}
},
"required": [
"email",
"phoneNumber"
],
"additionalProperties": false
},
"automaticMatching": {
"type": "object",
"properties": {
"email": {
"type": [
"boolean",
"null"
]
},
"phoneNumber": {
"type": [
"boolean",
"null"
]
},
"name": {
"type": [
"boolean",
"null"
]
},
"address": {
"type": [
"boolean",
"null"
]
},
"externalId": {
"type": [
"boolean",
"null"
]
}
},
"required": [
"email",
"phoneNumber",
"name",
"address",
"externalId"
],
"additionalProperties": false
},
"firstPartyCookies": {
"type": [
"boolean",
"null"
]
},
"expandedDataSharing": {
"type": [
"boolean",
"null"
]
}
},
"required": [
"id",
"code",
"name",
"setupMode",
"ownership",
"manualMatching",
"automaticMatching",
"firstPartyCookies",
"expandedDataSharing"
],
"additionalProperties": false
},
"optimizationEvent": {
"type": "string",
"maxLength": 2000
},
"events": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^\\d+$"
},
"code": {
"type": "string",
"minLength": 1,
"maxLength": 500
},
"name": {
"type": "string",
"maxLength": 2000
},
"eventType": {
"type": "string",
"maxLength": 2000
},
"optimizationEvent": {
"type": "string",
"maxLength": 2000
},
"deprecated": {
"type": "boolean"
},
"statisticType": {
"anyOf": [
{
"type": "string",
"maxLength": 2000
},
{
"type": "null"
}
]
},
"currency": {
"anyOf": [
{
"type": "string",
"maxLength": 2000
},
{
"type": "null"
}
]
},
"currencyValue": {
"anyOf": [
{
"type": "string",
"maxLength": 2000
},
{
"type": "null"
}
]
},
"rules": {
"type": "array",
"items": {
"type": "object",
"properties": {
"operator": {
"type": "string",
"maxLength": 2000
},
"trigger": {
"type": "string",
"maxLength": 2000
},
"variable": {
"type": "string",
"maxLength": 2000
},
"value": {
"type": "string",
"maxLength": 2000
}
},
"required": [
"operator",
"trigger",
"variable",
"value"
],
"additionalProperties": false
},
"maxItems": 100
}
},
"required": [
"id",
"code",
"name",
"eventType",
"optimizationEvent",
"deprecated",
"statisticType",
"currency",
"currencyValue",
"rules"
],
"additionalProperties": false
},
"maxItems": 1000
},
"customConversion": {
"anyOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^\\d+$"
},
"name": {
"type": "string",
"maxLength": 2000
},
"description": {
"type": "string",
"maxLength": 2000
},
"eventSourceType": {
"type": "string",
"const": "PIXEL"
},
"eventSourceId": {
"type": "string",
"pattern": "^\\d+$"
},
"optimizationEvent": {
"type": "string",
"maxLength": 2000
},
"rules": {
"type": "array",
"items": {
"type": "object",
"properties": {
"parameter": {
"type": "string",
"maxLength": 2000
},
"operator": {
"type": "string",
"maxLength": 2000
},
"values": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string",
"maxLength": 100
},
"minItems": 1,
"maxItems": 100
},
{
"type": "number",
"minimum": 0,
"maximum": 1000000000
}
]
}
},
"required": [
"parameter",
"operator",
"values"
],
"additionalProperties": false
},
"minItems": 1,
"maxItems": 100
},
"createdAt": {
"anyOf": [
{
"type": "string",
"maxLength": 2000
},
{
"type": "null"
}
]
},
"updatedAt": {
"anyOf": [
{
"type": "string",
"maxLength": 2000
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"name",
"description",
"eventSourceType",
"eventSourceId",
"optimizationEvent",
"rules",
"createdAt",
"updatedAt"
],
"additionalProperties": false
},
{
"type": "null"
}
]
}
},
"required": [
"provider",
"pixel",
"optimizationEvent",
"events",
"customConversion"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"provider": {
"type": "string",
"const": "meta-ads"
},
"accountBusinessId": {
"anyOf": [
{
"type": "string",
"pattern": "^\\d+$"
},
{
"type": "null"
}
]
},
"pixel": {
"anyOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^\\d+$"
},
"name": {
"type": "string",
"maxLength": 2000
},
"ownerAdAccountId": {
"anyOf": [
{
"type": "string",
"pattern": "^\\d+$"
},
{
"type": "null"
}
]
},
"ownerBusinessId": {
"anyOf": [
{
"type": "string",
"pattern": "^\\d+$"
},
{
"type": "null"
}
]
},
"ownership": {
"type": "string",
"enum": [
"ad-account",
"business",
"shared",
"unknown"
]
},
"automaticMatchingFields": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string",
"maxLength": 2000
},
"maxItems": 100
},
{
"type": "null"
}
]
},
"automaticMatchingEnabled": {
"type": [
"boolean",
"null"
]
},
"firstPartyCookieStatus": {
"anyOf": [
{
"type": "string",
"maxLength": 2000
},
{
"type": "null"
}
]
},
"dataUseSetting": {
"anyOf": [
{
"type": "string",
"maxLength": 2000
},
{
"type": "null"
}
]
},
"unavailable": {
"type": [
"boolean",
"null"
]
},
"restrictedToLift": {
"type": [
"boolean",
"null"
]
},
"restrictedToMta": {
"type": [
"boolean",
"null"
]
},
"containsCrmSource": {
"type": [
"boolean",
"null"
]
},
"consolidatedContainer": {
"type": [
"boolean",
"null"
]
},
"configuration": {
"anyOf": [
{
"type": "string",
"maxLength": 50000
},
{
"type": "null"
}
]
},
"autoAssignToAccounts": {
"type": [
"boolean",
"null"
]
}
},
"required": [
"id",
"name",
"ownerAdAccountId",
"ownerBusinessId",
"ownership",
"automaticMatchingFields",
"automaticMatchingEnabled",
"firstPartyCookieStatus",
"dataUseSetting",
"unavailable",
"restrictedToLift",
"restrictedToMta",
"containsCrmSource",
"consolidatedContainer",
"configuration",
"autoAssignToAccounts"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"customConversion": {
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^\\d+$"
},
"accountId": {
"type": "string",
"pattern": "^\\d+$"
},
"businessId": {
"anyOf": [
{
"type": "string",
"pattern": "^\\d+$"
},
{
"type": "null"
}
]
},
"name": {
"type": "string",
"maxLength": 2000
},
"description": {
"anyOf": [
{
"type": "string",
"maxLength": 2000
},
{
"type": "null"
}
]
},
"pixelId": {
"anyOf": [
{
"type": "string",
"pattern": "^\\d+$"
},
{
"type": "null"
}
]
},
"eventSourceId": {
"anyOf": [
{
"type": "string",
"pattern": "^\\d+$"
},
{
"type": "null"
}
]
},
"eventSourceType": {
"anyOf": [
{
"type": "string",
"maxLength": 2000
},
{
"type": "null"
}
]
},
"actionSourceType": {
"anyOf": [
{
"type": "string",
"maxLength": 2000
},
{
"type": "null"
}
]
},
"dataSources": {
"anyOf": [
{
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^\\d+$"
},
"name": {
"anyOf": [
{
"type": "string",
"maxLength": 2000
},
{
"type": "null"
}
]
},
"sourceType": {
"anyOf": [
{
"type": "string",
"maxLength": 2000
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"name",
"sourceType"
],
"additionalProperties": false
},
"maxItems": 100
},
{
"type": "null"
}
]
},
"eventCategory": {
"type": "string",
"maxLength": 2000
},
"rule": {
"anyOf": [
{
"type": "string",
"maxLength": 50000
},
{
"type": "null"
}
]
},
"advancedRule": {
"anyOf": [
{
"type": "string",
"maxLength": 50000
},
{
"type": "null"
}
]
},
"aggregationRule": {
"anyOf": [
{
"type": "string",
"maxLength": 50000
},
{
"type": "null"
}
]
},
"retentionDays": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"defaultConversionValue": {
"anyOf": [
{
"type": "string",
"maxLength": 2000
},
{
"type": "null"
}
]
},
"createdAt": {
"anyOf": [
{
"type": "string",
"maxLength": 2000
},
{
"type": "null"
}
]
},
"archived": {
"type": [
"boolean",
"null"
]
},
"unavailable": {
"type": [
"boolean",
"null"
]
},
"offlineDataSetId": {
"anyOf": [
{
"type": "string",
"pattern": "^\\d+$"
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"accountId",
"businessId",
"name",
"description",
"pixelId",
"eventSourceId",
"eventSourceType",
"actionSourceType",
"dataSources",
"eventCategory",
"rule",
"advancedRule",
"aggregationRule",
"retentionDays",
"defaultConversionValue",
"createdAt",
"archived",
"unavailable",
"offlineDataSetId"
],
"additionalProperties": false
}
},
"required": [
"provider",
"accountBusinessId",
"pixel",
"customConversion"
],
"additionalProperties": false
}
]
},
"definitionDigest": {
"type": "string",
"pattern": "^[a-f0-9]{64}$"
},
"availability": {
"type": "string",
"enum": [
"available",
"unavailable"
]
},
"blockers": {
"type": "array",
"items": {
"type": "string",
"minLength": 1
},
"maxItems": 100
},
"activity": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"unknown",
"active",
"inactive"
]
},
"detail": {
"type": "string",
"minLength": 1
}
},
"required": [
"status",
"detail"
],
"additionalProperties": false
},
"evidenceSource": {
"type": "string",
"enum": [
"provider-read",
"sandbox"
]
}
},
"required": [
"adapterKey",
"providerAccountRef",
"goalRef",
"name",
"definition",
"definitionDigest",
"availability",
"blockers",
"activity",
"evidenceSource"
],
"additionalProperties": false
},
"observedAt": {
"type": "string",
"format": "date-time"
},
"evidenceSource": {
"type": "string",
"enum": [
"provider-read",
"sandbox"
]
},
"tiktokSettings": {
"type": "object",
"properties": {
"clickAttributionWindow": {
"type": "string",
"enum": [
"ONE_DAY",
"SEVEN_DAYS",
"FOURTEEN_DAYS",
"TWENTY_EIGHT_DAYS"
]
},
"viewAttributionWindow": {
"type": "string",
"enum": [
"OFF",
"ONE_DAY",
"SEVEN_DAYS"
]
},
"attributionEventCount": {
"type": "string",
"enum": [
"ONCE",
"EVERY"
]
}
},
"required": [
"clickAttributionWindow",
"viewAttributionWindow",
"attributionEventCount"
],
"additionalProperties": false
},
"metaSettings": {
"type": "object",
"properties": {
"clickAttributionWindow": {
"type": "string",
"enum": [
"ONE_DAY",
"SEVEN_DAYS"
]
},
"viewAttributionWindow": {
"type": "string",
"enum": [
"OFF",
"ONE_DAY"
]
},
"attributionCountType": {
"type": "string",
"enum": [
"ALL_CONVERSIONS",
"FIRST_CONVERSION"
]
}
},
"required": [
"clickAttributionWindow",
"viewAttributionWindow",
"attributionCountType"
],
"additionalProperties": false
}
},
"required": [
"id",
"revision",
"channelCampaignId",
"connectionConfigurationRevision",
"approvedObjectiveDigest",
"providerAccountRef",
"goal",
"observedAt",
"evidenceSource"
],
"additionalProperties": false
}
},
"required": [
"campaign"
],
"additionalProperties": false
},
"creativeRefs": {
"type": "array",
"items": {
"type": "object",
"properties": {
"creativeId": {
"type": "string",
"minLength": 1
},
"externalCreativeRef": {
"type": "string",
"minLength": 1
}
},
"required": [
"creativeId",
"externalCreativeRef"
],
"additionalProperties": false
},
"minItems": 1,
"maxItems": 100
},
"note": {
"type": "string",
"maxLength": 500
}
},
"required": [
"outcome"
],
"additionalProperties": false
}
}
}
},
"responses": {
"400": {
"description": "Invalid request or unsupported fields",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Missing or invalid authentication",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Permission or product scope refused",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Route or tenant-scoped resource not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "State, revision, approval, funding or idempotency conflict",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"422": {
"description": "Supplier configuration, capability or upstream refusal",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Rate limit reached; wait before retrying",
"headers": {
"x-ratelimit-limit": {
"description": "Maximum requests permitted in the current rate-limit window.",
"schema": {
"type": "integer"
}
},
"x-ratelimit-remaining": {
"description": "Requests remaining in the current window.",
"schema": {
"type": "integer"
}
},
"x-ratelimit-reset": {
"description": "Seconds until the current rate-limit window resets.",
"schema": {
"type": "integer"
}
},
"retry-after": {
"description": "Minimum seconds to wait before retrying.",
"schema": {
"type": "integer"
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"500": {
"description": "Internal error; inspect state before retrying a mutation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Dependency or authentication verifier unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"2XX": {
"description": "Successful response. Response schema completeness: unmodeled. The request contract is complete; nested service payloads are not yet fully modeled in OpenAPI. Inspect returned fields before generating a typed SDK.",
"headers": {
"x-ratelimit-limit": {
"description": "Maximum requests permitted in the current rate-limit window.",
"schema": {
"type": "integer"
}
},
"x-ratelimit-remaining": {
"description": "Requests remaining in the current window.",
"schema": {
"type": "integer"
}
},
"x-ratelimit-reset": {
"description": "Seconds until the current rate-limit window resets.",
"schema": {
"type": "integer"
}
}
},
"content": {
"application/json": {
"schema": {}
}
}
}
},
"x-response-schema-completeness": "unmodeled",
"x-rate-limit": {
"requests": 300,
"windowMilliseconds": 60000,
"key": "request IP",
"headers": [
"x-ratelimit-limit",
"x-ratelimit-remaining",
"x-ratelimit-reset"
]
},
"x-idempotency": {
"policy": "not-generalized",
"note": "There is no universal Idempotency-Key middleware. Only the documented endpoint mechanisms protect retries."
},
"x-human-only": true,
"x-required-human-permissions": [
"operator:reconcile"
]
}