bulk Update Audience Segments

PATCH {{baseUrl}}/2024-04/marketing-solutions/audience-segments

Updates the properties of all segments with a valid configuration, and returns their IDs. For those that cannot be updated, one or multiple errors are returned.

Request Body

{"data"=>[{"attributes"=>{"name"=>"<string>", "description"=>{"value"=>"<string>"}, "inMarket"=>{"country"=>"<string>", "buyingPower"=>["Low", "VeryHigh"], "gender"=>{"value"=>"Male"}, "interestIds"=>["<string>", "<string>"], "brandIds"=>["<string>", "<string>"], "priceRange"=>["Low", "Medium"]}, "location"=>{"pointsOfInterest"=>[{"name"=>"<string>", "latitude"=>"<double>", "longitude"=>"<double>"}, {"name"=>"<string>", "latitude"=>"<double>", "longitude"=>"<double>"}], "radiusInKm"=>"<integer>", "registryType"=>"PointOfInterest"}, "retargeting"=>{"visitorsType"=>"NonBuyers", "daysSinceLastVisitMin"=>"<integer>", "daysSinceLastVisitMax"=>"<integer>"}, "lookalike"=>{"targetSize"=>"<long>"}, "prospecting"=>{"daysSinceLastVisitMin"=>{"value"=>"<integer>"}, "daysSinceLastVisitMax"=>{"value"=>"<integer>"}, "usersType"=>"Prospects"}}, "id"=>"<string>", "type"=>"<string>"}, {"attributes"=>{"name"=>"<string>", "description"=>{"value"=>"<string>"}, "inMarket"=>{"country"=>"<string>", "buyingPower"=>["Low", "Low"], "gender"=>{"value"=>"Male"}, "interestIds"=>["<string>", "<string>"], "brandIds"=>["<string>", "<string>"], "priceRange"=>["Medium", "High"]}, "location"=>{"pointsOfInterest"=>[{"name"=>"<string>", "latitude"=>"<double>", "longitude"=>"<double>"}, {"name"=>"<string>", "latitude"=>"<double>", "longitude"=>"<double>"}], "radiusInKm"=>"<integer>", "registryType"=>"PointOfInterest"}, "retargeting"=>{"visitorsType"=>"Buyers", "daysSinceLastVisitMin"=>"<integer>", "daysSinceLastVisitMax"=>"<integer>"}, "lookalike"=>{"targetSize"=>"<long>"}, "prospecting"=>{"daysSinceLastVisitMin"=>{"value"=>"<integer>"}, "daysSinceLastVisitMax"=>{"value"=>"<integer>"}, "usersType"=>"Prospects"}}, "id"=>"<string>", "type"=>"<string>"}]}

HEADERS

KeyDatatypeRequiredDescription
Content-Typestring
Acceptstring

RESPONSES

status: OK

{&quot;data&quot;:[{&quot;attributes&quot;:{&quot;name&quot;:&quot;\u003cstring\u003e&quot;,&quot;description&quot;:&quot;\u003cstring\u003e&quot;,&quot;type&quot;:&quot;InMarket&quot;,&quot;createdAt&quot;:&quot;\u003cdateTime\u003e&quot;,&quot;updatedAt&quot;:&quot;\u003cdateTime\u003e&quot;,&quot;advertiserId&quot;:&quot;\u003cstring\u003e&quot;,&quot;inMarket&quot;:{&quot;country&quot;:&quot;\u003cstring\u003e&quot;,&quot;buyingPower&quot;:[&quot;Medium&quot;,&quot;VeryHigh&quot;],&quot;gender&quot;:&quot;Unknown&quot;,&quot;interestIds&quot;:[&quot;\u003cstring\u003e&quot;,&quot;\u003cstring\u003e&quot;],&quot;brandIds&quot;:[&quot;\u003cstring\u003e&quot;,&quot;\u003cstring\u003e&quot;],&quot;priceRange&quot;:[&quot;Low&quot;,&quot;High&quot;]},&quot;prospecting&quot;:{&quot;daysSinceLastVisitMin&quot;:&quot;\u003cinteger\u003e&quot;,&quot;daysSinceLastVisitMax&quot;:&quot;\u003cinteger\u003e&quot;,&quot;usersType&quot;:&quot;Unknown&quot;},&quot;contactList&quot;:{&quot;isReadOnly&quot;:&quot;\u003cboolean\u003e&quot;},&quot;location&quot;:{&quot;pointsOfInterest&quot;:[{&quot;name&quot;:&quot;\u003cstring\u003e&quot;,&quot;latitude&quot;:&quot;\u003cdouble\u003e&quot;,&quot;longitude&quot;:&quot;\u003cdouble\u003e&quot;},{&quot;name&quot;:&quot;\u003cstring\u003e&quot;,&quot;latitude&quot;:&quot;\u003cdouble\u003e&quot;,&quot;longitude&quot;:&quot;\u003cdouble\u003e&quot;}],&quot;radiusInKm&quot;:&quot;\u003cinteger\u003e&quot;,&quot;registryType&quot;:&quot;PointOfInterest&quot;},&quot;behavioral&quot;:{&quot;category&quot;:&quot;BuyingPatterns&quot;,&quot;country&quot;:&quot;\u003cstring\u003e&quot;,&quot;startDate&quot;:&quot;\u003cdateTime\u003e&quot;,&quot;endDate&quot;:&quot;\u003cdateTime\u003e&quot;},&quot;retargeting&quot;:{&quot;visitorsType&quot;:&quot;NonBuyers&quot;,&quot;daysSinceLastVisitMin&quot;:&quot;\u003cinteger\u003e&quot;,&quot;daysSinceLastVisitMax&quot;:&quot;\u003cinteger\u003e&quot;},&quot;lookalike&quot;:{&quot;seedSegmentId&quot;:&quot;\u003cstring\u003e&quot;,&quot;targetSize&quot;:&quot;\u003clong\u003e&quot;}},&quot;id&quot;:&quot;\u003cstring\u003e&quot;,&quot;type&quot;:&quot;\u003cstring\u003e&quot;},{&quot;attributes&quot;:{&quot;name&quot;:&quot;\u003cstring\u003e&quot;,&quot;description&quot;:&quot;\u003cstring\u003e&quot;,&quot;type&quot;:&quot;Unknown&quot;,&quot;createdAt&quot;:&quot;\u003cdateTime\u003e&quot;,&quot;updatedAt&quot;:&quot;\u003cdateTime\u003e&quot;,&quot;advertiserId&quot;:&quot;\u003cstring\u003e&quot;,&quot;inMarket&quot;:{&quot;country&quot;:&quot;\u003cstring\u003e&quot;,&quot;buyingPower&quot;:[&quot;VeryHigh&quot;,&quot;Unknown&quot;],&quot;gender&quot;:&quot;Male&quot;,&quot;interestIds&quot;:[&quot;\u003cstring\u003e&quot;,&quot;\u003cstring\u003e&quot;],&quot;brandIds&quot;:[&quot;\u003cstring\u003e&quot;,&quot;\u003cstring\u003e&quot;],&quot;priceRange&quot;:[&quot;Low&quot;,&quot;Unknown&quot;]},&quot;prospecting&quot;:{&quot;daysSinceLastVisitMin&quot;:&quot;\u003cinteger\u003e&quot;,&quot;daysSinceLastVisitMax&quot;:&quot;\u003cinteger\u003e&quot;,&quot;usersType&quot;:&quot;Unknown&quot;},&quot;contactList&quot;:{&quot;isReadOnly&quot;:&quot;\u003cboolean\u003e&quot;},&quot;location&quot;:{&quot;pointsOfInterest&quot;:[{&quot;name&quot;:&quot;\u003cstring\u003e&quot;,&quot;latitude&quot;:&quot;\u003cdouble\u003e&quot;,&quot;longitude&quot;:&quot;\u003cdouble\u003e&quot;},{&quot;name&quot;:&quot;\u003cstring\u003e&quot;,&quot;latitude&quot;:&quot;\u003cdouble\u003e&quot;,&quot;longitude&quot;:&quot;\u003cdouble\u003e&quot;}],&quot;radiusInKm&quot;:&quot;\u003cinteger\u003e&quot;,&quot;registryType&quot;:&quot;Unknown&quot;},&quot;behavioral&quot;:{&quot;category&quot;:&quot;Unknown&quot;,&quot;country&quot;:&quot;\u003cstring\u003e&quot;,&quot;startDate&quot;:&quot;\u003cdateTime\u003e&quot;,&quot;endDate&quot;:&quot;\u003cdateTime\u003e&quot;},&quot;retargeting&quot;:{&quot;visitorsType&quot;:&quot;All&quot;,&quot;daysSinceLastVisitMin&quot;:&quot;\u003cinteger\u003e&quot;,&quot;daysSinceLastVisitMax&quot;:&quot;\u003cinteger\u003e&quot;},&quot;lookalike&quot;:{&quot;seedSegmentId&quot;:&quot;\u003cstring\u003e&quot;,&quot;targetSize&quot;:&quot;\u003clong\u003e&quot;}},&quot;id&quot;:&quot;\u003cstring\u003e&quot;,&quot;type&quot;:&quot;\u003cstring\u003e&quot;}],&quot;warnings&quot;:[{&quot;traceId&quot;:&quot;\u003cstring\u003e&quot;,&quot;traceIdentifier&quot;:&quot;\u003cstring\u003e&quot;,&quot;type&quot;:&quot;unknown&quot;,&quot;code&quot;:&quot;\u003cstring\u003e&quot;,&quot;instance&quot;:&quot;\u003cstring\u003e&quot;,&quot;title&quot;:&quot;\u003cstring\u003e&quot;,&quot;detail&quot;:&quot;\u003cstring\u003e&quot;,&quot;source&quot;:{&quot;culpa_d_1&quot;:&quot;\u003cstring\u003e&quot;},&quot;stackTrace&quot;:&quot;\u003cstring\u003e&quot;},{&quot;traceId&quot;:&quot;\u003cstring\u003e&quot;,&quot;traceIdentifier&quot;:&quot;\u003cstring\u003e&quot;,&quot;type&quot;:&quot;authorization&quot;,&quot;code&quot;:&quot;\u003cstring\u003e&quot;,&quot;instance&quot;:&quot;\u003cstring\u003e&quot;,&quot;title&quot;:&quot;\u003cstring\u003e&quot;,&quot;detail&quot;:&quot;\u003cstring\u003e&quot;,&quot;source&quot;:{&quot;dolore_8b_&quot;:&quot;\u003cstring\u003e&quot;,&quot;voluptate_3&quot;:&quot;\u003cstring\u003e&quot;},&quot;stackTrace&quot;:&quot;\u003cstring\u003e&quot;}],&quot;errors&quot;:[{&quot;traceId&quot;:&quot;\u003cstring\u003e&quot;,&quot;traceIdentifier&quot;:&quot;\u003cstring\u003e&quot;,&quot;type&quot;:&quot;authentication&quot;,&quot;code&quot;:&quot;\u003cstring\u003e&quot;,&quot;instance&quot;:&quot;\u003cstring\u003e&quot;,&quot;title&quot;:&quot;\u003cstring\u003e&quot;,&quot;detail&quot;:&quot;\u003cstring\u003e&quot;,&quot;source&quot;:{&quot;in_ead&quot;:&quot;\u003cstring\u003e&quot;,&quot;laborum3e8&quot;:&quot;\u003cstring\u003e&quot;,&quot;Ute08&quot;:&quot;\u003cstring\u003e&quot;},&quot;stackTrace&quot;:&quot;\u003cstring\u003e&quot;},{&quot;traceId&quot;:&quot;\u003cstring\u003e&quot;,&quot;traceIdentifier&quot;:&quot;\u003cstring\u003e&quot;,&quot;type&quot;:&quot;authentication&quot;,&quot;code&quot;:&quot;\u003cstring\u003e&quot;,&quot;instance&quot;:&quot;\u003cstring\u003e&quot;,&quot;title&quot;:&quot;\u003cstring\u003e&quot;,&quot;detail&quot;:&quot;\u003cstring\u003e&quot;,&quot;source&quot;:{&quot;velit_d&quot;:&quot;\u003cstring\u003e&quot;,&quot;laborisf&quot;:&quot;\u003cstring\u003e&quot;},&quot;stackTrace&quot;:&quot;\u003cstring\u003e&quot;}]}