Avid PubSuite Partner API
  1. Distributions
Avid PubSuite Partner API
  • Pubsuite API Introduction
  • Getting Started
    • Authentication
    • Response Format
    • Error Codes
    • Usage Limits
  • Endpoints
    • Endpoints / Resources Introduction
    • Global Pubsuite Reference Libaries
    • Workspace Organisation Users
      • Organisation Users List
      • Organisation User By Id
    • Advertiser Accounts
      • Advertiser Accounts List
      • Account Detail
      • Account Delete
      • Account Create
      • Account Update
    • Advertiser Account Members
      • Advertiser Account Members
      • Adv Account Member Detail
      • Account Delete
      • Advertiser Account Member Create
      • Account Update
    • Campaigns
      • Campaign Body Parameters
      • Campaigns
      • Campaign
      • Delete Campaign
      • Campaign Details
      • Update Campaign
    • Phases
      • Phase Body Parameters
      • Phases List
      • Phase
      • Phase Detail
      • Delete Phase
      • Phase Update
    • Content
      • Content Body Parameters
      • Contents
      • Content Detail
      • Create Content
      • Delete Content
      • Update Content
    • Distributions
      • Distribution Body Parameters
      • Distributions List
        GET
      • Create Distributions
        POST
      • Delete Distribution
        DELETE
      • Distribution Details
        GET
      • Distribution Update
        PUT
    • Publisher Profiles
      • Coming Soon
      • Publisher Profiles
      • Publisher Profile
      • Delete Publisher Profile
    • Publisher Products
      • Coming Soon
    • Data Sources
      • Coming Soon
    • Webhooks
      • Services
      • Create/Update Service
      • Registered Webhooks
      • Create Webhook
      • Update Webhook
      • Delete Webhook
  • Outbound Events
    • Outbound Events
  1. Distributions

Distribution Body Parameters

⚠️ This page is actively being updated

campaign_distribution_id

A system-generated unique identifier for each individual content distribution record.

Field LabelID
Data Type
RequiredSystem Generated
AccessRead/ Write
Allowed Values /
Input Notes
campaign_id

The campaign ID linking the content to the broader campaign it belongs to.

Field LabelCampaign ID
Data Type
RequiredNo
AccessRead/ Write
Allowed Values /
Input Notes
REF Table (campaigns Id)
content_id

A unique identifier automatically assigned to each content.

Field LabelContent ID
Data Type
RequiredNo
AccessRead/ Write
Allowed Values /
Input Notes
REF Table (campaign_contents Id)
distribution_type_id

The media format of the content being distributed (e.g., Video, Carousel, EDM, Image, Written Article, etc)

Field LabelDistribution Type
Data Type
RequiredSystem Generated
AccessRead/ Write
Allowed Values /
Input Notes
1 = Facebook News Feed,
2 = Instagram News Feed,
3 = Facebook Stories,
4 = Instagram Stories,
5 = Facebook Reels,
6 = Instagram Reels,
7 = TikTok News Feed,
8 = LinkedIn Post,
9 = YouTube Video Post,
10 = YouTube Shorts,
11 = Twitter Post,
12 = Pinterest Post,
13 = Website Post,
14 = Display,
15 = EDM,
16 = Social Display,
17 = Premium In Feed Native,
20 = Meta Ads (Facebook & Instagram),
21 = Premium In-Feed Ghost

REF Table (placements Id)
publisher_title_id

The unique identifier for the Publisher Title where this content is being distributed (e.g. Vogue, GQ, News.com.au)

Field LabelPublisther Title ID
Data Type
RequiredNo
AccessRead/ Write
Allowed Values /
Input Notes
REF Table (partner_brand_profiles Id)
placement_type

Describes the placement of the content or where the content appears (e.g. Facebook News Feed, Instagram Reel)

Field LabelDistribution Placement Type
Data Type
RequiredSystem Generated
AccessRead
Allowed Values /
Input Notes
status

Indicates the current progress or stage of the distribution within the workflow (e.g., In Production, Live)

Field LabelDistribution Status
Data Type
RequiredNo
AccessRead/ Write
Allowed Values /
Input Notes
1 = planning,
2 = live,
3 = cancel
type_name

A more descriptive label of the distribution version (e.g. "Facebook Post" or "Instagram Story").

Field LabelDistribution Type
Data Type
RequiredSystem Generated
AccessRead
Allowed Values /
Input Notes
Facebook Post,
Facebook Reel,
Facebook Story,
Instagram Post,
Instagram Reel,
Instagram Story,
TikTok Post,
Youtube Video Post,
Youtube Shorts
LinkedIn Feed Post,
Pinterest Post,
Website Article,
Premium Website Media,
Meta Ad,
Social Display Ad,
Premium In Feed Native,
Premium In Feed Native (Ghost),
class

Defines whether the distribution is considered ‘Primary’ (key deliverable) or ‘Supplementary’ (supporting content).

Field LabelDistribution Class
Data Type
RequiredNo
AccessRead/ Write
Allowed Values /
Input Notes
1 = Primary content,
2 = Supplementary
label

A custom title given to help identify this specific distribution

Field LabelDistribution Label
Data Type
RequiredNo
AccessRead/ Write
Allowed Values /
Input Notes
owner

Clarifies who is responsible for managing the distribution — Publisher, Advertiser, or Third Party.

Field LabelDistribution Owner
Data Type
RequiredNo
AccessRead/ Write
Allowed Values /
Input Notes
1 = Workspace,
2 = Avid Amp
live_date

The date the content distribution is scheduled to go live.

Field LabelPlanned Live Date
Data Type
RequiredNo
AccessRead/ Write
Allowed Values /
Input Notes
live_time

The time of day the content distribution is scheduled to go live.

Field LabelPlanned Live Time
Data Type
RequiredNo
AccessRead
Allowed Values /
Input Notes
advertiser_review

Indicates whether Advertiser review is required before the content can go live.

Field LabelAdvertiser Review
Data Type
RequiredYes
AccessRead/ Write
Allowed Values /
Input Notes
0 = No, 1 = Yes, 2 = For Fact Checking Only, 3 = At Advertiser Request Only
no_of_feedback_allowed

Specifies the total number of feedback rounds the Advertiser can give before final sign-off.

Field LabelNo. Of Feedback Allowed
Data Type
RequiredYes
AccessRead/ Write
Allowed Values /
Input Notes
current_feedback_rounds

Specifies how many feedback rounds have been used by Advertiser so far for this distribution.

Field LabelFeedback Round Used
Data Type
RequiredNo
AccessRead
Allowed Values /
Input Notes
preview_url

A preview link that allows stakeholders to review the content distribution before it goes live.

Field LabelPreview URL
Data Type
RequiredNo
AccessRead/ Write
Allowed Values /
Input Notes
live_post_id

PubSuite-generated unique identifier of the live post associated with this distribution.

Field LabelPost ID
Data Type
RequiredNo
AccessRead/ Write
Allowed Values /
Input Notes
live_content_url

The URL of the live content once published.

Field LabelLive URL
Data Type
RequiredNo
AccessRead/ Write
Allowed Values /
Input Notes
content_tile

The title or caption of a content distribution (e.g. article headline or social copy).

Field LabelHeadline/Caption/Title
Data Type
RequiredNo
AccessWrite/ Read
Allowed Values /
Input Notes
sponsored_tag

The handle or tag used to indicate sponsorship on platforms like Instagram or Facebook.

Field LabelSponsored Tag
Data Type
RequiredNo
AccessRead/ Write
Allowed Values /
Input Notes
has_destination_link

Indicates if the content includes a link to an external page or site, usually directed by the Advertiser.

Field LabelHas a destination link?
Data Type
RequiredYes
AccessRead/ Write
Allowed Values /
Input Notes
1 = Yes, 0= No
count_clicks_as

Defines how clicks generated from this content (if tracking was applied) should be treated (choose from: Clicks to Site, Clicks to Primary Content, or Do Not Count Clicks)

Field LabelCount Clicks As
Data Type
RequiredNo
AccessRead/ Write
Allowed Values /
Input Notes
1 = clicks_to_client_landing_page,
2 = do_not_count_clicks,
3 = clicks_to_primary_content
primary_outbound_link

The main external link included in the content, used to drive traffic to a destination, usually directed by the Advertiser.

Field LabelPrimary Outbound link
Data Type
RequiredNo
AccessRead/ Write
Allowed Values /
Input Notes
REF Table (distribution_links_library Id)
driving_traffic_to

If this content distribution is promoting a primary distribution, this refers to the "Post ID" of the distribution it's driving traffic to.

Field LabelDriving To
Data Type
RequiredNo
AccessRead/ Write
Allowed Values /
Input Notes
REF Table (content_distributions Id)
smart_id

An auto-generated PubSuite identifier for this distribution, used in third-party tracking or reporting tools.

Field LabelSmart ID
Data Type
RequiredSystem Generated
AccessRead
Allowed Values /
Input Notes
amp_start_date

The date when paid amplification is scheduled to begin.

Field LabelAmp Start Date
Data Type
RequiredNo
AccessRead/ Write
Allowed Values /
Input Notes
amp_start_time

The time when paid amplification is scheduled to begin.

Field LabelAmp Start Time
Data Type
RequiredNo
AccessRead/ Write
Allowed Values /
Input Notes
amp_end_date

The end date of the amplification period.

Field LabelAmp End Date
Data Type
RequiredNo
AccessRead/ Write
Allowed Values /
Input Notes
custom_placements_platforms

Specifies which platforms the amplification distributions apply to (e.g. FB, IG). Used when setting up meta ads.

Field LabelPlatforms
Data Type
RequiredNo
AccessRead/ Write
Allowed Values /
Input Notes
1 = facebook, 2 = instagram
placements_setup

Indicates whether standard or custom placements are being used for this distribution.

Field LabelPlacement Setup
Data Type
RequiredNo
AccessRead/ Write
Allowed Values /
Input Notes
1 = standard, 2 = custom
custom_placements_placements

A multi-select field specifying which custom placements are selected (e.g. 34, 35, 40).

Field LabelPlacements
Data Type
RequiredNo
AccessRead/ Write
Allowed Values /
Input Notes
31 = Facebook Feed,
32 = Instagram Feed,
33 = Facebook Marketplace,
34 = Facebook Video Feeds,
35 = Facebook Right Column,
36 = Instagram Explore,
37 = Instagram Stories,
38 = Facebook Stories,
39 = Instagram Reels,
40 = Facebook Reels,
41 = Facebook In-Stream Videos,
42 = Audience Network
ad_type

Specifies the amplification ad format being used, such as a dark post or sponsored post.

Field LabelAd Type
Data Type
RequiredNo
AccessRead/ Write
Allowed Values /
Input Notes
1 = page_post, 2 = dark_post
ad_page_post_promoting

Links to a content distribution in PubSuite that this ad is boosting or promoting or driving traffic to.

Field LabelPage Post Promoting
Data Type
RequiredNo
AccessRead/ Write
Allowed Values /
Input Notes
REF Table (content_distributions Id)
ad_banner_button

The call-to-action (CTA) button displayed on the ad (e.g. Learn More, Shop Now).

Field LabelAd Banner Button
Data Type
RequiredNo
AccessRead/ Write
Allowed Values /
Input Notes
0 = No Button,
1 = Shop Now,
2 = Sign Up,
3 = Subscribe,
4 = Watch More,
5 = Send WhatsApp Message,
6 = Apply Now,
7 = Book Now,
8 = Contact Us,
9 = Donate Now,
10 = Download,
11 = Get Offer,
12 = Get Quote,
13 = Get Showtimes,
14 = Learn More,
15 = Listen Now,
16 = Get Access,
17 = Request Time,
18 = See Menu,
ad_banner_display_url

The URL linked to the ad distribution

Field LabelBanner Display URL
Data Type
RequiredNo
AccessRead/ Write
Allowed Values /
Input Notes
ad_banner_description

The descriptive text shown on the banner to provide additional context or persuasion.

Field LabelAd Banner Description
Data Type
RequiredNo
AccessRead/ Write
Allowed Values /
Input Notes
ad_long_headline

The Ad headline used in native ad formats like DV360.

Field LabelAd Long Headline
Data Type
RequiredNo
AccessRead/ Write
Allowed Values /
Input Notes
ad_body_text

The Ad main body text used in native ad formats like DV360.

Field LabelAd Body Text
Data Type
RequiredNo
AccessRead/ Write
Allowed Values /
Input Notes
native_ad_platform

Specifies the platform this native ad is intended for (e.g. Outbrain).

Field LabelNative Ad Platform
Data Type
RequiredNo
AccessRead/ Write
Allowed Values /
Input Notes
1 = Taboola,
2 = DV360
display_ad_type

Defines the visual format or category of the display ad (e.g. Banner, Interstitial, Sidebar).

Field LabelDisplay Type
Data Type
RequiredNo
AccessRead/ Write
Allowed Values /
Input Notes
1 = Banner,
2 = Interstitial,
3= Sidebar
ad_audiences

Specifies which audiences or targeting segments are selected for this ad.

Field LabelAudiences
Data Type
RequiredNo
AccessRead
Allowed Values /
Input Notes
created_at

Date and time the distribution record was created, including the user who performed the action.

Field LabelCreated At
Data Type
RequiredSystem Generated
AccessRead
Allowed Values /
Input Notes
updated_at

Date and time the distribution record was last updated, including the user who performed the action.

Field LabelUpdated At
Data Type
RequiredSystem Generated
AccessRead
Allowed Values /
Input Notes
deleted_at

Date and time the distribution record was deleted, including the user who performed the action.

Field LabelDeleted At
Data Type
RequiredSystem Generated
AccessRead
Allowed Values /
Input Notes
Previous
Update Content
Next
Distributions List