Reference
Create a campaign
Create a draft campaign (outreach or nurture), optionally from a template and with people.
View MarkdownThis page is generated from the source code on every release.
Create a draft campaign (outreach or nurture), optionally from a template and with people.
Overview
| Name | Value |
|---|---|
| Code | campaigns.create |
| Scope needed | campaigns.write |
| Risk | Write |
| May need confirmation | No |
| Runs as | Answers right away |
Needs Idempotency-Key |
Yes |
| Member roles allowed | owner, manager |
| In the app | Campaigns → Create |
Input fields
| Field | Type | Required | Description |
|---|---|---|---|
name |
text |
Yes | |
goal |
"outreach" | "nurture" |
Yes | |
template |
"soft_open" | "after_purchase" | "invite_channel" |
No | |
personIds |
uuid[] |
No |
Example request
curl -X POST https://tlg.builera.app/api/public/v2/ops/campaigns.create \
-H "Authorization: Bearer $TELEGRAM_AUTO_API_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: <unique key per operation>" \
-d '{"name":"…","goal":"outreach"}'Output fields (data)
| Field | Type | Required |
|---|---|---|
ok |
true |
Yes |
id |
text |
Yes |
Example answer
{
"data": {
"ok": true,
"id": "00000000-0000-4000-8000-000000000000"
}
}Using it over MCP
Tool campaigns_create is listed on the profiles: Automation setup (setup). On other profiles, find it with tools_search and run it with tools_run.