Create Campaign

Create Campaign

curl --request POST \
  --url https://api.example.com/v1/campaigns \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "list_id": "<string>",
  "template": "<string>"
}
'

{
  "data": {
    "id": "<string>",
    "name": "<string>",
    "status": "<string>",
    "list_id": "<string>",
    "created_at": "<string>"
  }
}

POST

campaigns

Create Campaign

curl --request POST \
  --url https://api.example.com/v1/campaigns \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "list_id": "<string>",
  "template": "<string>"
}
'

{
  "data": {
    "id": "<string>",
    "name": "<string>",
    "status": "<string>",
    "list_id": "<string>",
    "created_at": "<string>"
  }
}

Request

Headers

Authorization: Bearer wbk_your_api_key_here
Content-Type: application/json

Body Parameters

name

string

required

Campaign name

list_id

string

required

UUID of the target contact list

template

string

required

Email template text (supports variables: {{name}}, {{company}}, {{title}})

Response

data

object

The created campaign object

Show Campaign properties

string

Campaign UUID

name

string

Campaign name

status

string

Campaign status (draft)

list_id

string

Target list UUID

created_at

string

ISO 8601 timestamp

curl -X POST \
  https://nbkxaqxwvkgbddekwsma.supabase.co/functions/v1/api-gateway/v1/campaigns \
  -H "Authorization: Bearer wbk_your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Q2 Outreach",
    "list_id": "list-uuid-here",
    "template": "Hi {{name}}, I noticed your work at {{company}}..."
  }'

Example Response

{
  "data": {
    "id": "new-campaign-uuid",
    "name": "Q2 Outreach",
    "status": "draft",
    "list_id": "list-uuid-here",
    "created_at": "2026-02-24T16:00:00Z"
  }
}

Template Variables

Use these variables in your template to personalize emails:

Variable	Description	Example
`{{name}}`	Contact’s first name	John
`{{full_name}}`	Contact’s full name	John Smith
`{{company}}`	Company name	Acme Corp
`{{title}}`	Job title	CEO

Example Template

Hi {{name}},

I noticed you're the {{title}} at {{company}}. I wanted to reach out because...

Best regards,
Your Name

Next Steps

After creating a campaign:

Review the draft in your dashboard
Use the Start Campaign endpoint to launch it
Or send it to Lexi AI for automated optimization

Errors

Status	Code	Description
400	`validation_error`	Missing required fields or invalid list ID
401	`invalid_key`	Invalid API key
403	`insufficient_permissions`	Missing `write` permission
404	`not_found`	List not found
429	`rate_limited`	Rate limit exceeded

List Campaigns Start Campaign

⌘I

Contacts

Lists

Prospects

Campaigns

Lexi AI

Request

Headers

Body Parameters

Response

Example Response

Template Variables

Example Template

Next Steps

Errors

Contacts

Lists

Prospects

Campaigns

Lexi AI

​Request

​Headers

​Body Parameters

​Response

​Example Response

​Template Variables

​Example Template

​Next Steps

​Errors

Request

Headers

Body Parameters

Response

Example Response

Template Variables

Example Template

Next Steps

Errors