Skip to content

Launch a draft campaign

POST
/campaigns/{id}/launch
curl --request POST \
--url https://ads.wortise.com/api/public/v1/campaigns/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/launch \
--header 'x-api-key: <x-api-key>'

Launches a draft campaign: stamps its pricing, debits the organization balance and syncs it to the ad server. Answers 409 when the campaign is not a draft, and 412 when it is not ready to launch (a missing field, a price below the organization minimum, an ad group without creatives, ad group budgets that do not add up to the campaign budget) or the balance does not cover the cost.

Requires the campaigns:launch scope.

id
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/

Draft campaign UUID.

The launched campaign.

Media typeapplication/json
object
end
Any of:
string format: date-time
fee
object
-2
number
other
number
id
integer
> 0 <= 9007199254740991
name
string
>= 1 characters
objective

Impressions (CPM) or clicks (CPC) targeted.

integer
> 0 <= 9007199254740991
organization
required
Any of:
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$/
origin
string
default: ads
Allowed values: ads pub
revenue

Unit price in USD (CPM or CPC) to external service-ads. Only for a campaign without ad groups

number
> 0
rush
boolean
sample
object
-2
number
other
number
start
Any of:
string format: date-time
status
string
default: disabled
Allowed values: enabled disabled archived
team
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$/
timezone
string
default: GMT
Allowed values: America/Argentina/Buenos_Aires America/Belize America/Bogota America/Boise America/Caracas America/Chicago America/Chihuahua America/Dawson America/Detroit America/Godthab America/Juneau America/Los_Angeles America/Mexico_City America/Montevideo America/Phoenix America/Regina America/Santiago America/Sao_Paulo America/St_Johns America/Tijuana Asia/Almaty Europe/Amsterdam Europe/Athens Europe/Belgrade Europe/Brussels Europe/Bucharest Europe/Dublin Europe/Helsinki Europe/Lisbon Europe/London Europe/Moscow Europe/Sarajevo GMT
type
string
default: CPM
Allowed values: CPC CPM CPE
user
object
expiration
required
number
max
required
number
> 0
verification
string
default: pending
Allowed values: approved pending rejected
_id
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
audience
object
appFilter
Array<string>
device
object
battery
object
plugged
required
boolean
brand
Array<string>
language
Array<string>
model
Array<string>
os
Array<string>
default: android,ios
Allowed values: android ios
osVersion
Array<string>
type
Array<string>
Allowed values: mobile desktop tv tablet ??
not

Only explicitly requested targeting exclusions.

object
appFilter
Array<string>
device
object
battery
object
plugged
required
boolean
brand
Array<string>
language
Array<string>
model
Array<string>
os
Array<string>
default: android,ios
Allowed values: android ios
osVersion
Array<string>
type
Array<string>
Allowed values: mobile desktop tv tablet ??
not
object recursive
tag
object
audiences
required
Array<object>
object
id
required
string
label
required
string
products
required
Array<object>
object
id
required
string
label
required
string
topics
required
Array<object>
object
id
required
string
label
required
string
app
object
category
Array<object>
object
id
required

E.g: “1”, “20”.

string
label
required
string
list
Array<object>
object
icon
string
id
required
string
label
required
string
platform
required
string
Allowed values: android ios web
appFilters
object
coppa
boolean
maxInstalls
number
minInstalls
number
minScore
number
<= 5
platform
Array<string>
Allowed values: android ios
cellular
object
carrier
required
Array<object>
>= 1 items
object
country
required
string
>= 1 characters
countryCode
required
string
>= 1 characters
iso
required
string
mcc
required
string
/^\d{3}$/
mnc
required
string
/^\d{2,3}$/
network
required
string
>= 1 characters
cpm
number
> 0
isPublic
boolean
location

Exact inventory locations or geographic areas to target.

Array
0
Any of:
One of:
object
countryCode
string
>= 2 characters <= 2 characters
displayName
required
string
lat
required
number
lng
required
number
placeId
required
string
source
required
string
Allowed value: google_places
type
required
string
Allowed value: place
types
required
Array<string>
time
object
day
Array<number>
hour
Array<object>
object
_id
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
from
required
number
<= 23
to
required
number
<= 23
traffic
object
age
object
key
additional properties
number
<= 1
category
object
key
additional properties
number
<= 1
country
object
key
additional properties
number
<= 1
device
object
key
additional properties
number
<= 1
gender
object
key
additional properties
number
<= 1
size
object
key
additional properties
number
<= 1
user

Optional demographic filters. Age codes are ranges: -18=under 18, 18=18–24, 25=25–34, 35=35–44, 45=45–54, 55=55–64, 65=65+. Adults 18+ requires all six adult ranges, not just 18. Gender ?? means unknown, not all genders; omit gender on creation or use [] on update for unrestricted gender.

object
gender
Array<string>
Allowed values: female male ??
id
Array<string>
age
Array<string>
Allowed values: -18 18 25 35 45 55 65
interest
Array<object>
object
id
required
string
label
required
string
tag
object
audiences
required
Array<object>
object
id
required
string
label
required
string
products
required
Array<object>
object
id
required
string
label
required
string
topics
required
Array<object>
object
id
required
string
label
required
string
_id
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$/
app
object
category
Array<object>
object
id
required

E.g: “1”, “20”.

string
label
required
string
list
Array<object>
object
icon
string
id
required
string
label
required
string
platform
required
string
Allowed values: android ios web
appFilters
object
coppa
boolean
maxInstalls
number
minInstalls
number
minScore
number
<= 5
platform
Array<string>
Allowed values: android ios
cellular
object
carrier
required
Array<object>
>= 1 items
object
country
required
string
>= 1 characters
countryCode
required
string
>= 1 characters
iso
required
string
mcc
required
string
/^\d{3}$/
mnc
required
string
/^\d{2,3}$/
network
required
string
>= 1 characters
cpm
number
> 0
createdAt
required
Any of:
string format: date-time
createdBy
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$/
deletedAt
Any of:
string format: date-time
isDraft
required
boolean
default: true
isPublic
boolean
location
required

Exact inventory locations or geographic areas to target.

Array
0
Any of:
One of:
object
countryCode
string
>= 2 characters <= 2 characters
displayName
required
string
lat
required
number
lng
required
number
placeId
required
string
source
required
string
Allowed value: google_places
type
required
string
Allowed value: place
types
required
Array<string>
time
object
day
Array<number>
hour
Array<object>
object
_id
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
from
required
number
<= 23
to
required
number
<= 23
traffic
object
age
object
key
additional properties
number
<= 1
category
object
key
additional properties
number
<= 1
country
object
key
additional properties
number
<= 1
device
object
key
additional properties
number
<= 1
gender
object
key
additional properties
number
<= 1
size
object
key
additional properties
number
<= 1
updatedAt
Any of:
string format: date-time
updatedBy
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$/
user

Optional demographic filters. Age codes are ranges: -18=under 18, 18=18–24, 25=25–34, 35=35–44, 45=45–54, 55=55–64, 65=65+. Adults 18+ requires all six adult ranges, not just 18. Gender ?? means unknown, not all genders; omit gender on creation or use [] on update for unrestricted gender.

object
gender
Array<string>
Allowed values: female male ??
id
Array<string>
age
Array<string>
Allowed values: -18 18 25 35 45 55 65
interest
Array<object>
object
id
required
string
label
required
string
autopilot

The advertiser lets the system slightly adjust the audience to ensure a better reach. Campaigns saved before it existed have no value: not authorized

boolean
default: true
brand
Any of:
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
budget

Budget in the campaign currency

number
> 0
budgetReducedAt

Last time the budget was lowered. The refund cron waits for the ads service to apply it

Any of:
string format: date-time
country

ISO-2 Country

string
>= 2 characters <= 2 characters
createdAt
Any of:
string format: date-time
createdBy
Any of:
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$/
cta
string
ctaLanguage
string
currency

Currency ISO 4217. E.g. USD, EUR. A draft saved without it takes the currency of the account that saves it, else USD.

string
Allowed values: BRL ARS UYU COP CLP MXN EUR USD
deletedAt
Any of:
string format: date-time
exchange

Exchange rate from local currency to USD

number
format
string
default: display
Allowed values: display orb smart_ads survey
isDelayed
boolean
isDraft
required
boolean
default: true
method
string
Allowed values: ai api manual
pausedAt
Any of:
string format: date-time
pendingRefund

USD taken off the budget and not yet credited back to the organization

number
refund
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
trackingTag
string format: uri
unitPrice

Unit price in local currency (CPM or CPC bid). Only for a campaign without ad groups

number
> 0
updatedAt
Any of:
string format: date-time
updatedBy
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$/
url
string format: uri
utm
object
campaign
string
id
string
medium
string
source
string
warnings

Tips the review raised when the campaign was last saved: the code the clients translate and the ad group it is about

Array<object>
default:
object
adGroup
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
code
required
string
Allowed values: campaign_too_short reach_limited

Example

{
"origin": "ads",
"rush": false,
"status": "enabled",
"timezone": "America/Argentina/Buenos_Aires",
"type": "CPC",
"verification": "approved",
"audience": {
"device": {
"os": [
"android",
"ios"
],
"type": [
"mobile"
]
},
"not": {
"device": {
"os": [
"android",
"ios"
],
"type": [
"mobile"
]
},
"app": {
"list": [
{
"platform": "android"
}
]
},
"appFilters": {
"platform": [
"android"
]
},
"location": [
{
"source": "google_places",
"type": "place"
}
],
"user": {
"gender": [
"female"
],
"age": [
"-18"
]
}
},
"app": {
"list": [
{
"platform": "android"
}
]
},
"appFilters": {
"platform": [
"android"
]
},
"isDraft": true,
"location": [
{
"source": "google_places",
"type": "place"
}
],
"user": {
"gender": [
"female"
],
"age": [
"-18"
]
}
},
"autopilot": true,
"currency": "BRL",
"format": "display",
"isDraft": true,
"method": "ai",
"warnings": []
}

The API key is missing, invalid, disabled or expired.

Media typeapplication/json
object
code
required

TRPC error code, e.g. UNAUTHORIZED, FORBIDDEN, NOT_FOUND, CONFLICT

string
Allowed values: PARSE_ERROR BAD_REQUEST INTERNAL_SERVER_ERROR NOT_IMPLEMENTED BAD_GATEWAY SERVICE_UNAVAILABLE GATEWAY_TIMEOUT UNAUTHORIZED PAYMENT_REQUIRED FORBIDDEN NOT_FOUND METHOD_NOT_SUPPORTED TIMEOUT CONFLICT PRECONDITION_FAILED PAYLOAD_TOO_LARGE UNSUPPORTED_MEDIA_TYPE UNPROCESSABLE_CONTENT PRECONDITION_REQUIRED TOO_MANY_REQUESTS CLIENT_CLOSED_REQUEST
message
required
string

Example

{
"code": "PARSE_ERROR"
}

The API key lacks the scope, or its owner lacks the dashboard permission.

Media typeapplication/json
object
code
required

TRPC error code, e.g. UNAUTHORIZED, FORBIDDEN, NOT_FOUND, CONFLICT

string
Allowed values: PARSE_ERROR BAD_REQUEST INTERNAL_SERVER_ERROR NOT_IMPLEMENTED BAD_GATEWAY SERVICE_UNAVAILABLE GATEWAY_TIMEOUT UNAUTHORIZED PAYMENT_REQUIRED FORBIDDEN NOT_FOUND METHOD_NOT_SUPPORTED TIMEOUT CONFLICT PRECONDITION_FAILED PAYLOAD_TOO_LARGE UNSUPPORTED_MEDIA_TYPE UNPROCESSABLE_CONTENT PRECONDITION_REQUIRED TOO_MANY_REQUESTS CLIENT_CLOSED_REQUEST
message
required
string

Example

{
"code": "PARSE_ERROR"
}

The resource does not exist in the organization of the API key.

Media typeapplication/json
object
code
required

TRPC error code, e.g. UNAUTHORIZED, FORBIDDEN, NOT_FOUND, CONFLICT

string
Allowed values: PARSE_ERROR BAD_REQUEST INTERNAL_SERVER_ERROR NOT_IMPLEMENTED BAD_GATEWAY SERVICE_UNAVAILABLE GATEWAY_TIMEOUT UNAUTHORIZED PAYMENT_REQUIRED FORBIDDEN NOT_FOUND METHOD_NOT_SUPPORTED TIMEOUT CONFLICT PRECONDITION_FAILED PAYLOAD_TOO_LARGE UNSUPPORTED_MEDIA_TYPE UNPROCESSABLE_CONTENT PRECONDITION_REQUIRED TOO_MANY_REQUESTS CLIENT_CLOSED_REQUEST
message
required
string

Example

{
"code": "PARSE_ERROR"
}

The request conflicts with the resource state.

Media typeapplication/json
object
code
required

TRPC error code, e.g. UNAUTHORIZED, FORBIDDEN, NOT_FOUND, CONFLICT

string
Allowed values: PARSE_ERROR BAD_REQUEST INTERNAL_SERVER_ERROR NOT_IMPLEMENTED BAD_GATEWAY SERVICE_UNAVAILABLE GATEWAY_TIMEOUT UNAUTHORIZED PAYMENT_REQUIRED FORBIDDEN NOT_FOUND METHOD_NOT_SUPPORTED TIMEOUT CONFLICT PRECONDITION_FAILED PAYLOAD_TOO_LARGE UNSUPPORTED_MEDIA_TYPE UNPROCESSABLE_CONTENT PRECONDITION_REQUIRED TOO_MANY_REQUESTS CLIENT_CLOSED_REQUEST
message
required
string

Example

{
"code": "PARSE_ERROR"
}

A precondition failed, e.g. the organization balance does not cover the launch.

Media typeapplication/json
object
code
required

TRPC error code, e.g. UNAUTHORIZED, FORBIDDEN, NOT_FOUND, CONFLICT

string
Allowed values: PARSE_ERROR BAD_REQUEST INTERNAL_SERVER_ERROR NOT_IMPLEMENTED BAD_GATEWAY SERVICE_UNAVAILABLE GATEWAY_TIMEOUT UNAUTHORIZED PAYMENT_REQUIRED FORBIDDEN NOT_FOUND METHOD_NOT_SUPPORTED TIMEOUT CONFLICT PRECONDITION_FAILED PAYLOAD_TOO_LARGE UNSUPPORTED_MEDIA_TYPE UNPROCESSABLE_CONTENT PRECONDITION_REQUIRED TOO_MANY_REQUESTS CLIENT_CLOSED_REQUEST
message
required
string

Example

{
"code": "PARSE_ERROR"
}

The API key exceeded its rate limit; retry after the Retry-After seconds.

Media typeapplication/json
object
code
required

TRPC error code, e.g. UNAUTHORIZED, FORBIDDEN, NOT_FOUND, CONFLICT

string
Allowed values: PARSE_ERROR BAD_REQUEST INTERNAL_SERVER_ERROR NOT_IMPLEMENTED BAD_GATEWAY SERVICE_UNAVAILABLE GATEWAY_TIMEOUT UNAUTHORIZED PAYMENT_REQUIRED FORBIDDEN NOT_FOUND METHOD_NOT_SUPPORTED TIMEOUT CONFLICT PRECONDITION_FAILED PAYLOAD_TOO_LARGE UNSUPPORTED_MEDIA_TYPE UNPROCESSABLE_CONTENT PRECONDITION_REQUIRED TOO_MANY_REQUESTS CLIENT_CLOSED_REQUEST
message
required
string

Example

{
"code": "PARSE_ERROR"
}
Retry-After
integer

Seconds to wait before retrying.

Unexpected server error.

Media typeapplication/json
object
code
required

TRPC error code, e.g. UNAUTHORIZED, FORBIDDEN, NOT_FOUND, CONFLICT

string
Allowed values: PARSE_ERROR BAD_REQUEST INTERNAL_SERVER_ERROR NOT_IMPLEMENTED BAD_GATEWAY SERVICE_UNAVAILABLE GATEWAY_TIMEOUT UNAUTHORIZED PAYMENT_REQUIRED FORBIDDEN NOT_FOUND METHOD_NOT_SUPPORTED TIMEOUT CONFLICT PRECONDITION_FAILED PAYLOAD_TOO_LARGE UNSUPPORTED_MEDIA_TYPE UNPROCESSABLE_CONTENT PRECONDITION_REQUIRED TOO_MANY_REQUESTS CLIENT_CLOSED_REQUEST
message
required
string

Example

{
"code": "PARSE_ERROR"
}