Advertising
Ads actions apply
Consume the exact reviewed single-use advertising token. Reuse the returned action ID for status after an uncertain response; never create a replacement mutation.
POST /advertising-api/actions/applyContract reviewed: · sha256:9aedef8d43dd4514
Overview
Consume the exact reviewed single-use advertising token. Reuse the returned action ID for status after an uncertain response; never create a replacement mutation.
A successful HTTP response can mean that a request was accepted rather than completed. For background work, save the returned ID and check the same operation until it finishes. A scheduled or accepted post is published only when the platform confirms it; a client timeout does not establish the result.
Authentication and permissions
A token can use only the rights held by its owner. Each request checks workspace membership, resource ownership, selected workspaces and granted capabilities. Core and full profiles change which tools are displayed; they do not grant access.
Request fields
Required means required inside its parent object and selected branch. A required child does not make an optional parent required. Rules and field names below are copied from the contract.
| Field / branch | Type / required | Constraints |
|---|---|---|
$ | objectRequired in parent |
|
workspace_id | stringRequired in parent |
|
prepare_token | stringRequired in parent |
|
reviewed_digest | stringRequired in parent |
|
Complete JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"workspace_id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"prepare_token": {
"type": "string",
"minLength": 32,
"maxLength": 128
},
"reviewed_digest": {
"type": "string",
"pattern": "^[a-f0-9]{64}$"
}
},
"required": [
"workspace_id",
"prepare_token",
"reviewed_digest"
],
"additionalProperties": false
}Response and completion
Success HTTP statuses: 200. When the operation is complete: terminal provider receipt.
A successful HTTP response can mean that a request was accepted rather than completed. For background work, save the returned ID and check the same operation until it finishes. A scheduled or accepted post is published only when the platform confirms it; a client timeout does not establish the result.
Required means required inside its parent object and selected branch. A required child does not make an optional parent required. Rules and field names below are copied from the contract.
| Field / branch | Type / required | Constraints |
|---|---|---|
$ | objectRequired in parent | — |
contract_version | stringRequired in parent |
|
action | objectRequired in parent | — |
action.id | stringRequired in parent |
|
action.workspace_id | stringRequired in parent |
|
action.advertising_account_id | stringRequired in parent |
|
action.mutation_id | stringRequired in parent |
|
action.status | stringRequired in parent |
|
action.command | objectRequired in parent | — |
action.commandoneOf 1 | objectRequired in parent | — |
action.command.operationoneOf 1 | stringRequired in parent |
|
action.command.nameoneOf 1 | stringRequired in parent |
|
action.command.budgetoneOf 1 | objectOptional / item | — |
action.command.budget.kindoneOf 1 | stringRequired in parent |
|
action.command.budget.amount_minoroneOf 1 | stringRequired in parent |
|
action.command.objectiveoneOf 1 | stringRequired in parent |
|
action.command.special_ad_categoriesoneOf 1 | arrayRequired in parent |
|
action.command.special_ad_categories[]oneOf 1 | stringOptional / item |
|
action.command.statusoneOf 1 | stringRequired in parent |
|
action.commandoneOf 2 | objectRequired in parent | — |
action.command.operationoneOf 2 | stringRequired in parent |
|
action.command.object_idoneOf 2 | stringRequired in parent |
|
action.command.nameoneOf 2 | stringOptional / item |
|
action.command.budgetoneOf 2 | objectOptional / item | — |
action.command.budget.kindoneOf 2 | stringRequired in parent |
|
action.command.budget.amount_minoroneOf 2 | stringRequired in parent |
|
action.command.statusoneOf 2 | stringOptional / item |
|
action.commandoneOf 3 | objectRequired in parent | — |
action.command.operationoneOf 3 | stringRequired in parent |
|
action.command.campaign_idoneOf 3 | stringRequired in parent |
|
action.command.nameoneOf 3 | stringRequired in parent |
|
action.command.budgetoneOf 3 | objectOptional / item | — |
action.command.budget.kindoneOf 3 | stringRequired in parent |
|
action.command.budget.amount_minoroneOf 3 | stringRequired in parent |
|
action.command.targetingoneOf 3 | objectRequired in parent | — |
action.command.targeting.geo_locationsoneOf 3 | objectRequired in parent | — |
action.command.targeting.geo_locations.countriesoneOf 3 | arrayRequired in parent |
|
action.command.targeting.geo_locations.countries[]oneOf 3 | stringOptional / item |
|
action.command.targeting.age_minoneOf 3 | integerRequired in parent |
|
action.command.targeting.age_maxoneOf 3 | integerRequired in parent |
|
action.command.targeting.gendersoneOf 3 | arrayOptional / item |
|
action.command.targeting.genders[]oneOf 3 | numberOptional / item | — |
action.command.targeting.genders[]oneOf 3 / anyOf 1 | numberOptional / item |
|
action.command.targeting.genders[]oneOf 3 / anyOf 2 | numberOptional / item |
|
action.command.targeting.localesoneOf 3 | arrayOptional / item |
|
action.command.targeting.locales[]oneOf 3 | integerOptional / item |
|
action.command.targeting.publisher_platformsoneOf 3 | arrayRequired in parent |
|
action.command.targeting.publisher_platforms[]oneOf 3 | stringOptional / item |
|
action.command.targeting.facebook_positionsoneOf 3 | arrayOptional / item |
|
action.command.targeting.facebook_positions[]oneOf 3 | stringOptional / item |
|
action.command.targeting.instagram_positionsoneOf 3 | arrayOptional / item |
|
action.command.targeting.instagram_positions[]oneOf 3 | stringOptional / item |
|
action.command.targeting.threads_positionsoneOf 3 | arrayOptional / item |
|
action.command.targeting.threads_positions[]oneOf 3 | stringOptional / item |
|
action.command.targeting.custom_audience_idsoneOf 3 | arrayOptional / item |
|
action.command.targeting.custom_audience_ids[]oneOf 3 | stringOptional / item |
|
action.command.targeting.excluded_custom_audience_idsoneOf 3 | arrayOptional / item |
|
action.command.targeting.excluded_custom_audience_ids[]oneOf 3 | stringOptional / item |
|
action.command.billing_eventoneOf 3 | stringRequired in parent |
|
action.command.optimization_goaloneOf 3 | stringRequired in parent |
|
action.command.bid_strategyoneOf 3 | stringRequired in parent |
|
action.command.start_timeoneOf 3 | stringOptional / item |
|
action.command.end_timeoneOf 3 | stringOptional / item |
|
action.command.promoted_objectoneOf 3 | objectOptional / item | — |
action.command.promoted_object.page_idoneOf 3 | stringOptional / item |
|
action.command.promoted_object.pixel_idoneOf 3 | stringOptional / item |
|
action.command.promoted_object.custom_event_typeoneOf 3 | stringOptional / item |
|
action.command.statusoneOf 3 | stringRequired in parent |
|
action.commandoneOf 4 | objectRequired in parent | — |
action.command.operationoneOf 4 | stringRequired in parent |
|
action.command.object_idoneOf 4 | stringRequired in parent |
|
action.command.nameoneOf 4 | stringOptional / item |
|
action.command.budgetoneOf 4 | objectOptional / item | — |
action.command.budget.kindoneOf 4 | stringRequired in parent |
|
action.command.budget.amount_minoroneOf 4 | stringRequired in parent |
|
action.command.statusoneOf 4 | stringOptional / item |
|
action.command.targetingoneOf 4 | objectOptional / item | — |
action.command.targeting.geo_locationsoneOf 4 | objectRequired in parent | — |
action.command.targeting.geo_locations.countriesoneOf 4 | arrayRequired in parent |
|
action.command.targeting.geo_locations.countries[]oneOf 4 | stringOptional / item |
|
action.command.targeting.age_minoneOf 4 | integerRequired in parent |
|
action.command.targeting.age_maxoneOf 4 | integerRequired in parent |
|
action.command.targeting.gendersoneOf 4 | arrayOptional / item |
|
action.command.targeting.genders[]oneOf 4 | numberOptional / item | — |
action.command.targeting.genders[]oneOf 4 / anyOf 1 | numberOptional / item |
|
action.command.targeting.genders[]oneOf 4 / anyOf 2 | numberOptional / item |
|
action.command.targeting.localesoneOf 4 | arrayOptional / item |
|
action.command.targeting.locales[]oneOf 4 | integerOptional / item |
|
action.command.targeting.publisher_platformsoneOf 4 | arrayRequired in parent |
|
action.command.targeting.publisher_platforms[]oneOf 4 | stringOptional / item |
|
action.command.targeting.facebook_positionsoneOf 4 | arrayOptional / item |
|
action.command.targeting.facebook_positions[]oneOf 4 | stringOptional / item |
|
action.command.targeting.instagram_positionsoneOf 4 | arrayOptional / item |
|
action.command.targeting.instagram_positions[]oneOf 4 | stringOptional / item |
|
action.command.targeting.threads_positionsoneOf 4 | arrayOptional / item |
|
action.command.targeting.threads_positions[]oneOf 4 | stringOptional / item |
|
action.command.targeting.custom_audience_idsoneOf 4 | arrayOptional / item |
|
action.command.targeting.custom_audience_ids[]oneOf 4 | stringOptional / item |
|
action.command.targeting.excluded_custom_audience_idsoneOf 4 | arrayOptional / item |
|
action.command.targeting.excluded_custom_audience_ids[]oneOf 4 | stringOptional / item |
|
action.command.start_timeoneOf 4 | stringOptional / item |
|
action.command.end_timeoneOf 4 | stringOptional / item |
|
action.commandoneOf 5 | objectRequired in parent | — |
action.command.operationoneOf 5 | stringRequired in parent |
|
action.command.nameoneOf 5 | stringRequired in parent |
|
action.command.adset_idoneOf 5 | stringRequired in parent |
|
action.command.creative_idoneOf 5 | stringRequired in parent |
|
action.command.statusoneOf 5 | stringRequired in parent |
|
action.commandoneOf 6 | objectRequired in parent | — |
action.command.operationoneOf 6 | stringRequired in parent |
|
action.command.object_idoneOf 6 | stringRequired in parent |
|
action.command.nameoneOf 6 | stringOptional / item |
|
action.command.creative_idoneOf 6 | stringOptional / item |
|
action.command.statusoneOf 6 | stringOptional / item |
|
action.commandoneOf 7 | objectRequired in parent | — |
action.command.operationoneOf 7 | stringRequired in parent |
|
action.command.nameoneOf 7 | stringRequired in parent |
|
action.command.object_story_speconeOf 7 | objectOptional / item | — |
action.command.object_story_spec.page_idoneOf 7 | stringRequired in parent |
|
action.command.object_story_spec.instagram_user_idoneOf 7 | stringOptional / item |
|
action.command.object_story_spec.link_dataoneOf 7 | objectRequired in parent | — |
action.command.object_story_spec.link_data.linkoneOf 7 | stringRequired in parent |
|
action.command.object_story_spec.link_data.messageoneOf 7 | stringRequired in parent |
|
action.command.object_story_spec.link_data.nameoneOf 7 | stringOptional / item |
|
action.command.object_story_spec.link_data.image_hashoneOf 7 | stringRequired in parent |
|
action.command.object_story_spec.link_data.call_to_actiononeOf 7 | stringOptional / item |
|
action.command.object_story_idoneOf 7 | stringOptional / item |
|
action.commandoneOf 8 | objectRequired in parent | — |
action.command.operationoneOf 8 | stringRequired in parent |
|
action.command.nameoneOf 8 | stringRequired in parent |
|
action.command.targetingoneOf 8 | objectRequired in parent | — |
action.command.targeting.geo_locationsoneOf 8 | objectRequired in parent | — |
action.command.targeting.geo_locations.countriesoneOf 8 | arrayRequired in parent |
|
action.command.targeting.geo_locations.countries[]oneOf 8 | stringOptional / item |
|
action.command.targeting.age_minoneOf 8 | integerRequired in parent |
|
action.command.targeting.age_maxoneOf 8 | integerRequired in parent |
|
action.command.targeting.gendersoneOf 8 | arrayOptional / item |
|
action.command.targeting.genders[]oneOf 8 | numberOptional / item | — |
action.command.targeting.genders[]oneOf 8 / anyOf 1 | numberOptional / item |
|
action.command.targeting.genders[]oneOf 8 / anyOf 2 | numberOptional / item |
|
action.command.targeting.localesoneOf 8 | arrayOptional / item |
|
action.command.targeting.locales[]oneOf 8 | integerOptional / item |
|
action.command.targeting.publisher_platformsoneOf 8 | arrayRequired in parent |
|
action.command.targeting.publisher_platforms[]oneOf 8 | stringOptional / item |
|
action.command.targeting.facebook_positionsoneOf 8 | arrayOptional / item |
|
action.command.targeting.facebook_positions[]oneOf 8 | stringOptional / item |
|
action.command.targeting.instagram_positionsoneOf 8 | arrayOptional / item |
|
action.command.targeting.instagram_positions[]oneOf 8 | stringOptional / item |
|
action.command.targeting.threads_positionsoneOf 8 | arrayOptional / item |
|
action.command.targeting.threads_positions[]oneOf 8 | stringOptional / item |
|
action.command.targeting.custom_audience_idsoneOf 8 | arrayOptional / item |
|
action.command.targeting.custom_audience_ids[]oneOf 8 | stringOptional / item |
|
action.command.targeting.excluded_custom_audience_idsoneOf 8 | arrayOptional / item |
|
action.command.targeting.excluded_custom_audience_ids[]oneOf 8 | stringOptional / item |
|
action.commandoneOf 9 | objectRequired in parent | — |
action.command.operationoneOf 9 | stringRequired in parent |
|
action.command.object_idoneOf 9 | stringRequired in parent |
|
action.command.nameoneOf 9 | stringOptional / item |
|
action.command.targetingoneOf 9 | objectOptional / item | — |
action.command.targeting.geo_locationsoneOf 9 | objectRequired in parent | — |
action.command.targeting.geo_locations.countriesoneOf 9 | arrayRequired in parent |
|
action.command.targeting.geo_locations.countries[]oneOf 9 | stringOptional / item |
|
action.command.targeting.age_minoneOf 9 | integerRequired in parent |
|
action.command.targeting.age_maxoneOf 9 | integerRequired in parent |
|
action.command.targeting.gendersoneOf 9 | arrayOptional / item |
|
action.command.targeting.genders[]oneOf 9 | numberOptional / item | — |
action.command.targeting.genders[]oneOf 9 / anyOf 1 | numberOptional / item |
|
action.command.targeting.genders[]oneOf 9 / anyOf 2 | numberOptional / item |
|
action.command.targeting.localesoneOf 9 | arrayOptional / item |
|
action.command.targeting.locales[]oneOf 9 | integerOptional / item |
|
action.command.targeting.publisher_platformsoneOf 9 | arrayRequired in parent |
|
action.command.targeting.publisher_platforms[]oneOf 9 | stringOptional / item |
|
action.command.targeting.facebook_positionsoneOf 9 | arrayOptional / item |
|
action.command.targeting.facebook_positions[]oneOf 9 | stringOptional / item |
|
action.command.targeting.instagram_positionsoneOf 9 | arrayOptional / item |
|
action.command.targeting.instagram_positions[]oneOf 9 | stringOptional / item |
|
action.command.targeting.threads_positionsoneOf 9 | arrayOptional / item |
|
action.command.targeting.threads_positions[]oneOf 9 | stringOptional / item |
|
action.command.targeting.custom_audience_idsoneOf 9 | arrayOptional / item |
|
action.command.targeting.custom_audience_ids[]oneOf 9 | stringOptional / item |
|
action.command.targeting.excluded_custom_audience_idsoneOf 9 | arrayOptional / item |
|
action.command.targeting.excluded_custom_audience_ids[]oneOf 9 | stringOptional / item |
|
action.reviewed_digest | stringRequired in parent |
|
action.effects | objectRequired in parent | — |
action.effects.creates_object | booleanRequired in parent | — |
action.effects.initial_status | string | nullRequired in parent | — |
action.effects.initial_statusanyOf 1 | stringRequired in parent |
|
action.effects.initial_statusanyOf 2 | nullRequired in parent | — |
action.effects.activates_delivery | booleanRequired in parent | — |
action.effects.changes_budget | booleanRequired in parent | — |
action.effects.changes_audience | booleanRequired in parent | — |
action.effects.changes_creative | booleanRequired in parent | — |
action.effects.currency | stringRequired in parent |
|
action.effects.timezone | stringRequired in parent |
|
action.effects.budget | object | nullRequired in parent | — |
action.effects.budgetanyOf 1 | objectRequired in parent | — |
action.effects.budget.kindanyOf 1 | stringRequired in parent |
|
action.effects.budget.amount_minoranyOf 1 | stringRequired in parent |
|
action.effects.budgetanyOf 2 | nullRequired in parent | — |
action.live_approval | objectRequired in parent | — |
action.live_approval.required | booleanRequired in parent | — |
action.live_approval.state | stringRequired in parent |
|
action.live_approval.reason | string | nullRequired in parent | — |
action.live_approval.reasonanyOf 1 | stringRequired in parent |
|
action.live_approval.reasonanyOf 2 | nullRequired in parent | — |
action.live_approval.expires_at | string | nullRequired in parent | — |
action.live_approval.expires_atanyOf 1 | stringRequired in parent |
|
action.live_approval.expires_atanyOf 2 | nullRequired in parent | — |
action.live_approval.approved_by | string | nullRequired in parent | — |
action.live_approval.approved_byanyOf 1 | stringRequired in parent |
|
action.live_approval.approved_byanyOf 2 | nullRequired in parent | — |
action.provider_object_id | string | nullRequired in parent | — |
action.provider_object_idanyOf 1 | stringRequired in parent |
|
action.provider_object_idanyOf 2 | nullRequired in parent | — |
action.failure_code | string | nullRequired in parent | — |
action.failure_codeanyOf 1 | stringRequired in parent |
|
action.failure_codeanyOf 2 | nullRequired in parent | — |
action.created_at | stringRequired in parent |
|
action.completed_at | string | nullRequired in parent | — |
action.completed_atanyOf 1 | stringRequired in parent |
|
action.completed_atanyOf 2 | nullRequired in parent | — |
replayed | booleanRequired in parent | — |
Complete JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"contract_version": {
"type": "string",
"const": "advertising/v1"
},
"action": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"workspace_id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"advertising_account_id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"mutation_id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"status": {
"type": "string",
"enum": [
"prepared",
"queued",
"processing",
"succeeded",
"failed",
"unknown",
"cancelled"
]
},
"command": {
"oneOf": [
{
"type": "object",
"properties": {
"operation": {
"type": "string",
"const": "create_campaign"
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"budget": {
"type": "object",
"properties": {
"kind": {
"type": "string",
"enum": [
"daily",
"lifetime"
]
},
"amount_minor": {
"type": "string",
"pattern": "^[1-9]\\d{0,11}$"
}
},
"required": [
"kind",
"amount_minor"
]
},
"objective": {
"type": "string",
"enum": [
"OUTCOME_AWARENESS",
"OUTCOME_ENGAGEMENT",
"OUTCOME_LEADS",
"OUTCOME_SALES",
"OUTCOME_TRAFFIC",
"OUTCOME_APP_PROMOTION"
]
},
"special_ad_categories": {
"default": [],
"maxItems": 4,
"type": "array",
"items": {
"type": "string",
"enum": [
"CREDIT",
"EMPLOYMENT",
"HOUSING",
"ISSUES_ELECTIONS_POLITICS"
]
}
},
"status": {
"default": "PAUSED",
"type": "string",
"const": "PAUSED"
}
},
"required": [
"operation",
"name",
"objective",
"special_ad_categories",
"status"
]
},
{
"type": "object",
"properties": {
"operation": {
"type": "string",
"const": "update_campaign"
},
"object_id": {
"type": "string",
"pattern": "^[1-9]\\d{1,24}$"
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"budget": {
"type": "object",
"properties": {
"kind": {
"type": "string",
"enum": [
"daily",
"lifetime"
]
},
"amount_minor": {
"type": "string",
"pattern": "^[1-9]\\d{0,11}$"
}
},
"required": [
"kind",
"amount_minor"
]
},
"status": {
"type": "string",
"enum": [
"ACTIVE",
"PAUSED",
"ARCHIVED"
]
}
},
"required": [
"operation",
"object_id"
]
},
{
"type": "object",
"properties": {
"operation": {
"type": "string",
"const": "create_adset"
},
"campaign_id": {
"type": "string",
"pattern": "^[1-9]\\d{1,24}$"
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"budget": {
"type": "object",
"properties": {
"kind": {
"type": "string",
"enum": [
"daily",
"lifetime"
]
},
"amount_minor": {
"type": "string",
"pattern": "^[1-9]\\d{0,11}$"
}
},
"required": [
"kind",
"amount_minor"
]
},
"targeting": {
"type": "object",
"properties": {
"geo_locations": {
"type": "object",
"properties": {
"countries": {
"minItems": 1,
"maxItems": 25,
"type": "array",
"items": {
"type": "string",
"pattern": "^[A-Z]{2}$"
}
}
},
"required": [
"countries"
]
},
"age_min": {
"default": 18,
"type": "integer",
"minimum": 18,
"maximum": 65
},
"age_max": {
"default": 65,
"type": "integer",
"minimum": 18,
"maximum": 65
},
"genders": {
"minItems": 1,
"maxItems": 2,
"type": "array",
"items": {
"anyOf": [
{
"type": "number",
"const": 1
},
{
"type": "number",
"const": 2
}
]
}
},
"locales": {
"maxItems": 25,
"type": "array",
"items": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
}
},
"publisher_platforms": {
"minItems": 1,
"maxItems": 3,
"type": "array",
"items": {
"type": "string",
"enum": [
"facebook",
"instagram",
"threads"
]
}
},
"facebook_positions": {
"maxItems": 4,
"type": "array",
"items": {
"type": "string",
"enum": [
"feed",
"story",
"facebook_reels",
"video_feeds"
]
}
},
"instagram_positions": {
"maxItems": 4,
"type": "array",
"items": {
"type": "string",
"enum": [
"stream",
"story",
"reels",
"explore"
]
}
},
"threads_positions": {
"maxItems": 1,
"type": "array",
"items": {
"type": "string",
"const": "threads_stream"
}
},
"custom_audience_ids": {
"maxItems": 4,
"type": "array",
"items": {
"type": "string",
"pattern": "^[1-9]\\d{1,24}$"
}
},
"excluded_custom_audience_ids": {
"maxItems": 4,
"type": "array",
"items": {
"type": "string",
"pattern": "^[1-9]\\d{1,24}$"
}
}
},
"required": [
"geo_locations",
"age_min",
"age_max",
"publisher_platforms"
]
},
"billing_event": {
"type": "string",
"enum": [
"IMPRESSIONS",
"LINK_CLICKS"
]
},
"optimization_goal": {
"type": "string",
"enum": [
"REACH",
"IMPRESSIONS",
"LINK_CLICKS",
"LANDING_PAGE_VIEWS",
"OFFSITE_CONVERSIONS",
"LEAD_GENERATION"
]
},
"bid_strategy": {
"default": "LOWEST_COST_WITHOUT_CAP",
"type": "string",
"const": "LOWEST_COST_WITHOUT_CAP"
},
"start_time": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"end_time": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"promoted_object": {
"type": "object",
"properties": {
"page_id": {
"type": "string",
"pattern": "^[1-9]\\d{1,24}$"
},
"pixel_id": {
"type": "string",
"pattern": "^[1-9]\\d{1,24}$"
},
"custom_event_type": {
"type": "string",
"enum": [
"PURCHASE",
"LEAD",
"COMPLETE_REGISTRATION",
"ADD_TO_CART"
]
}
}
},
"status": {
"default": "PAUSED",
"type": "string",
"const": "PAUSED"
}
},
"required": [
"operation",
"campaign_id",
"name",
"targeting",
"billing_event",
"optimization_goal",
"bid_strategy",
"status"
]
},
{
"type": "object",
"properties": {
"operation": {
"type": "string",
"const": "update_adset"
},
"object_id": {
"type": "string",
"pattern": "^[1-9]\\d{1,24}$"
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"budget": {
"type": "object",
"properties": {
"kind": {
"type": "string",
"enum": [
"daily",
"lifetime"
]
},
"amount_minor": {
"type": "string",
"pattern": "^[1-9]\\d{0,11}$"
}
},
"required": [
"kind",
"amount_minor"
]
},
"status": {
"type": "string",
"enum": [
"ACTIVE",
"PAUSED",
"ARCHIVED"
]
},
"targeting": {
"type": "object",
"properties": {
"geo_locations": {
"type": "object",
"properties": {
"countries": {
"minItems": 1,
"maxItems": 25,
"type": "array",
"items": {
"type": "string",
"pattern": "^[A-Z]{2}$"
}
}
},
"required": [
"countries"
]
},
"age_min": {
"default": 18,
"type": "integer",
"minimum": 18,
"maximum": 65
},
"age_max": {
"default": 65,
"type": "integer",
"minimum": 18,
"maximum": 65
},
"genders": {
"minItems": 1,
"maxItems": 2,
"type": "array",
"items": {
"anyOf": [
{
"type": "number",
"const": 1
},
{
"type": "number",
"const": 2
}
]
}
},
"locales": {
"maxItems": 25,
"type": "array",
"items": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
}
},
"publisher_platforms": {
"minItems": 1,
"maxItems": 3,
"type": "array",
"items": {
"type": "string",
"enum": [
"facebook",
"instagram",
"threads"
]
}
},
"facebook_positions": {
"maxItems": 4,
"type": "array",
"items": {
"type": "string",
"enum": [
"feed",
"story",
"facebook_reels",
"video_feeds"
]
}
},
"instagram_positions": {
"maxItems": 4,
"type": "array",
"items": {
"type": "string",
"enum": [
"stream",
"story",
"reels",
"explore"
]
}
},
"threads_positions": {
"maxItems": 1,
"type": "array",
"items": {
"type": "string",
"const": "threads_stream"
}
},
"custom_audience_ids": {
"maxItems": 4,
"type": "array",
"items": {
"type": "string",
"pattern": "^[1-9]\\d{1,24}$"
}
},
"excluded_custom_audience_ids": {
"maxItems": 4,
"type": "array",
"items": {
"type": "string",
"pattern": "^[1-9]\\d{1,24}$"
}
}
},
"required": [
"geo_locations",
"age_min",
"age_max",
"publisher_platforms"
]
},
"start_time": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"end_time": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
}
},
"required": [
"operation",
"object_id"
]
},
{
"type": "object",
"properties": {
"operation": {
"type": "string",
"const": "create_ad"
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"adset_id": {
"type": "string",
"pattern": "^[1-9]\\d{1,24}$"
},
"creative_id": {
"type": "string",
"pattern": "^[1-9]\\d{1,24}$"
},
"status": {
"default": "PAUSED",
"type": "string",
"const": "PAUSED"
}
},
"required": [
"operation",
"name",
"adset_id",
"creative_id",
"status"
]
},
{
"type": "object",
"properties": {
"operation": {
"type": "string",
"const": "update_ad"
},
"object_id": {
"type": "string",
"pattern": "^[1-9]\\d{1,24}$"
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"creative_id": {
"type": "string",
"pattern": "^[1-9]\\d{1,24}$"
},
"status": {
"type": "string",
"enum": [
"ACTIVE",
"PAUSED",
"ARCHIVED"
]
}
},
"required": [
"operation",
"object_id"
]
},
{
"type": "object",
"properties": {
"operation": {
"type": "string",
"const": "create_creative"
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"object_story_spec": {
"type": "object",
"properties": {
"page_id": {
"type": "string",
"pattern": "^[1-9]\\d{1,24}$"
},
"instagram_user_id": {
"type": "string",
"pattern": "^[1-9]\\d{1,24}$"
},
"link_data": {
"type": "object",
"properties": {
"link": {
"type": "string",
"maxLength": 2048,
"format": "uri"
},
"message": {
"type": "string",
"maxLength": 5000
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"image_hash": {
"type": "string",
"pattern": "^[a-fA-F0-9]{16,128}$"
},
"call_to_action": {
"type": "string",
"enum": [
"LEARN_MORE",
"SHOP_NOW",
"SIGN_UP",
"CONTACT_US"
]
}
},
"required": [
"link",
"message",
"image_hash"
]
}
},
"required": [
"page_id",
"link_data"
]
},
"object_story_id": {
"type": "string",
"pattern": "^[1-9]\\d{1,24}_[1-9]\\d{1,24}$"
}
},
"required": [
"operation",
"name"
]
},
{
"type": "object",
"properties": {
"operation": {
"type": "string",
"const": "create_saved_audience"
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"targeting": {
"type": "object",
"properties": {
"geo_locations": {
"type": "object",
"properties": {
"countries": {
"minItems": 1,
"maxItems": 25,
"type": "array",
"items": {
"type": "string",
"pattern": "^[A-Z]{2}$"
}
}
},
"required": [
"countries"
]
},
"age_min": {
"default": 18,
"type": "integer",
"minimum": 18,
"maximum": 65
},
"age_max": {
"default": 65,
"type": "integer",
"minimum": 18,
"maximum": 65
},
"genders": {
"minItems": 1,
"maxItems": 2,
"type": "array",
"items": {
"anyOf": [
{
"type": "number",
"const": 1
},
{
"type": "number",
"const": 2
}
]
}
},
"locales": {
"maxItems": 25,
"type": "array",
"items": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
}
},
"publisher_platforms": {
"minItems": 1,
"maxItems": 3,
"type": "array",
"items": {
"type": "string",
"enum": [
"facebook",
"instagram",
"threads"
]
}
},
"facebook_positions": {
"maxItems": 4,
"type": "array",
"items": {
"type": "string",
"enum": [
"feed",
"story",
"facebook_reels",
"video_feeds"
]
}
},
"instagram_positions": {
"maxItems": 4,
"type": "array",
"items": {
"type": "string",
"enum": [
"stream",
"story",
"reels",
"explore"
]
}
},
"threads_positions": {
"maxItems": 1,
"type": "array",
"items": {
"type": "string",
"const": "threads_stream"
}
},
"custom_audience_ids": {
"maxItems": 4,
"type": "array",
"items": {
"type": "string",
"pattern": "^[1-9]\\d{1,24}$"
}
},
"excluded_custom_audience_ids": {
"maxItems": 4,
"type": "array",
"items": {
"type": "string",
"pattern": "^[1-9]\\d{1,24}$"
}
}
},
"required": [
"geo_locations",
"age_min",
"age_max",
"publisher_platforms"
]
}
},
"required": [
"operation",
"name",
"targeting"
]
},
{
"type": "object",
"properties": {
"operation": {
"type": "string",
"const": "update_saved_audience"
},
"object_id": {
"type": "string",
"pattern": "^[1-9]\\d{1,24}$"
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"targeting": {
"type": "object",
"properties": {
"geo_locations": {
"type": "object",
"properties": {
"countries": {
"minItems": 1,
"maxItems": 25,
"type": "array",
"items": {
"type": "string",
"pattern": "^[A-Z]{2}$"
}
}
},
"required": [
"countries"
]
},
"age_min": {
"default": 18,
"type": "integer",
"minimum": 18,
"maximum": 65
},
"age_max": {
"default": 65,
"type": "integer",
"minimum": 18,
"maximum": 65
},
"genders": {
"minItems": 1,
"maxItems": 2,
"type": "array",
"items": {
"anyOf": [
{
"type": "number",
"const": 1
},
{
"type": "number",
"const": 2
}
]
}
},
"locales": {
"maxItems": 25,
"type": "array",
"items": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
}
},
"publisher_platforms": {
"minItems": 1,
"maxItems": 3,
"type": "array",
"items": {
"type": "string",
"enum": [
"facebook",
"instagram",
"threads"
]
}
},
"facebook_positions": {
"maxItems": 4,
"type": "array",
"items": {
"type": "string",
"enum": [
"feed",
"story",
"facebook_reels",
"video_feeds"
]
}
},
"instagram_positions": {
"maxItems": 4,
"type": "array",
"items": {
"type": "string",
"enum": [
"stream",
"story",
"reels",
"explore"
]
}
},
"threads_positions": {
"maxItems": 1,
"type": "array",
"items": {
"type": "string",
"const": "threads_stream"
}
},
"custom_audience_ids": {
"maxItems": 4,
"type": "array",
"items": {
"type": "string",
"pattern": "^[1-9]\\d{1,24}$"
}
},
"excluded_custom_audience_ids": {
"maxItems": 4,
"type": "array",
"items": {
"type": "string",
"pattern": "^[1-9]\\d{1,24}$"
}
}
},
"required": [
"geo_locations",
"age_min",
"age_max",
"publisher_platforms"
]
}
},
"required": [
"operation",
"object_id"
]
}
]
},
"reviewed_digest": {
"type": "string",
"pattern": "^[a-f0-9]{64}$"
},
"effects": {
"type": "object",
"properties": {
"creates_object": {
"type": "boolean"
},
"initial_status": {
"anyOf": [
{
"type": "string",
"const": "PAUSED"
},
{
"type": "null"
}
]
},
"activates_delivery": {
"type": "boolean"
},
"changes_budget": {
"type": "boolean"
},
"changes_audience": {
"type": "boolean"
},
"changes_creative": {
"type": "boolean"
},
"currency": {
"type": "string",
"pattern": "^[A-Z]{3}$"
},
"timezone": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"budget": {
"anyOf": [
{
"type": "object",
"properties": {
"kind": {
"type": "string",
"enum": [
"daily",
"lifetime"
]
},
"amount_minor": {
"type": "string",
"pattern": "^[1-9]\\d{0,11}$"
}
},
"required": [
"kind",
"amount_minor"
]
},
{
"type": "null"
}
]
}
},
"required": [
"creates_object",
"initial_status",
"activates_delivery",
"changes_budget",
"changes_audience",
"changes_creative",
"currency",
"timezone",
"budget"
]
},
"live_approval": {
"type": "object",
"properties": {
"required": {
"type": "boolean"
},
"state": {
"type": "string",
"enum": [
"not_required",
"missing",
"approved",
"expired",
"revoked",
"invalid"
]
},
"reason": {
"anyOf": [
{
"type": "string",
"maxLength": 100
},
{
"type": "null"
}
]
},
"expires_at": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
{
"type": "null"
}
]
},
"approved_by": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
{
"type": "null"
}
]
}
},
"required": [
"required",
"state",
"reason",
"expires_at",
"approved_by"
]
},
"provider_object_id": {
"anyOf": [
{
"type": "string",
"pattern": "^[1-9]\\d{1,24}$"
},
{
"type": "null"
}
]
},
"failure_code": {
"anyOf": [
{
"type": "string",
"maxLength": 100
},
{
"type": "null"
}
]
},
"created_at": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"completed_at": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"workspace_id",
"advertising_account_id",
"mutation_id",
"status",
"command",
"reviewed_digest",
"effects",
"live_approval",
"provider_object_id",
"failure_code",
"created_at",
"completed_at"
]
},
"replayed": {
"type": "boolean"
}
},
"required": [
"contract_version",
"action",
"replayed"
]
}Errors and safe retries
Check the HTTP status and response body. A 400 validation error may contain a ZodError; handler errors use error, message and code fields. Keep request_id or x-request-id for diagnosis, without credentials. Fix 401/403 access errors before retrying, and follow Retry-After for 429. If a write is uncertain or returns 5xx, read the existing result first. Reuse an idempotency key only where supported; retry behaviour varies by operation and does not guarantee exactly-once delivery.
Troubleshooting guideExamples
These examples use fictional values checked against the schemas. Replace the IDs with ones you are authorized to use, the media with ready assets and the dates with your confirmed publishing time. Check the account’s eligibility before submitting a write. This page sends no API requests.
Set SOSOAPI_ACCESS_TOKEN on your server to a credential accepted by this operation, and keep it out of browser code. For an AI Agent, use sosoapi auth login to sign in through the browser and let the CLI refresh its credentials.
request.json
{
"workspace_id": "11111111-1111-4111-8111-111111111111",
"prepare_token": "exampleaaaaaaaaaaaaaaaaaaaaaaaaa",
"reviewed_digest": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
}cURL
curl --request POST \
"https://gqeshlawtcexsapabaui.supabase.co/functions/v1/advertising-api/actions/apply" \
-H "Authorization: Bearer $SOSOAPI_ACCESS_TOKEN" \
-H "Content-Type: application/json" \
--data-binary @request.jsonJavaScript
// Server-side JavaScript. Do not print tokens or credential-bearing responses.
const token = process.env.SOSOAPI_ACCESS_TOKEN;
if (!token) throw new Error("Set an accepted credential for this operation");
const response = await fetch("https://gqeshlawtcexsapabaui.supabase.co/functions/v1/advertising-api/actions/apply", {
method: "POST",
headers: { "Content-Type": "application/json", Authorization: "Bearer " + token },
body: JSON.stringify({
"workspace_id": "11111111-1111-4111-8111-111111111111",
"prepare_token": "exampleaaaaaaaaaaaaaaaaaaaaaaaaa",
"reviewed_digest": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
})
});
const result = await response.json();
// Check response.ok, the operation-specific body and completion state before continuing.CLI
npx sosoapi api post /advertising-api/actions/apply < request.jsonSynthetic response example
{
"contract_version": "advertising/v1",
"action": {
"id": "11111111-1111-4111-8111-111111111111",
"workspace_id": "11111111-1111-4111-8111-111111111111",
"advertising_account_id": "11111111-1111-4111-8111-111111111111",
"mutation_id": "11111111-1111-4111-8111-111111111111",
"status": "prepared",
"command": {
"operation": "create_campaign",
"name": "example",
"objective": "OUTCOME_AWARENESS",
"special_ad_categories": [],
"status": "PAUSED"
},
"reviewed_digest": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
"effects": {
"creates_object": false,
"initial_status": null,
"activates_delivery": false,
"changes_budget": false,
"changes_audience": false,
"changes_creative": false,
"currency": "USD",
"timezone": "UTC",
"budget": null
},
"live_approval": {
"required": false,
"state": "not_required",
"reason": null,
"expires_at": null,
"approved_by": null
},
"provider_object_id": null,
"failure_code": null,
"created_at": "2099-01-15T09:00:00Z",
"completed_at": null
},
"replayed": false
}