Skip to main content
PATCH
Update a campaign

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

brand_id
integer<int32>
required

The Dash Social assigned ID of the brand.

campaign_id
integer
required

The ID of the campaign object.

Required range: x >= 0

Body

application/json
benchmark_campaigns
integer[] | null

A list of campaign ids to benchmark the campaign against

creator_filters
object

Filters to apply on the included creators

creator_ids
integer[]

List of creator IDs to add to the campaign.

end_date
string | null

A formatted datetime string in UTC.

Pattern: ^\d{4}-\d{2}-\d{2}(T\d{2}:\d{2}:\d{2}(Z|((\+|-)\d{2}:\d{2})))?$
Example:

"2019-12-12"

google_analytics_selected_campaigns
string[] | null

A list of the selected google analytics campaigns.

hashtag_ids
integer[]

A list of hashtags added to the campaign.

name
string

Name of the campaign.

Required string length: 1 - 64
start_date
string | null

A formatted datetime string in UTC.

Pattern: ^\d{4}-\d{2}-\d{2}(T\d{2}:\d{2}:\d{2}(Z|((\+|-)\d{2}:\d{2})))?$
Example:

"2019-12-01"

topline_metrics
object | null

Custom top line metrics and goals for the campaign

ttcm_spark_ads_authorization_days
integer | null

Duration in which ttcm_orders_invite_link is valid (in days)

Response

OK

brand_id
integer
required
ad_campaigns
object[]
avg_emv
number

Sum of EMV across supported channels divided by number of posts with EMV values

avg_engagement_rate
number

Sum of average engagement per media across supported channels divided by number of posts with avg engagement rate values

avg_engagements
number

Sum of engagements across supported channels divided by number of posts

benchmark_campaigns
any
read-only

A list of campaign objects to benchmark the campaign against

created_at
string<date-time>
creator_filters
object
creator_ids
integer[]
earliest_media_published_date
string<date-time>
end_date
string<date-time>
google_analytics_selected_campaigns
string[]
has_relationships
boolean
has_ugc
boolean
hashtags
unknown
id
integer
included_ad_sources
unknown
included_creator_sources
any
read-only

A list of creator channels

included_media_sources
string[]
latest_media_published_date
string<date-time>
name
string
number_of_media
integer
show_v1_facebook_metrics
boolean
show_v1_instagram_metrics
boolean
show_v2_facebook_metrics
boolean
show_v2_instagram_metrics
boolean
start_date
string<date-time>
top_media
any
topline_metrics
object

Custom top line metrics and goals for the campaign

total_clicks
integer

Sum of clicks across supported channels

total_creator_likes
integer

Sum of creator likes across supported channels

total_emv
integer

Sum of EMV across supported channels

total_engagements
integer

Sum of engagements across all channels

total_impressions
integer

Sum of impressions across supported channels

total_video_views
integer

Sum of video views across supported channels

ttcm_orders_campaign_code
string | null
Maximum string length: 256

URL for inviting creators to a TikTok campaign

ttcm_spark_ads_authorization_days
integer

Duration in which ttcm_orders_invite_link is valid (in days)

updated_at
string<date-time>