bulk Update Audience Segments
PATCH {{baseUrl}}/preview/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"=>["VeryHigh", "High"], "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"=>"NonBuyers", "daysSinceLastVisitMin"=>"<integer>", "daysSinceLastVisitMax"=>"<integer>"}, "lookalike"=>{"targetSize"=>"<long>"}, "prospecting"=>{"daysSinceLastVisitMin"=>{"value"=>"<integer>"}, "daysSinceLastVisitMax"=>{"value"=>"<integer>"}, "usersType"=>"ProspectsOrNonBuyers"}}, "id"=>"<string>", "type"=>"<string>"}, {"attributes"=>{"name"=>"<string>", "description"=>{"value"=>"<string>"}, "inMarket"=>{"country"=>"<string>", "buyingPower"=>["VeryHigh", "High"], "gender"=>{"value"=>"Male"}, "interestIds"=>["<string>", "<string>"], "brandIds"=>["<string>", "<string>"], "priceRange"=>["Medium", "Medium"]}, "location"=>{"pointsOfInterest"=>[{"name"=>"<string>", "latitude"=>"<double>", "longitude"=>"<double>"}, {"name"=>"<string>", "latitude"=>"<double>", "longitude"=>"<double>"}], "radiusInKm"=>"<integer>", "registryType"=>"PointOfInterest"}, "retargeting"=>{"visitorsType"=>"All", "daysSinceLastVisitMin"=>"<integer>", "daysSinceLastVisitMax"=>"<integer>"}, "lookalike"=>{"targetSize"=>"<long>"}, "prospecting"=>{"daysSinceLastVisitMin"=>{"value"=>"<integer>"}, "daysSinceLastVisitMax"=>{"value"=>"<integer>"}, "usersType"=>"Prospects"}}, "id"=>"<string>", "type"=>"<string>"}]}
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
Content-Type | string | ||
Accept | string |
RESPONSES
status: OK
{"data":[{"attributes":{"name":"\u003cstring\u003e","description":"\u003cstring\u003e","type":"Unknown","createdAt":"\u003cdateTime\u003e","updatedAt":"\u003cdateTime\u003e","advertiserId":"\u003cstring\u003e","inMarket":{"country":"\u003cstring\u003e","buyingPower":["Unknown","Unknown"],"gender":"Female","interestIds":["\u003cstring\u003e","\u003cstring\u003e"],"brandIds":["\u003cstring\u003e","\u003cstring\u003e"],"priceRange":["Medium","High"]},"prospecting":{"daysSinceLastVisitMin":"\u003cinteger\u003e","daysSinceLastVisitMax":"\u003cinteger\u003e","usersType":"ProspectsOrNonBuyers"},"contactList":{"isReadOnly":"\u003cboolean\u003e"},"location":{"pointsOfInterest":[{"name":"\u003cstring\u003e","latitude":"\u003cdouble\u003e","longitude":"\u003cdouble\u003e"},{"name":"\u003cstring\u003e","latitude":"\u003cdouble\u003e","longitude":"\u003cdouble\u003e"}],"radiusInKm":"\u003cinteger\u003e","registryType":"PointOfInterest"},"behavioral":{"category":"Unknown","country":"\u003cstring\u003e","startDate":"\u003cdateTime\u003e","endDate":"\u003cdateTime\u003e"},"retargeting":{"visitorsType":"Unknown","daysSinceLastVisitMin":"\u003cinteger\u003e","daysSinceLastVisitMax":"\u003cinteger\u003e"},"lookalike":{"seedSegmentId":"\u003cstring\u003e","targetSize":"\u003clong\u003e"}},"id":"\u003cstring\u003e","type":"\u003cstring\u003e"},{"attributes":{"name":"\u003cstring\u003e","description":"\u003cstring\u003e","type":"Retargeting","createdAt":"\u003cdateTime\u003e","updatedAt":"\u003cdateTime\u003e","advertiserId":"\u003cstring\u003e","inMarket":{"country":"\u003cstring\u003e","buyingPower":["VeryHigh","Unknown"],"gender":"Male","interestIds":["\u003cstring\u003e","\u003cstring\u003e"],"brandIds":["\u003cstring\u003e","\u003cstring\u003e"],"priceRange":["High","Unknown"]},"prospecting":{"daysSinceLastVisitMin":"\u003cinteger\u003e","daysSinceLastVisitMax":"\u003cinteger\u003e","usersType":"Prospects"},"contactList":{"isReadOnly":"\u003cboolean\u003e"},"location":{"pointsOfInterest":[{"name":"\u003cstring\u003e","latitude":"\u003cdouble\u003e","longitude":"\u003cdouble\u003e"},{"name":"\u003cstring\u003e","latitude":"\u003cdouble\u003e","longitude":"\u003cdouble\u003e"}],"radiusInKm":"\u003cinteger\u003e","registryType":"Unknown"},"behavioral":{"category":"Lifestyles","country":"\u003cstring\u003e","startDate":"\u003cdateTime\u003e","endDate":"\u003cdateTime\u003e"},"retargeting":{"visitorsType":"NonBuyers","daysSinceLastVisitMin":"\u003cinteger\u003e","daysSinceLastVisitMax":"\u003cinteger\u003e"},"lookalike":{"seedSegmentId":"\u003cstring\u003e","targetSize":"\u003clong\u003e"}},"id":"\u003cstring\u003e","type":"\u003cstring\u003e"}],"warnings":[{"traceId":"\u003cstring\u003e","traceIdentifier":"\u003cstring\u003e","type":"validation","code":"\u003cstring\u003e","instance":"\u003cstring\u003e","title":"\u003cstring\u003e","detail":"\u003cstring\u003e","source":{"velit59c":"\u003cstring\u003e","fugiat0a":"\u003cstring\u003e","fugiatf76":"\u003cstring\u003e"},"stackTrace":"\u003cstring\u003e"},{"traceId":"\u003cstring\u003e","traceIdentifier":"\u003cstring\u003e","type":"authorization","code":"\u003cstring\u003e","instance":"\u003cstring\u003e","title":"\u003cstring\u003e","detail":"\u003cstring\u003e","source":{"ullamco_7_":"\u003cstring\u003e"},"stackTrace":"\u003cstring\u003e"}],"errors":[{"traceId":"\u003cstring\u003e","traceIdentifier":"\u003cstring\u003e","type":"authentication","code":"\u003cstring\u003e","instance":"\u003cstring\u003e","title":"\u003cstring\u003e","detail":"\u003cstring\u003e","source":{"mollitd":"\u003cstring\u003e","esse_a2f":"\u003cstring\u003e","deserunt1d":"\u003cstring\u003e"},"stackTrace":"\u003cstring\u003e"},{"traceId":"\u003cstring\u003e","traceIdentifier":"\u003cstring\u003e","type":"authorization","code":"\u003cstring\u003e","instance":"\u003cstring\u003e","title":"\u003cstring\u003e","detail":"\u003cstring\u003e","source":{"laboris_b24":"\u003cstring\u003e","occaecat_d0":"\u003cstring\u003e","Ut_8":"\u003cstring\u003e"},"stackTrace":"\u003cstring\u003e"}]}