Phase Update - Avid PubSuite Partner API

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": [
        {
            "id": 10,
            "phase_no": 1,
            "phase_title": "Awarenes Launch",
            "earliest_phase_launch_date": "2025-08-01",
            "latest_phase_launch_date": "2025-08-05",
            "earliest_phase_end_date": "2025-08-20",
            "latest_phase_end_date": "2025-08-25",
            "no_of_pieces": 12,
            "g_impressions": 150000,
            "e_impressions": 180000,
            "g_article_views": 30000,
            "e_article_views": 35000,
            "g_video_views": 20000,
            "e_video_views": 25000,
            "g_traffic_to_site": 6000,
            "e_traffic_to_site": 8500,
            "phase_pacing": 8,
            "phase_description": "Launch phase designed to generate maximum visibility across paid media, PR, and owned channels."
        },
         {
            "id": 11,
            "phase_no": 1,
            "phase_title": "Awarenes Launch",
            "earliest_phase_launch_date": "2025-08-01",
            "latest_phase_launch_date": "2025-08-05",
            "earliest_phase_end_date": "2025-08-20",
            "latest_phase_end_date": "2025-08-25",
            "no_of_pieces": 12,
            "g_impressions": 150000,
            "e_impressions": 180000,
            "g_article_views": 30000,
            "e_article_views": 35000,
            "g_video_views": 20000,
            "e_video_views": 25000,
            "g_traffic_to_site": 6000,
            "e_traffic_to_site": 8500,
            "phase_pacing": 8,
            "phase_description": "Launch phase designed to generate maximum visibility across paid media, PR, and owned channels."
        }
    ]
}

Responses

🟢200Success

application/json

Body

Example

{
    "success": true,
    "message": "string",
    "data": {
        "phase": {
            "phase_id": 0,
            "campaign_id": 0,
            "phase_title": "string",
            "phase_no": 0,
            "phase_description": "string",
            "phase_pacing": "string",
            "earliest_phase_launch_date": "string",
            "latest_phase_launch_date": "string",
            "earliest_phase_end_date": "string",
            "latest_phase_end_date": "string",
            "created_at": "string",
            "updated_at": "string",
            "deleted_at": null
        }
    }
}

🟠401Unauthorized

🟠404Resource Not Found

🟠422Unprocessable Entity

🔴500Internal Server Error