Update a Data Marketplace Segment

put

https://api.liveramp.com/data-marketplace/provider-api/v1/segments/{id}

Update the metadata for a Data Marketplace segment.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

You can update any metadata for a Data Marketplace segment except for segment IDs or, if a segment has already been distributed, prices or currency information. Updating a distributed segment is prohibited to prevent pricing discrepancies.

Data Marketplace Update Restrictions

These fields cannot be updated.

Parameter	Description
`segmentId`	Data Marketplace segment ID
`activationSegmentId`	First-party segment ID from the Activation API

If your segment was distributed, you cannot update its prices or currency information. This applies to all the parameters for the pricing object.

Path Params

int32

required

The Data Marketplace segmentId.

Body Params

A Provider's Data Marketplace Segment(s)

name

string

The segment name shown to Data Marketplace buyers. This is automatically populated by the info provided when your first-party segment was uploaded. See Naming Data Marketplace Segments for requirements and recommendations.

type

string

enum

SYNDICATED segments are created without a specific campaign in mind and are typically available to all data buyers in LiveRamp's Data Marketplace or another platform's UI. CUSTOM segments are typically targeted to a specific campaign. DIRECT segments are used on platforms where a pre-approved agreement is in place. The allowedPlatforms field must not be used for syndicated segments and is required for custom and direct segments.

Allowed:

description

string

A brief description of the segment, shown to Data Marketplace buyers.

dataSourceLocation

string

enum

Geographical source location for the segment, or where this data can be bought. If not specified, provider defaults are used.

restrictions

object

This field can only be set by providers who have been configured for Customer Profiles. Please reach out to your LiveRamp representative for more information.

pricing

object

Segment pricing model and price. You must specify at least one price, and prices must exist for each use case that is enabled in the permittedUseCases object. Values are either in currency or percentage. $1.50 is input as 1.50. 75.6% is input as 75.6.

providerSegmentIdentifier

string

Data Marketplace provider ID.

providerComments

string

Comments that are not visible to the buyer. Typically used to specify platform and seat ID for custom segments.

Headers

lr-org-id

string

required

The standard way for a LiveRamp API client to identify the Org it is operating as is to set the LR-Org-ID HTTP header.

Responses

Data Marketplace Update Restrictions

200Success

400Bad Request

401Unauthorized

403Forbidden

404v1/segment not found