Skip to content

Update a marketing/ad campaign

Requires EDITOR. At least one field required.

projectId
required
string

Tenant project id (row-level isolation on every query).

campaignId
required
string

Campaign id.

Media typeapplication/json

Partial update; at least one field required.

object
>= 1 properties
name
string
>= 1 characters
type
string
platform
string | null
budget
number | null
utmSource
string | null
utmMedium
string | null
utmCampaign
string | null
utmTerm
string | null
utmContent
string | null
startDate
string | null
endDate
string | null
status
string
config
object | null
Examplegenerated
json
{
"name": "example",
"type": "example",
"platform": "example",
"budget": 1,
"utmSource": "example",
"utmMedium": "example",
"utmCampaign": "example",
"utmTerm": "example",
"utmContent": "example",
"startDate": "example",
"endDate": "example",
"status": "example",
"config": "example"
}

Updated.

Media typeapplication/json
object
ok
boolean
campaign
object
key
additional properties
any

Invalid config.

Media typeapplication/json
object
error
required

Human-readable error message.

string
message
string
Examplegenerated
json
{
"error": "example",
"message": "example"
}

Not authenticated (no valid session/principal).

Media typeapplication/json
object
error
required

Human-readable error message.

string
message
string
Examplegenerated
json
{
"error": "example",
"message": "example"
}

Authenticated but lacks the required project role.

Media typeapplication/json
object
error
required

Human-readable error message.

string
message
string
Examplegenerated
json
{
"error": "example",
"message": "example"
}

Resource not found (or belongs to another project — indistinguishable).

Media typeapplication/json
object
error
required

Human-readable error message.

string
message
string
Examplegenerated
json
{
"error": "example",
"message": "example"
}