Partnerize · Example Payload
Partnerize Examples
Example requests and responses for the Partnerize API
Affiliate MarketingPartner MarketingPartnershipsPerformance MarketingCommissionsTrackingAnalytics
Partnerize Examples is an example object payload from Partnerize, with 3 top-level fields. It illustrates the shape of data this provider's APIs accept or return.
Top-level fields
descriptionbrandspartners
Example Payload
{
"description": "Example requests and responses for the Partnerize API",
"brands": {
"brands_listNetworks_200_response": {
"response": {
"value": {
"networks": [
{
"network": {
"auto_approve_publishers": "y",
"cm_client_id": "b4d0d85c2cff813cdce092c261b2b200",
"default_campaign_id": "",
"network_application_id": "2",
"network_contact_email": "",
"network_description": "PHG Network",
"network_id": "1l1000003",
"network_locale": "bg",
"network_name": "PHG",
"network_notes": "Internal PHG Network"
}
}
]
}
}
},
"brands_listAllPartnersOnTheNetwork_200_response": {
"response": {
"value": {
"publishers": [
{
"publisher": {
"abn": null,
"account_name": "publisher123",
"campaign_select": null,
"company_division": null,
"company_name": "Demo Partner",
"contact_email": "demo@performancehorizon.com",
"contact_locale": "bg",
"contact_name": "John Smith",
"databases": [
{
"active": "y",
"creation_method": "Email",
"database_id": "111111l300347",
"database_name": "Partnerize Test Database",
"female": 50,
"male": 50,
"max_age": 77,
"min_age": 25,
"publisher_id": "1l1007802",
"size": 53000
}
],
"default_currency": "GBP",
"description": null,
"foreign_identifier": null,
"gst_registered": null,
"im_provider": "Skype",
"im_username": "elisangis",
"is_affiliate_user": "y",
"is_foreign_network": "y",
"is_lead_user": "y",
"legal_entity": "GB",
"network_id": "1l1000003",
"network_notes": null,
"network_status": "a",
"operating_country": "GB",
"phone": "01595725007",
"phone_area": "+44",
"promotional_method": 10,
"promotional_method_name": "Portal",
"promotional_countries": [
{
"iso": "GB",
"name": "United Kingdom"
},
{
"iso": "US",
"name": "United States"
}
],
"publisher_id": "1l1007802",
"reporting_identifier": null,
"reporting_timezone": "Australia/Sydney",
"signup_ip": "178.23.129.160",
"uk_vat_registered": "y",
"us_tax_state": null,
"vat_number": 974997534,
"vertical": 10,
"vertical_name": "Other",
"websites": [
{
"active": "y",
"primary": "n",
"description": "Demo Partner website",
"publisher_id": "1l1007802",
"website_country": "GB",
"website_id": "11l18694",
"website_name": null,
"website_type": 9,
"website_type_name": "PPC",
"website_url": "http://www.performancehorizon.com",
"website_vertical": 10,
"website_vertical_name": "Technical"
}
],
"week_start": "Monday"
}
}
]
}
}
},
"brands_updatePartnersNetworkStatus_200_response": {
"response": {
"value": {
"publishers": [
{
"publisher": {
"abn": null,
"account_name": "partner123",
"campaign_select": null,
"company_division": null,
"company_name": "Demo Partner",
"contact_email": "demo@performancehorizon.com",
"contact_locale": "bg",
"contact_name": "John Smith",
"databases": [
{
"active": "y",
"creation_method": "Email",
"database_id": "111111l300347",
"database_name": "Partnerize Test Database",
"female": 50,
"male": 50,
"max_age": 77,
"min_age": 25,
"publisher_id": "1l1007802",
"size": 53000
}
],
"default_currency": "GBP",
"description": null,
"foreign_identifier": null,
"gst_registered": null,
"im_provider": "Skype",
"im_username": "elisangis",
"is_affiliate_user": "y",
"is_foreign_network": "y",
"is_lead_user": "y",
"legal_entity": "GB",
"network_id": "1l1000003",
"network_notes": null,
"network_status": "a",
"operating_country": "GB",
"phone": "01595725007",
"phone_area": "+44",
"promotional_method": 10,
"promotional_method_name": "Portal",
"publisher_id": "1l1007802",
"reporting_identifier": null,
"reporting_timezone": "Australia/Sydney",
"signup_ip": "178.23.129.160",
"uk_vat_registered": "y",
"us_tax_state": null,
"vat_number": 974997534,
"vertical": 10,
"vertical_name": "Other",
"websites": [
{
"active": "y",
"primary": "n",
"description": "Demo Partner website",
"publisher_id": "1l1007802",
"website_country": "GB",
"website_id": "11l18694",
"website_name": null,
"website_type": 9,
"website_type_name": "PPC",
"website_url": "http://www.performancehorizon.com",
"website_vertical": 10,
"website_vertical_name": "Technical"
}
],
"week_start": "Monday"
}
}
]
}
}
},
"brands_List-network-terms-and-conditions_200_response": {
"response": {
"value": {
"terms": [
{
"term": {
"locale": "bg",
"ref_legal_entity_id": "1",
"ref_terms_and_conditions_locale_id": "11l100",
"terms_and_conditions": "You must accept these terms and conditions to join",
"tnc_type": "entity"
}
}
]
}
}
},
"brands_listAllCampaigns_200_response": {
"response": {
"value": {
"campaigns": [
{
"campaign": {
"advertiser_id": "10l110",
"allow_deep_linking": "y",
"allow_third_party_pixel": "y",
"append_url_parameters": "",
"associated_campaigns": "",
"automated_invoicing_date": 4,
"automated_invoicing_po_number": null,
"auto_approve_publisher": "y",
"auto_rejected_ips": null,
"basket_value_cap": null,
"budget_summary_interval": null,
"budget_summary_start_time": null,
"campaign_currency_conversions": [],
"campaign_id": "10l176",
"campaign_languages": null,
"campaign_logo": "http://partnerize.com/logo.png",
"campaign_notes": "",
"campaign_overloads": [],
"commission_by_meta_label": "[ \"label 1\",\"label 2\" ]",
"commission_by_meta": "[ \"field_1\",\"field_2\" ]",
"commissions": [],
"conversion_hiatus_period": 7,
"conversion_type": "sale",
"cookie_period": 0,
"cookie_status": null,
"default_commission_rate": "5",
"default_currency": "GBP",
"default_override": 10,
"deferred_lead_submission": null,
"description": {
"en": "<p>Awesome new campaign</p>"
},
"destination_url": "http://www.performancehorizon.com",
"dont_consolidate": "y",
"dont_invoice": "y",
"extra_restricted_deep_linking": "",
"force_approve_period": 0,
"hidden_campaign": "y",
"invoice_address_1": null,
"invoice_address_2": null,
"invoice_address_3": null,
"invoice_address_4": null,
"invoice_address_country": null,
"invoice_address_postcode": null,
"invoice_company": null,
"invoice_contact": null,
"invoice_only": null,
"ip_tracking_time": 0,
"is_cpc": "y",
"lead_confirmation_url_fail": "",
"lead_confirmation_url_success": "",
"multiple_conversions_per_click": "n",
"network_fee": null,
"pay_publisher_directly": "y",
"payment_date": null,
"prepend_url_string": "http://google.com",
"recurring_payment_setup": "y",
"report_meta_purge_period": null,
"reporting_timezone": "Australia/Sydney",
"restricted_deep_linking": "y",
"secure_tracking": "y",
"status": "a",
"terms": {
"en": {
"terms": "Important campaign terms and conditions"
}
},
"test_mode": "y",
"title": "PHG Aff Demo",
"tq_auto_approve": 60,
"tq_enabled": "y",
"tq_enabled_publishers": "",
"tracking_method": "s2s",
"tracking_subdomain": null,
"unique_conversion_refs": "y",
"vertical_id": 10,
"vertical_name": "Other",
"week_start": "Monday",
"advertiser_name": "Advertiser Name"
}
}
]
}
}
},
"brands_createACampaign_200_response": {
"response": {
"value": {
"campaign": {
"advertiser_id": "10l110",
"allow_deep_linking": "y",
"allow_third_party_pixel": "y",
"append_url_parameters": "",
"associated_campaigns": "",
"automated_invoicing_date": 4,
"automated_invoicing_po_number": null,
"auto_approve_publisher": "y",
"auto_rejected_ips": null,
"budget_summary_interval": null,
"budget_summary_start_time": null,
"campaign_currency_conversions": [],
"campaign_id": "10l176",
"campaign_languages": null,
"campaign_logo": "http://performancehorizon.com/logo.png",
"campaign_notes": "",
"campaign_overloads": [],
"commission_by_meta_label": "[ \"label 1\",\"label 2\" ]",
"commission_by_meta": "[ \"field_1\",\"field_2\" ]",
"commissions": [],
"conversion_hiatus_period": 7,
"conversion_type": "sale",
"cookie_period": 0,
"cookie_status": null,
"default_commission_rate": "5",
"default_currency": "GBP",
"default_override": 10,
"deferred_lead_submission": null,
"description": {
"en": "<p>Awesome new campaign</p>"
},
"destination_url": "http://www.performancehorizon.com",
"dont_consolidate": "y",
"dont_invoice": "y",
"extra_restricted_deep_linking": "",
"force_approve_period": 0,
"hidden_campaign": "y",
"invoice_address_1": null,
"invoice_address_2": null,
"invoice_address_3": null,
"invoice_address_4": null,
"invoice_address_country": null,
"invoice_address_postcode": null,
"invoice_company": null,
"invoice_contact": null,
"invoice_only": null,
"ip_tracking_time": 0,
"is_cpc": "y",
"lead_confirmation_url_fail": "",
"lead_confirmation_url_success": "",
"multiple_conversions_per_click": "n",
"network_fee": null,
"pay_publisher_directly": "y",
"payment_date": null,
"prepend_url_string": "http://google.com",
"promotional_countries": [
{
"iso": "US",
"name": "United States"
},
{
"iso": "GB",
"name": "United Kingdom"
}
],
"recurring_payment_setup": "y",
"report_meta_purge_period": null,
"reporting_timezone": "Australia/Sydney",
"restricted_deep_linking": "y",
"secure_tracking": "y",
"status": "a",
"terms": {
"en": {
"terms": "Important campaign terms and conditions"
}
},
"test_mode": "y",
"title": "PHG Aff Demo",
"tq_auto_approve": 60,
"tq_enabled": "y",
"tq_enabled_publishers": "",
"tracking_method": "s2s",
"tracking_subdomain": null,
"unique_conversion_refs": "y",
"vertical_id": 10,
"vertical_name": "Other",
"week_start": "Monday",
"advertiser_name": "Advertiser Name"
}
}
}
},
"brands_Retrieve a Campaign_200_response": {
"response": {
"value": {
"campaign": {
"campaign_icon": "https://console.partnerize.com/assets/icons/campaigns/10l176.png",
"advertiser_id": "10l110",
"allow_deep_linking": "y",
"allow_third_party_pixel": "y",
"append_url_parameters": "",
"associated_campaigns": "",
"automated_invoicing_date": 4,
"automated_invoicing_po_number": null,
"auto_approve_publisher": "y",
"auto_rejected_ips": null,
"budget_summary_interval": null,
"budget_summary_start_time": null,
"campaign_currency_conversions": [],
"campaign_id": "10l176",
"campaign_languages": null,
"campaign_logo": "http://performancehorizon.com/logo.png",
"campaign_notes": "",
"campaign_overloads": [],
"commission_by_meta_label": "[ \"label 1\",\"label 2\" ]",
"commission_by_meta": "[ \"field_1\",\"field_2\" ]",
"commissions": [],
"conversion_hiatus_period": 7,
"conversion_type": "sale",
"cookie_period": 0,
"cookie_status": null,
"default_commission_rate": "5",
"default_currency": "GBP",
"default_override": 10,
"deferred_lead_submission": null,
"description": {
"en": "Awesome new campaign"
},
"destination_url": "http://www.performancehorizon.com",
"dont_consolidate": "y",
"dont_invoice": "y",
"extra_restricted_deep_linking": "",
"force_approve_period": 0,
"hidden_campaign": "y",
"invoice_address_1": null,
"invoice_address_2": null,
"invoice_address_3": null,
"invoice_address_4": null,
"invoice_address_country": null,
"invoice_address_postcode": null,
"invoice_company": null,
"invoice_contact": null,
"invoice_only": null,
"ip_tracking_time": 0,
"is_cpc": "y",
"lead_confirmation_url_fail": "",
"lead_confirmation_url_success": "",
"multiple_conversions_per_click": "n",
"network_fee": null,
"pay_publisher_directly": "y",
"payment_date": null,
"prepend_url_string": "http://google.com",
"promotional_countries": [
{
"iso": "US",
"name": "United States"
},
{
"iso": "GB",
"name": "United Kingdom"
}
],
"recurring_payment_setup": "y",
"report_meta_purge_period": null,
"reporting_timezone": "Australia/Sydney",
"restricted_deep_linking": "y",
"secure_tracking": "y",
"status": "a",
"terms": {
"en": {
"terms": "Important campaign terms and conditions"
}
},
"test_mode": "y",
"title": "PHG Aff Demo",
"tq_auto_approve": 60,
"tq_enabled": "y",
"tq_enabled_publishers": "",
"tracking_method": "s2s",
"tracking_subdomain": null,
"unique_conversion_refs": "y",
"vertical_id": 10,
"vertical_name": "Other",
"week_start": "Monday",
"advertiser_name": "Advertiser Name"
}
}
}
},
"brands_Delete a Campaign_200_response": {
"response": {
"value": {
"campaign": {
"campaign_icon": "http://example.com/path/to/image.png",
"advertiser_id": "10l110",
"allow_deep_linking": "y",
"allow_third_party_pixel": "y",
"append_url_parameters": "",
"associated_campaigns": "",
"automated_invoicing_date": 4,
"automated_invoicing_po_number": null,
"auto_approve_publisher": "y",
"auto_rejected_ips": null,
"budget_summary_interval": null,
"budget_summary_start_time": null,
"campaign_currency_conversions": [],
"campaign_id": "10l176",
"campaign_languages": null,
"campaign_logo": "http://performancehorizon.com/logo.png",
"campaign_notes": "",
"campaign_overloads": [],
"commission_by_meta_label": "[ \"label 1\",\"label 2\" ]",
"commission_by_meta": "[ \"field_1\",\"field_2\" ]",
"commissions": [],
"conversion_hiatus_period": 7,
"conversion_type": "sale",
"cookie_period": 0,
"cookie_status": null,
"default_commission_rate": "5",
"default_currency": "GBP",
"default_override": 10,
"deferred_lead_submission": null,
"description": {
"en": "Awesome new campaign"
},
"destination_url": "http://www.performancehorizon.com",
"dont_consolidate": "y",
"dont_invoice": "y",
"extra_restricted_deep_linking": "",
"force_approve_period": 0,
"hidden_campaign": "y",
"invoice_address_1": null,
"invoice_address_2": null,
"invoice_address_3": null,
"invoice_address_4": null,
"invoice_address_country": null,
"invoice_address_postcode": null,
"invoice_company": null,
"invoice_contact": null,
"invoice_only": null,
"ip_tracking_time": 0,
"is_cpc": "y",
"lead_confirmation_url_fail": "",
"lead_confirmation_url_success": "",
"multiple_conversions_per_click": "n",
"network_fee": null,
"pay_publisher_directly": "y",
"payment_date": null,
"prepend_url_string": "http://google.com",
"recurring_payment_setup": "y",
"report_meta_purge_period": null,
"reporting_timezone": "Australia/Sydney",
"restricted_deep_linking": "y",
"secure_tracking": "y",
"status": "a",
"terms": {
"en": {
"terms": "Important campaign terms and conditions"
}
},
"test_mode": "y",
"title": "PHG Aff Demo",
"tq_auto_approve": 60,
"tq_enabled": "y",
"tq_enabled_publishers": "",
"tracking_method": "s2s",
"tracking_subdomain": null,
"unique_conversion_refs": "y",
"vertical_id": 10,
"vertical_name": "Other",
"week_start": "Monday"
},
"status": {
"campaign_id": "10l176",
"message": "Campaign successfully deleted",
"retire_reason": "No longer needed",
"status": "Deleted"
}
}
}
},
"brands_Update a Campaign_200_response": {
"response": {
"value": {
"campaign": {
"campaign_icon": "https://console.partnerize.com/assets/icons/campaigns/10l176.png",
"advertiser_id": "10l110",
"allow_deep_linking": "y",
"allow_third_party_pixel": "y",
"append_url_parameters": "",
"associated_campaigns": "",
"automated_invoicing_date": 4,
"automated_invoicing_po_number": null,
"auto_approve_publisher": "y",
"auto_rejected_ips": null,
"budget_summary_interval": null,
"budget_summary_start_time": null,
"campaign_currency_conversions": [],
"campaign_id": "10l176",
"campaign_languages": null,
"campaign_logo": "http://performancehorizon.com/logo.png",
"campaign_notes": "",
"campaign_overloads": [],
"commission_by_meta_label": "[ \"label 1\",\"label 2\" ]",
"commission_by_meta": "[ \"field_1\",\"field_2\" ]",
"commissions": [],
"conversion_hiatus_period": 7,
"conversion_type": "sale",
"cookie_period": 0,
"cookie_status": null,
"default_commission_rate": "5",
"default_currency": "GBP",
"default_override": 10,
"deferred_lead_submission": null,
"description": {
"en": "Awesome new campaign"
},
"destination_url": "http://www.performancehorizon.com",
"dont_consolidate": "y",
"dont_invoice": "y",
"extra_restricted_deep_linking": "",
"force_approve_period": 0,
"hidden_campaign": "y",
"invoice_address_1": null,
"invoice_address_2": null,
"invoice_address_3": null,
"invoice_address_4": null,
"invoice_address_country": null,
"invoice_address_postcode": null,
"invoice_company": null,
"invoice_contact": null,
"invoice_only": null,
"ip_tracking_time": 0,
"is_cpc": "y",
"lead_confirmation_url_fail": "",
"lead_confirmation_url_success": "",
"multiple_conversions_per_click": "n",
"network_fee": null,
"pay_publisher_directly": "y",
"payment_date": null,
"prepend_url_string": "http://google.com",
"recurring_payment_setup": "y",
"report_meta_purge_period": null,
"reporting_timezone": "Australia/Sydney",
"restricted_deep_linking": "y",
"secure_tracking": "y",
"status": "a",
"terms": {
"en": {
"terms": "terms for the locale"
}
},
"test_mode": "y",
"title": "PHG Aff Demo",
"tq_auto_approve": 60,
"tq_enabled": "y",
"tq_enabled_publishers": "",
"tracking_method": "s2s",
"tracking_subdomain": null,
"unique_conversion_refs": "y",
"vertical_id": 10,
"vertical_name": "Other",
"week_start": "Monday"
}
}
}
},
"brands_List all Participating Partners_200_response": {
"response": {
"value": {
"publishers": [
{
"publisher": {
"abn": null,
"account_name": "partner123",
"campaign_custom_terms_and_conditions_id": "10l176",
"campaign_custom_terms_and_conditions_title": "Some fancy title",
"campaign_select": null,
"campaign_status": "a",
"company_division": null,
"company_name": "Demo Partner",
"contact_email": "demo@partnerize.com",
"contact_locale": "bg",
"contact_name": "John Smith",
"databases": [
{
"active": "y",
"creation_method": "Email",
"database_id": "111111l300347",
"database_name": "Partnerize Database",
"female": 50,
"male": 50,
"max_age": 77,
"min_age": 25,
"publisher_id": "1l1007802",
"size": 53000
}
],
"default_currency": "GBP",
"description": null,
"foreign_identifier": null,
"gst_registered": null,
"im_provider": "Skype",
"im_username": "elisangis",
"is_affiliate_user": "y",
"is_foreign_network": "y",
"is_lead_user": "y",
"legal_entity": "GB",
"network_id": "1l1000003",
"network_notes": null,
"network_status": "a",
"operating_country": "GB",
"phone": "01595725007",
"phone_area": "+44",
"promotional_method": 10,
"promotional_method_name": "Portal",
"publisher_id": "1l1007802",
"reporting_identifier": null,
"reporting_timezone": "Australia/Sydney",
"signup_ip": "178.23.129.160",
"uk_vat_registered": "y",
"us_tax_state": null,
"vat_number": 974997534,
"vertical": 10,
"vertical_name": "Other",
"websites": [
{
"active": "y",
"primary": "n",
"description": "Demo Partner website",
"publisher_id": "1l1007802",
"website_country": "GB",
"website_id": "11l18694",
"website_name": null,
"website_type": 9,
"website_type_name": "PPC",
"website_url": "http://www.partnerize.com",
"website_vertical": 10,
"website_vertical_name": "Technical"
}
],
"week_start": "Monday"
}
}
]
}
}
},
"brands_update-partner-participation_200_response": {
"response": {
"value": {
"publishers": [
{
"publisher": {
"abn": null,
"account_name": "partner123",
"campaign_custom_terms_and_conditions_id": "10l176",
"campaign_custom_terms_and_conditions_title": "Some fancy title",
"campaign_select": null,
"campaign_status": "a",
"company_division": null,
"company_name": "Demo Partner",
"contact_email": "demo@partnerize.com",
"contact_locale": "bg",
"contact_name": "John Smith",
"databases": [
{
"active": "y",
"creation_method": "Email",
"database_id": "111111l300347",
"database_name": "Partnerize Database",
"female": 50,
"male": 50,
"max_age": 77,
"min_age": 25,
"publisher_id": "1l1007802",
"size": 53000
}
],
"default_currency": "GBP",
"description": null,
"foreign_identifier": null,
"gst_registered": null,
"im_provider": "Skype",
"im_username": "elisangis",
"is_affiliate_user": "y",
"is_foreign_network": "y",
"is_lead_user": "y",
"legal_entity": "GB",
"network_id": "1l1000003",
"network_notes": null,
"network_status": "a",
"operating_country": "GB",
"phone": "01595725007",
"phone_area": "+44",
"promotional_method": 10,
"promotional_method_name": "Portal",
"publisher_id": "1l1007802",
"reporting_identifier": null,
"reporting_timezone": "Australia/Sydney",
"signup_ip": "178.23.129.160",
"uk_vat_registered": "y",
"us_tax_state": null,
"vat_number": 974997534,
"vertical": 10,
"vertical_name": "Other",
"websites": [
{
"active": "y",
"primary": "n",
"description": "Demo Partner website",
"publisher_id": "1l1007802",
"website_country": "GB",
"website_id": "11l18694",
"website_name": null,
"website_type": 9,
"website_type_name": "PPC",
"website_url": "http://www.partnerize.com",
"website_vertical": 10,
"website_vertical_name": "Technical"
}
],
"week_start": "Monday"
}
}
]
}
}
},
"brands_Retrieve a Participating Partner_200_response": {
"response": {
"value": {
"publishers": [
{
"publisher": {
"abn": null,
"account_name": "partner123",
"campaign_custom_terms_and_conditions_id": "10l176",
"campaign_custom_terms_and_conditions_title": "Some fancy title",
"campaign_select": null,
"campaign_status": "a",
"company_division": null,
"company_name": "Demo Partner",
"contact_email": "demo@partnerize.com",
"contact_locale": "bg",
"contact_name": "John Smith",
"databases": [
{
"active": "y",
"creation_method": "Email",
"database_id": "111111l300347",
"database_name": "Partnerize Database",
"female": 50,
"male": 50,
"max_age": 77,
"min_age": 25,
"publisher_id": "1l1007802",
"size": 53000
}
],
"default_currency": "GBP",
"description": null,
"foreign_identifier": null,
"gst_registered"
# --- truncated at 32 KB (221 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/partnerize/refs/heads/main/examples/partnerize-examples.json