Campaign Body Parameters

⚠️ This page is actively being updated

campaign_status

The current status identifier for the campaign (e.g., in production, live, complete).

Field Label	Campaign Status
Data Type	`enum integer`
Required	No
Access	Read/ Write
Allowed Values / Input Notes	WS Custom Reference Library Provided

workflow_id

The workflow selected for the campaign.

Field Label	Campaign Workflow ID
Data Type	`integer`
Required	No
Access	Read/ Write
Allowed Values / Input Notes	WS Custom Reference Library Provided

campaign_id

A unique identifier automatically assigned to each campaign.

Field Label	ID
Data Type	`integer`
Required	No
Access	Read
Allowed Values / Input Notes

primary_advertiser_account_id

The unique PubSuite code used to identify the Advertiser Organisation the campaign is created for. Not a system ID, but a predefined code specific to each organisation.

Field Label	Primary Advertiser account ID
Data Type	`integer`
Required	Yes
Access	Read/ Write
Allowed Values / Input Notes

campaign_title

The title or name of the campaign as entered by the user. May include brand, product, or objective references to help quickly identify the campaign within the platform.

Field Label	Campaign Title
Data Type	`string`
Required	No
Access	Read/ Write
Allowed Values / Input Notes

brand_promoting

The name of the brand being promoted within the campaign.

Field Label	Brand Promoting
Data Type	`string`
Required	No
Access	Read/ Write
Allowed Values / Input Notes

brand_industry_id

The industry category (E.g., Travel, Finance, Alcohol) assigned to this campaign in relation to the Advertiser's Brand.

Field Label	Brand Industry
Data Type	`integer`
Required	No
Access	Read
Allowed Values / Input Notes	Pubsuite Reference Library Available. View Brand Industries Values

brand_sub_industry_id

A more specific sub-category within the main industry that campaign belongs to in relation to the Advertiser's Brand.

Field Label	Brand Sub Industry
Data Type	`integer`
Required	No
Access	Read
Allowed Values / Input Notes	Pubsuite Reference Library Available. View Brand Industries Values

campaign_content_tactic

Content Tactics are Avid Pubsuite Campaign strategies that can be utilised by Publishers to drive better content results. Discuss with your Avid PubSuite Sales Manager.

Field Label	Campaign Solution
Data Type	`enum integer`
Required	No
Access	Read
Allowed Values / Input Notes	Pubsuite Reference Library Available. View Content Tactics Values

campaign_description

A free text field used to provide additional context, narrative, or background about the campaign.

Field Label	Campaign Description
Data Type	`string`
Required	No
Access	Read/ Write
Allowed Values / Input Notes

campaign_objective

The main goal or purpose of the campaign (e.g., increasing awareness, driving engagement, boosting conversion).

Field Label	Campaign Objective
Data Type	`string`
Required	No
Access	Read/ Write
Allowed Values / Input Notes

campaign_target_audience_summary

A short, clear summary of the campaign's intended audience, outlining demographics, interests, behaviours, and more (if known or applicable).

Field Label	Campaign Target Audience Summary
Data Type	`string`
Required	No
Access	Write/ Read
Allowed Values / Input Notes

no_content_pieces

Total number of content distribution pieces booked in the signed insertion order (IO).

Field Label	No. Of Content Pieces
Data Type	`number`
Required	No
Access	Read/ Write
Allowed Values / Input Notes

earliest_start_date

The earliest possible live date for any piece of content within the campaign. This does not require all content to be live—just the earliest point at which at least one piece can go live.

Field Label	Earliest Campaign Launch Date
Data Type	`string <date-time>`
Required	No
Access	Read
Allowed Values / Input Notes

latest_start_date

The latest possible live date for any piece of content in the campaign. Not all content must launch at this time—this marks the final window by which at least one piece should be live.

Field Label	Latest Campaign Launch Date
Data Type	`string <date-time>`
Required	No
Access	Read
Allowed Values / Input Notes

earliest_end_date

The earliest possible date by which all campaign content can be completed and taken offline. This marks the soonest point the entire campaign can wrap up.

Field Label	Earliest Campaign End Date
Data Type	`string <date-time>`
Required	No
Access	Read
Allowed Values / Input Notes

latest_end_date

The latest permissible date by which all content must be completed and the entire campaign must end. No content should remain live or in-flight beyond this point.

Field Label	Latest Campaign End Date
Data Type	`string <date-time>`
Required	No
Access	Read
Allowed Values / Input Notes

actual_start_date

The confirmed date when the campaign is officially live, marked by the first piece of content going live. This may differ from the planned launch window and reflects the actual go-live milestone.

Field Label	Actual start date
Data Type	`string <date-time>`
Required	No
Access	Read
Allowed Values / Input Notes

campaign_gross_cost

The full agreed campaign cost before any deductions, including taxes and service fees (e.g., GST).

Field Label	Total Campaign Gross Cost
Data Type	`number`
Required	No
Access	Read/ Write
Allowed Values / Input Notes

campaign_net_cost

The final agreed cost of the campaign after applying all discounts, rebates, and negotiated reductions. This amount excludes any applicable taxes or service fees (e.g., GST).

Field Label	Total Campaign Net Cost
Data Type	`number`
Required	No
Access	Read/ Write
Allowed Values / Input Notes

media_plan_external_url

A URL link to the campaign’s final and approved Media Plan document or resource for reference.

Field Label	External Media Plan Link (Optional)
Data Type	`string`
Required	No
Access	Read/ Write
Allowed Values / Input Notes

rate_card_external_url

A URL link to the campaign’s final and approved Rate Card document for reference.

Field Label	External Rate Card Link (Optional)
Data Type	`string`
Required	No
Access	Read/ Write
Allowed Values / Input Notes

crm_deal_llink

A URL linking to the external Sales CRM system deal or opportunity associated with this campaign.

Field Label	External Sales CRM Deal Link
Data Type	`string`
Required	No
Access	Read/ Write
Allowed Values / Input Notes

performance_monitoring

Indicates whether the Advertiser wants to use external platforms (e.g., Google Analytics, DCM) to monitor the performance of campaign content.

Field Label	Third Party Performance Monitoring
Data Type	`enum integer`
Required	No
Access	Read/ Write
Allowed Values / Input Notes	1 = Yes, 2 = No

tracking_report_info

Details of the Advertiser's third-party tracking or analytics platforms (e.g., Google Analytics, DCM) that will be used to monitor the performance of relevant content distributions in the campaign. User can include specifics such as the platform name and the metrics being tracked.

Field Label	Tracking and Reporting Information
Data Type	`string`
Required	No
Access	Read/ Write
Allowed Values / Input Notes

using_utm_tracking

Indicates whether the Advertiser wants to use use link tracking methods like UTM parameters, click trackers, or similar technologies to track site traffic of relevant content distributions in the campaign.

Field Label	Using UTM/Click Trackers?
Data Type	`enum integer`
Required	Yes
Access	Read/ Write
Allowed Values / Input Notes	0 = No, 1 = Yes

client_external_reporting_tools

Defines the tools/types of tools that will be utilised by the client for tracking and reporting on the campaign

Field Label	Client/Agency Reporting
Data Type	`array [enum integer]`
Required	No
Access	Read
Allowed Values / Input Notes	1 = UTM Tags, 2 = DCM Tags, 3 = Affiliate Platform Tags, 4 = Other

utm_info

Details about the Advertiser’s UTM structure and click-tracking setup for relevant content distributions in the campaign, if this is going to be supplied. This may include the exact format of tracking setup and any instructions for implementation.

Field Label	UTM Info/Click Tracking Info
Data Type	`string`
Required	No
Access	Read/ Write
Allowed Values / Input Notes

universal_content_requirements

Defines any mandatory requirements that apply across all content pieces, such as legal disclaimers, product-specific rules, or other compliance guidelines.

Field Label	Universal Content Requirements
Data Type	`string`
Required	No
Access	Read/ Write
Allowed Values / Input Notes

mandatory_dos

A list of required elements, language, or messaging that must be included in some or all campaign content pieces. This may include legal disclaimers, specific phrases, or brand guidelines (e.g., the brand name must always be written in all capital letter).

Field Label	Mandatory Do's
Data Type	`string`
Required	No
Access	Read/ Write
Allowed Values / Input Notes

mandatory_donts

A list of messaging, claims, themes, or content elements that must not appear in any campaign material. This may include legal restrictions, brand compliance rules, prohibited language, or topics that must be avoided entirely.

Field Label	Mandatory Dont's
Data Type	`string`
Required	No
Access	Read/ Write
Allowed Values / Input Notes

content_look_feel_requests

Describes the desired tone, style, and overall impression the campaign content should convey to the audience. Examples include aiming for a premium and polished look, a fun and casual vibe, or a relaxed and accessible approach.

Field Label	Content Look and Feel Requests
Data Type	`string`
Required	No
Access	Read/ Write
Allowed Values / Input Notes

additional_audience_targeting_notes

A free text field used to provide additional context or details about audience targeting, including any demographic, behavioural or segment-related instructions per product, phase or content.

Field Label	Additional Audience Targeting Notes
Data Type	`string`
Required	No
Access	Read/ Write
Allowed Values / Input Notes

additonal_campaign_notes

Internal-use only. Captures extra context that helps define campaign success from the internal team's perspective. May include success metrics, resell or upsell opportunities, client preferences, or key watchouts. Not visible to Advertisers.

Field Label	Additional Campaign Notes
Data Type	`string`
Required	No
Access	Read/ Write
Allowed Values / Input Notes

potential_up_sell_opportunities

Internal-only. Details key success factors and metrics that can lead to future bookings (resell opportunities), as well as strategies or insights to help unlock additional budget (upsell opportunities). Not visible to Advertisers.

Field Label	Potential Re-Sell & Upsell Opportunities
Data Type	`string`
Required	No
Access	Read/ Write
Allowed Values / Input Notes

facebook_profile_to_tag

The official Facebook Page handle of the Advertiser’s brand (e.g., @brandname), used for tagging, attribution, and linking within campaign content and reporting.

Field Label	Social Handle FB
Data Type	`string`
Required	No
Access	Read/ Write
Allowed Values / Input Notes

instagram_profile_to_tag

The official Instagram handle of the Advertiser’s brand (e.g., @brandname), used for tagging, attribution, and linking within campaign content and reporting.

Field Label	Social Handle IG
Data Type	`string`
Required	No
Access	Read/ Write
Allowed Values / Input Notes

tiktok_profile_to_tag

The official TikTok handle of the Advertiser’s brand (e.g., @brandname), used for tagging, attribution, and linking within campaign content and reporting.

Field Label	Social Handle TikTok
Data Type	`string`
Required	No
Access	Read/ Write
Allowed Values / Input Notes

linkedin_profile_to_tag

The official LinkedIn handle of the Advertiser’s brand (e.g., company or page name), used for tagging, attribution, and linking within campaign content and reporting.

Field Label	Social Handle LinkedIn
Data Type	`string`
Required	No
Access	Read/ Write
Allowed Values / Input Notes

pinterest_profile_to_tag

The official Pinterest handle of the Advertiser’s brand (e.g., @brandname), used for tagging, attribution, and linking within campaign content and reporting.

Field Label	Social Handle Pinterest
Data Type	`string`
Required	No
Access	Write/ Read
Allowed Values / Input Notes

advertiser_primary_campaign_manager_id

The main point of contact from the Advertiser side who inputs, reviews, and oversees all campaign implementation activities.

Field Label	Advertiser Primary Campaign Manager
Data Type	`integer`
Required	No
Access	Read/ Write
Allowed Values / Input Notes

primary_campaign_manager_email

Field Label	Advertiser Primary Campaign Manager Email
Data Type	`string`
Required	No
Access	Read/ Write
Allowed Values / Input Notes

advertiser_primary_commercial_manager_id

The main contact from the Advertiser responsible for managing commercial terms, billing details, and financial requirements for the campaign.

Field Label	Advertiser Primary Commercial Manager ID
Data Type	`integer`
Required	No
Access	Read/ Write
Allowed Values / Input Notes

primary_commercial_manager_email

Field Label	Advertiser Primary Commercial Manager Email
Data Type	`string`
Required	No
Access	Read/ Write
Allowed Values / Input Notes

billing_company_name

Name of the organisation responsible for billing related to this campaign.

Field Label	Billing Organisation
Data Type	`string`
Required	No
Access	Read/ Write
Allowed Values / Input Notes

billing_company_address

Physical address of the billing organisation used for invoicing purposes.

Field Label	Billing Company Address
Data Type	`string`
Required	No
Access	Read/ Write
Allowed Values / Input Notes

billing_contact_person

Full name of the primary contact handling all billing matters.

Field Label	Billing Contact Person
Data Type	`string`
Required	No
Access	Read/ Write
Allowed Values / Input Notes

billing_contact_email

Email address of the primary contact handling all billing matters.

Field Label	Billing Contact Email
Data Type	`string`
Required	No
Access	Read/ Write
Allowed Values / Input Notes

billing_contact_phone

Phone number of the primary contact handling all billing matters.

Field Label	Billing Contact Phone
Data Type	`integer`
Required	No
Access	Read/ Write
Allowed Values / Input Notes

purchase_order_number

Advertiser-provided purchase order (PO) number associated with the campaign, if applicable.

Field Label	Purchase Order Number
Data Type	`string`
Required	No
Access	Read/ Write
Allowed Values / Input Notes

g_impressions

The minimum number of impressions the Publisher commits to delivering to the Advertiser for the whole campaign.

Field Label	Guaranteed Impressions
Data Type	`integer`
Required	No
Access	Read/ Write
Allowed Values / Input Notes

e_impressions

The forecasted number of impressions the Publisher expect to deliver for the whole campaign. This is an estimate and is not guaranteed. Actual delivery may vary.

Field Label	Expected Impressions
Data Type	`integer`
Required	No
Access	Read/ Write
Allowed Values / Input Notes

g_article_views

The minimum number of article views the Publisher commits to delivering to the Advertiser for the whole campaign.

Field Label	Guaranteed Article Views
Data Type	`integer`
Required	No
Access	Read/ Write
Allowed Values / Input Notes

e_article_views

The forecasted number of article views the Publisher expect to deliver for the whole campaign. This is an estimate and is not guaranteed. Actual delivery may vary.

Field Label	Expected Article Views
Data Type	`integer`
Required	No
Access	Read/ Write
Allowed Values / Input Notes

g_clicks_to_site

The minimum number of clicks to site the Publisher commits to delivering to the Advertiser for the whole campaign.

Field Label	Guaranteed Traffic to Site
Data Type	`integer`
Required	No
Access	Read/ Write
Allowed Values / Input Notes

e_licks_to_site

The forecasted number of clicks to site the Publisher expect to deliver for the whole campaign. This is an estimate and is not guaranteed. Actual delivery may vary.

Field Label	Expected Traffic to Site
Data Type	`integer`
Required	No
Access	Read/ Write
Allowed Values / Input Notes

g_video_views

The minimum number of video plays the Publisher commits to delivering to the Advertiser for the whole campaign.

Field Label	Guaranteed Video Plays
Data Type	`integer`
Required	No
Access	Read/ Write
Allowed Values / Input Notes

e_video_views

The forecasted number of video plays the Publisher expect to deliver for the whole campaign. This is an estimate and is not guaranteed. Actual delivery may vary.

Field Label	Expected Video Plays
Data Type	`integer`
Required	No
Access	Read/ Write
Allowed Values / Input Notes

deleted_at

Date and time the content record was deleted.

Field Label	Deleted At
Data Type	`string <date-time>`
Required	No
Access	Read
Allowed Values / Input Notes

created_at

Date and time the content record was created

Field Label	Created At
Data Type	`string <date-time>`
Required	No
Access	Read
Allowed Values / Input Notes

updated_at

Date and time the content record was last updated.

Field Label	Updated At
Data Type	`string <date-time>`
Required	No
Access	Read
Allowed Values / Input Notes

Campaign Parameters Value Definitions

Workspace Camapign Team Roles - Role Type Values

The Workspace Campaign Team roles allows you to assign you Workspace internal team to Campaign Team Roles to assist in campaign managment and actions. Assign your team to the right role based on their desired involvement in the campaign. Team members can be assigned to more than one role.

Manager Type	ID	Description	Operational Impact
Campaign Manager	1	This Campaign Manager Role is best suited to the team member(s) who will running your campagn.	Permissions Campaign Managers recieve primary access across the entire campaign including campaign, content, and distribution editing. Default Campaign Notifications They recieve notifications relating campaign, content and distribution updates
Commercial Manager	2	The Commerical Manager Role is best suited for the team member(s) who facilitated the Sale of services to the advertiser.	For workspaces using Campaign Builder, Commerical Managers are copied from campaign plans into campaigns during conversion when a plan is approved. Permissions Commercial Managers are able to view all campaign information but not make changes to actual campaigns themselves. They can make changes to campaign plans in campaign builder which inturn upon approval update Campaigns. Default Campaign Notifications Commerical Managers dont recieve any notifcations
Account Manager	3	The Account Manager Role is responsible for managing the advertiser relationship throughout campaign setup and implementation, liaise with internal teams, and address advertiser inquiries	Permissions Account Managers are given permissions to coordinate campaign level configuration Default Campaign Notifcations Recieve notfications on campaign level updates.
Content Manager	4	Content Manager are responsible for overseeing the Content for each campaign. This role is best suited to the person who is accountable for content quality.	Permissions Primary access to content pieces, including creating, editing, and deleting. Default Campaign Notifcations Recieve notfications in relation to content review updates
Content Editor	5	Is responsible for content pieces, including creating, editing, and deleting. This role is best suited to the person who will be creating your content.	Permissions Partial access to content with a focus on being able to be assigned and contribute to content pieces, but excluded from editing fundamental campaign details. Default Campaign Notifcations Updates relating to content they're assigned to
Content Scheduler	6	The Content Scheduler role is for team members who are responsible for posting content on live digital assets	Permissions Ability to manage content status and set content to go live Default Campaign Notifcations Updates relating content being ready for scheduling
Reporting Manager	7	The Reporting Manger roles is for team members who are responsible for ensuring campaign reporting data is accurate.	Permissions Ability to manage distribution content performance data records Default Campaign Notifcations Recieves notifications for campaign reporting checkups.

Campaign Body Parameters