Avid PubSuite Partner API
  1. Phases
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
        GET
      • Phase
        POST
      • Phase Detail
        GET
      • Delete Phase
        DELETE
      • Phase Update
        PUT
    • Content
      • Content Body Parameters
      • Contents
      • Content Detail
      • Create Content
      • Delete Content
      • Update Content
    • Distributions
      • Distribution Body Parameters
      • Distributions List
      • Create Distributions
      • Delete Distribution
      • Distribution Details
      • Distribution Update
    • 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. Phases

Phase Body Parameters

⚠️ This page is actively being updated

phase_id

A unique identifier automatically assigned to each phase within a campaign.

Field LabelPhase ID
Data Type
RequiredNo
AccessRead
Allowed Values /
Input Notes
campaign_id

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

Field LabelCampaign ID
Data Type
RequiredNo
AccessRead/ Write
Allowed Values /
Input Notes
Ref Table = campaigns
phase_title

The title or name of the phase, typically reflecting the theme, objective, or content focus for this portion of the campaign

Field LabelPhase Title
Data Type
RequiredNo
AccessRead/ Write
Allowed Values /
Input Notes
phase_no

The sequence or order number assigned to the phase (e.g., Phase 1, Phase 2). Helps identify its position within the full campaign.

Field LabelPhase Number
Data Type
RequiredNo
AccessWrite/ Read
Allowed Values /
Input Notes
phase_description

A free text field to provide more detail or context about what the phase covers, including objectives, messaging, or strategic focus.

Field LabelPhase Description
Data Type
RequiredNo
AccessRead/ Write
Allowed Values /
Input Notes
phase_pacing

Describes how the content within the phase should be delivered over time (e.g., even pacing, front-paced, or evenly-paced). Helps inform scheduling and performance expectations.

Field LabelPhase Pacing
Data Type
RequiredNo
AccessRead/ Write
Allowed Values /
Input Notes
key_message

The core messages or themes that must be communicated in this phase. May include product benefits, campaign slogans, or promotional details.

Field LabelKey Phase Message(s)
Data Type
RequiredNo
AccessRead/ Write
Allowed Values /
Input Notes
primary_cta

The primary action the Advertiser wants the audience to take during this phase (e.g., “Shop Now”, “Learn More”, “Sign Up”).

Field LabelPhase Main Call To Action
Data Type
RequiredNo
AccessRead/ Write
Allowed Values /
Input Notes
phase_net_spend

The total net budget allocated to this phase, after any applicable discounts or deductions. Excludes tax and service fees.

Field LabelPhase Net Spend
Data Type
RequiredNo
AccessRead/ Write
Allowed Values /
Input Notes
earliest_phase_launch_date

The first possible date that any content within the phase may go live. Does not require all content to launch on this date.

Field LabelEarliest Phase Live Date
Data Type
RequiredNo
AccessRead/ Write
Allowed Values /
Input Notes
latest_phase_launch_date

The final permissible date for content within this phase to go live. All content for the phase should be live on or before this date.

Field LabelLatest Phase Live Date
Data Type
RequiredNo
AccessRead/ Write
Allowed Values /
Input Notes
earliest_phase_end_date

The soonest date all content within the phase can be completed and taken offline.

Field LabelEarliest Phase End Date
Data Type
RequiredNo
AccessRead/ Write
Allowed Values /
Input Notes
latest_phase_end_date

The last allowable date for the phase to be completed and all related content to be taken offline.

Field LabelLatest Phase End Date
Data Type
RequiredNo
AccessRead/ Write
Allowed Values /
Input Notes
g_impressions

The minimum number of impressions the Publisher commits to delivering during this phase.

Field LabelGuaranteed Impressions
Data Type
RequiredNo
AccessRead/ Write
Allowed Values /
Input Notes
e_impressions

The forecasted number of impressions the Publisher expects to deliver during this phase. This is an estimate and not guaranteed. Actual delivery may vary.

Field LabelExpected Impressions
Data Type
RequiredNo
AccessRead/ Write
Allowed Values /
Input Notes
g_video_views

The minimum number of video plays the Publisher commits to delivering during this phase.

Field LabelGuaranteed Video Plays
Data Type
RequiredNo
AccessRead/ Write
Allowed Values /
Input Notes
e_video_views

The forecasted number of video plays the Publisher expects to deliver during this phase. This is an estimate and not guaranteed. Actual delivery may vary.

Field LabelExpected Video Plays
Data Type
RequiredNo
AccessRead/ Write
Allowed Values /
Input Notes
g_article_views

The minimum number of article views the Publisher commits to delivering during this phase.

Field LabelGuaranteed Article Views
Data Type
RequiredNo
AccessRead/ Write
Allowed Values /
Input Notes
e_article_views

The forecasted number of article views the Publisher expects to deliver during this phase. This is an estimate and not guaranteed. Actual delivery may vary.

Field LabelExpected Article Views
Data Type
RequiredNo
AccessRead/ Write
Allowed Values /
Input Notes
g_traffic_to_site

The minimum number of clicks to site the Publisher commits to delivering during this phase.

Field LabelGuaranteed Traffic to Site
Data Type
RequiredNo
AccessRead/ Write
Allowed Values /
Input Notes
e_traffic_to_site

The forecasted number of clicks to site the Publisher expects to deliver during this phase. This is an estimate and not guaranteed. Actual delivery may vary.

Field LabelExpected Traffic to Site
Data Type
RequiredNo
AccessRead/ Write
Allowed Values /
Input Notes
no_of_pieces

The total number of individual content pieces (e.g., articles, videos, social posts) planned or booked for this phase.

Field LabelNo of Phase Content Pieces
Data Type
RequiredNo
AccessRead/ Write
Allowed Values /
Input Notes
created_at

Date and time the phase record was created.

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

Date and time the phase record was last updated.

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

Date and time the phase record was deleted.

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