bulk Create Audience Segments
POST {{baseUrl}}/2023-07/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"=>["Medium", "Medium"]}, "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>"}}}, {"type"=>"<string>", "attributes"=>{"advertiserId"=>"<string>", "name"=>"<string>", "description"=>"<string>", "inMarket"=>{"country"=>"<string>", "buyingPower"=>["Low", "Medium"], "gender"=>"Male", "interestIds"=>["<string>", "<string>"], "brandIds"=>["<string>", "<string>"], "priceRange"=>["Low", "Low"]}, "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>"}}}]}
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Content-Type | string | ||
Accept | string |
RESPONSES
status: OK
{"data":[{"attributes":{"name":"\u003cstring\u003e","description":"\u003cstring\u003e","type":"Retargeting","createdAt":"\u003cdateTime\u003e","updatedAt":"\u003cdateTime\u003e","advertiserId":"\u003cstring\u003e","inMarket":{"country":"\u003cstring\u003e","buyingPower":["Medium","Low"],"gender":"Unknown","interestIds":["\u003cstring\u003e","\u003cstring\u003e"],"brandIds":["\u003cstring\u003e","\u003cstring\u003e"],"priceRange":["Unknown","Medium"]},"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":"BuyingPatterns","country":"\u003cstring\u003e","startDate":"\u003cdateTime\u003e","endDate":"\u003cdateTime\u003e"},"retargeting":{"visitorsType":"Buyers","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":["Unknown","Unknown"],"gender":"Unknown","interestIds":["\u003cstring\u003e","\u003cstring\u003e"],"brandIds":["\u003cstring\u003e","\u003cstring\u003e"],"priceRange":["High","Low"]},"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":"Unknown"},"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":"authorization","code":"\u003cstring\u003e","instance":"\u003cstring\u003e","title":"\u003cstring\u003e","detail":"\u003cstring\u003e","source":{"ut_e72":"\u003cstring\u003e","proident_12":"\u003cstring\u003e"},"stackTrace":"\u003cstring\u003e"},{"traceId":"\u003cstring\u003e","traceIdentifier":"\u003cstring\u003e","type":"validation","code":"\u003cstring\u003e","instance":"\u003cstring\u003e","title":"\u003cstring\u003e","detail":"\u003cstring\u003e","source":{"fugiat_68":"\u003cstring\u003e","et_3a":"\u003cstring\u003e"},"stackTrace":"\u003cstring\u003e"}],"errors":[{"traceId":"\u003cstring\u003e","traceIdentifier":"\u003cstring\u003e","type":"quota","code":"\u003cstring\u003e","instance":"\u003cstring\u003e","title":"\u003cstring\u003e","detail":"\u003cstring\u003e","source":{"magna9":"\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":{"eiusmod_b1f":"\u003cstring\u003e","auteb":"\u003cstring\u003e","reprehenderit_75":"\u003cstring\u003e","deserunt_0":"\u003cstring\u003e"},"stackTrace":"\u003cstring\u003e"}]}