Appearance
meta.ads.adset.create-paused ​
Create a Marketing API ad set with status=PAUSED only. Never sets ACTIVE (SOCIAL-004).
Overview ​
| Property | Value |
|---|---|
| Workflow type | Atomic |
| Library | App-meta-ads |
| Version | 1.0 |
Input Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
workflow_run_id | string | No | — | Parent DAG workflow run id (engine-injected when used as a step) |
organization_uuid | string | Yes | — | — |
connection_uuid | string | Yes | — | — |
ad_account_id | string | No | — | — |
campaign_id | string | Yes | — | Parent campaign id (prefer a PAUSED create-paused campaign) |
name | string | Yes | — | Ad set name |
daily_budget | integer | No | — | Daily budget in account currency minor units (default 1000) |
optimization_goal | string | No | — | Default LINK_CLICKS |
billing_event | string | No | — | Default IMPRESSIONS |
countries | json | No | — | ISO country codes for targeting (default ['BR']) |
page_id | string | No | — | Optional Facebook Page id for promoted_object (needed for many traffic creatives) |
Output Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
workflow_run_id | string | No | — | Parent DAG workflow run id (engine-injected when used as a step) |
organization_uuid | string | Yes | — | — |
connection_uuid | string | Yes | — | — |
ad_account_id | string | No | — | — |
campaign_id | string | No | — | — |
name | string | Yes | — | Ad set name |
daily_budget | integer | No | — | — |
optimization_goal | string | No | — | — |
billing_event | string | No | — | Default IMPRESSIONS |
countries | json | No | — | ISO country codes for targeting (default ['BR']) |
page_id | string | No | — | Optional Facebook Page id for promoted_object (needed for many traffic creatives) |
adset_id | string | No | — | — |
status | string | No | — | — |
enabled | boolean | No | — | — |
failure_reason | string | No | — | Engine-stamped human-readable failure reason |
failed_at | string | No | — | ISO timestamp when the workflow failed |
failed_at_state | string | No | — | Engine-stamped state when the workflow failed |
failed_step | string | No | — | Engine-stamped step name (DAG path) |
failed_layer | integer | No | — | Engine-stamped layer index (DAG path) |
error | string | No | — | Engine-stamped exception message |
error_type | string | No | — | Engine-stamped exception class name |
completed_at | string | No | — | — |
States ​
| State | Initial | Terminal | Success | Auto-advance | Description |
|---|---|---|---|---|---|
pending | Yes | No | — | execute | — |
completed | No | Yes | Yes | — | — |
failed | No | Yes | No | — | — |
State Diagram ​
Transitions ​
| From | Action | To | Description |
|---|---|---|---|
pending | execute | completed | — |
* (any state) | fail | failed | — |
Outcomes ​
| Outcome | Type | Description | State Data Keys |
|---|---|---|---|
completed | SUCCESS | Meta Ads atom completed successfully | completed_at |
failed | FAILURE | Meta Ads atom failed | failure_reason, error, error_type |
API Usage ​
bash
POST /api/workflows/start
Content-Type: application/json
{
"workflow_type": "meta.ads.adset.create-paused",
"initial_data": {
"organization_uuid": "value",
"connection_uuid": "value",
"campaign_id": "value",
"name": "value"
}
}