RollWorks API Documentation

This is the complete API documentation for connecting to the RollWorks API using MindCloud's Universal API. If you are new to MindCloud, start with the Introduction to see how one API can sit in front of many different apps.

MindCloud is an integration company that offers one normalized API to access 3,100+ apps from a single place. It cleans up provider-specific quirks, keeps requests and responses consistent, and centralizes authentication so you do not need to manage separate flows for every app. Browse other apps.

Meet RollWorks: Manage RollWorks audiences, target accounts, segments, and reporting. Keep reading to get started.

Quickstart

Before you run your first RollWorks request, you need three things:

1. A MindCloud account — sign in or create an account at MindCloud.
2. A MindCloud API Key — create one in API Keys. Keep it on your server.
3. At least one RollWorks connection — create or choose one in Connections. Note its connectionId.

Every RollWorks action uses the same URL pattern:

https://connect.mindcloud.co/v1/universal/rollWorks/latest/actions/{actionSlug}

You need a MindCloud API Key and a RollWorks connection. Then call an action such as Estimate Composite Segment Size:

curl --request GET \
  --url "https://connect.mindcloud.co/v1/universal/rollWorks/latest/actions/estimate-composite-segment-size" \
  --header "Authorization: Bearer $MINDCLOUD_API_KEY" \
  --get \
  --data-urlencode "connectionId=$CONNECTION_ID"

Every response comes back in the same envelope, with your rows in a data array:

{
  "success": true,
  "data": [
    { "id": "1042", "name": "Ava" }
  ],
  "meta": {}
}

After your first request works, use Shape your requests to control arguments, pagination, filtering, fields, and errors.

Authentication

Authentication has two layers. Your MindCloud API Key authenticates the request to MindCloud, sent as a Bearer token in the Authorization header. The connectionId selects the connected RollWorks account that should run the action. MindCloud stores and refreshes the RollWorks credentials behind that connection, so you never send provider tokens with your requests.

Pass connectionId in the query string for GET and DELETE actions, and in the JSON body for POST, PUT, and PATCH actions. Keep your MindCloud API Key on your server; do not ship it in browser code, mobile apps, public repositories, or logs.

RollWorks actions

All 57 published actions for this RollWorks version. Each page documents the endpoint, arguments, and response controls.

• POSTAccept Segment Sharing Invitation
• PUTBulk Create Or Update Segments by Bulk Route
• PUTBulk Create Or Update Segments by Put Route
• POSTCreate ICP by Advertisable EID
• POSTCreate Segment
• POSTCreate Segment Sharing Invitation
• POSTCreate Target Accounts List
• POSTCreate Target Accounts Tier
• DELETEDelete ICP by ICP EID and Advertisable EID
• DELETEDelete Mirror Segment
• DELETEDelete Segment
• DELETEDelete Target Accounts List
• DELETEDelete Target Accounts List Items by Delete Route
• DELETEDelete Target Accounts List Items by Post Delete Route
• DELETEDelete Target Accounts Tier
• GETEstimate Composite Segment Size
• GETExecute GraphQL queries
• GETGet CDP Plus User List Sizes by Segment and Date
• GETGet Domain References
• GETGet Exact User Counts by Date and Metric
• GETGet ICP by ICP EID and Advertisable EID
• GETGet Segment
• GETGet Source Segment for Sharing Invitation
• GETGet Target Accounts List
• GETGet Target Accounts Tier
• GETGet User Attribute Counts by Name and Value
• GETGet User List Sizes by Ad and Date
• GETGet User List Sizes by Ad Group and Date
• GETGet User List Sizes by Advertisable and Date
• GETGet User List Sizes by Segment and Date Batch
• GETGet User List Sizes by Segment and Date with Summary
• GETList Advertisers
• GETList Domains in Target Account Lists
• GETList ICP Accounts by Advertisable EID
• GETList ICPs by Advertisable EID
• GETList Scores by TAL EID and Advertisable EID
• GETList Segments
• GETList Segments with General Exclusions
• GETList Sharing Invitations
• GETList Target Accounts Items
• GETList Target Accounts List Names and EIDs
• GETList Target Accounts Lists
• GETList Target Accounts Lists with General Exclusions
• GETList Target Accounts Tiers
• GETList User Attribute Segments by TAL Reference
• GETList User Attributes by Advertisable
• GETList Valid and Invalid Segments for Crosschannel LAL Targeting
• PUTReactivate Segment
• DELETERevoke Sharing Invitation
• GETSearch Target Accounts Items
• PUTUpdate ICP by ICP EID and Advertisable EID
• PUTUpdate Or Delete TAG TAL References
• PUTUpdate Segment or Replace User List
• PUTUpdate Target Accounts List
• PUTUpdate Target Accounts List Items
• PUTUpdate Target Accounts Tier
• PUTUpsert Target Accounts List Items

Related apps

More Marketing apps on the Universal API, behind the same REST shape. Or browse all apps.

Google FormsMailchimpCalendlyWebflowGoogle AdsActiveCampaignBrevoMailerLite