Skip to main content
POST
/
api
/
v1
/
campaigns
Create a new campaign
curl --request POST \
  --url https://{subdomain}.mindhunters.ai/api/v1/campaigns \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "Summer Promotion 2025",
  "description": "Campaign for summer products promotion",
  "status": "Draft",
  "campaign_type": "email",
  "start_date": "2025-06-01T00:00:00Z",
  "end_date": "2025-08-31T23:59:59Z",
  "rules": {
    "target_audience": "new_customers",
    "minimum_age": 18
  },
  "agent_id": 1,
  "agent_app_id": 2
}'
{
  "success": true,
  "message": "Campaign created successfully",
  "data": {
    "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "description": "<string>",
    "status": "<string>",
    "campaign_type": "<string>",
    "start_date": "2023-11-07T05:31:56Z",
    "end_date": "2023-11-07T05:31:56Z",
    "rules": {},
    "agent_id": 123,
    "agent_app_id": 123,
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  }
}

Authorizations

​
Authorization
string
header
required

Use a Bearer token to access these API endpoints. Example: "Bearer {your-token}"

Body

application/json
​
name
string
Example:

"Summer Promotion 2025"

​
description
string | null
Example:

"Campaign for summer products promotion"

​
status
enum<string>
Available options:
Active,
Draft,
Completed,
Archived
Example:

"Draft"

​
campaign_type
string | null
Example:

"email"

​
start_date
string<date-time> | null
Example:

"2025-06-01T00:00:00Z"

​
end_date
string<date-time> | null
Example:

"2025-08-31T23:59:59Z"

​
rules
object | null
Example:
{
  "target_audience": "new_customers",
  "minimum_age": 18
}
​
agent_id
integer | null
Example:

1

​
agent_app_id
integer | null
Example:

2

Response

Created

​
success
boolean
Example:

true

​
message
string
Example:

"Campaign created successfully"

​
data
object