API Reference

Create content

Parameters

AdvertiserId required

Unique identifier for the advertiser account.

CampaignId required

Unique identifier for the program (or campaign).

Url required

The URL used to identify the content page.

Type required

The type of compliance content being created or updated. Only PAGE is the supported value currently.

Reason required

A reason for the creation or update of content. Used for auditing, review or reporting purposes.

Source required

The source of where the request has come from. Only CONTENT_API is supported currently.

PartnerId required if program has "Partner ID Required"

Unique identifier for the partner account that the content is linked to.

ContentLabels optional

Content labels can be used to tag the content record for categorization purposes of that content. These labels are used to assist with filtering of the content or identifying related pieces of content to manage content as well as reviews and violations. Multiple labels can be added with a comma (,) used to separate labels.

Products optional

Product SKUs can be used to link specific content records with the product record that exists within the impact.com Product Data Platform. These products are used to assist with filtering of the content or identifying related pieces of content to manage content as well as reviews and violations. Multiple Products SKUs can be added with a comma (,) used to separate labels.

Keywords optional

An array of keyword items, each with a name, status, and function.

View object parameters

Name requiredif submitting keywords

The actual keyword.

Status required if submitting keywords

Status of the keyword: either APPROVED or NOT_APPROVED.

Function required if submitting keywords

Function of the keyword. Valid values are MONITORED`, NOT_MONITORED, CHANGE_DETECTION, or DISCOVERY.

Language optional

This is the language identified for the specific content.

PaidLink optional

This sets whether or not the content is a paid link or not.

Monitored optional

This sets whether or not the content should be monitored within the impact.com Compliance Monitoring service

Cadence optional

This sets whether or not the content should be managed with a cadence rule within the impact.com Compliance Monitoring service.

Returns

Returns the status of the request and the URI of submission. Returns an error if create parameters are invalid or if a required parameter is missing.

Example request

curl 'https://api.impact.com/Agencies/<AccountSID>/Compliance/Content' \
  -X POST \
  -u '<AccountSid>:<AuthToken>' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/x-www-form-urlencoded' \
  -d 'Type=CONTENT' \
  -d 'AdvertiserId=123456' \
  -d 'CampaignId=9876' \
  -d 'Url=https://www.example.com/partnerblog' \
  -d 'Source=CONTENT_API' \
  -d 'Reason=New Content' \
  -d 'PartnerId=98765' \
  -d 'Products=PRD12334,PRD45353' \
  -d 'Language=English' \
  -d 'PaidLink=false' \
  -d 'Monitored=true' \
  -d 'Cadence=false'

Example response

{
  "Status": "QUEUED",
  "QueuedUri": "/Agencies/<AccountSID>/Compliance/Content/ComplianceAPISubmissions/content_api_1603459292102"
}