--- title: "Retrieve outbound messages" method: GET path: "/v1/messages" tags: ["Messages"] --- # Retrieve outbound messages `GET /v1/messages` ## Request - Base URL: `https://platform.hootsuite.com` - URL: `https://platform.hootsuite.com/v1/messages` - Auth: OAuth 2 - Authorization code: `https://platform.hootsuite.com/oauth2/auth` - Token URL: `https://platform.hootsuite.com/oauth2/token` Outbound messages are messages that are scheduled or were previously sent. This endpoint returns outbound messages sorted by increasing scheduled send time. Messages pending approval, including those created by and/or actionable by the given user, will also be returned via this API. Messages returned can be filtered by social profile or the current state of the message. If more than 50 results are returned a cursor will be automatically created to paginate the results. Query Parameters must be [URL encoded](https://en.wikipedia.org/wiki/Percent-encoding). For example: ``` ?startTime=2020-01-01T00%3A00%3A00Z &endTime=2020-01-15T17%3A55%3A01Z &socialProfileIds=1234 &state=SCHEDULED &limit=5 ``` To specify multiple social profiles, use the following [syntax](http://stackoverflow.com/questions/6243051/how-to-pass-an-array-within-a-query-string): ``` ?socialProfileIds=1234&socialProfileIds=5678 ``` ## Query parameters - `startTime` string, required - `endTime` string, required - `state` string - `socialProfileIds` integer - `limit` integer - `cursor` string - `includeUnscheduledReviewMsgs` boolean ## Headers - `Authorization` string, required ## Response `200` Success - SocialProfileMessagesResponseEnvelope - `data` SocialProfileMessage[], required: The data response envelope. - `id` string, required: The message ID. - `state` 'SCHEDULED' | 'SUBMITTED' | 'PENDING_APPROVAL' | 'SENT' | 'SEND_FAILED_PERMANENTLY' | 'REJECTED', required: The message state. - `text` string: The message text to publish. - `socialProfile` object: The social profile that the message will be published to. - `id` string: The social profile ID. - `externalURL` string: The external public URL of the social profile. - `scheduledSendTime` string: The time the message is scheduled to be sent in UTC time, [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format. Missing or different timezones will not be accepted, to ensure there is no ambiguity about scheduled time. Dates must end with 'Z' to be accepted. - `webhookUrls` string[]: The webhook URL(s) to call to when the message’s state changes. - `tags` string[]: The Hootsuite message tags to apply to the message. To set tags the social profile must belong to an organization. Tags are case sensitive. Limited permission members can only use the existing tags for organization and cannot create new ones. See more about message tags at the Hootsuite Help Center. - `targeting` object: Social network targeting options to be applied when publishing the message. - `facebookPage` FacebookPageTargeting: Targeting options for Facebook Page. Note that recently Facebook has deprecated feed targeting fields `ageMax`, `genders`, and `locales`. - `ageMin` integer: Minimum age to target the message at. If used, must be value of 13, 17, 18, 19, 21. - `education` string[]: Education level to target the message at. - `interestedIn` string[]: Interested in preferences to target the message at. - `relationshipStatus` string[]: Relationship status to target the message at. - `countries` object[]: Country to target the message at. - `k` string: The full name of the country being targeted. - `v` string: The 2-digit ISO 3166 format code, as provided by Facebook. - `regions` object[]: Region to target the message at. Note that regions can only be specified when there is exactly one country targeted. Limit 200. - `k` string: The full name of the region being targeted. - `v` string: The region key, as provided by Facebook. - `cities` object[]: City to target the message at. Note that cities can only be specified when there is exactly one country targeted. Limit 250. - `k` string: The full name of the city being targeted. - `v` string: The city key, as provided by Facebook. - `zips` object[]: Zip/Postal Code to target the message at. Limit 50,000. - `k` string: The name of the zip/postal code being targeted. - `v` string: The zip/postal code key, as provided by Facebook. - `linkedInCompany` LinkedInCompanyTargeting: Targeting options for LinkedIn Company. Legacy field, please do not use. - `companySize` string[]: Company size to target the message at. self: 'Self employed' 1-10: '1 to 10 employees' 11-50: '11 to 50 employees' 51-200: '51 to 200 employees' 201-500: '201 to 500 employees' 501-1000: '501 to 1000 employees' 1001-5000: '1001 to 5000 employees' 5001-10000: '5001 to 10000 employees' 10001: '10001+ employees' - `geography` string[]: Geography to target the message at. Valid values: af: 'Africa' af.cm: 'Cameroon' af.dz: 'Algeria' af.eg: 'Egypt' af.gh: 'Ghana' af.ke: 'Kenya' af.ma: 'Morocco' af.ng: 'Nigeria' af.tn: 'Tunisia' af.tz: 'Tanzania' af.ug: 'Uganda' af.za: 'South Africa' af.za.*.5852: 'Cape Town Area, south Africa' af.za.*.5855 : 'Durban Area, South Africa' af.za.*.5862: 'Johannesburg Area, South Africa' af.zw: 'Zimbabwe' aq: 'Antarctica' as: 'Asia' as.bd: 'Bangladesh' as.cn: 'China' as.cn.*.8909: 'Shanghai City, China' as.cn.*.8910: 'Shenzhen, Guangdong, China' as.cn.*.8911: 'Beijing City, China' as.cn.*.8919: 'Guangzhou, Guangdong, China' as.hk: 'Hong Kong' as.id: 'Indonesia' as.id.*.8594: 'Greater Jakarta Area, Indonesia' as.in: 'India' as.in.an: 'Andaman & Nicobar Islands' as.in.ap: 'Andhra Pradesh' as.in.ap.6508: 'Hyderabad Area, India' as.in.ar: 'Arunachal Pradesh' as.in.as: 'Assam' as.in.br: 'Bihar' as.in.cg: 'Chattisgarh' as.in.ch: 'Chandigarh' as.in.dd: 'Daman & Diu' as.in.dl: 'Delhi' as.in.dl.7151: 'New Delhi Area, India' as.in.dn: 'Dadra & Nagar Haveli' as.in.ga: 'Goa' as.in.gj: 'Gujarat' as.in.gj.6552: 'Vadodara Area, India' as.in.gj.7065: 'Ahmedabad Area, India' as.in.hp: 'Himachal Pradesh' as.in.hr: 'Haryana' as.in.hr.7391: 'Gurgaon, India' as.in.jh: 'Jharkhand' as.in.jk: 'Jammu & Kashmir' as.in.ka: 'Karnataka' as.in.ka.7127: 'Bengaluru Area, India' as.in.kl: 'Kerala' as.in.kl.6477: 'Cochin Area, India' as.in.ld: 'Lakshadweep' as.in.mh: 'Maharashtra' as.in.mh.6751: 'Nagpur Area, India' as.in.mh.7150: 'Mumbai Area, India' as.in.mh.7350: 'Pune Area, India' as.in.ml: 'Meghalaya' as.in.mn: 'Manipur' as.in.mp: 'Madhya Pradesh' as.in.mp.7382: 'Indore Area, India' as.in.mz: 'Mizoram' as.in.nl: 'Nagaland' as.in.or: 'Orissa' as.in.pb: 'Punjab' as.in.pb.6879: 'Chandigarh Area, India' as.in.py: 'Pondicherry' as.in.rj: 'Rajasthan' as.in.rj.7287: 'Jaipur Area, India' as.in.sk: 'Sikkim' as.in.tn: 'Tamil Nadu' as.in.tn.6472: 'Coimbatore Area, India' as.in.tn.6891: 'Chennai Area, India' as.in.tr: 'Tripura' as.in.ul: 'Uttarakhand' as.in.up: 'Uttar Pradesh' as.in.up.7093: 'Lucknow Area, India' as.in.up.7392: 'Noida Area, India' as.in.wb: 'West Bengal' as.in.wb.7003: 'Kolkata Area, India' as.jp: 'Japan' as.kr: 'Korea' as.kr.*.7700: 'Gangnam-gu, Seoul, Korea' as.lk: 'Sri Lanka' as.my: 'Malaysia' as.my.*.7945: 'Selangor, Malaysia' as.my.*.7960: 'Kuala Lumpur, Malaysia' as.np: 'Nepal' as.ph: 'Philippines' as.sg: 'Singapore' as.th: 'Thailand' as.tw: 'Taiwan' as.vn: 'Vietnam' eu: 'Europe' eu.at: 'Austria' eu.be: 'Belgium' eu.be.*.4918: 'Antwerp Area, Belgium' eu.be.*.4920: 'Brussels Area, Belgium' eu.bg: 'Bulgaria' eu.ch: 'Switzerland' eu.ch.*.4930: 'Geneva Area, Switzerland' eu.ch.*.4938: 'Zürich Area, Switzerland' eu.cz: 'Czech Republic' eu.de: 'Germany' eu.de.*.4953: 'Cologne Area, Germany' eu.de.*.4966: 'Frankfurt Am Main Area, Germany' eu.de.*.5000: 'Munich Area, Germany' eu.dk: 'Denmark' eu.dk.*.5038: 'Copenhagen Area, Denmark' eu.dk.*.5041: 'Odense Area, Denmark' eu.dk.*.5044: 'Ålborg Area, Denmark' eu.dk.*.5045: 'Århus Area, Denmark' eu.es: 'Spain' eu.es.*.5064: 'Barcelona Area, Spain' eu.es.*.5113: 'Madrid Area, Spain' eu.fi: 'Finland' eu.fr: 'France' eu.fr.*.5205: 'Lille Area, France' eu.fr.*.5210: 'Lyon Area, France' eu.fr.*.5211: 'Marseille Area, France' eu.fr.*.5221: 'Nice Area, France' eu.fr.*.5227: 'Paris Area, France' eu.fr.*.5249: 'Toulouse Area, France' eu.gb: 'United Kingdom' eu.gb.*.4544: 'Birmingham, United Kingdom' eu.gb.*.4550: 'Brighton, United Kingdom' eu.gb.*.4552: 'Bristol, United Kingdom' eu.gb.*.4555: 'Cambridge, United Kingdom' eu.gb.*.4558: 'Chelmsford, United Kingdom' eu.gb.*.4562: 'Coventry, United Kingdom' eu.gb.*.4573: 'London, United Kingdom' eu.gb.*.4574: 'Edinburgh, United Kingdom' eu.gb.*.4579: 'Glasgow, United Kingdom' eu.gb.*.4580: 'Gloucester, United Kingdom' eu.gb.*.4582: 'Guildford, United Kingdom' eu.gb.*.4583: 'Harrow, United Kingdom' eu.gb.*.4586: 'Hemel Hempstead, United Kingdom' eu.gb.*.4597: 'Kingston upon Thames, United Kingdom' eu.gb.*.4603: 'Leicester, United Kingdom' eu.gb.*.4606: 'Leeds, United Kingdom' eu.gb.*.4608: 'Manchester, United Kingdom' eu.gb.*.4610: 'Milton Keynes, United Kingdom' eu.gb.*.4612: 'Newcastle upon Tyne, United Kingdom' eu.gb.*.4613: 'Nottingham, United Kingdom' eu.gb.*.4614: 'Northampton, United Kingdom' eu.gb.*.4618: 'Oxford, United Kingdom' eu.gb.*.4623: 'Portsmouth, United Kingdom' eu.gb.*.4625: 'Reading, United Kingdom' eu.gb.*.4626: 'Redhill, United Kingdom' eu.gb.*.4628: 'Sheffield, United Kingdom' eu.gb.*.4632: 'Slough, United Kingdom' eu.gb.*.4635: 'Southampton, United Kingdom' eu.gb.*.4644: 'Tonbridge, United Kingdom' eu.gb.*.4648: 'Twickenham, United Kingdom' eu.gr: 'Greece' eu.hr: 'Croatia' eu.hu: 'Hungary' eu.ie: 'Ireland' eu.it: 'Italy' eu.it.*.5587: 'Bologna Area, Italy' eu.it.*.5616: 'Milan Area, Italy' eu.it.*.5636: 'Rome Area, Italy' eu.it.*.5652: 'Turin Area, Italy' eu.it.*.5657: 'Venice Area, Italy' eu.lt: 'Lithuania' eu.nl: 'Netherlands' eu.nl.*.5663: 'Almere Stad Area, Netherlands' eu.nl.*.5664: 'Amsterdam Area, Netherlands' eu.nl.*.5665: 'Apeldoorn Area, Netherlands' eu.nl.*.5668: 'Eindhoven Area, Netherlands' eu.nl.*.5669: 'Enschede Area, Netherlands' eu.nl.*.5673: 'Groningen Area, Netherlands' eu.nl.*.5681: 'Nijmegen Area, Netherlands' eu.nl.*.5688: 'The Hague Area, Netherlands' eu.nl.*.5690: 'Utrecht Area, Netherlands' eu.nl.*.5906: 'Breda Area, Netherlands' eu.nl.*.5907: 'Tilburg Area, Netherlands' eu.nl.*.5908: 'Rotterdam Area, Netherlands' eu.nl.*.7417: 'Maastricht Area, Netherlands' eu.no: 'Norway' eu.pl: 'Poland' eu.pt: 'Portugal' eu.ro: 'Romania' eu.rs: 'Serbia' eu.ru: 'Russian Federation' eu.se: 'Sweden' eu.sk: 'Slovak Republic' eu.tr: 'Turkey' eu.tr.*.7585: 'Istanbul, Turkey' eu.ua: 'Ukraine' la: 'Latin America' la.ar: 'Argentina' la.bo: 'Bolivia' la.br: 'Brazil' la.br.ac: 'Acre' la.br.al: 'Alagoas' la.br.am: 'Amazonas' la.br.ap: 'Amapá' la.br.ba: 'Bahia' la.br.ce: 'Ceará' la.br.df: 'Distrito Federal' la.br.es: 'Espírito Santo' la.br.go: 'Goiás' la.br.ma: 'Maranhão' la.br.mg: 'Minas Gerais' la.br.mg.6156: 'Belo Horizonte Area, Brazil' la.br.ms: 'Mato Grosso do Sul' la.br.mt: 'Mato Grosso' la.br.pa: 'Pará' la.br.pb: 'Paraíba' la.br.pe: 'Pernambuco' la.br.pi: 'Piauí' la.br.pr: 'Paraná' la.br.pr.6399: 'Curitiba Area, Brazil' la.br.rj: 'Rio de Janeiro' la.br.rj.6034: 'Rio de Janeiro Area, Brazil' la.br.rn: 'Rio Grande do Norte' la.br.ro: 'Rondônia' la.br.rr: 'Roraima' la.br.rs: 'Rio Grande do Sul' la.br.rs.6467: 'Porto Alegre Area, Brazil' la.br.sc: 'Santa Catarina' la.br.se: 'Sergipe' la.br.sp: 'São Paulo' la.br.sp.6104: 'Campinas Area, Brazil' la.br.sp.6368: 'São Paulo Area, Brazil' la.br.to: 'Tocantins' la.cl: 'Chile' la.co: 'Colombia' la.cr: 'Costa Rica' la.do: 'Dominican Republic' la.ec: 'Ecuador' la.gt: 'Guatemala' la.mx: 'Mexico' la.mx.*.5921: 'Mexico City Area, Mexico' la.mx.*.5955: 'Naucalpan de Juárez Area, Mexico' la.pa: 'Panama' la.pe: 'Peru' la.pr: 'Puerto Rico' la.tt: 'Trinidad and Tobago' la.uy: 'Uruguay' la.ve: 'Venezuela' me: 'Middle East' me.ae: 'United Arab Emirates' me.bh: 'Bahrain' me.il: 'Israel' me.jo: 'Jordan' me.kw: 'Kuwait' me.pk: 'Pakistan' me.qa: 'Qatar' me.sa: 'Saudi Arabia' na: 'North America' na.ca: 'Canada' na.ca.ab: 'Alberta' na.ca.ab.4872: 'Edmonton, Canada Area' na.ca.ab.4882: 'Calgary, Canada Area' na.ca.bc: 'British Columbia' na.ca.bc.4873: 'British Columbia, Canada' na.ca.bc.4880: 'Vancouver, Canada Area' na.ca.mb: 'Manitoba' na.ca.nb: 'New Brunswick' na.ca.nl: 'Newfoundland And Labrador' na.ca.ns: 'Nova Scotia' na.ca.ns.4874: 'Halifax, Canada Area' na.ca.nt: 'Northwest Territories' na.ca.nu: 'Nunavut' na.ca.on: 'Ontario' na.ca.on.4864: 'Ontario, Canada' na.ca.on.4865: 'Kitchener, Canada Area' na.ca.on.4869: 'London, Canada Area' na.ca.on.4876: 'Toronto, Canada Area' na.ca.on.4884: 'Ottawa, Canada Area' na.ca.pe: 'Prince Edward Island' na.ca.qc: 'Quebec' na.ca.qc.4863: 'Montreal, Canada Area' na.ca.qc.4866: 'Winnipeg, Canada Area' na.ca.qc.4875: 'Quebec, Canada' na.ca.sk: 'Saskatchewan' na.ca.yt: 'Yukon' na.us: 'United States' na.us.ak: 'Alaska' na.us.ak.38: 'Anchorage, Alaska Area' na.us.al: 'Alabama' na.us.al.100: 'Birmingham, Alabama Area' na.us.al.344: 'Huntsville, Alabama Area' na.us.al.516: 'Mobile, Alabama Area' na.us.ar: 'Arkansas' na.us.ar.258: 'Fayetteville, Arkansas Area' na.us.ar.440: 'Little Rock, Arkansas Area' na.us.az: 'Arizona' na.us.az.620: 'Phoenix, Arizona Area' na.us.az.852: 'Tucson, Arizona Area' na.us.ca: 'California' na.us.ca.284: 'Fresno, California Area' na.us.ca.49: 'Greater Los Angeles Area' na.us.ca.51: 'Orange County, California Area' na.us.ca.712: 'Salinas, California Area' na.us.ca.732: 'Greater San Diego Area' na.us.ca.748: 'Santa Barbara, California Area' na.us.ca.812: 'Stockton, California Area' na.us.ca.82: 'Sacramento, California Area' na.us.ca.84: 'San Francisco Bay Area' na.us.co: 'Colorado' na.us.co.172: 'Colorado Springs, Colorado Area' na.us.co.267: 'Fort Collins, Colorado Area' na.us.co.34: 'Greater Denver Area' na.us.ct: 'Connecticut' na.us.ct.327: 'Hartford, Connecticut Area' na.us.ct.552: 'New London/Norwich, Connecticut Area' na.us.dc: 'District Of Columbia' na.us.dc.97: 'Washington D.C. Metro Area' na.us.de: 'Delaware' na.us.fl: 'Florida' na.us.fl.202: 'Daytona Beach, Florida Area' na.us.fl.270: 'Fort Myers, Florida Area' na.us.fl.271: 'Fort Pierce, Florida Area' na.us.fl.290: 'Gainesville, Florida Area' na.us.fl.359: 'Jacksonville, Florida Area' na.us.fl.398: 'Lakeland, Florida Area' na.us.fl.490: 'Melbourne, Florida Area' na.us.fl.56: 'Miami/Fort Lauderdale Area' na.us.fl.596: 'Orlando, Florida Area' na.us.fl.751: 'Sarasota, Florida Area' na.us.fl.824: 'Tallahassee, Florida Area' na.us.fl.828: 'Tampa/St. Petersburg, Florida Area' na.us.fl.896: 'West Palm Beach, Florida Area' na.us.ga: 'Georgia' na.us.ga.52: 'Greater Atlanta Area' na.us.ga.60: 'Augusta, Georgia Area' na.us.ga.752: 'Savannah, Georgia Area' na.us.hi: 'Hawaii' na.us.hi.332: 'Hawaiian Islands' na.us.ia: 'Iowa' na.us.ia.196: 'Davenport, Iowa Area' na.us.ia.212: 'Des Moines, Iowa Area' na.us.id: 'Idaho' na.us.id.108: 'Boise, Idaho Area' na.us.il: 'Illinois' na.us.il.14: 'Greater Chicago Area' na.us.il.140: 'Urbana-Champaign, Illinois Area' na.us.il.612: 'Peoria, Illinois Area' na.us.il.688: 'Rockford, Illinois Area' na.us.in: 'Indiana' na.us.in.244: 'Evansville, Indiana Area' na.us.in.276: 'Fort Wayne, Indiana Area' na.us.in.348: 'Indianapolis, Indiana Area' na.us.ks: 'Kansas' na.us.ks.904: 'Wichita, Kansas Area' na.us.ky: 'Kentucky' na.us.ky.428: 'Lexington, Kentucky Area' na.us.ky.452: 'Louisville, Kentucky Area' na.us.la: 'Louisiana' na.us.la.556: 'Greater New Orleans Area' na.us.la.76: 'Baton Rouge, Louisiana Area' na.us.ma: 'Massachusetts' na.us.ma.7: 'Greater Boston Area' na.us.ma.800: 'Springfield, Massachusetts Area' na.us.md: 'Maryland' na.us.md.7416: 'Baltimore, Maryland Area' na.us.me: 'Maine' na.us.me.640: 'Portland, Maine Area' na.us.mi: 'Michigan' na.us.mi.300: 'Greater Grand Rapids, Michigan Area' na.us.mi.35: 'Greater Detroit Area' na.us.mi.372: 'Kalamazoo, Michigan Area' na.us.mi.404: 'Lansing, Michigan Area' na.us.mi.696: 'Saginaw, Michigan Area' na.us.mn: 'Minnesota' na.us.mn.512: 'Greater Minneapolis-St. Paul Area' na.us.mo: 'Missouri' na.us.mo.174: 'Columbia, Missouri Area' na.us.mo.376: 'Kansas City, Missouri Area' na.us.mo.704: 'Greater St. Louis Area' na.us.mo.792: 'Springfield, Missouri Area' na.us.ms: 'Mississippi' na.us.ms.356: 'Jackson, Mississippi Area' na.us.mt: 'Montana' na.us.nc: 'North Carolina' na.us.nc.152: 'Charlotte, North Carolina Area' na.us.nc.312: 'Greensboro/Winston-Salem, North Carolina Area' na.us.nc.48: 'Asheville, North Carolina Area' na.us.nc.664: 'Raleigh-Durham, North Carolina Area' na.us.nc.920: 'Wilmington, North Carolina Area' na.us.nd: 'North Dakota' na.us.ne: 'Nebraska' na.us.ne.436: 'Lincoln, Nebraska Area' na.us.ne.592: 'Greater Omaha Area' na.us.nh: 'New Hampshire' na.us.nj: 'New Jersey' na.us.nm: 'New Mexico' na.us.nm.20: 'Albuquerque, New Mexico Area' na.us.nv: 'Nevada' na.us.nv.412: 'Las Vegas, Nevada Area' na.us.nv.672: 'Reno, Nevada Area' na.us.ny: 'New York' na.us.ny.128: 'Buffalo/Niagara, New York Area' na.us.ny.16: 'Albany, New York Area' na.us.ny.684: 'Rochester, New York Area' na.us.ny.70: 'Greater New York City Area' na.us.ny.816: 'Syracuse, New York Area' na.us.ny.96: 'Ithaca, New York Area' na.us.oh: 'Ohio' na.us.oh.184: 'Columbus, Ohio Area' na.us.oh.200: 'Dayton, Ohio Area' na.us.oh.21: 'Cincinnati Area' na.us.oh.28: 'Cleveland/Akron, Ohio Area' na.us.oh.840: 'Toledo, Ohio Area' na.us.ok: 'Oklahoma' na.us.ok.588: 'Oklahoma City, Oklahoma Area' na.us.ok.856: 'Tulsa, Oklahoma Area' na.us.or: 'Oregon' na.us.or.240: 'Eugene, Oregon Area' na.us.or.79: 'Portland, Oregon Area' na.us.pa: 'Pennsylvania' na.us.pa.24: 'Allentown, Pennsylvania Area' na.us.pa.324: 'Harrisburg, Pennsylvania Area' na.us.pa.400: 'Lancaster, Pennsylvania Area' na.us.pa.628: 'Greater Pittsburgh Area' na.us.pa.756: 'Scranton, Pennsylvania Area' na.us.pa.77: 'Greater Philadelphia Area' na.us.ri: 'Rhode Island' na.us.ri.648: 'Providence, Rhode Island Area' na.us.sc: 'South Carolina' na.us.sc.144: 'Charleston, South Carolina Area' na.us.sc.176: 'Columbia, South Carolina Area' na.us.sc.316: 'Greenville, South Carolina Area' na.us.sd: 'South Dakota' na.us.sd.776: 'Sioux Falls, South Dakota Area' na.us.tn: 'Tennessee' na.us.tn.156: 'Chattanooga, Tennessee Area' na.us.tn.366: 'Johnson City, Tennessee Area' na.us.tn.384: 'Knoxville, Tennessee Area' na.us.tn.492: 'Greater Memphis Area' na.us.tn.536: 'Greater Nashville Area' na.us.tx: 'Texas' na.us.tx.232: 'El Paso, Texas Area' na.us.tx.31: 'Dallas/Fort Worth Area' na.us.tx.42: 'Houston, Texas Area' na.us.tx.64: 'Austin, Texas Area' na.us.tx.724: 'San Antonio, Texas Area' na.us.ut: 'Utah' na.us.ut.652: 'Provo, Utah Area' na.us.ut.716: 'Greater Salt Lake City Area' na.us.va: 'Virginia' na.us.va.154: 'Charlottesville, Virginia Area' na.us.va.572: 'Norfolk, Virginia Area' na.us.va.676: 'Richmond, Virginia Area' na.us.va.680: 'Roanoke, Virginia Area' na.us.vt: 'Vermont' na.us.vt.130: 'Burlington, Vermont Area' na.us.wa: 'Washington' na.us.wa.784: 'Spokane, Washington Area' na.us.wa.91: 'Greater Seattle Area' na.us.wi: 'Wisconsin' na.us.wi.308: 'Green Bay, Wisconsin Area' na.us.wi.46: 'Oshkosh, Wisconsin Area' na.us.wi.472: 'Madison, Wisconsin Area' na.us.wi.63: 'Greater Milwaukee Area' na.us.wv: 'West Virginia' na.us.wy: 'Wyoming' oc: 'Oceania' oc.au: 'Australia' oc.au.*.4886: 'Adelaide Area, Australia' oc.au.*.4893: 'Canberra Area, Australia' oc.au.*.4900: 'Melbourne Area, Australia' oc.au.*.4905: 'Perth Area, Australia' oc.au.*.4909: 'Brisbane Area, Australia' oc.au.*.4910: 'Sydney Area, Australia' oc.nz: 'New Zealand' - `industry` string[]: Industry to target the message at. 63: 'Agriculture - Farming' 64: 'Agriculture - Ranching' 65: 'Agriculture - Dairy' 66: 'Agriculture - Fishery' 35: 'Arts - Motion Pictures and Film' 37: 'Arts - Museums and Institutions' 38: 'Arts - Fine Art' 39: 'Arts - Performing Arts' 99: 'Arts - Design' 111: 'Arts - Arts and Crafts' 115: 'Arts - Music' 136: 'Arts - Photography' 140: 'Arts - Graphic Design' 48: 'Construction - Construction' 49: 'Construction - Building Materials' 50: 'Construction - Architecture & Planning' 51: 'Construction - Civil Engineering' 18: 'Consumer Goods - Cosmetics' 19: 'Consumer Goods - Apparel & Fashion' 20: 'Consumer Goods - Sporting Goods' 21: 'Consumer Goods - Tobacco' 22: 'Consumer Goods - Supermarkets' 23: 'Consumer Goods - Food Production' 24: 'Consumer Goods - Consumer Electronics' 25: 'Consumer Goods - Consumer Goods' 26: 'Consumer Goods - Furniture' 27: 'Consumer Goods - Retail' 133: 'Consumer Goods - Wholesale' 134: 'Consumer Goods - Import and Export' 142: 'Consumer Goods - Wine and Spirits' 143: 'Consumer Goods - Luxury Goods & Jewelry' 11: 'Corporate - Management Consulting' 80: 'Corporate - Marketing and Advertising' 97: 'Corporate - Market Research' 98: 'Corporate - Public Relations and Communications' 104: 'Corporate - Staffing and Recruiting' 105: 'Corporate - Professional Training & Coaching' 121: 'Corporate - Security and Investigations' 122: 'Corporate - Facilities Services' 123: 'Corporate - Outsourcing/Offshoring' 137: 'Corporate - Human Resources' 138: 'Corporate - Business Supplies and Equipment' 67: 'Educational - Primary/Secondary Education' 68: 'Educational - Higher Education' 69: 'Educational - Education Management' 70: 'Educational - Research' 132: 'Educational - E-Learning' 41: 'Finance - Banking' 42: 'Finance - Insurance' 43: 'Finance - Financial Services' 44: 'Finance - Real Estate' 45: 'Finance - Investment Banking' 46: 'Finance - Investment Management' 47: 'Finance - Accounting' 106: 'Finance - Venture Capital & Private Equity' 128: 'Finance - Commercial Real Estate' 129: 'Finance - Capital Markets' 71: 'Government - Military' 72: 'Government - Legislative Office' 73: 'Government - Judiciary' 74: 'Government - International Affairs' 75: 'Government - Government Administration' 76: 'Government - Executive Office' 77: 'Government - Law Enforcement' 78: 'Government - Public Safety' 79: 'Government - Public Policy' 107: 'Government - Political Organization' 148: 'Government - Government Relations' 1: 'High Tech - Defense & Space' 3: 'High Tech - Computer Hardware' 4: 'High Tech - Computer Software' 5: 'High Tech - Computer Networking' 6: 'High Tech - Internet' 7: 'High Tech - Semiconductors' 8: 'High Tech - Telecommunications' 96: 'High Tech - Information Technology and Services' 114: 'High Tech - Nanotechnology' 118: 'High Tech - Computer & Network Security' 119: 'High Tech - Wireless' 9: 'Legal - Law Practice' 10: 'Legal - Legal Services' 120: 'Legal - Alternative Dispute Resolution' 52: 'Manufacturing - Aviation & Aerospace' 53: 'Manufacturing - Automotive' 54: 'Manufacturing - Chemicals' 55: 'Manufacturing - Machinery' 56: 'Manufacturing - Mining & Metals' 57: 'Manufacturing - Oil & Energy' 58: 'Manufacturing - Shipbuilding' 59: 'Manufacturing - Utilities' 60: 'Manufacturing - Textiles' 61: 'Manufacturing - Paper & Forest Products' 62: 'Manufacturing - Railroad Manufacture' 112: 'Manufacturing - Electrical/Electronic Manufacturing' 117: 'Manufacturing - Plastics' 135: 'Manufacturing - Mechanical or Industrial Engineering' 144: 'Manufacturing - Renewables & Environment' 145: 'Manufacturing - Glass, Ceramics & Concrete' 146: 'Manufacturing - Packaging and Containers' 147: 'Manufacturing - Industrial Automation' 36: 'Media - Broadcast Media' 81: 'Media - Newspapers' 82: 'Media - Publishing' 83: 'Media - Printing' 103: 'Media - Writing and Editing' 113: 'Media - Online Media' 126: 'Media - Media Production' 127: 'Media - Animation' 12: 'Medical - Biotechnology' 13: 'Medical - Medical Practice' 14: 'Medical - Hospital & Health Care' 15: 'Medical - Pharmaceuticals' 16: 'Medical - Veterinary' 17: 'Medical - Medical Devices' 124: 'Medical - Health, Wellness and Fitness' 125: 'Medical - Alternative Medicine' 139: 'Medical - Mental Health Care' 91: 'Non-profit - Consumer Services' 100: 'Non-profit - Non-profit Organization Management' 101: 'Non-profit - Fund-Raising' 102: 'Non-profit - Program Development' 130: 'Non-profit - Think Tanks' 131: 'Non-profit - Philanthropy' 141: 'Non-profit - International Trade and Development' 28: 'Recreational - Entertainment' 29: 'Recreational - Gambling & Casinos' 30: 'Recreational - Leisure, Travel & Tourism' 31: 'Recreational - Hospitality' 32: 'Recreational - Restaurants' 33: 'Recreational - Sports' 34: 'Recreational - Food & Beverages' 40: 'Recreational - Recreational Facilities and Services' 109: 'Recreational - Computer Games' 110: 'Recreational - Events Services' 84: 'Service - Information Services' 85: 'Service - Libraries' 86: 'Service - Environmental Services' 88: 'Service - Individual & Family Services' 89: 'Service - Religious Institutions' 90: 'Service - Civic & Social Organization' 108: 'Service - Translation and Localization' 87: 'Transportation - Package/Freight Delivery' 92: 'Transportation - Transportation/Trucking/Railroad' 93: 'Transportation - Warehousing' 94: 'Transportation - Airlines/Aviation' 95: 'Transportation - Maritime' 116: 'Transportation - Logistics and Supply Chain' - `jobFunction` string[]: Job function to target the message at. acad: 'Research' acct: 'Accounting' admn: 'Administrative' bd: 'Business Development' buy: 'Purchasing' cnsl: 'Consulting' cre: 'Arts and Design' css: 'Community and Social Services' edu: 'Education' eng: 'Engineering' ent: 'Entrepreneurship' finc: 'Finance' hr: 'Human Resources' it: 'Information Technology' lgl: 'Legal' med: 'Healthcare Services' mktg: 'Marketing' mps: 'Military and Protective Services' ops: 'Operations' ppm: 'Program and Project Management' pr: 'Media and Communication' prod: 'Product Management' qa: 'Quality Assurance' re: 'Real Estate' sale: 'Sales' supp: 'Support' - `seniority` string[]: Seniority to target the message at. c: 'Chief X Officer' d: 'Director' en: 'Entry' ic: 'Senior' m: 'Manager' o: 'Owner' p: 'Partner' tr: 'Training' up: 'Unpaid' vp: 'Vice President' - `privacy` object: Social network privacy options to be applied when publishing the message. - `facebook` FacebookPrivacy - `visibility` string[]: Facebook visibility rules. At most 1 can be used. - `linkedIn` LinkedInPrivacy - `visibility` string[]: LinkedIn visibility rules. At most 1 can be used. - `location` Location: The message’s geolocation in decimal degrees for latitude and longitude. Twitter allows users to set the location for a post manually. The location object takes in Decimal Degrees for latitude and longitude. Decimal degrees are an alternative to using degrees, minutes, and seconds (DMS). The values for latitude and longitude are bounded by ±90° and ±180° respectively. Positive latitudes are north of the equator, negative latitudes are south of the equator. Positive longitudes are east of Prime Meridian, negative longitudes are west of the Prime Meridian.
Not supported by Pinterest. - `latitude` number, double: The latitude in decimal degrees. Must be between -90 to 90. - `longitude` number, double: The longitude in decimal degrees. Must be between -180 to 180. - `emailNotification` boolean: A flag to determine whether email notifications are sent when the message is published. - `mediaUrls` MediaUrl[]: The ow.ly media attached to the message - `thumbnailUrl` string: The thumbnail media URL. - `url` string: The media URL. - `media` Media[]: The media attached to the message - `id` string: The media ID. - `thumbnailId` string: The thumbnail media ID. - `videoOptions` object: The metadata to set for a video. - `facebook` object: Facebook video metadata. Optional. - `title` string: The video title - `category` 'BEAUTY_FASHION' | 'BUSINESS' | 'CARS_TRUCKS' | 'COMEDY' | 'CUTE_ANIMALS' | 'ENTERTAINMENT' | 'FAMILY' | 'FOOD_HEALTH' | 'HOME' | 'LIFESTYLE' | 'MUSIC' | 'NEWS' | 'POLITICS' | 'SCIENCE' | 'SPORTS' | 'TECHNOLOGY' | 'VIDEO_GAMING' | 'OTHER': The video category - `extendedInfo` object[]: Social profile metadata attached to the message. Only available for Pinterest messages at this time. - `socialProfileType` 'PINTEREST': The social profile type that this extendedInfo object is for. - `socialProfileId` string: The social profile ID that this extendedInfo object is for. - `data` object: Social profile specific meta data. - `boardId` string: Pinterest board ID for Pin - `destinationUrl` string: Website for Pin - `postId` string: The external message ID used by social network for this message. Only set once the message has been published. - `postUrl` string: The URL of the message live on the social network. Only set once the message has been published. Only available for Facebook and LinkedIn messages at this time. - `createdByMember` object: The identifier of the member who originally created the message. - `id` string: ID of member. - `lastUpdatedByMember` object: The identifier of the member who last updated the message. - `id` string: ID of member. - `sequenceNumber` number: The number representing which step in the approval process the message is on, or null if the message is not subject to approval. - `reviewers` Reviewer[]: A list of message reviewers - `id` string: The reviewer member ID. - `type` 'MESSAGE_LEVEL' | 'TEAM' | 'MEMBER' | 'EXTERNAL' | 'SYSTEM' | 'ADMIN_AND_EDITOR' | 'ORGANIZATION': The reviewer type - `metadata` object: The metadata response envelope. - `cursor` object: The cursor to paginate the results. A cursor will be created if the number of results exceeds the limit set in the query parameters. - `next` string: A cursor to the next page of results. This is set to null if no more pages exist. - `previous` string: A cursor to the previous page of results. This is set to null if no previous pages exist. ## Other responses - `400`: Bad Request --- [API](https://skmtc.dev/hootsuite/apis/hootsuite-rest-api.md) - [All operations](https://skmtc.dev/hootsuite/apis/hootsuite-rest-api/llms.txt) - [OpenAPI document](https://skmtc.dev/hootsuite/apis/hootsuite-rest-api/revisions/adac53bd28bb?raw)