Supported RollWorks APIs

Naga Sri Hari Gonaboyina

Updated May 21, 2024 10:37

When you configure an export, import, or another type of flow step using the form view designed for the RollWorks connector, the following API operations are supported:

Note: You can also create a composite endpoint for this application. For more information, see Application-specific (simple) forms.

Resource	API endpoint	Export	Import
Activation Status	Check TOS acceptance status	X
Ad	Fetch ad	X
	Clone ad		X
	Create ad		X
	Create templated web ads		X
	Edit ad		X
	List users by ad	X
	List users by ad group	X
	List users by advertisable	X
	Estimate composite segment size	X
Ad group	Fetch ad group	X
	Create ad group		X
	Edit an existing ad group		X
	Edit an ad group ad		X
	Fetches an ad group	X
	Fetches the ads associated with this ad group	X
	Add segments to the ad group		X
	Create ad group		X
	Detaches ads from an ad group		X
	Edit ad group		X
	Pause ad group		X
	Pause ad		X
	Pause ads		X
	Remove segments from ad group		X
	Attach ads to an ad group		X
	Unpause ad group		X
	Unpause ad		X
	Unpause ads		X
Advertisable	Fetches an advertisable	X
	Get ad groups	X
	Get ad groups Fast	X
	Get ads	X
	Get ads fast	X
	Get campaigns	X
	Get campaigns fast	X
	Get pixel	X
	Get segments	X
	Get suggested country	X
	Create advertisable		X
	Edit advertisable		X
	Enable roll crawl		X
Advertisable logo	Create advertisable logo		X
Campaign	Fetch campaign	X
	Create campaign		X
	Edit an existing campaign		X
	Fetch campaigns for a given strategy	X
	Modify a specific campaign		X
	Fetch campaign	X
	Get ad groups	X
	Create campaign		X
	Edit campaign		X
	Pause campaign		X
	Pause ads		X
	Unpause campaign		X
	Unpause ads		X
	Manage campaign emails	X
	Creates a send roll campaign		X
	Edit campaign’s email		X
	Change a campaign’s status		X
	Update campaign		X
Consent banner	Fetch consent banner configuration	X
Consent banner	Update or create banner configuration		X
Dynamic configuration	Dynamic configuration	X
	Edit dynamic configuration		X
	Enable feed parsing		X
Dynamic template	Dynamic Template	X
Dynamic template capability description	Retrieve a list of template capabilities	X
Feed	Autoconfigure product feed		X
Invoice	Fetch invoice	X
Marketplace	Retrieve a list of marketplace mappings	X
Marketplace	Create marketplace mapping		X
Messages	Manage advertisable alerts	X
Messages	Manage current advertisable alerts		X
Opt Out	Deactivate an advertisable		X
Organization	Fetch organization details	X
	Get accounts	X
	Get advertisables	X
	Get advertisables paginated	X
	Get billing Methods	X
	Get Users	X
Pixel	Fetch the pixel by EID	X
	Get pixel rules	X
	Get segments	X
Playbooks	Fetch playbooks with only simple data response	X
	Fetch a playbook	X
	Create a new playbook		X
	Edit an existing playbook		X
Product feeds	Delete feed configuration	X
	Delete parser configuration	X
	Verify whether the config at the given feed is downloadable or not	X
	Get feed status	X
	Get feed Config	X
	Get parser config	X
	Get products	X
	Get troubled products	X
	Get match rate statistics	X
	Parse preview	X
	Set parser configuration	X
	Add feed configuration		X
	Auto configure product feed		X
	Edit feed configuration		X
	Edit feed configuration		X
	Set parser configs		X
Report	Pull ads reports	X
	Pull advertisables reports	X
	Pull campaigns reports	X
Rule	Fetch a rule object by EID	X
	Get segments	X
	Create rule		X
Segment	Get segment	X
	Edit an existing segment		X
	User list sizes by segment	X
	User counts	X
	List users by segment	X
	List users by advertisable (post)		X
Sender Info	Updates the sender info for the advertisable		X
Settings	Get advertisable settings	X
Settings	Update advertisable settings		X
Strategy	Fetch strategy	X
	Create a new strategy		X
	Edit an existing strategy		X
Target account lists	Retrieve all target accounts lists	X
	Get a target accounts list	X
	Retrieve all target accounts tiers	X
	Retrieve a single target accounts tier	X
	Retrieve all target accounts items	X
	Retrieve all target accounts items filtered	X
	Retrieve the references for a set of domains	X
	Retrieve user attributes associated with an advertisable	X
	Retrieve user attribute counts for a pair of attribute name and value	X
	Create a new target accounts list		X
	Update a target accounts List		X
	Delete a target accounts list		X
	Create a new target accounts tier		X
	Update a target accounts tier		X
	Delete a single target accounts tier		X
	Upsert target accounts list items		X
	Updates target accounts list items		X
	Delete a list of target accounts list items		X
	Delete a list of target accounts list items		X
Unsubscribers	List of unsubscribed email addresses	X
Unsubscribers	Record a list of unsubscribed email addresses	X
Untagged	Retrieve list of accessible advertisers	X
	Retrieve a list of valid and invalid segments for crosschannel targeting	X
	Retrieve a list of ICP by advertisable EID	X
	Retrieve list of segments	X
	Retrieve scores by tal EID, advertisable EID, and optional ICP EID	X
	Retrieve a list of segments with general exclusions	X
	Return a list of user attribute segments.	X
	Retrieve segment information	X
	Fetch details of the audience that wants to be shared with a sharing invitation	X
	Fetch all invitations sent by an advertisable or a specific invitation	X
	Send a segment sharing invitation		X
	Create an ICP by advertisable EID		X
	Delete ICP details by ICP EID and advertisable EID		X
	Create a new segment		X
	Create a new target accounts tier		X
	Update or delete tag/ tal references		X
	Upsert target accounts list items		X
	Delete an existing segment		X
	Create a new target accounts tier		X
	Send a segment sharing invitation		X
	Revoke an invitation		X
	Create a mirror segment		X
	Delete a mirror segment		X
User	Fetch current user	X
	Edit user		X
	Grant user privileges		X
Xdevice opt in	Retrieve cross device opt in setting	X
Xdevice opt in	Update cross device opt in		X