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

Testing
POST
https://api.avidpubsuite.com/v2/phases
Creates a new campaign phase with metadata including title, pacing, messaging, content performance targets, and launch/end dates. This endpoint is used to define the structure and performance expectations of a phase before activation or execution.

Request

Authorization
Add parameter in header
X-API-Key
Example:
X-API-Key: ********************
Header Params

Body Params application/json

Example
{
  "campaign_id": 1,
  "phases": [
    {
      "phase_no": 12,
      "external_id": "22",
      "phase_title": "Preeeeee-Series Awarenesss",
      "phase_description": "The first phase of the campaign will focus on creating awareness and building excitement for the upcoming cricket series between Australia and Pakistan. The phase will leverage social media, articles, and teaser videos.",
      "phase_pacing": 2,
      "key_message": "Get ready for the cricket showdown of the year. Stay tuned for exclusive updates and match previews.",
      "earliest_phase_launch_date": "2025-06-01",
      "latest_phase_launch_date": "2025-06-01",
      "earliest_phase_end_date": "2025-06-15",
      "latest_phase_end_date": "2025-06-15",
      "g_impressions": 19956220,
      "e_impressions": 25000000,
      "g_video_views": 33642971,
      "e_video_views": 50000000,
      "g_article_views": 23421487,
      "e_article_views": 30000000,
      "g_traffic_to_site": 18703277,
      "e_traffic_to_site": 25000000,
      "no_of_pieces": 50000000,
      "custom_fields": {
        "adpoint_burst_name": "Cricket Series 2025555 - Awareness"
      }
    },
    {
      "phase_no": 233,
      "external_id": "331",
      "phase_title": "Pre-Series Awareness",
      "phase_description": "The first phase of the campaign will focus on creating awareness and building excitement for the upcoming cricket series between Australia and Pakistan. The phase will leverage social media, articles, and teaser videos.",
      "phase_pacing": 2,
      "key_message": "Get ready for the cricket showdown of the year. Stay tuned for exclusive updates and match previews.",
      "earliest_phase_launch_date": "2025-06-01",
      "latest_phase_launch_date": "2025-06-01",
      "earliest_phase_end_date": "2025-06-15",
      "latest_phase_end_date": "2025-06-15",
      "g_impressions": 19956220,
      "e_impressions": 25000000,
      "g_video_views": 33642971,
      "e_video_views": 50000000,
      "g_article_views": 23421487,
      "e_article_views": 30000000,
      "g_traffic_to_site": 18703277,
      "e_traffic_to_site": 25000000,
      "no_of_pieces": 50000000,
      "custom_fields": {
        "adpoint_burst_name": "Cricket Series 20255555 - Awareness"
      }
    }
  ]
}

Responses

🟢200Success
application/json
Body

Example

{"success":true,"message":"Phase created successfully","data":null}
🟠401Unauthorized
🟠404Resource Not Found
🟠422Unprocessable Entity
🔴500Internal Server Error
Previous
Phases List
Next
Phase Detail