bulk Create Audience Segments

POST {{baseUrl}}/2024-01/marketing-solutions/audience-segments/create

Creates all segments with a valid configuration, and returns their IDs. For those that cannot be created, one or multiple errors are returned.

Request Body

{"data"=>[{"type"=>"<string>", "attributes"=>{"advertiserId"=>"<string>", "name"=>"<string>", "description"=>"<string>", "inMarket"=>{"country"=>"<string>", "buyingPower"=>["High", "Medium"], "gender"=>"Female", "interestIds"=>["<string>", "<string>"], "brandIds"=>["<string>", "<string>"], "priceRange"=>["Low", "Medium"]}, "prospecting"=>{"usersType"=>"ProspectsOrNonBuyers", "daysSinceLastVisitMin"=>"<integer>", "daysSinceLastVisitMax"=>"<integer>"}, "location"=>{"pointsOfInterest"=>[{"name"=>"<string>", "latitude"=>"<double>", "longitude"=>"<double>"}, {"name"=>"<string>", "latitude"=>"<double>", "longitude"=>"<double>"}], "radiusInKm"=>"<integer>"}, "retargeting"=>{"daysSinceLastVisitMax"=>"<integer>", "daysSinceLastVisitMin"=>"<integer>", "visitorsType"=>"Buyers"}, "lookalike"=>{"seedSegmentId"=>"<string>", "targetSize"=>"<long>"}}}, {"type"=>"<string>", "attributes"=>{"advertiserId"=>"<string>", "name"=>"<string>", "description"=>"<string>", "inMarket"=>{"country"=>"<string>", "buyingPower"=>["Low", "Medium"], "gender"=>"Female", "interestIds"=>["<string>", "<string>"], "brandIds"=>["<string>", "<string>"], "priceRange"=>["High", "High"]}, "prospecting"=>{"usersType"=>"Prospects", "daysSinceLastVisitMin"=>"<integer>", "daysSinceLastVisitMax"=>"<integer>"}, "location"=>{"pointsOfInterest"=>[{"name"=>"<string>", "latitude"=>"<double>", "longitude"=>"<double>"}, {"name"=>"<string>", "latitude"=>"<double>", "longitude"=>"<double>"}], "radiusInKm"=>"<integer>"}, "retargeting"=>{"daysSinceLastVisitMax"=>"<integer>", "daysSinceLastVisitMin"=>"<integer>", "visitorsType"=>"Buyers"}, "lookalike"=>{"seedSegmentId"=>"<string>", "targetSize"=>"<long>"}}}]}

HEADERS

RESPONSES

status: OK

{"data":[{"attributes":{"name":"\u003cstring\u003e","description":"\u003cstring\u003e","type":"Location","createdAt":"\u003cdateTime\u003e","updatedAt":"\u003cdateTime\u003e","advertiserId":"\u003cstring\u003e","inMarket":{"country":"\u003cstring\u003e","buyingPower":["VeryHigh","High"],"gender":"Male","interestIds":["\u003cstring\u003e","\u003cstring\u003e"],"brandIds":["\u003cstring\u003e","\u003cstring\u003e"],"priceRange":["Low","Unknown"]},"prospecting":{"daysSinceLastVisitMin":"\u003cinteger\u003e","daysSinceLastVisitMax":"\u003cinteger\u003e","usersType":"Unknown"},"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":"Unknown","country":"\u003cstring\u003e","startDate":"\u003cdateTime\u003e","endDate":"\u003cdateTime\u003e"},"retargeting":{"visitorsType":"All","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":"Unknown","createdAt":"\u003cdateTime\u003e","updatedAt":"\u003cdateTime\u003e","advertiserId":"\u003cstring\u003e","inMarket":{"country":"\u003cstring\u003e","buyingPower":["High","High"],"gender":"Female","interestIds":["\u003cstring\u003e","\u003cstring\u003e"],"brandIds":["\u003cstring\u003e","\u003cstring\u003e"],"priceRange":["Low","Unknown"]},"prospecting":{"daysSinceLastVisitMin":"\u003cinteger\u003e","daysSinceLastVisitMax":"\u003cinteger\u003e","usersType":"Unknown"},"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":"Seasonal","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"}],"warnings":[{"traceId":"\u003cstring\u003e","traceIdentifier":"\u003cstring\u003e","type":"availability","code":"\u003cstring\u003e","instance":"\u003cstring\u003e","title":"\u003cstring\u003e","detail":"\u003cstring\u003e","source":{"veniam_01f":"\u003cstring\u003e","sint_9":"\u003cstring\u003e"},"stackTrace":"\u003cstring\u003e"},{"traceId":"\u003cstring\u003e","traceIdentifier":"\u003cstring\u003e","type":"deprecation","code":"\u003cstring\u003e","instance":"\u003cstring\u003e","title":"\u003cstring\u003e","detail":"\u003cstring\u003e","source":{"eu31":"\u003cstring\u003e","in_65":"\u003cstring\u003e","minim3":"\u003cstring\u003e","sit_4fc":"\u003cstring\u003e"},"stackTrace":"\u003cstring\u003e"}],"errors":[{"traceId":"\u003cstring\u003e","traceIdentifier":"\u003cstring\u003e","type":"unknown","code":"\u003cstring\u003e","instance":"\u003cstring\u003e","title":"\u003cstring\u003e","detail":"\u003cstring\u003e","source":{"laboris3c":"\u003cstring\u003e"},"stackTrace":"\u003cstring\u003e"},{"traceId":"\u003cstring\u003e","traceIdentifier":"\u003cstring\u003e","type":"quota","code":"\u003cstring\u003e","instance":"\u003cstring\u003e","title":"\u003cstring\u003e","detail":"\u003cstring\u003e","source":{"occaecat_08":"\u003cstring\u003e","sunt518":"\u003cstring\u003e"},"stackTrace":"\u003cstring\u003e"}]}