Widget Newsletter

The Experience Widget Newsletter is accessible as an API to add a new subscriber to a list or multiple lists.

This API requires having the Newsletter widget option enabled on the CRM.

Unlike the other CRM APIs, there is no Bearer Token for this API.

To use it, you will need to contact our support team. You will be provided:

  • A widget ID

  • One or more Sending list ID

With these elements, you will be able to add a recipient to the CRM Newsletter Widget.

Each email sent through this API will trigger an email to the recipient to confirm his subscription to the newsletter.

If the recipient does not confirm his subscription, he will not be available on the property Sending List.

Request

GET

https://widgets.experience-hotel.com/front/widget/widget-newsletter/{{WIDGET_ID}}?callback=callback&selected_lists[]=167&fields[email]=test@test.com&fields[title]=1&fields[firstname]&fields[lastname]&fields[address_street_number_and_name]&fields[address_postal_code]&fields[country]&fields[mobile_formatted]&lang_id=1
Params
Format
Description

callback

YYYY-MM-DD

The callback parameters serve no purpose when the endpoint is used by an API, it is used only for front end integration

selected_lists[]

Numeric

Mailing list identifier. Can be repeated multiple times to subscribe the email to different CSV Sending lists on the CRM example : selected_lists[]=123&selected_lists[]=456&selected_lists[]=789

Provided by Experience Hotel.

fields[email]

String

E-mail to be added to the list (required)

fields[title]

Numeric

Title of the recipient (Mr: 1, Mrs: 2)

fields[firstname]

String

Firstname

fields[lastname]

String

Lastname

fields[address_street_number_and_name]

String

Address - Street and number

fields[address_postal_code]

String

Address - postal code

fields[country]

Numeric

fields[mobile_formatted]

String

Format : +336110101010

lang_id

Numeric

Language of the recipient. Use languages reference ID

Response

If no errors, you will only receive a 200 OK status code.

Languages ID reference

id
Language
Lang code

1

French

fr

2

English

en

3

Portuguese

pt

12

Italian

it

22

German

de

32

Spanish

es

42

Russian

ru

52

Japanese

ja

62

Dutch

nl

72

Danish

da

82

Swedish

sv

92

Hongrois

hu

102

Hungarian

el

112

Romanian

ro

122

Czech

cs

132

Finnish

fi

142

Norwegian

no

152

Icelandic

is

153

Simplified Chinese

zh-cn

154

Afar

aa

155

Abkhazian

ab

156

Avestan

ae

157

Afrikaans

af

158

Akan

ak

159

Amharic

am

160

Aragonese

an

161

Arabic

ar

162

Assamese

as

163

Avaric

av

164

Aymara

ay

165

Azerbaijani

az

166

Bashkir

ba

167

Belarusian

be

168

Bulgarian

bg

169

Bihari languages

bh

170

Bislama

bi

171

Bambara

bm

172

Bengali

bn

173

Tibetan

bo

174

Breton

br

175

Bosnian

bs

176

Catalan; Valencian

ca

177

Chechen

ce

178

Chamorro

ch

179

Corsican

co

180

Cree

cr

181

Church Slavic

cu

182

Chuvash

cv

183

Welsh

cy

184

Divehi; Dhivehi; Maldivian

dv

185

Dzongkha

dz

186

Ewe

ee

187

Esperanto

eo

188

Estonian

et

189

Basque

eu

190

Persian

fa

191

Fulah

ff

192

Fijian

fj

193

Faroese

fo

195

Western Frisian

fy

196

Irish

ga

197

Gaelic; Scottish Gaelic

gd

198

Galician

gl

199

Guarani

gn

200

Gujarati

gu

201

Manx

gv

202

Hebrew

he

203

Hindi

hi

204

Hiri Motu

ho

205

Croatian

hr

206

Haitian; Haitian Creole

ht

207

Armenian

hy

208

Herero

hz

209

Interlingua

ia

210

Indonesian

id

211

Interlingue; Occidental

ie

212

Igbo

ig

213

Sichuan Yi; Nuosu

ii

214

Inupiaq

ik

215

Ido

io

216

Inuktitut

iu

217

Japanese

ja2

218

Javanese

jv

219

Georgian

ka

220

Kongo

kg

221

Kikuyu; Gikuyu

ki

222

Kuanyama; Kwanyama

kj

223

Kazakh

kk

224

Kalaallisut; Greenlandic

kl

225

Central Khmer

km

226

Kannada

kn

227

Korean

ko

228

Kanuri

kr

229

Kashmiri

ks

230

Kurdish

ku

231

Komi

kv

232

Cornish

kw

233

Kirghiz; Kyrgyz

ky

234

Latin

la

235

Luxembourgish; Letzeburgesch

lb

236

Ganda

lg

237

Limburgan; Limburger; Limburgish

li

238

Lingala

ln

239

Lao

lo

240

Lithuanian

lt

241

Luba-Katanga

lu

242

Latvian

lv

243

Malagasy

mg

244

Marshallese

mh

245

Maori

mi

246

Macedonian

mk

247

Malayalam

ml

248

Mongolian

mn

249

Marathi

mr

250

Malay

ms

251

Maltese

mt

252

Burmese

my

253

Nauru

na

254

Bokmål, Norwegian; Norwegian Bokmål

nb

255

Ndebele, North; North Ndebele

nd

256

Nepali

ne

257

Ndonga

ng

258

Norwegian Nynorsk; Nynorsk, Norwegian

nn

259

Ndebele, South; South Ndebele

nr

260

Navajo; Navaho

nv

261

Chichewa; Chewa; Nyanja

ny

262

Occitan

oc

263

Ojibwa

oj

264

Oromo

om

265

Oriya

or

266

Ossetian; Ossetic

os

267

Panjabi; Punjabi

pa

268

Pali

pi

269

Polish

pl

270

Pushto; Pashto

ps

271

Quechua

qu

272

Romansh

rm

273

Rundi

rn

274

Kinyarwanda

rw

275

Sanskrit

sa

276

Sardinian

sc

277

Sindhi

sd

278

Northern Sami

se

279

Sango

sg

280

Sinhala; Sinhalese

si

281

Slovak

sk

282

Slovenian

sl

283

Samoan

sm

284

Shona

sn

285

Somali

so

286

Albanian

sq

287

Serbian

sr

288

Swati

ss

289

Sotho, Southern

st

290

Sundanese

su

291

Swahili

sw

292

Tamil

ta

293

Telugu

te

294

Tajik

tg

295

Thai

th

296

Tigrinya

ti

297

Turkmen

tk

298

Tagalog

tl

299

Tswana

tn

300

Tonga (Tonga Islands)

to

301

Turkish

tr

302

Tsonga

ts

303

Tatar

tt

304

Twi

tw

305

Tahitian

ty

306

Uighur; Uyghur

ug

307

Ukrainian

uk

308

Urdu

ur

309

Uzbek

uz

310

Venda

ve

311

Vietnamese

vi

312

Volapük

vo

313

Walloon

wa

314

Wolof

wo

315

Xhosa

xh

316

Yiddish

yi

317

Yoruba

yo

318

Zhuang; Chuang

za

319

Chinese

zh

320

Zulu

zu

321

Traditional Chinese

zh-hk

Country ID References

id
countrycode
name

1

AF

Afghanistan

2

AX

Åland Islands

3

AL

Albania

4

DZ

Algeria

5

AS

American Samoa

6

AD

Andorra

7

AO

Angola

8

AI

Anguilla

9

AQ

Antarctica

10

AG

Antigua & Barbuda

11

AR

Argentina

12

AM

Armenia

13

AW

Aruba

14

AC

Ascension Island

15

AU

Australia

16

AT

Austria

17

AZ

Azerbaijan

18

BS

Bahamas

19

BH

Bahrain

20

BD

Bangladesh

21

BB

Barbados

22

BY

Belarus

23

BE

Belgium

24

BZ

Belize

25

BJ

Benin

26

BM

Bermuda

27

BT

Bhutan

28

BO

Bolivia

29

BA

Bosnia & Herzegovina

30

BW

Botswana

31

BR

Brazil

32

IO

British Indian Ocean Territory

33

VG

British Virgin Islands

34

BN

Brunei

35

BG

Bulgaria

36

BF

Burkina Faso

37

BI

Burundi

38

KH

Cambodia

39

CM

Cameroon

40

CA

Canada

41

IC

Canary Islands

42

CV

Cape Verde

43

BQ

Caribbean Netherlands

44

KY

Cayman Islands

45

CF

Central African Republic

46

EA

Ceuta & Melilla

47

TD

Chad

48

CL

Chile

49

CN

China

50

CX

Christmas Island

51

CC

Cocos (Keeling) Islands

52

CO

Colombia

53

KM

Comoros

54

CG

Congo - Brazzaville

55

CD

Congo - Kinshasa

56

CK

Cook Islands

57

CR

Costa Rica

58

CI

Côte d’Ivoire

59

HR

Croatia

60

CU

Cuba

61

CW

Curaçao

62

CY

Cyprus

63

CZ

Czech Republic

64

DK

Denmark

65

DG

Diego Garcia

66

DJ

Djibouti

67

DM

Dominica

68

DO

Dominican Republic

69

EC

Ecuador

70

EG

Egypt

71

SV

El Salvador

72

GQ

Equatorial Guinea

73

ER

Eritrea

74

EE

Estonia

75

ET

Ethiopia

76

FK

Falkland Islands

77

FO

Faroe Islands

78

FJ

Fiji

79

FI

Finland

80

FR

France

81

GF

French Guiana

82

PF

French Polynesia

83

TF

French Southern Territories

84

GA

Gabon

85

GM

Gambia

86

GE

Georgia

87

DE

Germany

88

GH

Ghana

89

GI

Gibraltar

90

GR

Greece

91

GL

Greenland

92

GD

Grenada

93

GP

Guadeloupe

94

GU

Guam

95

GT

Guatemala

96

GG

Guernsey

97

GN

Guinea

98

GW

Guinea-Bissau

99

GY

Guyana

100

HT

Haiti

101

HN

Honduras

102

HK

Hong Kong SAR China

103

HU

Hungary

104

IS

Iceland

105

IN

India

106

ID

Indonesia

107

IR

Iran

108

IQ

Iraq

109

IE

Ireland

110

IM

Isle of Man

111

IL

Israel

112

IT

Italy

113

JM

Jamaica

114

JP

Japan

115

JE

Jersey

116

JO

Jordan

117

KZ

Kazakhstan

118

KE

Kenya

119

KI

Kiribati

120

XK

Kosovo

121

KW

Kuwait

122

KG

Kyrgyzstan

123

LA

Laos

124

LV

Latvia

125

LB

Lebanon

126

LS

Lesotho

127

LR

Liberia

128

LY

Libya

129

LI

Liechtenstein

130

LT

Lithuania

131

LU

Luxembourg

132

MO

Macau SAR China

133

MK

Macedonia

134

MG

Madagascar

135

MW

Malawi

136

MY

Malaysia

137

MV

Maldives

138

ML

Mali

139

MT

Malta

140

MH

Marshall Islands

141

MQ

Martinique

142

MR

Mauritania

143

MU

Mauritius

144

YT

Mayotte

145

MX

Mexico

146

FM

Micronesia

147

MD

Moldova

148

MC

Monaco

149

MN

Mongolia

150

ME

Montenegro

151

MS

Montserrat

152

MA

Morocco

153

MZ

Mozambique

154

MM

Myanmar (Burma)

155

NA

Namibia

156

NR

Nauru

157

NP

Nepal

158

NL

Netherlands

159

NC

New Caledonia

160

NZ

New Zealand

161

NI

Nicaragua

162

NE

Niger

163

NG

Nigeria

164

NU

Niue

165

NF

Norfolk Island

166

KP

North Korea

167

MP

Northern Mariana Islands

168

NO

Norway

169

OM

Oman

170

PK

Pakistan

171

PW

Palau

172

PS

Palestinian Territories

173

PA

Panama

174

PG

Papua New Guinea

175

PY

Paraguay

176

PE

Peru

177

PH

Philippines

178

PN

Pitcairn Islands

179

PL

Poland

180

PT

Portugal

181

PR

Puerto Rico

182

QA

Qatar

183

RE

Réunion

184

RO

Romania

185

RU

Russia

186

RW

Rwanda

187

WS

Samoa

188

SM

San Marino

189

ST

São Tomé & Príncipe

190

SA

Saudi Arabia

191

SN

Senegal

192

RS

Serbia

193

SC

Seychelles

194

SL

Sierra Leone

195

SG

Singapore

196

SX

Sint Maarten

197

SK

Slovakia

198

SI

Slovenia

199

SB

Solomon Islands

200

SO

Somalia

201

ZA

South Africa

202

GS

South Georgia & South Sandwich Islands

203

KR

South Korea

204

SS

South Sudan

205

ES

Spain

206

LK

Sri Lanka

207

BL

St. Barthélemy

208

SH

St. Helena

209

KN

St. Kitts & Nevis

210

LC

St. Lucia

211

MF

St. Martin

212

PM

St. Pierre & Miquelon

213

VC

St. Vincent & Grenadines

214

SD

Sudan

215

SR

Suriname

216

SJ

Svalbard & Jan Mayen

217

SZ

Swaziland

218

SE

Sweden

219

CH

Switzerland

220

SY

Syria

221

TW

Taiwan

222

TJ

Tajikistan

223

TZ

Tanzania

224

TH

Thailand

225

TL

Timor-Leste

226

TG

Togo

227

TK

Tokelau

228

TO

Tonga

229

TT

Trinidad & Tobago

230

TA

Tristan da Cunha

231

TN

Tunisia

232

TR

Turkey

233

TM

Turkmenistan

234

TC

Turks & Caicos Islands

235

TV

Tuvalu

236

UM

U.S. Outlying Islands

237

VI

U.S. Virgin Islands

238

UG

Uganda

239

UA

Ukraine

240

AE

United Arab Emirates

241

GB

United Kingdom

242

US

United States

243

UY

Uruguay

244

UZ

Uzbekistan

245

VU

Vanuatu

246

VA

Vatican City

247

VE

Venezuela

248

VN

Vietnam

249

WF

Wallis & Futuna

250

EH

Western Sahara

251

YE

Yemen

252

ZM

Zambia

253

ZW

Zimbabwe

Last updated