Sharing Data Marketplace Segments with Buyers
Learn how to use the Data Seller API to share a Data Marketplace segment with an approved buyer, review your existing shares, and disable a segment you no longer want to offer.
Overall Steps
Before you begin, enable a Data Marketplace segment and make sure you know its Data Marketplace segment
id.
Find the buyers you can share with
Use the List approved buyers call to get the buyers you can share segments with. For each buyer, the response includes:
orgId: The buyer's LiveRamp Organization ID. You need this value to share a segment.name: The buyer's display name.permissions.shareSegments: Whether the buyer can receive segments you share.
You can only share a segment with a buyer returned by this call. Sharing with an organization that is not an approved buyer is rejected.
Share a segment with a buyer
Use the Share a Data Marketplace Segment with a buyer call, passing the segment id and the buyer's orgId in the path:
PUT /v1/segments/{id}/shares/{buyerOrgId}
Sharing a segment makes it available in the buyer's catalog. It's most often used to give a specific buyer access to a custom (private) segment, for example in an Advertiser Direct workflow. You don't need to share a public segment for it to be used in Advertiser Direct, and buyers can also activate shared segments in other destinations.
The call is idempotent:
- The first call creates the share and returns
201. - Repeating the same call returns
200with the existing share record. Nothing changes.
The response is a share record containing the marketplaceSegmentId, the buyer (orgId and name), and the origin of the share:
seller-shared: You shared the segment.buyer-requested: The buyer requested the segment. Sharing a segment that a buyer already requested returns the existing share, and its origin staysbuyer-requested.
For example, this request shares segment 48213 with buyer 0011a00000XYZ:
curl -X PUT \
"https://api.liveramp.com/data-marketplace/provider-api/v1/segments/48213/shares/0011a00000XYZ" \
-H "Authorization: Bearer $ACCESS_TOKEN" \
-H "lr-org-id: $ORG_ID"
The response (201 Created):
{
"marketplaceSegmentId": 48213,
"buyer": {
"orgId": "0011a00000XYZ",
"name": "Acme Buyer"
},
"origin": "seller-shared"
}Review your shares
Use the List Data Marketplace segment shares call to see the segments you've shared with buyers. Narrow the results with these optional query parameters. Repeat a parameter to pass more than one value.
| Parameter | Filters by | Limit |
|---|---|---|
marketplaceSegmentIds | Data Marketplace segment ID | Up to 20 |
partnerOrgIds | Buyer Organization ID | Up to 20 |
origins | seller-shared or buyer-requested | - |
Results are paginated. Use limit (1–100, default 10) and pass the _pagination.after value from the previous response as after to get the next page. When after is null, there are no more results.
Updated 1 day ago