Skip to content

Create campaign

POST
/api/v1/gtm/campaigns
curl --request POST \
--url https://api.ultimateteam.ai/api/v1/gtm/campaigns \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <X-API-Key>' \
--data '{ "daily_limit": 25, "icp_config": {}, "name": "example", "target_count": 500 }'

Create a new outreach campaign.

Media typeapplication/json
CampaignCreate

Request body for creating an outreach campaign.

object
daily_limit
Daily Limit
integer
default: 25 >= 1 <= 1000
icp_config
Icp Config
object
key
additional properties
any
name
required
Name
string
>= 1 characters <= 255 characters
target_count
Target Count
integer
default: 500 >= 1 <= 50000

Successful Response

Media typeapplication/json
CampaignResponse

Response body for a single campaign.

object
completed_at
Any of:
string format: date-time
created_at
required
Created At
string format: date-time
daily_limit
required
Daily Limit
integer
icp_config
required
Icp Config
object
key
additional properties
any
id
required
Id
string format: uuid
invites_redeemed
required
Invites Redeemed
integer
name
required
Name
string
outreach_sent
required
Outreach Sent
integer
prospects_found
required
Prospects Found
integer
status
required
Status
string
target_count
required
Target Count
integer
tenant_id
required
Tenant Id
string format: uuid
updated_at
required
Updated At
string format: date-time
Examplegenerated
{
"completed_at": "2026-04-15T12:00:00Z",
"created_at": "2026-04-15T12:00:00Z",
"daily_limit": 1,
"icp_config": {},
"id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
"invites_redeemed": 1,
"name": "example",
"outreach_sent": 1,
"prospects_found": 1,
"status": "example",
"target_count": 1,
"tenant_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
"updated_at": "2026-04-15T12:00:00Z"
}

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
ctx
Context
object
input
Input
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
Examplegenerated
{
"detail": [
{
"ctx": {},
"input": "example",
"loc": [
"example"
],
"msg": "example",
"type": "example"
}
]
}