Manage Meta Ad Set, Image or Carousel Creative (Paused First)
curl --request POST \
--url https://app.bily.ai/api/customer/v1/platform/{resourceUrl}/actions/manage-meta-asset \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"adAccountId": "<string>",
"sourceAuthority": {
"dataSourceAdAccountId": "<string>",
"dataSourceConnectorId": "<string>"
},
"payload": {
"operation": "create-awareness-website-image",
"expectedAccountFingerprint": "<string>",
"objective": "OUTCOME_AWARENESS",
"optimizationGoal": "REACH",
"campaignName": "<string>",
"adsetName": "<string>",
"name": "<string>",
"budget": 123,
"budgetType": "daily",
"countries": [
"<string>"
],
"pageId": "<string>",
"imageHash": "<string>",
"expectedImageFingerprint": "<string>",
"primaryText": "<string>",
"headline": "<string>",
"description": "<string>",
"destinationUrl": "<string>",
"urlTags": "<string>",
"status": "PAUSED"
}
}
'const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
adAccountId: '<string>',
sourceAuthority: {dataSourceAdAccountId: '<string>', dataSourceConnectorId: '<string>'},
payload: {
operation: 'create-awareness-website-image',
expectedAccountFingerprint: '<string>',
objective: 'OUTCOME_AWARENESS',
optimizationGoal: 'REACH',
campaignName: '<string>',
adsetName: '<string>',
name: '<string>',
budget: 123,
budgetType: 'daily',
countries: ['<string>'],
pageId: '<string>',
imageHash: '<string>',
expectedImageFingerprint: '<string>',
primaryText: '<string>',
headline: '<string>',
description: '<string>',
destinationUrl: '<string>',
urlTags: '<string>',
status: 'PAUSED'
}
})
};
fetch('https://app.bily.ai/api/customer/v1/platform/{resourceUrl}/actions/manage-meta-asset', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://app.bily.ai/api/customer/v1/platform/{resourceUrl}/actions/manage-meta-asset"
payload = {
"adAccountId": "<string>",
"sourceAuthority": {
"dataSourceAdAccountId": "<string>",
"dataSourceConnectorId": "<string>"
},
"payload": {
"operation": "create-awareness-website-image",
"expectedAccountFingerprint": "<string>",
"objective": "OUTCOME_AWARENESS",
"optimizationGoal": "REACH",
"campaignName": "<string>",
"adsetName": "<string>",
"name": "<string>",
"budget": 123,
"budgetType": "daily",
"countries": ["<string>"],
"pageId": "<string>",
"imageHash": "<string>",
"expectedImageFingerprint": "<string>",
"primaryText": "<string>",
"headline": "<string>",
"description": "<string>",
"destinationUrl": "<string>",
"urlTags": "<string>",
"status": "PAUSED"
}
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){}{
"error": "Store not found",
"requestId": "<string>",
"details": "<unknown>",
"retryAfter": "<string>"
}{
"error": "Store not found",
"requestId": "<string>",
"details": "<unknown>",
"retryAfter": "<string>"
}{
"error": "Store not found",
"requestId": "<string>",
"details": "<unknown>",
"retryAfter": "<string>"
}{
"error": "Store not found",
"requestId": "<string>",
"details": "<unknown>",
"retryAfter": "<string>"
}{
"error": "Store not found",
"requestId": "<string>",
"details": "<unknown>",
"retryAfter": "<string>"
}{
"error": "Store not found",
"requestId": "<string>",
"details": "<unknown>",
"retryAfter": "<string>"
}{
"error": "Store not found",
"requestId": "<string>",
"details": "<unknown>",
"retryAfter": "<string>"
}{
"error": "Store not found",
"requestId": "<string>",
"details": "<unknown>",
"retryAfter": "<string>"
}{
"error": "Store not found",
"requestId": "<string>",
"details": "<unknown>",
"retryAfter": "<string>"
}Campaign actions
Manage Meta Ad Set, Image or Carousel Creative (Paused First)
Create a complete paused Awareness website-image package with operation:create-awareness-website-image: one daily-budget OUTCOME_AWARENESS campaign, one REACH/IMPRESSIONS ad set bound to the selected Page, and one static Facebook Feed image ad with its reviewed website link; no Awareness WEBSITE destination override. The separate operation:create-leads-website-image creates one paused OUTCOME_LEADS campaign, WEBSITE/OFFSITE_CONVERSIONS/IMPRESSIONS ad set with an explicit current workspace/advertiser pixel and LEAD event, and linked Facebook Feed image ad. It requires expectedPixelFingerprint and attributionWindow:ONE_DAY_CLICK as its supported fixed profile. Both require exact account, Page, retained-image fingerprints, daily budget, reviewed copy/link/tracking and complete native readback; no instant form, messaging, app, video, Lead carousel or other attribution profile. Existing Traffic/Sales ad-set, image and static carousel operations retain their own eligibility. Receipts retain exact accepted IDs; uncertain writes must not be replayed. This is an execution endpoint. For a reviewed user change, save its supported capability/body as an immutable action draft, review it, and explicitly publish that draft. Check action-jobs/capabilities before staging; a catalog entry alone does not make it stageable.
POST
/
platform
/
{resourceUrl}
/
actions
/
manage-meta-asset
Manage Meta Ad Set, Image or Carousel Creative (Paused First)
curl --request POST \
--url https://app.bily.ai/api/customer/v1/platform/{resourceUrl}/actions/manage-meta-asset \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"adAccountId": "<string>",
"sourceAuthority": {
"dataSourceAdAccountId": "<string>",
"dataSourceConnectorId": "<string>"
},
"payload": {
"operation": "create-awareness-website-image",
"expectedAccountFingerprint": "<string>",
"objective": "OUTCOME_AWARENESS",
"optimizationGoal": "REACH",
"campaignName": "<string>",
"adsetName": "<string>",
"name": "<string>",
"budget": 123,
"budgetType": "daily",
"countries": [
"<string>"
],
"pageId": "<string>",
"imageHash": "<string>",
"expectedImageFingerprint": "<string>",
"primaryText": "<string>",
"headline": "<string>",
"description": "<string>",
"destinationUrl": "<string>",
"urlTags": "<string>",
"status": "PAUSED"
}
}
'const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
adAccountId: '<string>',
sourceAuthority: {dataSourceAdAccountId: '<string>', dataSourceConnectorId: '<string>'},
payload: {
operation: 'create-awareness-website-image',
expectedAccountFingerprint: '<string>',
objective: 'OUTCOME_AWARENESS',
optimizationGoal: 'REACH',
campaignName: '<string>',
adsetName: '<string>',
name: '<string>',
budget: 123,
budgetType: 'daily',
countries: ['<string>'],
pageId: '<string>',
imageHash: '<string>',
expectedImageFingerprint: '<string>',
primaryText: '<string>',
headline: '<string>',
description: '<string>',
destinationUrl: '<string>',
urlTags: '<string>',
status: 'PAUSED'
}
})
};
fetch('https://app.bily.ai/api/customer/v1/platform/{resourceUrl}/actions/manage-meta-asset', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://app.bily.ai/api/customer/v1/platform/{resourceUrl}/actions/manage-meta-asset"
payload = {
"adAccountId": "<string>",
"sourceAuthority": {
"dataSourceAdAccountId": "<string>",
"dataSourceConnectorId": "<string>"
},
"payload": {
"operation": "create-awareness-website-image",
"expectedAccountFingerprint": "<string>",
"objective": "OUTCOME_AWARENESS",
"optimizationGoal": "REACH",
"campaignName": "<string>",
"adsetName": "<string>",
"name": "<string>",
"budget": 123,
"budgetType": "daily",
"countries": ["<string>"],
"pageId": "<string>",
"imageHash": "<string>",
"expectedImageFingerprint": "<string>",
"primaryText": "<string>",
"headline": "<string>",
"description": "<string>",
"destinationUrl": "<string>",
"urlTags": "<string>",
"status": "PAUSED"
}
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){}{
"error": "Store not found",
"requestId": "<string>",
"details": "<unknown>",
"retryAfter": "<string>"
}{
"error": "Store not found",
"requestId": "<string>",
"details": "<unknown>",
"retryAfter": "<string>"
}{
"error": "Store not found",
"requestId": "<string>",
"details": "<unknown>",
"retryAfter": "<string>"
}{
"error": "Store not found",
"requestId": "<string>",
"details": "<unknown>",
"retryAfter": "<string>"
}{
"error": "Store not found",
"requestId": "<string>",
"details": "<unknown>",
"retryAfter": "<string>"
}{
"error": "Store not found",
"requestId": "<string>",
"details": "<unknown>",
"retryAfter": "<string>"
}{
"error": "Store not found",
"requestId": "<string>",
"details": "<unknown>",
"retryAfter": "<string>"
}{
"error": "Store not found",
"requestId": "<string>",
"details": "<unknown>",
"retryAfter": "<string>"
}{
"error": "Store not found",
"requestId": "<string>",
"details": "<unknown>",
"retryAfter": "<string>"
}Authorizations
ApiKeyAuthBearerAuth
A server-side Bily API key created under Settings > AI tools > Access keys. Select the intended workspace before creating it.
Headers
An organization ID returned by GET /context or GET /organizations. Omit it when a scoped key supplies the organization. Otherwise provide it when no organization is selected.
Example:
"org_01J8W7T9G3E6ZQ4M2K5N8P1R0S"
Path Parameters
Exact workspace URL returned by GET /context.
Body
application/json
Response
Request completed. Inspect the returned state and any verification fields.
The response is of type object.