Update a campaign

curl --request PATCH \
  --url https://library-backend.dashsocial.com/brands/{brand_id}/campaigns/{campaign_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "benchmark_campaigns": [
    123
  ],
  "creator_filters": {
    "excluded_media_ids": [],
    "included_media_ids": []
  },
  "creator_ids": [
    123
  ],
  "end_date": "2019-12-12",
  "google_analytics_selected_campaigns": [
    "<string>"
  ],
  "hashtag_ids": [
    123
  ],
  "name": "<string>",
  "start_date": "2019-12-01",
  "topline_metrics": {
    "CREATOR_SUMMARY": [
      {
        "goal": null
      }
    ],
    "OWNED_SUMMARY": [
      {
        "goal": null,
        "id": 123,
        "metric": "<string>"
      }
    ],
    "SOCIAL_ADS_SUMMARY": [
      {
        "goal": null
      }
    ]
  },
  "ttcm_spark_ads_authorization_days": 123
}
'

{
  "brand_id": 123,
  "ad_campaigns": [
    {
      "source_ad_account_id": "<string>",
      "source_campaign_id": "<string>"
    }
  ],
  "avg_emv": 123,
  "avg_engagement_rate": 123,
  "avg_engagements": 123,
  "benchmark_campaigns": "<unknown>",
  "created_at": "2023-11-07T05:31:56Z",
  "creator_filters": {
    "excluded_media_ids": [],
    "included_media_ids": [],
    "source_created_at": {
      "end": "<string>",
      "start": "<string>"
    }
  },
  "creator_ids": [
    123
  ],
  "earliest_media_published_date": "2023-11-07T05:31:56Z",
  "end_date": "2023-11-07T05:31:56Z",
  "google_analytics_selected_campaigns": [
    "<string>"
  ],
  "has_relationships": true,
  "has_ugc": true,
  "hashtags": null,
  "id": 123,
  "included_ad_sources": null,
  "included_creator_sources": "<unknown>",
  "included_media_sources": [
    "<string>"
  ],
  "latest_media_published_date": "2023-11-07T05:31:56Z",
  "name": "<string>",
  "number_of_media": 123,
  "show_v1_facebook_metrics": true,
  "show_v1_instagram_metrics": true,
  "show_v2_facebook_metrics": true,
  "show_v2_instagram_metrics": true,
  "start_date": "2023-11-07T05:31:56Z",
  "top_media": "<unknown>",
  "topline_metrics": {
    "CREATOR_SUMMARY": [
      {
        "goal": null
      }
    ],
    "OWNED_SUMMARY": [
      {
        "goal": null,
        "id": 123,
        "metric": "<string>"
      }
    ],
    "SOCIAL_ADS_SUMMARY": [
      {
        "goal": null
      }
    ]
  },
  "total_clicks": 123,
  "total_creator_likes": 123,
  "total_emv": 123,
  "total_engagements": 123,
  "total_impressions": 123,
  "total_video_views": 123,
  "ttcm_orders_campaign_code": "<string>",
  "ttcm_orders_invite_link": "<string>",
  "ttcm_spark_ads_authorization_days": 123,
  "updated_at": "2023-11-07T05:31:56Z"
}

PATCH

brands

{brand_id}

campaigns

{campaign_id}

Update a campaign

curl --request PATCH \
  --url https://library-backend.dashsocial.com/brands/{brand_id}/campaigns/{campaign_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "benchmark_campaigns": [
    123
  ],
  "creator_filters": {
    "excluded_media_ids": [],
    "included_media_ids": []
  },
  "creator_ids": [
    123
  ],
  "end_date": "2019-12-12",
  "google_analytics_selected_campaigns": [
    "<string>"
  ],
  "hashtag_ids": [
    123
  ],
  "name": "<string>",
  "start_date": "2019-12-01",
  "topline_metrics": {
    "CREATOR_SUMMARY": [
      {
        "goal": null
      }
    ],
    "OWNED_SUMMARY": [
      {
        "goal": null,
        "id": 123,
        "metric": "<string>"
      }
    ],
    "SOCIAL_ADS_SUMMARY": [
      {
        "goal": null
      }
    ]
  },
  "ttcm_spark_ads_authorization_days": 123
}
'

{
  "brand_id": 123,
  "ad_campaigns": [
    {
      "source_ad_account_id": "<string>",
      "source_campaign_id": "<string>"
    }
  ],
  "avg_emv": 123,
  "avg_engagement_rate": 123,
  "avg_engagements": 123,
  "benchmark_campaigns": "<unknown>",
  "created_at": "2023-11-07T05:31:56Z",
  "creator_filters": {
    "excluded_media_ids": [],
    "included_media_ids": [],
    "source_created_at": {
      "end": "<string>",
      "start": "<string>"
    }
  },
  "creator_ids": [
    123
  ],
  "earliest_media_published_date": "2023-11-07T05:31:56Z",
  "end_date": "2023-11-07T05:31:56Z",
  "google_analytics_selected_campaigns": [
    "<string>"
  ],
  "has_relationships": true,
  "has_ugc": true,
  "hashtags": null,
  "id": 123,
  "included_ad_sources": null,
  "included_creator_sources": "<unknown>",
  "included_media_sources": [
    "<string>"
  ],
  "latest_media_published_date": "2023-11-07T05:31:56Z",
  "name": "<string>",
  "number_of_media": 123,
  "show_v1_facebook_metrics": true,
  "show_v1_instagram_metrics": true,
  "show_v2_facebook_metrics": true,
  "show_v2_instagram_metrics": true,
  "start_date": "2023-11-07T05:31:56Z",
  "top_media": "<unknown>",
  "topline_metrics": {
    "CREATOR_SUMMARY": [
      {
        "goal": null
      }
    ],
    "OWNED_SUMMARY": [
      {
        "goal": null,
        "id": 123,
        "metric": "<string>"
      }
    ],
    "SOCIAL_ADS_SUMMARY": [
      {
        "goal": null
      }
    ]
  },
  "total_clicks": 123,
  "total_creator_likes": 123,
  "total_emv": 123,
  "total_engagements": 123,
  "total_impressions": 123,
  "total_video_views": 123,
  "ttcm_orders_campaign_code": "<string>",
  "ttcm_orders_invite_link": "<string>",
  "ttcm_spark_ads_authorization_days": 123,
  "updated_at": "2023-11-07T05:31:56Z"
}

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

Show child attributes

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

Custom top line metrics and goals for the campaign

Show child attributes

ttcm_spark_ads_authorization_days

integer | null

Duration in which ttcm_orders_invite_link is valid (in days)

Response

brand_id

integer

required

ad_campaigns

object[]

Show child attributes

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

Show child attributes

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

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

Show child attributes

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

ttcm_orders_invite_link

string<url>

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>

Update a campaign Delete a campaign

Documentation Index

Authorizations

Path Parameters

Body

Response