Create Pinterest Campaign (Paused First)
curl --request POST \
--url https://app.bily.ai/api/customer/v1/platform/{resourceUrl}/actions/create-pinterest-campaign \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"adAccountId": "<string>",
"payload": {
"name": "<string>",
"status": "PAUSED",
"budget": 123,
"startTime": "<string>",
"endTime": "<string>"
}
}
'const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
adAccountId: '<string>',
payload: {
name: '<string>',
status: 'PAUSED',
budget: 123,
startTime: '<string>',
endTime: '<string>'
}
})
};
fetch('https://app.bily.ai/api/customer/v1/platform/{resourceUrl}/actions/create-pinterest-campaign', 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/create-pinterest-campaign"
payload = {
"adAccountId": "<string>",
"payload": {
"name": "<string>",
"status": "PAUSED",
"budget": 123,
"startTime": "<string>",
"endTime": "<string>"
}
}
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
Create Pinterest Campaign (Paused First)
Create a new Pinterest campaign with one current objectiveType: AWARENESS, CONSIDERATION, VIDEO_COMPLETION, SALES, or LEADS. intendedPromotionType is STANDARD_AD or CATALOG; CATALOG is only valid with SALES or CONSIDERATION. Connected-channel creation requires explicit PAUSED status; lifetime budgets require an endTime. 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
/
create-pinterest-campaign
Create Pinterest Campaign (Paused First)
curl --request POST \
--url https://app.bily.ai/api/customer/v1/platform/{resourceUrl}/actions/create-pinterest-campaign \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"adAccountId": "<string>",
"payload": {
"name": "<string>",
"status": "PAUSED",
"budget": 123,
"startTime": "<string>",
"endTime": "<string>"
}
}
'const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
adAccountId: '<string>',
payload: {
name: '<string>',
status: 'PAUSED',
budget: 123,
startTime: '<string>',
endTime: '<string>'
}
})
};
fetch('https://app.bily.ai/api/customer/v1/platform/{resourceUrl}/actions/create-pinterest-campaign', 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/create-pinterest-campaign"
payload = {
"adAccountId": "<string>",
"payload": {
"name": "<string>",
"status": "PAUSED",
"budget": 123,
"startTime": "<string>",
"endTime": "<string>"
}
}
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.
Response
Request completed. Inspect the returned state and any verification fields.
The response is of type object.