ampscript-data 3.2.0 → 3.4.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +17 -5
- package/package.json +1 -1
- package/src/index.js +1531 -375
package/src/index.js
CHANGED
|
@@ -78,15 +78,31 @@ export const VERIFICATION_BLOCKED_REASONS = Object.freeze([
|
|
|
78
78
|
* arguments (2-5 fail) would set `minArgs: 1, maxArgs: 6, validArities: [1, 6]`.
|
|
79
79
|
* Absent → behavior is a pure contiguous range. No AMPscript function currently needs it.
|
|
80
80
|
*
|
|
81
|
-
|
|
81
|
+
* `sfmcGuideUrl` (OPTIONAL): absolute URL of our own published reference page,
|
|
82
|
+
* `https://sfmc.guide/engagement/ampscript/functions/<lowercase-name>/`. Present ONLY when
|
|
83
|
+
* that page actually exists — it is written by the verification skills at step 4j, together
|
|
84
|
+
* with the page itself, and therefore always accompanies `isConfirmed: true`. Unlike `docUrl`
|
|
85
|
+
* (Salesforce) and `guideUrl` (ampscript.guide), this one points at content we own and have
|
|
86
|
+
* runtime-proven. Kept in sync by a cross-package test in `tests/cross-package.test.mjs`.
|
|
87
|
+
*
|
|
88
|
+
* `handlebarsExact` (OPTIONAL): only meaningful when `handlebarsEquivalent` names a helper.
|
|
89
|
+
* `true` means the helper is an argument-for-argument drop-in replacement for the AMPscript
|
|
90
|
+
* function. `false` means the helper does the same job but with a different call shape (dropped,
|
|
91
|
+
* shifted, or renamed arguments, or different error behaviour), so a converter must emit a hint
|
|
92
|
+
* for a human to finish the rewrite rather than a mechanical substitution. Must be present
|
|
93
|
+
* whenever `handlebarsEquivalent` is non-null.
|
|
94
|
+
*
|
|
95
|
+
@type {{name: string, mcnSince: number | null, mcnNotes: string | null, handlebarsEquivalent?: string | null, handlebarsExact?: boolean, docUrl?: string, guideUrl?: string, sfmcGuideUrl?: string, minArgs: number, maxArgs: number, validArities?: number[], category: string, description: string, params: {name: string, description: string, type?: string, enum?: (string | number)[], optional?: boolean, default?: string | number | boolean}[], returnType?: string, returnDescription?: string, returnEnum?: (string | number)[], syntax?: string, example?: string, repeat?: {startIndex: number, groupSize: number, minGroups: number, countParam?: string}[], deprecated?: boolean, deprecatedReplacement?: string, deprecatedReason?: string, isConfirmed?: boolean, verificationBlocked?: boolean, verificationBlockedReason?: string, differsFromOfficialDocs?: boolean, officialDocsNote?: string}[]} */
|
|
82
96
|
export const FUNCTIONS = [
|
|
83
97
|
{
|
|
84
98
|
name: 'Add',
|
|
85
99
|
mcnSince: 67,
|
|
86
100
|
handlebarsEquivalent: 'add',
|
|
101
|
+
handlebarsExact: true,
|
|
87
102
|
mcnNotes: null,
|
|
88
103
|
docUrl: 'https://developer.salesforce.com/docs/marketing/marketing-cloud-ampscript/references/mc-ampscript-math/mc-ampscript-reference-math-add.html',
|
|
89
104
|
guideUrl: 'https://ampscript.guide/add/',
|
|
105
|
+
sfmcGuideUrl: 'https://sfmc.guide/engagement/ampscript/functions/add/',
|
|
90
106
|
minArgs: 2,
|
|
91
107
|
maxArgs: 2,
|
|
92
108
|
category: 'Math',
|
|
@@ -134,6 +150,11 @@ export const FUNCTIONS = [
|
|
|
134
150
|
'var @list = "fdc5dfe4-e5e1-48af-87a1-4ac10433e895"\n' +
|
|
135
151
|
'AddMscrmListMember(@member, @list)\n' +
|
|
136
152
|
']%%',
|
|
153
|
+
isConfirmed: true,
|
|
154
|
+
nonFunctionalAtRuntime: true,
|
|
155
|
+
deprecated: true,
|
|
156
|
+
deprecatedReason:
|
|
157
|
+
'The Marketing Cloud Connector for Microsoft Dynamics CRM was retired (online integration in December 2020, on-premises in October 2021), so the Dynamics CRM AMPscript functions no longer have a live integration to call and are non-functional. No replacement AMPscript function exists; integrate Dynamics data through the SFTP import/export or a custom API instead.',
|
|
137
158
|
},
|
|
138
159
|
{
|
|
139
160
|
name: 'AddObjectArrayItem',
|
|
@@ -142,6 +163,7 @@ export const FUNCTIONS = [
|
|
|
142
163
|
mcnNotes: null,
|
|
143
164
|
docUrl: 'https://developer.salesforce.com/docs/marketing/marketing-cloud-ampscript/references/mc-ampscript-api/mc-ampscript-reference-api-add-object-array.html',
|
|
144
165
|
guideUrl: 'https://ampscript.guide/addobjectarrayitem/',
|
|
166
|
+
sfmcGuideUrl: 'https://sfmc.guide/engagement/ampscript/functions/addobjectarrayitem/',
|
|
145
167
|
minArgs: 3,
|
|
146
168
|
maxArgs: 3,
|
|
147
169
|
category: 'Marketing Cloud API',
|
|
@@ -156,6 +178,7 @@ export const FUNCTIONS = [
|
|
|
156
178
|
'No value is returned; the item is appended to the named array property.',
|
|
157
179
|
syntax: 'AddObjectArrayItem(apiObject, arrayProperty, itemToAdd)',
|
|
158
180
|
example: "AddObjectArrayItem(@apiObject, 'Recipients', @recipient)",
|
|
181
|
+
isConfirmed: true,
|
|
159
182
|
},
|
|
160
183
|
{
|
|
161
184
|
name: 'AttachFile',
|
|
@@ -229,24 +252,41 @@ export const FUNCTIONS = [
|
|
|
229
252
|
returnDescription: 'No value is returned; the file is attached to the outgoing email.',
|
|
230
253
|
syntax: 'AttachFile(fileLocationType, fileLocation, attachmentFileName, viewOnWeb, viewOnWebUrl, viewOnWebFileName, viewOnWebDuration, contentDispositionAttachment)',
|
|
231
254
|
example: "%%=AttachFile('http', 'https://example.com/catalog.pdf', 'Catalog.pdf')=%%",
|
|
255
|
+
isConfirmed: false,
|
|
256
|
+
verificationBlocked: true,
|
|
257
|
+
verificationBlockedReason: 'no-working-invocation',
|
|
258
|
+
officialDocsNote:
|
|
259
|
+
'AttachFile targets the outgoing email at send time; it has no working invocation on a CloudPage. Every reached call — contentbuilder key, http URL, and the two-argument minimum form — aborted the page with HTTP 422 and no partial output, on the child QA BU (MID 518005426) and again on the parent BU (MID 7281698). The abort only happens when the call is actually reached: gating it behind an unmatched query-string branch leaves the page at HTTP 200, so the failure is a runtime abort of the reached call rather than a compile-time rejection. The official reference additionally documents that the capability must be provisioned per account, which cannot be observed from a full-access probe.',
|
|
232
260
|
},
|
|
233
261
|
{
|
|
234
262
|
name: 'AttributeValue',
|
|
235
263
|
mcnSince: null,
|
|
236
|
-
handlebarsEquivalent:
|
|
264
|
+
handlebarsEquivalent: 'personalizationResult',
|
|
265
|
+
handlebarsExact: false,
|
|
237
266
|
mcnNotes: null,
|
|
238
267
|
docUrl: 'https://developer.salesforce.com/docs/marketing/marketing-cloud-ampscript/references/mc-ampscript-utilities/mc-ampscript-reference-utilities-attribute-value.html',
|
|
239
268
|
guideUrl: 'https://ampscript.guide/attributevalue/',
|
|
269
|
+
sfmcGuideUrl: 'https://sfmc.guide/engagement/ampscript/functions/attributevalue/',
|
|
240
270
|
minArgs: 1,
|
|
241
271
|
maxArgs: 1,
|
|
242
272
|
category: 'Utility',
|
|
243
273
|
description:
|
|
244
|
-
'
|
|
245
|
-
params: [
|
|
274
|
+
'Reads an attribute of the current message or page context by name, giving an empty value instead of failing when the name is unknown. The name is matched without regard to case, and system attributes such as the message context resolve on a CloudPage even though no subscriber is involved.',
|
|
275
|
+
params: [
|
|
276
|
+
{
|
|
277
|
+
name: 'attributeName',
|
|
278
|
+
description:
|
|
279
|
+
'Attribute name, matched without regard to case; an empty name aborts the page',
|
|
280
|
+
type: 'string',
|
|
281
|
+
},
|
|
282
|
+
],
|
|
246
283
|
returnType: 'string',
|
|
247
|
-
returnDescription:
|
|
284
|
+
returnDescription:
|
|
285
|
+
'The attribute value as a string, or an empty value when the name resolves to nothing.',
|
|
248
286
|
syntax: 'AttributeValue(attributeName)',
|
|
249
287
|
example: "%%=AttributeValue('firstname')=%%",
|
|
288
|
+
isConfirmed: true,
|
|
289
|
+
differsFromOfficialDocs: false,
|
|
250
290
|
},
|
|
251
291
|
{
|
|
252
292
|
name: 'AuthenticatedEmployeeID',
|
|
@@ -258,10 +298,15 @@ export const FUNCTIONS = [
|
|
|
258
298
|
minArgs: 0,
|
|
259
299
|
maxArgs: 0,
|
|
260
300
|
category: 'Utility',
|
|
261
|
-
description:
|
|
301
|
+
description:
|
|
302
|
+
'Returns the numeric employee ID of the Marketing Cloud user tied to the current context. On a public CloudPage, where nobody is signed in, it still returns a non-empty ID rather than an empty value, so it cannot be used to tell an authenticated visitor apart from an anonymous one.',
|
|
262
303
|
params: [],
|
|
263
304
|
returnType: 'string',
|
|
264
|
-
returnDescription:
|
|
305
|
+
returnDescription:
|
|
306
|
+
'The employee ID as a numeric string, usable directly in Concat and in comparisons. It was non-empty even without a signed-in visitor.',
|
|
307
|
+
isConfirmed: true,
|
|
308
|
+
differsFromOfficialDocs: false,
|
|
309
|
+
sfmcGuideUrl: 'https://sfmc.guide/engagement/ampscript/functions/authenticatedemployeeid/',
|
|
265
310
|
syntax: 'AuthenticatedEmployeeID()',
|
|
266
311
|
example: '%%=AuthenticatedEmployeeID()=%%',
|
|
267
312
|
},
|
|
@@ -275,10 +320,18 @@ export const FUNCTIONS = [
|
|
|
275
320
|
minArgs: 0,
|
|
276
321
|
maxArgs: 0,
|
|
277
322
|
category: 'Utility',
|
|
278
|
-
description:
|
|
323
|
+
description:
|
|
324
|
+
'Returns the notification email address of the Marketing Cloud user tied to the current context. On a public CloudPage, where nobody is signed in, it still returns a non-empty address rather than an empty value, so it cannot be used to tell an authenticated visitor apart from an anonymous one. It is a separate value from AuthenticatedEmployeeUserName() — neither can be derived from the other.',
|
|
279
325
|
params: [],
|
|
280
326
|
returnType: 'string',
|
|
281
|
-
returnDescription:
|
|
327
|
+
returnDescription:
|
|
328
|
+
'The notification address as a string, usable directly in Concat and in comparisons. On the business unit tested it was a real email address on a registered domain, and it was non-empty even without a signed-in visitor.',
|
|
329
|
+
isConfirmed: true,
|
|
330
|
+
differsFromOfficialDocs: true,
|
|
331
|
+
officialDocsNote:
|
|
332
|
+
'Proven on the child BU MCDEV_Training_QA (MID 518005426); the parent BU was not needed. The official reference scopes the function to microsites that use sender authenticated redirection and explicitly says it is not for use with CloudPages. At runtime the opposite happened: an anonymous GET of a public CloudPage rendered at HTTP 200 and the call returned a well-formed, non-empty notification email address — Empty() answered false, Length() reported 29 characters and IsEmailAddress() accepted it. The value behaved as an ordinary string when used inline, nested inside Concat and compared against the empty string. The literal address is redacted here because it identifies an account user; only its shape is described.',
|
|
333
|
+
sfmcGuideUrl:
|
|
334
|
+
'https://sfmc.guide/engagement/ampscript/functions/authenticatedemployeenotificationaddress/',
|
|
282
335
|
syntax: 'AuthenticatedEmployeeNotificationAddress()',
|
|
283
336
|
example: '%%=AuthenticatedEmployeeNotificationAddress()=%%',
|
|
284
337
|
},
|
|
@@ -292,10 +345,16 @@ export const FUNCTIONS = [
|
|
|
292
345
|
minArgs: 0,
|
|
293
346
|
maxArgs: 0,
|
|
294
347
|
category: 'Utility',
|
|
295
|
-
description:
|
|
348
|
+
description:
|
|
349
|
+
'Returns the login username of the Marketing Cloud user tied to the current context. On a public CloudPage, where nobody is signed in, it still returns a non-empty username rather than an empty value, so it cannot be used to tell an authenticated visitor apart from an anonymous one.',
|
|
296
350
|
params: [],
|
|
297
351
|
returnType: 'string',
|
|
298
|
-
returnDescription:
|
|
352
|
+
returnDescription:
|
|
353
|
+
'The username as a string, usable directly in Concat and in comparisons. On the business unit tested it was shaped like an email address and was non-empty even without a signed-in visitor.',
|
|
354
|
+
isConfirmed: true,
|
|
355
|
+
differsFromOfficialDocs: false,
|
|
356
|
+
sfmcGuideUrl:
|
|
357
|
+
'https://sfmc.guide/engagement/ampscript/functions/authenticatedemployeeusername/',
|
|
299
358
|
syntax: 'AuthenticatedEmployeeUserName()',
|
|
300
359
|
example: '%%=AuthenticatedEmployeeUserName()=%%',
|
|
301
360
|
},
|
|
@@ -309,10 +368,16 @@ export const FUNCTIONS = [
|
|
|
309
368
|
minArgs: 0,
|
|
310
369
|
maxArgs: 0,
|
|
311
370
|
category: 'Utility',
|
|
312
|
-
description:
|
|
371
|
+
description:
|
|
372
|
+
'Returns the enterprise ID (EID) of the Marketing Cloud account tied to the current context. On a public CloudPage, where nobody is signed in, it still returns a non-empty ID rather than an empty value, so it cannot be used to tell an authenticated visitor apart from an anonymous one. Called from a child business unit it reports the parent (enterprise) MID, not the child MID, and it is a different value from AuthenticatedEmployeeID().',
|
|
313
373
|
params: [],
|
|
314
374
|
returnType: 'string',
|
|
315
|
-
returnDescription:
|
|
375
|
+
returnDescription:
|
|
376
|
+
'The enterprise ID as a digits-only numeric string, usable directly in Concat, in comparisons and in arithmetic. It was non-empty even without a signed-in visitor.',
|
|
377
|
+
isConfirmed: true,
|
|
378
|
+
differsFromOfficialDocs: false,
|
|
379
|
+
sfmcGuideUrl:
|
|
380
|
+
'https://sfmc.guide/engagement/ampscript/functions/authenticatedenterpriseid/',
|
|
316
381
|
syntax: 'AuthenticatedEnterpriseID()',
|
|
317
382
|
example: '%%=AuthenticatedEnterpriseID()=%%',
|
|
318
383
|
},
|
|
@@ -323,13 +388,18 @@ export const FUNCTIONS = [
|
|
|
323
388
|
mcnNotes: null,
|
|
324
389
|
docUrl: 'https://developer.salesforce.com/docs/marketing/marketing-cloud-ampscript/references/mc-ampscript-sites/mc-ampscript-reference-sites-authenticated-member-id.html',
|
|
325
390
|
guideUrl: 'https://ampscript.guide/authenticatedmemberid/',
|
|
391
|
+
sfmcGuideUrl: 'https://sfmc.guide/engagement/ampscript/functions/authenticatedmemberid/',
|
|
326
392
|
minArgs: 0,
|
|
327
393
|
maxArgs: 0,
|
|
328
394
|
category: 'Utility',
|
|
329
|
-
description:
|
|
395
|
+
description:
|
|
396
|
+
'Returns the member ID (MID) of the business unit the code runs on. On a public CloudPage, where nobody is signed in, it still returns a non-empty MID rather than an empty value, so it cannot be used to tell an authenticated visitor apart from an anonymous one. Called from a child business unit it reports that CHILD MID, unlike AuthenticatedEnterpriseID(), which reports the parent (enterprise) MID in the same render.',
|
|
330
397
|
params: [],
|
|
331
398
|
returnType: 'string',
|
|
332
|
-
returnDescription:
|
|
399
|
+
returnDescription:
|
|
400
|
+
'The member ID as a digits-only numeric string, usable directly in Concat, in comparisons and in arithmetic. It was non-empty even without a signed-in visitor.',
|
|
401
|
+
isConfirmed: true,
|
|
402
|
+
differsFromOfficialDocs: false,
|
|
333
403
|
syntax: 'AuthenticatedMemberID()',
|
|
334
404
|
example: '%%=AuthenticatedMemberID()=%%',
|
|
335
405
|
},
|
|
@@ -340,13 +410,18 @@ export const FUNCTIONS = [
|
|
|
340
410
|
mcnNotes: null,
|
|
341
411
|
docUrl: 'https://developer.salesforce.com/docs/marketing/marketing-cloud-ampscript/references/mc-ampscript-sites/mc-ampscript-reference-sites-authenticated-member-name.html',
|
|
342
412
|
guideUrl: 'https://ampscript.guide/authenticatedmembername/',
|
|
413
|
+
sfmcGuideUrl: 'https://sfmc.guide/engagement/ampscript/functions/authenticatedmembername/',
|
|
343
414
|
minArgs: 0,
|
|
344
415
|
maxArgs: 0,
|
|
345
416
|
category: 'Utility',
|
|
346
|
-
description:
|
|
417
|
+
description:
|
|
418
|
+
'Returns the display name of the business unit the code runs on. On a public CloudPage, where nobody is signed in, it still returns a non-empty name rather than an empty value, so it cannot be used to tell an authenticated visitor apart from an anonymous one. It is the business unit name as shown in the Marketing Cloud UI — spaces and punctuation included — not a person and not the login username returned by AuthenticatedEmployeeUserName() in the same render.',
|
|
347
419
|
params: [],
|
|
348
420
|
returnType: 'string',
|
|
349
|
-
returnDescription:
|
|
421
|
+
returnDescription:
|
|
422
|
+
'The business unit display name as a free-text string that can contain spaces and punctuation, usable directly in Concat and in comparisons. It was non-empty even without a signed-in visitor.',
|
|
423
|
+
isConfirmed: true,
|
|
424
|
+
differsFromOfficialDocs: false,
|
|
350
425
|
syntax: 'AuthenticatedMemberName()',
|
|
351
426
|
example: '%%=AuthenticatedMemberName()=%%',
|
|
352
427
|
},
|
|
@@ -357,11 +432,12 @@ export const FUNCTIONS = [
|
|
|
357
432
|
mcnNotes: null,
|
|
358
433
|
docUrl: 'https://developer.salesforce.com/docs/marketing/marketing-cloud-ampscript/references/mc-ampscript-content/mc-ampscript-reference-content-barcode-url.html',
|
|
359
434
|
guideUrl: 'https://ampscript.guide/barcodeurl/',
|
|
360
|
-
|
|
435
|
+
sfmcGuideUrl: 'https://sfmc.guide/engagement/ampscript/functions/barcodeurl/',
|
|
436
|
+
minArgs: 4,
|
|
361
437
|
maxArgs: 9,
|
|
362
438
|
category: 'Content',
|
|
363
439
|
description:
|
|
364
|
-
'Generates a URL
|
|
440
|
+
'Generates a URL that renders a barcode image from the given value, symbology, width, and height, plus optional formatting. An empty value aborts the page instead of returning an empty result.',
|
|
365
441
|
params: [
|
|
366
442
|
{
|
|
367
443
|
name: 'valueToConvert',
|
|
@@ -433,7 +509,9 @@ export const FUNCTIONS = [
|
|
|
433
509
|
returnType: 'string',
|
|
434
510
|
returnDescription: 'A URL that renders the requested barcode image.',
|
|
435
511
|
syntax: 'BarcodeURL(valueToConvert, barcodeType, width, height, checksumValue, showText, altText, rotation, transparentBG)',
|
|
436
|
-
example: "%%=BarcodeURL('
|
|
512
|
+
example: "<img src=\"%%=BarcodeURL('12345678901', 'code128auto', 150, 50)=%%\">",
|
|
513
|
+
isConfirmed: true,
|
|
514
|
+
differsFromOfficialDocs: false,
|
|
437
515
|
},
|
|
438
516
|
{
|
|
439
517
|
name: 'Base64Decode',
|
|
@@ -445,23 +523,40 @@ export const FUNCTIONS = [
|
|
|
445
523
|
minArgs: 1,
|
|
446
524
|
maxArgs: 3,
|
|
447
525
|
category: 'Encryption and Encoding',
|
|
448
|
-
description:
|
|
526
|
+
description:
|
|
527
|
+
'Decodes a Base64-encoded string. The decoded bytes are read as UTF-8 unless encoding names another character encoding, and any value that is not well-formed Base64 aborts the page instead of returning an empty or partial result.',
|
|
449
528
|
params: [
|
|
450
|
-
{ name: 'encodedString', description: 'Base64 string to decode', type: 'string' },
|
|
451
|
-
{ name: 'encoding', description: 'Encoding scheme', type: 'string', optional: true },
|
|
452
529
|
{
|
|
453
|
-
name: '
|
|
530
|
+
name: 'encodedString',
|
|
531
|
+
description:
|
|
532
|
+
'Base64 string to decode; it must be well-formed, because malformed input aborts the page',
|
|
533
|
+
type: 'string',
|
|
534
|
+
},
|
|
535
|
+
{
|
|
536
|
+
name: 'encoding',
|
|
537
|
+
description:
|
|
538
|
+
'Name of the character encoding used to turn the decoded bytes back into text; defaults to UTF-8, and an unrecognised or empty name aborts the page',
|
|
539
|
+
type: 'string',
|
|
540
|
+
enum: ['UTF-8', 'UTF-16', 'UTF-16BE', 'UTF-32', 'ASCII', 'ISO-8859-1'],
|
|
541
|
+
optional: true,
|
|
542
|
+
default: 'UTF-8',
|
|
543
|
+
},
|
|
544
|
+
{
|
|
545
|
+
name: 'abortOnFailure',
|
|
454
546
|
mcnSince: null,
|
|
455
547
|
mcnNotes: null,
|
|
456
|
-
description:
|
|
457
|
-
|
|
548
|
+
description:
|
|
549
|
+
'Flag reserved for send-time failure handling; 0, 1, true and false are all accepted and none of them changes the value a successful decode returns',
|
|
550
|
+
type: 'number|boolean',
|
|
458
551
|
optional: true,
|
|
459
552
|
},
|
|
460
553
|
],
|
|
461
554
|
returnType: 'string',
|
|
462
555
|
returnDescription: 'The decoded string.',
|
|
463
|
-
syntax: 'Base64Decode(encodedString[, encoding,
|
|
556
|
+
syntax: 'Base64Decode(encodedString[, encoding, abortOnFailure])',
|
|
464
557
|
example: "%%=Base64Decode('SGVsbG8=')=%%",
|
|
558
|
+
isConfirmed: true,
|
|
559
|
+
sfmcGuideUrl: 'https://sfmc.guide/engagement/ampscript/functions/base64decode/',
|
|
465
560
|
},
|
|
466
561
|
{
|
|
467
562
|
name: 'Base64Encode',
|
|
@@ -473,15 +568,31 @@ export const FUNCTIONS = [
|
|
|
473
568
|
minArgs: 1,
|
|
474
569
|
maxArgs: 2,
|
|
475
570
|
category: 'Encryption and Encoding',
|
|
476
|
-
description:
|
|
571
|
+
description:
|
|
572
|
+
'Encodes a value as a Base64 string. The bytes encoded are the UTF-8 representation of the input unless encoding names another character encoding.',
|
|
477
573
|
params: [
|
|
478
|
-
{
|
|
479
|
-
|
|
574
|
+
{
|
|
575
|
+
name: 'value',
|
|
576
|
+
description: 'Value to encode; the empty string encodes to the empty string',
|
|
577
|
+
type: 'string',
|
|
578
|
+
},
|
|
579
|
+
{
|
|
580
|
+
name: 'encoding',
|
|
581
|
+
description:
|
|
582
|
+
'Name of the character encoding applied before encoding; any encoding name the platform recognises works, and an unrecognised or empty name aborts the page',
|
|
583
|
+
type: 'string',
|
|
584
|
+
enum: ['UTF-8', 'UTF-16', 'UTF-16BE', 'UTF-32', 'ASCII', 'ISO-8859-1'],
|
|
585
|
+
optional: true,
|
|
586
|
+
default: 'UTF-8',
|
|
587
|
+
},
|
|
480
588
|
],
|
|
481
589
|
returnType: 'string',
|
|
482
|
-
returnDescription:
|
|
590
|
+
returnDescription:
|
|
591
|
+
'The Base64-encoded representation of the input, padded with = to a multiple of four characters.',
|
|
483
592
|
syntax: 'Base64Encode(value[, encoding])',
|
|
484
593
|
example: "%%=Base64Encode('Hello')=%%",
|
|
594
|
+
isConfirmed: true,
|
|
595
|
+
sfmcGuideUrl: 'https://sfmc.guide/engagement/ampscript/functions/base64encode/',
|
|
485
596
|
},
|
|
486
597
|
{
|
|
487
598
|
name: 'BeginImpressionRegion',
|
|
@@ -490,10 +601,14 @@ export const FUNCTIONS = [
|
|
|
490
601
|
mcnNotes: null,
|
|
491
602
|
docUrl: 'https://developer.salesforce.com/docs/marketing/marketing-cloud-ampscript/references/mc-ampscript-content/mc-ampscript-reference-content-begin-impression-region.html',
|
|
492
603
|
guideUrl: 'https://ampscript.guide/beginimpressionregion/',
|
|
604
|
+
sfmcGuideUrl: 'https://sfmc.guide/engagement/ampscript/functions/beginimpressionregion/',
|
|
493
605
|
minArgs: 1,
|
|
494
606
|
maxArgs: 1,
|
|
607
|
+
isConfirmed: true,
|
|
608
|
+
differsFromOfficialDocs: false,
|
|
495
609
|
category: 'Content',
|
|
496
|
-
description:
|
|
610
|
+
description:
|
|
611
|
+
'Marks the start of an impression tracking region. The region name must be a literal — a variable argument aborts the page.',
|
|
497
612
|
params: [{ name: 'regionName', description: 'Impression region name', type: 'string' }],
|
|
498
613
|
returnType: 'void',
|
|
499
614
|
returnDescription: 'No value is returned; it marks the start of an impression region.',
|
|
@@ -507,11 +622,12 @@ export const FUNCTIONS = [
|
|
|
507
622
|
mcnNotes: null,
|
|
508
623
|
docUrl: 'https://developer.salesforce.com/docs/marketing/marketing-cloud-ampscript/references/mc-ampscript-content/mc-ampscript-reference-content-build-option-list.html',
|
|
509
624
|
guideUrl: 'https://ampscript.guide/buildoptionlist/',
|
|
625
|
+
sfmcGuideUrl: 'https://sfmc.guide/engagement/ampscript/functions/buildoptionlist/',
|
|
510
626
|
minArgs: 3,
|
|
511
627
|
maxArgs: INF,
|
|
512
628
|
category: 'Content',
|
|
513
629
|
description:
|
|
514
|
-
'Builds HTML <option> elements from
|
|
630
|
+
'Builds HTML <option> elements from supplied value/text pairs for use in a <select> dropdown, marking the pair whose value matches the default selection as selected.',
|
|
515
631
|
params: [
|
|
516
632
|
{
|
|
517
633
|
name: 'defaultSelection',
|
|
@@ -556,14 +672,18 @@ export const FUNCTIONS = [
|
|
|
556
672
|
']%%\n' +
|
|
557
673
|
'<p>Choose an option:</p>\n' +
|
|
558
674
|
'<select name="choice">\n%%=v(@OptionList)=%%\n</select>',
|
|
675
|
+
isConfirmed: true,
|
|
676
|
+
differsFromOfficialDocs: false,
|
|
559
677
|
},
|
|
560
678
|
{
|
|
561
679
|
name: 'BuildRowsetFromJSON',
|
|
562
680
|
mcnSince: 67,
|
|
563
|
-
handlebarsEquivalent:
|
|
681
|
+
handlebarsEquivalent: 'jsonPath',
|
|
682
|
+
handlebarsExact: false,
|
|
564
683
|
mcnNotes: null,
|
|
565
684
|
docUrl: 'https://developer.salesforce.com/docs/marketing/marketing-cloud-ampscript/references/mc-ampscript-content/mc-ampscript-reference-content-build-rowset-from-json.html',
|
|
566
685
|
guideUrl: 'https://ampscript.guide/buildrowsetfromjson/',
|
|
686
|
+
sfmcGuideUrl: 'https://sfmc.guide/engagement/ampscript/functions/buildrowsetfromjson/',
|
|
567
687
|
minArgs: 3,
|
|
568
688
|
maxArgs: 3,
|
|
569
689
|
category: 'Content',
|
|
@@ -586,14 +706,19 @@ export const FUNCTIONS = [
|
|
|
586
706
|
mcnSince: null,
|
|
587
707
|
mcnNotes: null,
|
|
588
708
|
description:
|
|
589
|
-
'
|
|
590
|
-
type: 'boolean',
|
|
709
|
+
'Pass 1 or true to get an empty rowset when the payload or path cannot be parsed; 0 or false makes the same input abort the page',
|
|
710
|
+
type: 'boolean|number',
|
|
591
711
|
},
|
|
592
712
|
],
|
|
593
713
|
returnType: 'rowset',
|
|
594
|
-
returnDescription:
|
|
714
|
+
returnDescription:
|
|
715
|
+
'A rowset built from the matched JSON nodes. A path that matches nothing yields a rowset with zero rows rather than an error.',
|
|
595
716
|
syntax: 'BuildRowsetFromJSON(jsonData, jsonPathExpression, returnEmptyOnError)',
|
|
596
717
|
example: "%%[ SET @rows = BuildRowsetFromJSON(@json, '$.items[*]', 1) ]%%",
|
|
718
|
+
isConfirmed: true,
|
|
719
|
+
differsFromOfficialDocs: true,
|
|
720
|
+
officialDocsNote:
|
|
721
|
+
'The official syntax section states that a false third argument yields an empty rowset and a true one raises an exception; runtime on the child BU (MID 518005426, CloudPage GET) does the opposite. Malformed JSON with 1 rendered a rowset of zero rows, while the identical payload with 0 aborted the page with HTTP 422. The same page also proved that an unparsable payload, an unset variable, an empty string, [] and a path matching nothing all yield zero rows when 1 is passed. Note the official Errors section already describes the runtime ordering, so the page contradicts itself.',
|
|
597
722
|
},
|
|
598
723
|
{
|
|
599
724
|
name: 'BuildRowSetFromString',
|
|
@@ -602,6 +727,7 @@ export const FUNCTIONS = [
|
|
|
602
727
|
mcnNotes: null,
|
|
603
728
|
docUrl: 'https://developer.salesforce.com/docs/marketing/marketing-cloud-ampscript/references/mc-ampscript-content/mc-ampscript-reference-content-build-rowset-from-string.html',
|
|
604
729
|
guideUrl: 'https://ampscript.guide/buildrowsetfromstring/',
|
|
730
|
+
sfmcGuideUrl: 'https://sfmc.guide/engagement/ampscript/functions/buildrowsetfromstring/',
|
|
605
731
|
minArgs: 2,
|
|
606
732
|
maxArgs: 2,
|
|
607
733
|
category: 'Content',
|
|
@@ -614,15 +740,18 @@ export const FUNCTIONS = [
|
|
|
614
740
|
},
|
|
615
741
|
{
|
|
616
742
|
name: 'delimiter',
|
|
617
|
-
description:
|
|
743
|
+
description:
|
|
744
|
+
'The separator to split on; it may be several characters long, and an empty separator leaves the input as a single row',
|
|
618
745
|
type: 'string',
|
|
619
746
|
},
|
|
620
747
|
],
|
|
621
748
|
returnType: 'rowset',
|
|
622
749
|
returnDescription:
|
|
623
|
-
'A rowset where each row holds one delimited segment of the input string.',
|
|
750
|
+
'A rowset where each row holds one delimited segment of the input string. The single column has no name, so read it with Field(row, 1). An empty or unset input gives zero rows.',
|
|
624
751
|
syntax: 'BuildRowSetFromString(sourceData, delimiter)',
|
|
625
752
|
example: "%%=BuildRowSetFromString('a,b,c', ',')=%%",
|
|
753
|
+
isConfirmed: true,
|
|
754
|
+
differsFromOfficialDocs: false,
|
|
626
755
|
},
|
|
627
756
|
{
|
|
628
757
|
name: 'BuildRowSetFromXML',
|
|
@@ -631,6 +760,7 @@ export const FUNCTIONS = [
|
|
|
631
760
|
mcnNotes: null,
|
|
632
761
|
docUrl: 'https://developer.salesforce.com/docs/marketing/marketing-cloud-ampscript/references/mc-ampscript-content/mc-ampscript-reference-content-build-rowset-from-xml.html',
|
|
633
762
|
guideUrl: 'https://ampscript.guide/buildrowsetfromxml/',
|
|
763
|
+
sfmcGuideUrl: 'https://sfmc.guide/engagement/ampscript/functions/buildrowsetfromxml/',
|
|
634
764
|
minArgs: 3,
|
|
635
765
|
maxArgs: 3,
|
|
636
766
|
category: 'Content',
|
|
@@ -647,41 +777,56 @@ export const FUNCTIONS = [
|
|
|
647
777
|
mcnSince: null,
|
|
648
778
|
mcnNotes: null,
|
|
649
779
|
description:
|
|
650
|
-
'
|
|
651
|
-
type: 'boolean',
|
|
780
|
+
'Pass 1 or true to get an empty rowset when the payload or path cannot be parsed; 0 or false makes the same input abort the page',
|
|
781
|
+
type: 'boolean|number',
|
|
652
782
|
},
|
|
653
783
|
],
|
|
654
784
|
returnType: 'rowset',
|
|
655
|
-
returnDescription:
|
|
785
|
+
returnDescription:
|
|
786
|
+
'A rowset built from the matched XML nodes, with a Value column, an Xml column holding the inner markup, and one <attribute>_att column per attribute seen on any matched node. An XPath that matches nothing yields zero rows rather than an error.',
|
|
656
787
|
syntax: 'BuildRowSetFromXML(xmlData, xpathExpression, returnEmptyOnError)',
|
|
657
788
|
example: "%%[ SET @rows = BuildRowSetFromXML(@xml, '/root/item', 1) ]%%",
|
|
789
|
+
isConfirmed: true,
|
|
790
|
+
differsFromOfficialDocs: true,
|
|
791
|
+
officialDocsNote:
|
|
792
|
+
'The official syntax section states that a false third argument yields an empty rowset and a true one raises an exception; runtime on the child BU (MID 518005426, CloudPage GET) behaves the other way round. Unclosed XML parsed with 1 rendered a rowset of zero rows, whereas the identical payload with 0 aborted the page with HTTP 422. An empty string, an unset variable, an empty root element and an XPath matching nothing likewise gave zero rows under 1.',
|
|
658
793
|
},
|
|
659
794
|
{
|
|
660
795
|
name: 'Char',
|
|
661
796
|
mcnSince: null,
|
|
662
|
-
handlebarsEquivalent:
|
|
797
|
+
handlebarsEquivalent: 'char',
|
|
798
|
+
handlebarsExact: true,
|
|
663
799
|
mcnNotes: null,
|
|
664
800
|
docUrl: 'https://developer.salesforce.com/docs/marketing/marketing-cloud-ampscript/references/mc-ampscript-string/mc-ampscript-reference-string-char.html',
|
|
665
801
|
guideUrl: 'https://ampscript.guide/char/',
|
|
666
802
|
minArgs: 1,
|
|
667
803
|
maxArgs: 2,
|
|
668
804
|
category: 'String',
|
|
669
|
-
description:
|
|
805
|
+
description:
|
|
806
|
+
'Returns the character for the given numeric character code. Codes above 255 are not rejected — they resolve to the matching Unicode character.',
|
|
670
807
|
params: [
|
|
671
|
-
{
|
|
808
|
+
{
|
|
809
|
+
name: 'characterCode',
|
|
810
|
+
description: 'Character code, as a whole number',
|
|
811
|
+
type: 'string|number',
|
|
812
|
+
},
|
|
672
813
|
{
|
|
673
814
|
name: 'numRepetitions',
|
|
674
815
|
mcnSince: null,
|
|
675
816
|
mcnNotes: null,
|
|
676
|
-
description: 'Number of times to repeat the returned character',
|
|
677
|
-
type: 'number',
|
|
817
|
+
description: 'Number of times to repeat the returned character, as a whole number',
|
|
818
|
+
type: 'string|number',
|
|
678
819
|
optional: true,
|
|
679
820
|
},
|
|
680
821
|
],
|
|
681
822
|
returnType: 'string',
|
|
682
|
-
returnDescription:
|
|
823
|
+
returnDescription:
|
|
824
|
+
'The character for the supplied code, repeated when a repetition count is given. A count of 0 yields an empty string.',
|
|
683
825
|
syntax: 'Char(characterCode[, numRepetitions])',
|
|
684
826
|
example: '%%=Char(10)=%%',
|
|
827
|
+
isConfirmed: true,
|
|
828
|
+
differsFromOfficialDocs: false,
|
|
829
|
+
sfmcGuideUrl: 'https://sfmc.guide/engagement/ampscript/functions/char/',
|
|
685
830
|
},
|
|
686
831
|
{
|
|
687
832
|
name: 'ClaimRow',
|
|
@@ -690,6 +835,7 @@ export const FUNCTIONS = [
|
|
|
690
835
|
mcnNotes: null,
|
|
691
836
|
docUrl: 'https://developer.salesforce.com/docs/marketing/marketing-cloud-ampscript/references/mc-ampscript-data-extension/mc-ampscript-reference-data-extension-claim-row.html',
|
|
692
837
|
guideUrl: 'https://ampscript.guide/claimrow/',
|
|
838
|
+
sfmcGuideUrl: 'https://sfmc.guide/engagement/ampscript/functions/claimrow/',
|
|
693
839
|
minArgs: 4,
|
|
694
840
|
maxArgs: INF,
|
|
695
841
|
category: 'Data Extension',
|
|
@@ -746,6 +892,10 @@ export const FUNCTIONS = [
|
|
|
746
892
|
repeat: [{ startIndex: 4, groupSize: 2, minGroups: 0 }],
|
|
747
893
|
syntax: 'ClaimRow(dataExt, claimColumn, claimantColumn, claimantValue[, additionalColumnNameN, additionalColumnValueN, ...])',
|
|
748
894
|
example: "%%[ SET @row = ClaimRow('Coupons', 'Claimed', 'SubKey', _subscriberkey) ]%%",
|
|
895
|
+
isConfirmed: true,
|
|
896
|
+
differsFromOfficialDocs: true,
|
|
897
|
+
officialDocsNote:
|
|
898
|
+
'Runtime-proven on a Marketing Cloud Engagement CloudPage (child BU MID 518005426) against a data extension built to the documented claimable schema (Text primary key, Text claimant column, required non-nullable Boolean claim column defaulting to False, nullable Date column). Each call passing a NEW claimant value claims the next unclaimed row and advances: four distinct claimants received C1, C2, C3, C4 in order, each row flipping to claimed with its claimant recorded and ClaimedDate auto-populated. Re-calling with a claimant value that already holds a row returns that same row rather than advancing (per-subscriber idempotency). The official reference states that ClaimRow returns an exception when no unclaimed rows remain; at runtime it instead returned an empty row that does not abort the page (Empty() on it is true), so a caller must guard with Empty() rather than expecting a raised error. Each claim was driven by a separate HTTP request carrying the claimant value as a RequestParameter — the prior single-render probe that reused one claimant value never advanced because of the idempotency rule, not a provisioning gap.',
|
|
749
899
|
},
|
|
750
900
|
{
|
|
751
901
|
name: 'ClaimRowValue',
|
|
@@ -754,6 +904,7 @@ export const FUNCTIONS = [
|
|
|
754
904
|
mcnNotes: null,
|
|
755
905
|
docUrl: 'https://developer.salesforce.com/docs/marketing/marketing-cloud-ampscript/references/mc-ampscript-data-extension/mc-ampscript-reference-data-extension-claim-row-value.html',
|
|
756
906
|
guideUrl: 'https://ampscript.guide/claimrowvalue/',
|
|
907
|
+
sfmcGuideUrl: 'https://sfmc.guide/engagement/ampscript/functions/claimrowvalue/',
|
|
757
908
|
minArgs: 3,
|
|
758
909
|
maxArgs: INF,
|
|
759
910
|
category: 'Data Extension',
|
|
@@ -808,6 +959,8 @@ export const FUNCTIONS = [
|
|
|
808
959
|
repeat: [{ startIndex: 4, groupSize: 2, minGroups: 0 }],
|
|
809
960
|
syntax: 'ClaimRowValue(dataExt, returnValueColumn, claimColumn[, valueIfClaimed, claimantColumnN, claimantValueN, ...])',
|
|
810
961
|
example: "%%=ClaimRowValue('Coupons', 'Code', 'Claimed', '', 'SubKey', _subscriberkey)=%%",
|
|
962
|
+
isConfirmed: true,
|
|
963
|
+
differsFromOfficialDocs: false,
|
|
811
964
|
},
|
|
812
965
|
{
|
|
813
966
|
name: 'CloudPagesURL',
|
|
@@ -820,7 +973,10 @@ export const FUNCTIONS = [
|
|
|
820
973
|
maxArgs: INF,
|
|
821
974
|
category: 'Utility',
|
|
822
975
|
description:
|
|
823
|
-
'
|
|
976
|
+
'Builds the published URL of a CloudPages landing page. Name-value pairs are appended in PAIRS and are folded into a single encrypted query token rather than readable parameters; an odd trailing argument or a page ID that matches no page aborts the page.',
|
|
977
|
+
isConfirmed: true,
|
|
978
|
+
differsFromOfficialDocs: false,
|
|
979
|
+
sfmcGuideUrl: 'https://sfmc.guide/engagement/ampscript/functions/cloudpagesurl/',
|
|
824
980
|
params: [
|
|
825
981
|
{
|
|
826
982
|
name: 'pageId',
|
|
@@ -854,7 +1010,7 @@ export const FUNCTIONS = [
|
|
|
854
1010
|
],
|
|
855
1011
|
returnType: 'string',
|
|
856
1012
|
returnDescription:
|
|
857
|
-
'
|
|
1013
|
+
'The page URL. With no extra pairs it is the bare published URL; with pairs it carries one encrypted query token that changes on every call, so the result must never be compared or cached.',
|
|
858
1014
|
repeat: [{ startIndex: 1, groupSize: 2, minGroups: 0 }],
|
|
859
1015
|
syntax: 'CloudPagesURL(pageId[, paramName1, paramValue1, paramNameN, paramValueN, ...])',
|
|
860
1016
|
example: "%%=CloudPagesURL(123, 'key', 'value')=%%",
|
|
@@ -863,9 +1019,11 @@ export const FUNCTIONS = [
|
|
|
863
1019
|
name: 'Concat',
|
|
864
1020
|
mcnSince: 67,
|
|
865
1021
|
handlebarsEquivalent: 'concat',
|
|
1022
|
+
handlebarsExact: true,
|
|
866
1023
|
mcnNotes: null,
|
|
867
1024
|
docUrl: 'https://developer.salesforce.com/docs/marketing/marketing-cloud-ampscript/references/mc-ampscript-string/mc-ampscript-reference-string-concat.html',
|
|
868
1025
|
guideUrl: 'https://ampscript.guide/concat/',
|
|
1026
|
+
sfmcGuideUrl: 'https://sfmc.guide/engagement/ampscript/functions/concat/',
|
|
869
1027
|
minArgs: 1,
|
|
870
1028
|
maxArgs: INF,
|
|
871
1029
|
isConfirmed: true,
|
|
@@ -900,6 +1058,7 @@ export const FUNCTIONS = [
|
|
|
900
1058
|
mcnNotes: null,
|
|
901
1059
|
docUrl: 'https://developer.salesforce.com/docs/marketing/marketing-cloud-ampscript/references/mc-ampscript-content/mc-ampscript-reference-content-area.html',
|
|
902
1060
|
guideUrl: 'https://ampscript.guide/contentarea/',
|
|
1061
|
+
sfmcGuideUrl: 'https://sfmc.guide/engagement/ampscript/functions/contentarea/',
|
|
903
1062
|
minArgs: 1,
|
|
904
1063
|
maxArgs: 5,
|
|
905
1064
|
category: 'Content',
|
|
@@ -934,7 +1093,8 @@ export const FUNCTIONS = [
|
|
|
934
1093
|
name: 'errorMessage',
|
|
935
1094
|
mcnSince: null,
|
|
936
1095
|
mcnNotes: null,
|
|
937
|
-
description:
|
|
1096
|
+
description:
|
|
1097
|
+
'Default content to return if an error occurs. This value is emitted literally - any AMPscript it contains is not evaluated.',
|
|
938
1098
|
type: 'string',
|
|
939
1099
|
optional: true,
|
|
940
1100
|
},
|
|
@@ -952,6 +1112,8 @@ export const FUNCTIONS = [
|
|
|
952
1112
|
returnDescription: 'The rendered HTML of the referenced content area.',
|
|
953
1113
|
syntax: 'ContentArea(contentAreaId[, impressionRegionName, errorOnMissingContentArea, errorMessage, statusCode])',
|
|
954
1114
|
example: '%%=ContentArea(12345)=%%',
|
|
1115
|
+
isConfirmed: true,
|
|
1116
|
+
differsFromOfficialDocs: false,
|
|
955
1117
|
deprecated: true,
|
|
956
1118
|
deprecatedReplacement: 'ContentBlockByID',
|
|
957
1119
|
deprecatedReason:
|
|
@@ -964,6 +1126,7 @@ export const FUNCTIONS = [
|
|
|
964
1126
|
mcnNotes: null,
|
|
965
1127
|
docUrl: 'https://developer.salesforce.com/docs/marketing/marketing-cloud-ampscript/references/mc-ampscript-content/mc-ampscript-reference-content-area-by-name.html',
|
|
966
1128
|
guideUrl: 'https://ampscript.guide/contentareabyname/',
|
|
1129
|
+
sfmcGuideUrl: 'https://sfmc.guide/engagement/ampscript/functions/contentareabyname/',
|
|
967
1130
|
minArgs: 1,
|
|
968
1131
|
maxArgs: 5,
|
|
969
1132
|
category: 'Content',
|
|
@@ -996,7 +1159,8 @@ export const FUNCTIONS = [
|
|
|
996
1159
|
name: 'errorMessage',
|
|
997
1160
|
mcnSince: null,
|
|
998
1161
|
mcnNotes: null,
|
|
999
|
-
description:
|
|
1162
|
+
description:
|
|
1163
|
+
'Default content to return if an error occurs. This value is emitted literally - any AMPscript it contains is not evaluated.',
|
|
1000
1164
|
type: 'string',
|
|
1001
1165
|
optional: true,
|
|
1002
1166
|
},
|
|
@@ -1014,6 +1178,8 @@ export const FUNCTIONS = [
|
|
|
1014
1178
|
returnDescription: 'The rendered HTML of the named content area.',
|
|
1015
1179
|
syntax: 'ContentAreaByName(contentAreaName[, impressionRegionName, errorOnMissingContentArea, errorMessage, statusCode])',
|
|
1016
1180
|
example: String.raw`%%=ContentAreaByName('My Folder\My Content')=%%`,
|
|
1181
|
+
isConfirmed: true,
|
|
1182
|
+
differsFromOfficialDocs: false,
|
|
1017
1183
|
deprecated: true,
|
|
1018
1184
|
deprecatedReplacement: 'ContentBlockByName',
|
|
1019
1185
|
deprecatedReason:
|
|
@@ -1023,10 +1189,10 @@ export const FUNCTIONS = [
|
|
|
1023
1189
|
name: 'ContentBlockByID',
|
|
1024
1190
|
mcnSince: 67,
|
|
1025
1191
|
handlebarsEquivalent: null,
|
|
1026
|
-
mcnHandlebarsGap: true,
|
|
1027
1192
|
mcnNotes: null,
|
|
1028
1193
|
docUrl: 'https://developer.salesforce.com/docs/marketing/marketing-cloud-ampscript/references/mc-ampscript-content/mc-ampscript-reference-content-block-by-id.html',
|
|
1029
1194
|
guideUrl: 'https://ampscript.guide/contentblockbyid/',
|
|
1195
|
+
sfmcGuideUrl: 'https://sfmc.guide/engagement/ampscript/functions/contentblockbyid/',
|
|
1030
1196
|
minArgs: 1,
|
|
1031
1197
|
maxArgs: 5,
|
|
1032
1198
|
category: 'Content',
|
|
@@ -1060,7 +1226,8 @@ export const FUNCTIONS = [
|
|
|
1060
1226
|
name: 'errorMessage',
|
|
1061
1227
|
mcnSince: null,
|
|
1062
1228
|
mcnNotes: null,
|
|
1063
|
-
description:
|
|
1229
|
+
description:
|
|
1230
|
+
'Default content to return if an error occurs. This value is emitted literally - any AMPscript it contains is not evaluated.',
|
|
1064
1231
|
type: 'string',
|
|
1065
1232
|
optional: true,
|
|
1066
1233
|
},
|
|
@@ -1078,15 +1245,18 @@ export const FUNCTIONS = [
|
|
|
1078
1245
|
returnDescription: 'The rendered HTML of the content block identified by ID.',
|
|
1079
1246
|
syntax: 'ContentBlockByID(contentBlockId[, impressionRegionName, errorOnMissingContentBlock, errorMessage, statusCode])',
|
|
1080
1247
|
example: '%%=ContentBlockByID(12345)=%%',
|
|
1248
|
+
isConfirmed: true,
|
|
1249
|
+
differsFromOfficialDocs: false,
|
|
1081
1250
|
},
|
|
1082
1251
|
{
|
|
1083
1252
|
name: 'ContentBlockByKey',
|
|
1084
1253
|
mcnSince: 67,
|
|
1085
|
-
handlebarsEquivalent:
|
|
1086
|
-
|
|
1254
|
+
handlebarsEquivalent: 'getContentBlock',
|
|
1255
|
+
handlebarsExact: false,
|
|
1087
1256
|
mcnNotes: null,
|
|
1088
1257
|
docUrl: 'https://developer.salesforce.com/docs/marketing/marketing-cloud-ampscript/references/mc-ampscript-content/mc-ampscript-reference-content-block-by-key.html',
|
|
1089
1258
|
guideUrl: 'https://ampscript.guide/contentblockbykey/',
|
|
1259
|
+
sfmcGuideUrl: 'https://sfmc.guide/engagement/ampscript/functions/contentblockbykey/',
|
|
1090
1260
|
minArgs: 1,
|
|
1091
1261
|
maxArgs: 5,
|
|
1092
1262
|
category: 'Content',
|
|
@@ -1120,7 +1290,8 @@ export const FUNCTIONS = [
|
|
|
1120
1290
|
name: 'errorMessage',
|
|
1121
1291
|
mcnSince: null,
|
|
1122
1292
|
mcnNotes: null,
|
|
1123
|
-
description:
|
|
1293
|
+
description:
|
|
1294
|
+
'Default content to return if an error occurs. This value is emitted literally - any AMPscript it contains is not evaluated.',
|
|
1124
1295
|
type: 'string',
|
|
1125
1296
|
optional: true,
|
|
1126
1297
|
},
|
|
@@ -1138,15 +1309,17 @@ export const FUNCTIONS = [
|
|
|
1138
1309
|
returnDescription: 'The rendered HTML of the content block identified by customer key.',
|
|
1139
1310
|
syntax: 'ContentBlockByKey(contentBlockKey[, impressionRegionName, errorOnMissingContentBlock, errorMessage, statusCode])',
|
|
1140
1311
|
example: "%%=ContentBlockByKey('welcome-header')=%%",
|
|
1312
|
+
isConfirmed: true,
|
|
1313
|
+
differsFromOfficialDocs: false,
|
|
1141
1314
|
},
|
|
1142
1315
|
{
|
|
1143
1316
|
name: 'ContentBlockByName',
|
|
1144
1317
|
mcnSince: 67,
|
|
1145
1318
|
handlebarsEquivalent: null,
|
|
1146
|
-
mcnHandlebarsGap: true,
|
|
1147
1319
|
mcnNotes: null,
|
|
1148
1320
|
docUrl: 'https://developer.salesforce.com/docs/marketing/marketing-cloud-ampscript/references/mc-ampscript-content/mc-ampscript-reference-content-block-by-name.html',
|
|
1149
1321
|
guideUrl: 'https://ampscript.guide/contentblockbyname/',
|
|
1322
|
+
sfmcGuideUrl: 'https://sfmc.guide/engagement/ampscript/functions/contentblockbyname/',
|
|
1150
1323
|
minArgs: 1,
|
|
1151
1324
|
maxArgs: 5,
|
|
1152
1325
|
category: 'Content',
|
|
@@ -1181,7 +1354,8 @@ export const FUNCTIONS = [
|
|
|
1181
1354
|
name: 'errorMessage',
|
|
1182
1355
|
mcnSince: null,
|
|
1183
1356
|
mcnNotes: null,
|
|
1184
|
-
description:
|
|
1357
|
+
description:
|
|
1358
|
+
'Default content to return if an error occurs. This value is emitted literally - any AMPscript it contains is not evaluated.',
|
|
1185
1359
|
type: 'string',
|
|
1186
1360
|
optional: true,
|
|
1187
1361
|
},
|
|
@@ -1199,6 +1373,8 @@ export const FUNCTIONS = [
|
|
|
1199
1373
|
returnDescription: 'The rendered HTML of the content block identified by name or path.',
|
|
1200
1374
|
syntax: 'ContentBlockByName(contentBlockName[, impressionRegionName, errorOnMissingContentBlock, errorMessage, statusCode])',
|
|
1201
1375
|
example: String.raw`%%=ContentBlockByName('My Folder\Welcome Header')=%%`,
|
|
1376
|
+
isConfirmed: true,
|
|
1377
|
+
differsFromOfficialDocs: false,
|
|
1202
1378
|
},
|
|
1203
1379
|
{
|
|
1204
1380
|
name: 'ContentImageByID',
|
|
@@ -1207,10 +1383,12 @@ export const FUNCTIONS = [
|
|
|
1207
1383
|
mcnNotes: null,
|
|
1208
1384
|
docUrl: 'https://developer.salesforce.com/docs/marketing/marketing-cloud-ampscript/references/mc-ampscript-content/mc-ampscript-reference-content-image-by-id.html',
|
|
1209
1385
|
guideUrl: 'https://ampscript.guide/contentimagebyid/',
|
|
1210
|
-
|
|
1386
|
+
sfmcGuideUrl: 'https://sfmc.guide/engagement/ampscript/functions/contentimagebyid/',
|
|
1387
|
+
minArgs: 1,
|
|
1211
1388
|
maxArgs: 2,
|
|
1212
1389
|
category: 'Content',
|
|
1213
|
-
description:
|
|
1390
|
+
description:
|
|
1391
|
+
'Returns an HTML img tag for a Content Builder image asset by its numeric ID. A missing image with no fallback aborts the page.',
|
|
1214
1392
|
params: [
|
|
1215
1393
|
{
|
|
1216
1394
|
name: 'id',
|
|
@@ -1224,12 +1402,16 @@ export const FUNCTIONS = [
|
|
|
1224
1402
|
description:
|
|
1225
1403
|
"The ID of a fallback image in Content Builder. The function uses this image if it can't find the image that you specified in the first parameter",
|
|
1226
1404
|
type: 'number|string',
|
|
1405
|
+
optional: true,
|
|
1227
1406
|
},
|
|
1228
1407
|
],
|
|
1229
1408
|
returnType: 'string',
|
|
1230
|
-
returnDescription:
|
|
1231
|
-
|
|
1232
|
-
|
|
1409
|
+
returnDescription:
|
|
1410
|
+
'An HTML img tag for the referenced image, with title, alt, border and thid attributes.',
|
|
1411
|
+
syntax: 'ContentImageByID(id[, defaultImageExternalId])',
|
|
1412
|
+
example: '%%=ContentImageByID(12345)=%%',
|
|
1413
|
+
isConfirmed: true,
|
|
1414
|
+
differsFromOfficialDocs: false,
|
|
1233
1415
|
},
|
|
1234
1416
|
{
|
|
1235
1417
|
name: 'ContentImageByKey',
|
|
@@ -1238,10 +1420,12 @@ export const FUNCTIONS = [
|
|
|
1238
1420
|
mcnNotes: null,
|
|
1239
1421
|
docUrl: 'https://developer.salesforce.com/docs/marketing/marketing-cloud-ampscript/references/mc-ampscript-content/mc-ampscript-reference-content-image-by-key.html',
|
|
1240
1422
|
guideUrl: 'https://ampscript.guide/contentimagebykey/',
|
|
1241
|
-
|
|
1423
|
+
sfmcGuideUrl: 'https://sfmc.guide/engagement/ampscript/functions/contentimagebykey/',
|
|
1424
|
+
minArgs: 1,
|
|
1242
1425
|
maxArgs: 2,
|
|
1243
1426
|
category: 'Content',
|
|
1244
|
-
description:
|
|
1427
|
+
description:
|
|
1428
|
+
'Returns an HTML img tag for a Content Builder image asset by its customer key. A missing image with no fallback aborts the page.',
|
|
1245
1429
|
params: [
|
|
1246
1430
|
{
|
|
1247
1431
|
name: 'imageExternalKey',
|
|
@@ -1254,12 +1438,16 @@ export const FUNCTIONS = [
|
|
|
1254
1438
|
mcnNotes: null,
|
|
1255
1439
|
description: 'External key of the fallback image asset',
|
|
1256
1440
|
type: 'string',
|
|
1441
|
+
optional: true,
|
|
1257
1442
|
},
|
|
1258
1443
|
],
|
|
1259
1444
|
returnType: 'string',
|
|
1260
|
-
returnDescription:
|
|
1261
|
-
|
|
1262
|
-
|
|
1445
|
+
returnDescription:
|
|
1446
|
+
'An HTML img tag for the referenced image, with title, alt, border and thid attributes.',
|
|
1447
|
+
syntax: 'ContentImageByKey(imageExternalKey[, defaultImageExternalKey])',
|
|
1448
|
+
example: "%%=ContentImageByKey('hero-image')=%%",
|
|
1449
|
+
isConfirmed: true,
|
|
1450
|
+
differsFromOfficialDocs: false,
|
|
1263
1451
|
},
|
|
1264
1452
|
{
|
|
1265
1453
|
name: 'CreateMSCRMRecord',
|
|
@@ -1307,6 +1495,11 @@ export const FUNCTIONS = [
|
|
|
1307
1495
|
repeat: [{ startIndex: 2, groupSize: 2, minGroups: 1, countParam: 'numFields' }],
|
|
1308
1496
|
syntax: 'CreateMSCRMRecord(entityName, numFields, attributeName1, attributeValue1[, attributeNameN, attributeValueN, ...])',
|
|
1309
1497
|
example: "%%=CreateMSCRMRecord('contact', 1, 'lastname', 'Smith')=%%",
|
|
1498
|
+
isConfirmed: true,
|
|
1499
|
+
nonFunctionalAtRuntime: true,
|
|
1500
|
+
deprecated: true,
|
|
1501
|
+
deprecatedReason:
|
|
1502
|
+
'The Marketing Cloud Connector for Microsoft Dynamics CRM was retired (online integration in December 2020, on-premises in October 2021), so the Dynamics CRM AMPscript functions no longer have a live integration to call and are non-functional. No replacement AMPscript function exists; integrate Dynamics data through the SFTP import/export or a custom API instead.',
|
|
1310
1503
|
},
|
|
1311
1504
|
{
|
|
1312
1505
|
name: 'CreateObject',
|
|
@@ -1315,6 +1508,7 @@ export const FUNCTIONS = [
|
|
|
1315
1508
|
mcnNotes: null,
|
|
1316
1509
|
docUrl: 'https://developer.salesforce.com/docs/marketing/marketing-cloud-ampscript/references/mc-ampscript-api/mc-ampscript-reference-api-create-object.html',
|
|
1317
1510
|
guideUrl: 'https://ampscript.guide/createobject/',
|
|
1511
|
+
sfmcGuideUrl: 'https://sfmc.guide/engagement/ampscript/functions/createobject/',
|
|
1318
1512
|
minArgs: 1,
|
|
1319
1513
|
maxArgs: 1,
|
|
1320
1514
|
category: 'Marketing Cloud API',
|
|
@@ -1327,6 +1521,7 @@ export const FUNCTIONS = [
|
|
|
1327
1521
|
returnDescription: 'A new API object instance for use with the Invoke* functions.',
|
|
1328
1522
|
syntax: 'CreateObject(objectName)',
|
|
1329
1523
|
example: "%%=CreateObject('DataExtensionObject')=%%",
|
|
1524
|
+
isConfirmed: true,
|
|
1330
1525
|
},
|
|
1331
1526
|
{
|
|
1332
1527
|
name: 'CreateSalesforceObject',
|
|
@@ -1335,10 +1530,16 @@ export const FUNCTIONS = [
|
|
|
1335
1530
|
mcnNotes: null,
|
|
1336
1531
|
docUrl: 'https://developer.salesforce.com/docs/marketing/marketing-cloud-ampscript/references/mc-ampscript-salesforce/mc-ampscript-reference-salesforce-create-object.html',
|
|
1337
1532
|
guideUrl: 'https://ampscript.guide/createsalesforceobject/',
|
|
1533
|
+
sfmcGuideUrl: 'https://sfmc.guide/engagement/ampscript/functions/createsalesforceobject/',
|
|
1338
1534
|
minArgs: 4,
|
|
1339
1535
|
maxArgs: INF,
|
|
1340
1536
|
category: 'Sales and Service Cloud',
|
|
1341
|
-
description:
|
|
1537
|
+
description:
|
|
1538
|
+
'Creates a new record in a connected Salesforce Sales or Service Cloud object via Marketing Cloud Connect and returns the 18-character ID of the created record. Requires an active Marketing Cloud Connect integration; the field names must be valid API names on the target object, and a fault (unknown object or field) aborts the whole page rather than returning an error value.',
|
|
1539
|
+
isConfirmed: true,
|
|
1540
|
+
differsFromOfficialDocs: false,
|
|
1541
|
+
officialDocsNote:
|
|
1542
|
+
'The success path was runtime-proven on cred/DEV (MID 510007949), which has an active Marketing Cloud Connect integration to a real Salesforce org. Creating a benign Task with a single opaque field returned a real 18-character Salesforce ID (an 00T-prefixed Task ID), confirming the documented return shape. The fault path was also proven: an unknown object name and an unknown field name on a real object each aborted the CloudPage with HTTP 422 — the SOAP fault from the connected org propagates as an uncatchable page abort (AMPscript has no try/catch), exactly like RetrieveSalesforceObjects against an unknown object — so there is no testable error value, the function either returns an ID or aborts. AMPscript has no delete function for Salesforce objects, so the created Task remains as benign residue in the org. Catalog signature, returnType and repeat group all match the official reference and ampscript.guide, so differsFromOfficialDocs stays false.',
|
|
1342
1543
|
params: [
|
|
1343
1544
|
{
|
|
1344
1545
|
name: 'objectName',
|
|
@@ -1368,7 +1569,7 @@ export const FUNCTIONS = [
|
|
|
1368
1569
|
{ name: 'fieldValueN', description: 'Additional field value', optional: true },
|
|
1369
1570
|
],
|
|
1370
1571
|
returnType: 'string',
|
|
1371
|
-
returnDescription: 'The ID of the newly created Salesforce object record.',
|
|
1572
|
+
returnDescription: 'The 18-character ID of the newly created Salesforce object record.',
|
|
1372
1573
|
repeat: [{ startIndex: 2, groupSize: 2, minGroups: 1, countParam: 'numFields' }],
|
|
1373
1574
|
syntax: 'CreateSalesforceObject(objectName, numFields, fieldName1, fieldValue1[, fieldNameN, fieldValueN, ...])',
|
|
1374
1575
|
example: "%%=CreateSalesforceObject('Contact', 1, 'LastName', 'Smith')=%%",
|
|
@@ -1383,17 +1584,41 @@ export const FUNCTIONS = [
|
|
|
1383
1584
|
minArgs: 4,
|
|
1384
1585
|
maxArgs: 4,
|
|
1385
1586
|
category: 'MobileConnect',
|
|
1386
|
-
description:
|
|
1587
|
+
description:
|
|
1588
|
+
'Initiates an SMS conversation with a contact from within a MobileConnect message. Returns true when a conversation is created inside a MobileConnect message context, and false in any other context (for example a CloudPage or email). The success path cannot be exercised outside a live MobileConnect send.',
|
|
1589
|
+
isConfirmed: false,
|
|
1590
|
+
verificationBlocked: true,
|
|
1591
|
+
verificationBlockedReason: 'no-working-invocation',
|
|
1592
|
+
differsFromOfficialDocs: true,
|
|
1593
|
+
officialDocsNote:
|
|
1594
|
+
"Runtime-observed on cred/DEV (MID 510007949), the only BU available for this batch (no parent-BU escalation). Unlike Msg()/Noun()/Verb(), this is an ordinary function call, so it compiles and runs on a CloudPage: called there with a real short code, the authorized destination number and app 'MOBILECONNECT', it returned the literal boolean false (Empty() false) and the page rendered fully with no exception — no SMS was sent. Passing an invalid app value also returned false, so the CloudPage context masks any app-validation error. This confirms the ampscript.guide claim that the function returns false outside a MobileConnect message context; the official Salesforce reference omits this and describes only the in-context behaviour (true on success, exception on failure). The success path (true, real conversation creation) requires a live MobileConnect message context that does not exist on a CloudPage and cannot be captured on this tenant, so the function is recorded blocked for the success path while the CloudPage false-return is proven. The catalogued signature was also corrected here: the four parameters are originationNumber, destinationNumber, nextKeyword and app, and the return is a boolean, not void.",
|
|
1387
1595
|
params: [
|
|
1388
|
-
{
|
|
1389
|
-
|
|
1390
|
-
|
|
1391
|
-
|
|
1596
|
+
{
|
|
1597
|
+
name: 'originationNumber',
|
|
1598
|
+
description: 'The MobileConnect short code or long code used to send',
|
|
1599
|
+
type: 'string',
|
|
1600
|
+
},
|
|
1601
|
+
{
|
|
1602
|
+
name: 'destinationNumber',
|
|
1603
|
+
description: "The contact's phone number, including country code",
|
|
1604
|
+
type: 'string',
|
|
1605
|
+
},
|
|
1606
|
+
{
|
|
1607
|
+
name: 'nextKeyword',
|
|
1608
|
+
description: 'The keyword to set as the next conversation keyword',
|
|
1609
|
+
type: 'string',
|
|
1610
|
+
},
|
|
1611
|
+
{
|
|
1612
|
+
name: 'app',
|
|
1613
|
+
description: "The application for the conversation; must be 'MOBILECONNECT'",
|
|
1614
|
+
type: 'string',
|
|
1615
|
+
},
|
|
1392
1616
|
],
|
|
1393
|
-
returnType: '
|
|
1394
|
-
returnDescription:
|
|
1395
|
-
|
|
1396
|
-
|
|
1617
|
+
returnType: 'boolean',
|
|
1618
|
+
returnDescription:
|
|
1619
|
+
'true when a conversation is created inside a MobileConnect message context; false in any other context (proven on a CloudPage). Fails with an exception in-context if unsuccessful.',
|
|
1620
|
+
syntax: 'CreateSmsConversation(originationNumber, destinationNumber, nextKeyword, app)',
|
|
1621
|
+
example: '%%=CreateSmsConversation("12345", MOBILE_NUMBER, "KEYWORD", "MOBILECONNECT")=%%',
|
|
1397
1622
|
},
|
|
1398
1623
|
{
|
|
1399
1624
|
name: 'DataExtensionRowCount',
|
|
@@ -1402,6 +1627,9 @@ export const FUNCTIONS = [
|
|
|
1402
1627
|
mcnNotes: null,
|
|
1403
1628
|
docUrl: 'https://developer.salesforce.com/docs/marketing/marketing-cloud-ampscript/references/mc-ampscript-data-extension/mc-ampscript-reference-data-extension-de-row-count.html',
|
|
1404
1629
|
guideUrl: 'https://ampscript.guide/dataextensionrowcount/',
|
|
1630
|
+
sfmcGuideUrl: 'https://sfmc.guide/engagement/ampscript/functions/dataextensionrowcount/',
|
|
1631
|
+
isConfirmed: true,
|
|
1632
|
+
differsFromOfficialDocs: false,
|
|
1405
1633
|
minArgs: 1,
|
|
1406
1634
|
maxArgs: 1,
|
|
1407
1635
|
category: 'Data Extension',
|
|
@@ -1424,25 +1652,41 @@ export const FUNCTIONS = [
|
|
|
1424
1652
|
name: 'DateAdd',
|
|
1425
1653
|
mcnSince: 67,
|
|
1426
1654
|
handlebarsEquivalent: 'dateAdd',
|
|
1655
|
+
handlebarsExact: true,
|
|
1427
1656
|
mcnNotes: null,
|
|
1428
1657
|
docUrl: 'https://developer.salesforce.com/docs/marketing/marketing-cloud-ampscript/references/mc-ampscript-date-time/mc-ampscript-reference-date-time-date-add.html',
|
|
1429
1658
|
guideUrl: 'https://ampscript.guide/dateadd/',
|
|
1659
|
+
sfmcGuideUrl: 'https://sfmc.guide/engagement/ampscript/functions/dateadd/',
|
|
1660
|
+
isConfirmed: true,
|
|
1661
|
+
differsFromOfficialDocs: false,
|
|
1430
1662
|
minArgs: 3,
|
|
1431
1663
|
maxArgs: 3,
|
|
1432
1664
|
category: 'Date and Time',
|
|
1433
|
-
description:
|
|
1665
|
+
description:
|
|
1666
|
+
'Adds a whole number of intervals to a date value. Only the five documented units are accepted and every other unit, including seconds and weeks, aborts the page — as does a non-integer amount or a date the engine cannot parse.',
|
|
1434
1667
|
params: [
|
|
1435
|
-
{
|
|
1436
|
-
|
|
1668
|
+
{
|
|
1669
|
+
name: 'date',
|
|
1670
|
+
description:
|
|
1671
|
+
'The date to adjust, either a real date value or a parseable date string',
|
|
1672
|
+
type: 'string|date',
|
|
1673
|
+
},
|
|
1674
|
+
{
|
|
1675
|
+
name: 'amountToAdd',
|
|
1676
|
+
description:
|
|
1677
|
+
'Whole number of intervals to add; negative subtracts, zero returns the date unchanged, and a decimal aborts the page',
|
|
1678
|
+
type: 'string|number',
|
|
1679
|
+
},
|
|
1437
1680
|
{
|
|
1438
1681
|
name: 'unitToAdd',
|
|
1439
1682
|
description:
|
|
1440
|
-
'The unit
|
|
1683
|
+
'The unit to add, case-insensitive. Accepted values: Y (years), M (months), D (days), H (hours), MI (minutes). Any other value aborts the page',
|
|
1441
1684
|
type: 'string',
|
|
1442
1685
|
},
|
|
1443
1686
|
],
|
|
1444
1687
|
returnType: 'date',
|
|
1445
|
-
returnDescription:
|
|
1688
|
+
returnDescription:
|
|
1689
|
+
'The resulting date value, which the other date functions accept directly. Adding months clamps to the last day of the shorter target month.',
|
|
1446
1690
|
syntax: 'DateAdd(date, amountToAdd, unitToAdd)',
|
|
1447
1691
|
example: "%%=DateAdd(Now(), 7, 'D')=%%",
|
|
1448
1692
|
},
|
|
@@ -1450,36 +1694,44 @@ export const FUNCTIONS = [
|
|
|
1450
1694
|
name: 'DateDiff',
|
|
1451
1695
|
mcnSince: 67,
|
|
1452
1696
|
handlebarsEquivalent: 'dateDiff',
|
|
1697
|
+
handlebarsExact: true,
|
|
1453
1698
|
mcnNotes: null,
|
|
1454
1699
|
docUrl: 'https://developer.salesforce.com/docs/marketing/marketing-cloud-ampscript/references/mc-ampscript-date-time/mc-ampscript-reference-date-time-date-diff.html',
|
|
1455
1700
|
guideUrl: 'https://ampscript.guide/datediff/',
|
|
1456
1701
|
minArgs: 3,
|
|
1457
1702
|
maxArgs: 3,
|
|
1458
1703
|
category: 'Date and Time',
|
|
1459
|
-
description:
|
|
1704
|
+
description:
|
|
1705
|
+
'Counts how many boundaries of the requested unit lie between two dates, by truncating both to that unit and subtracting — so a 23-hour gap that crosses midnight counts as 1 day, while 23 hours within one day counts as 0. Finer units than the one requested are ignored rather than rounded.',
|
|
1460
1706
|
params: [
|
|
1461
1707
|
{
|
|
1462
1708
|
name: 'startDate',
|
|
1463
|
-
description:
|
|
1464
|
-
|
|
1709
|
+
description:
|
|
1710
|
+
'The starting date, either a real date value or a parseable date string',
|
|
1711
|
+
type: 'string|date',
|
|
1465
1712
|
},
|
|
1466
1713
|
{
|
|
1467
1714
|
name: 'endDate',
|
|
1468
|
-
description:
|
|
1469
|
-
|
|
1715
|
+
description:
|
|
1716
|
+
'The end date, either a real date value or a parseable date string; a later end date gives a positive result and an earlier one a negative result',
|
|
1717
|
+
type: 'string|date',
|
|
1470
1718
|
},
|
|
1471
1719
|
{
|
|
1472
1720
|
name: 'unitOfDifference',
|
|
1473
|
-
description:
|
|
1721
|
+
description:
|
|
1722
|
+
'The unit to count in, case-insensitive. Accepted values: Y (years), M (months), D (days), H (hours), MI (minutes). Any other value aborts the page',
|
|
1474
1723
|
type: 'string',
|
|
1475
1724
|
enum: ['Y', 'M', 'D', 'H', 'MI'],
|
|
1476
1725
|
},
|
|
1477
1726
|
],
|
|
1478
1727
|
returnType: 'number',
|
|
1479
1728
|
returnDescription:
|
|
1480
|
-
'
|
|
1729
|
+
'A whole number that is negative when the end date precedes the start date and 0 when both fall inside the same unit.',
|
|
1481
1730
|
syntax: 'DateDiff(startDate, endDate, unitOfDifference)',
|
|
1482
1731
|
example: "%%=DateDiff(Now(), DateAdd(Now(), 1, 'D'), 'MI')=%%",
|
|
1732
|
+
isConfirmed: true,
|
|
1733
|
+
differsFromOfficialDocs: false,
|
|
1734
|
+
sfmcGuideUrl: 'https://sfmc.guide/engagement/ampscript/functions/datediff/',
|
|
1483
1735
|
},
|
|
1484
1736
|
{
|
|
1485
1737
|
name: 'DateParse',
|
|
@@ -1491,26 +1743,32 @@ export const FUNCTIONS = [
|
|
|
1491
1743
|
minArgs: 1,
|
|
1492
1744
|
maxArgs: 2,
|
|
1493
1745
|
category: 'Date and Time',
|
|
1494
|
-
description:
|
|
1746
|
+
description:
|
|
1747
|
+
'Parses a date string into a date value. A string the parser cannot read aborts the page instead of returning a sentinel, and an ambiguous day-first string such as 5/8/2026 is silently read month-first rather than rejected. An offset or GMT marker in the input is honoured and converted to the account time zone.',
|
|
1748
|
+
isConfirmed: true,
|
|
1749
|
+
differsFromOfficialDocs: false,
|
|
1750
|
+
sfmcGuideUrl: 'https://sfmc.guide/engagement/ampscript/functions/dateparse/',
|
|
1495
1751
|
params: [
|
|
1496
1752
|
{
|
|
1497
1753
|
name: 'dateString',
|
|
1498
|
-
description:
|
|
1499
|
-
|
|
1754
|
+
description:
|
|
1755
|
+
'A date or timestamp string, or an existing date value; anything the parser cannot read aborts the page',
|
|
1756
|
+
type: 'string|date',
|
|
1500
1757
|
},
|
|
1501
1758
|
{
|
|
1502
1759
|
name: 'useUtc',
|
|
1503
1760
|
mcnSince: null,
|
|
1504
1761
|
mcnNotes: null,
|
|
1505
1762
|
description:
|
|
1506
|
-
'If true, return the
|
|
1507
|
-
type: 'boolean',
|
|
1763
|
+
'If true, return the instant in UTC; otherwise in the account time zone. Accepts 1/0, true/false, or those spellings quoted, and is not validated',
|
|
1764
|
+
type: 'string|boolean|number',
|
|
1508
1765
|
optional: true,
|
|
1509
1766
|
default: false,
|
|
1510
1767
|
},
|
|
1511
1768
|
],
|
|
1512
1769
|
returnType: 'date',
|
|
1513
|
-
returnDescription:
|
|
1770
|
+
returnDescription:
|
|
1771
|
+
'A real date value the other date functions accept directly. Rendered on its own it prints as a US short date followed by a 12-hour clock with an AM/PM suffix.',
|
|
1514
1772
|
syntax: 'DateParse(dateString[, useUtc])',
|
|
1515
1773
|
example: "%%=DateParse('2026-01-15T08:30:00', 1)=%%",
|
|
1516
1774
|
},
|
|
@@ -1524,18 +1782,24 @@ export const FUNCTIONS = [
|
|
|
1524
1782
|
minArgs: 2,
|
|
1525
1783
|
maxArgs: 2,
|
|
1526
1784
|
category: 'Date and Time',
|
|
1527
|
-
description:
|
|
1785
|
+
description:
|
|
1786
|
+
'Extracts one component from a date. The hour is reported on a 12-hour clock with no AM/PM indicator, so 19:35 yields 7 and any time at midnight — including a date with no time part at all — yields 12. Month and day come back zero-padded to two digits while hour and minute do not.',
|
|
1787
|
+
isConfirmed: true,
|
|
1788
|
+
differsFromOfficialDocs: false,
|
|
1789
|
+
sfmcGuideUrl: 'https://sfmc.guide/engagement/ampscript/functions/datepart/',
|
|
1528
1790
|
params: [
|
|
1529
1791
|
{
|
|
1530
1792
|
name: 'dateString',
|
|
1531
|
-
description:
|
|
1532
|
-
|
|
1793
|
+
description:
|
|
1794
|
+
'A real date value or a parseable date string; an unreadable or empty value aborts the page',
|
|
1795
|
+
type: 'string|date',
|
|
1533
1796
|
},
|
|
1534
1797
|
{
|
|
1535
1798
|
name: 'datePart',
|
|
1536
1799
|
mcnSince: null,
|
|
1537
1800
|
mcnNotes: null,
|
|
1538
|
-
description:
|
|
1801
|
+
description:
|
|
1802
|
+
'The component to extract, case-insensitive. Any other value aborts the page',
|
|
1539
1803
|
type: 'string',
|
|
1540
1804
|
enum: [
|
|
1541
1805
|
'year',
|
|
@@ -1554,7 +1818,7 @@ export const FUNCTIONS = [
|
|
|
1554
1818
|
],
|
|
1555
1819
|
returnType: 'string',
|
|
1556
1820
|
returnDescription:
|
|
1557
|
-
'The requested component
|
|
1821
|
+
'The requested component as text — a zero-padded two-digit month or day, an unpadded hour or minute, a four-digit year, or the full English month name. Numeric components still feed the math functions directly.',
|
|
1558
1822
|
syntax: 'DatePart(dateString, datePart)',
|
|
1559
1823
|
example: "%%=DatePart('2026-01-15', 'Y')=%%",
|
|
1560
1824
|
},
|
|
@@ -1568,10 +1832,23 @@ export const FUNCTIONS = [
|
|
|
1568
1832
|
minArgs: 8,
|
|
1569
1833
|
maxArgs: 8,
|
|
1570
1834
|
category: 'Encryption and Encoding',
|
|
1571
|
-
|
|
1835
|
+
isConfirmed: true,
|
|
1836
|
+
sfmcGuideUrl: 'https://sfmc.guide/engagement/ampscript/functions/decryptsymmetric/',
|
|
1837
|
+
description:
|
|
1838
|
+
'Decrypts a Base64 ciphertext produced by EncryptSymmetric, using the same algorithm, passphrase, salt and initialization vector.',
|
|
1572
1839
|
params: [
|
|
1573
|
-
{
|
|
1574
|
-
|
|
1840
|
+
{
|
|
1841
|
+
name: 'encryptedValue',
|
|
1842
|
+
description: 'Base64 ciphertext to decrypt',
|
|
1843
|
+
type: 'string',
|
|
1844
|
+
},
|
|
1845
|
+
{
|
|
1846
|
+
name: 'algorithm',
|
|
1847
|
+
description:
|
|
1848
|
+
'Cipher name, optionally followed by semicolon-separated mode and padding settings; must match the settings used to encrypt, and an unrecognised name aborts the page',
|
|
1849
|
+
type: 'string',
|
|
1850
|
+
enum: ['aes', 'des', 'tripledes'],
|
|
1851
|
+
},
|
|
1575
1852
|
{
|
|
1576
1853
|
name: 'passwordExternalKey',
|
|
1577
1854
|
mcnSince: null,
|
|
@@ -1616,6 +1893,9 @@ export const FUNCTIONS = [
|
|
|
1616
1893
|
mcnNotes: null,
|
|
1617
1894
|
docUrl: 'https://developer.salesforce.com/docs/marketing/marketing-cloud-ampscript/references/mc-ampscript-data-extension/mc-ampscript-reference-data-extension-delete-data.html',
|
|
1618
1895
|
guideUrl: 'https://ampscript.guide/deletedata/',
|
|
1896
|
+
sfmcGuideUrl: 'https://sfmc.guide/engagement/ampscript/functions/deletedata/',
|
|
1897
|
+
isConfirmed: true,
|
|
1898
|
+
differsFromOfficialDocs: false,
|
|
1619
1899
|
minArgs: 3,
|
|
1620
1900
|
maxArgs: INF,
|
|
1621
1901
|
category: 'Data Extension',
|
|
@@ -1660,6 +1940,9 @@ export const FUNCTIONS = [
|
|
|
1660
1940
|
mcnNotes: null,
|
|
1661
1941
|
docUrl: 'https://developer.salesforce.com/docs/marketing/marketing-cloud-ampscript/references/mc-ampscript-data-extension/mc-ampscript-reference-data-extension-delete-de.html',
|
|
1662
1942
|
guideUrl: 'https://ampscript.guide/deletede/',
|
|
1943
|
+
sfmcGuideUrl: 'https://sfmc.guide/engagement/ampscript/functions/deletede/',
|
|
1944
|
+
isConfirmed: true,
|
|
1945
|
+
differsFromOfficialDocs: false,
|
|
1663
1946
|
minArgs: 3,
|
|
1664
1947
|
maxArgs: INF,
|
|
1665
1948
|
category: 'Data Extension',
|
|
@@ -1712,6 +1995,11 @@ export const FUNCTIONS = [
|
|
|
1712
1995
|
returnDescription: 'A rowset describing the available Microsoft Dynamics CRM entities.',
|
|
1713
1996
|
syntax: 'DescribeMSCRMEntities()',
|
|
1714
1997
|
example: '%%[ SET @entities = DescribeMSCRMEntities() ]%%',
|
|
1998
|
+
isConfirmed: true,
|
|
1999
|
+
nonFunctionalAtRuntime: true,
|
|
2000
|
+
deprecated: true,
|
|
2001
|
+
deprecatedReason:
|
|
2002
|
+
'The Marketing Cloud Connector for Microsoft Dynamics CRM was retired (online integration in December 2020, on-premises in October 2021), so the Dynamics CRM AMPscript functions no longer have a live integration to call and are non-functional. No replacement AMPscript function exists; integrate Dynamics data through the SFTP import/export or a custom API instead.',
|
|
1715
2003
|
},
|
|
1716
2004
|
{
|
|
1717
2005
|
name: 'DescribeMSCRMEntityAttributes',
|
|
@@ -1729,14 +2017,21 @@ export const FUNCTIONS = [
|
|
|
1729
2017
|
returnDescription: 'A rowset describing the attributes of the requested CRM entity.',
|
|
1730
2018
|
syntax: 'DescribeMSCRMEntityAttributes(entityType)',
|
|
1731
2019
|
example: "%%[ SET @attrs = DescribeMSCRMEntityAttributes('contact') ]%%",
|
|
2020
|
+
isConfirmed: true,
|
|
2021
|
+
nonFunctionalAtRuntime: true,
|
|
2022
|
+
deprecated: true,
|
|
2023
|
+
deprecatedReason:
|
|
2024
|
+
'The Marketing Cloud Connector for Microsoft Dynamics CRM was retired (online integration in December 2020, on-premises in October 2021), so the Dynamics CRM AMPscript functions no longer have a live integration to call and are non-functional. No replacement AMPscript function exists; integrate Dynamics data through the SFTP import/export or a custom API instead.',
|
|
1732
2025
|
},
|
|
1733
2026
|
{
|
|
1734
2027
|
name: 'Divide',
|
|
1735
2028
|
mcnSince: 67,
|
|
1736
2029
|
handlebarsEquivalent: 'divide',
|
|
2030
|
+
handlebarsExact: true,
|
|
1737
2031
|
mcnNotes: null,
|
|
1738
2032
|
docUrl: 'https://developer.salesforce.com/docs/marketing/marketing-cloud-ampscript/references/mc-ampscript-math/mc-ampscript-reference-math-divide.html',
|
|
1739
2033
|
guideUrl: 'https://ampscript.guide/divide/',
|
|
2034
|
+
sfmcGuideUrl: 'https://sfmc.guide/engagement/ampscript/functions/divide/',
|
|
1740
2035
|
minArgs: 2,
|
|
1741
2036
|
maxArgs: 2,
|
|
1742
2037
|
category: 'Math',
|
|
@@ -1760,13 +2055,24 @@ export const FUNCTIONS = [
|
|
|
1760
2055
|
mcnNotes: null,
|
|
1761
2056
|
docUrl: 'https://developer.salesforce.com/docs/marketing/marketing-cloud-ampscript/references/mc-ampscript-utilities/mc-ampscript-reference-utilities-domain.html',
|
|
1762
2057
|
guideUrl: 'https://ampscript.guide/domain/',
|
|
2058
|
+
sfmcGuideUrl: 'https://sfmc.guide/engagement/ampscript/functions/domain/',
|
|
1763
2059
|
minArgs: 1,
|
|
1764
2060
|
maxArgs: 1,
|
|
2061
|
+
isConfirmed: true,
|
|
2062
|
+
differsFromOfficialDocs: false,
|
|
1765
2063
|
category: 'Utility',
|
|
1766
|
-
description:
|
|
1767
|
-
|
|
2064
|
+
description:
|
|
2065
|
+
'Returns everything after the first at sign, without validating the address or the domain. A value with no at sign, an empty string and a number all return an empty string.',
|
|
2066
|
+
params: [
|
|
2067
|
+
{
|
|
2068
|
+
name: 'emailAddress',
|
|
2069
|
+
description: 'Email address; the text after the first at sign is returned verbatim',
|
|
2070
|
+
type: 'string',
|
|
2071
|
+
},
|
|
2072
|
+
],
|
|
1768
2073
|
returnType: 'string',
|
|
1769
|
-
returnDescription:
|
|
2074
|
+
returnDescription:
|
|
2075
|
+
'The text following the first at sign, preserving the original case and any further at signs. Empty when the value contains no at sign or nothing follows it.',
|
|
1770
2076
|
syntax: 'Domain(emailAddress)',
|
|
1771
2077
|
example: "%%=Domain('user@example.com')=%%",
|
|
1772
2078
|
},
|
|
@@ -1774,17 +2080,28 @@ export const FUNCTIONS = [
|
|
|
1774
2080
|
name: 'Empty',
|
|
1775
2081
|
mcnSince: 67,
|
|
1776
2082
|
handlebarsEquivalent: 'isEmpty',
|
|
2083
|
+
handlebarsExact: true,
|
|
1777
2084
|
mcnNotes: null,
|
|
1778
2085
|
docUrl: 'https://developer.salesforce.com/docs/marketing/marketing-cloud-ampscript/references/mc-ampscript-utilities/mc-ampscript-reference-utilities-empty.html',
|
|
1779
2086
|
guideUrl: 'https://ampscript.guide/empty/',
|
|
2087
|
+
sfmcGuideUrl: 'https://sfmc.guide/engagement/ampscript/functions/empty/',
|
|
1780
2088
|
minArgs: 1,
|
|
1781
2089
|
maxArgs: 1,
|
|
1782
2090
|
category: 'Utility',
|
|
1783
|
-
description:
|
|
1784
|
-
|
|
2091
|
+
description:
|
|
2092
|
+
'Returns true when the value is an empty string, an unset variable, or an undeclared variable. Whitespace, the number 0, the string "0" and the string "false" are all treated as present.',
|
|
2093
|
+
params: [
|
|
2094
|
+
{
|
|
2095
|
+
name: 'value',
|
|
2096
|
+
description:
|
|
2097
|
+
'Value to test; a variable, literal, attribute or nested function call is accepted',
|
|
2098
|
+
type: 'string|number|boolean|date',
|
|
2099
|
+
},
|
|
2100
|
+
],
|
|
1785
2101
|
returnType: 'boolean',
|
|
1786
|
-
returnDescription: 'True when the value is empty or
|
|
2102
|
+
returnDescription: 'True when the value is empty or missing, otherwise false.',
|
|
1787
2103
|
returnEnum: [true, false],
|
|
2104
|
+
isConfirmed: true,
|
|
1788
2105
|
syntax: 'Empty(value)',
|
|
1789
2106
|
example: '%%=Empty(@myVar)=%%',
|
|
1790
2107
|
},
|
|
@@ -1798,10 +2115,19 @@ export const FUNCTIONS = [
|
|
|
1798
2115
|
minArgs: 8,
|
|
1799
2116
|
maxArgs: 8,
|
|
1800
2117
|
category: 'Encryption and Encoding',
|
|
1801
|
-
|
|
2118
|
+
isConfirmed: true,
|
|
2119
|
+
sfmcGuideUrl: 'https://sfmc.guide/engagement/ampscript/functions/encryptsymmetric/',
|
|
2120
|
+
description:
|
|
2121
|
+
'Encrypts a value using symmetric key encryption and returns the ciphertext as Base64. The result is deterministic: the same inputs produce the same ciphertext on every call.',
|
|
1802
2122
|
params: [
|
|
1803
2123
|
{ name: 'value', description: 'Value to encrypt', type: 'string' },
|
|
1804
|
-
{
|
|
2124
|
+
{
|
|
2125
|
+
name: 'algorithm',
|
|
2126
|
+
description:
|
|
2127
|
+
'Cipher name, optionally followed by semicolon-separated mode and padding settings such as des;mode=ecb;padding=zeros; an unrecognised name aborts the page',
|
|
2128
|
+
type: 'string',
|
|
2129
|
+
enum: ['aes', 'des', 'tripledes'],
|
|
2130
|
+
},
|
|
1805
2131
|
{
|
|
1806
2132
|
name: 'passwordExternalKey',
|
|
1807
2133
|
mcnSince: null,
|
|
@@ -1834,7 +2160,7 @@ export const FUNCTIONS = [
|
|
|
1834
2160
|
{ name: 'iv', description: 'IV value or empty to use external key', type: 'string' },
|
|
1835
2161
|
],
|
|
1836
2162
|
returnType: 'string',
|
|
1837
|
-
returnDescription: 'The
|
|
2163
|
+
returnDescription: 'The ciphertext, Base64-encoded.',
|
|
1838
2164
|
syntax: 'EncryptSymmetric(value, algorithm, passwordExternalKey, password, saltExternalKey, salt, ivExternalKey, iv)',
|
|
1839
2165
|
example: "%%=EncryptSymmetric('secret', 'aes', 'pwKey', '', 'saltKey', '', 'ivKey', '')=%%",
|
|
1840
2166
|
},
|
|
@@ -1845,8 +2171,11 @@ export const FUNCTIONS = [
|
|
|
1845
2171
|
mcnNotes: null,
|
|
1846
2172
|
docUrl: 'https://developer.salesforce.com/docs/marketing/marketing-cloud-ampscript/references/mc-ampscript-content/mc-ampscript-reference-content-end-impression-region.html',
|
|
1847
2173
|
guideUrl: 'https://ampscript.guide/endimpressionregion/',
|
|
2174
|
+
sfmcGuideUrl: 'https://sfmc.guide/engagement/ampscript/functions/endimpressionregion/',
|
|
1848
2175
|
minArgs: 0,
|
|
1849
2176
|
maxArgs: 1,
|
|
2177
|
+
isConfirmed: true,
|
|
2178
|
+
differsFromOfficialDocs: false,
|
|
1850
2179
|
category: 'Content',
|
|
1851
2180
|
description: 'Marks the end of an impression tracking region.',
|
|
1852
2181
|
params: [
|
|
@@ -1854,8 +2183,9 @@ export const FUNCTIONS = [
|
|
|
1854
2183
|
name: 'endAllRegions',
|
|
1855
2184
|
mcnSince: null,
|
|
1856
2185
|
mcnNotes: null,
|
|
1857
|
-
description:
|
|
1858
|
-
|
|
2186
|
+
description:
|
|
2187
|
+
'Whether to end all open impression regions. A truthy value ends every open region; the default ends only the most recent one.',
|
|
2188
|
+
type: 'string|boolean|number',
|
|
1859
2189
|
optional: true,
|
|
1860
2190
|
},
|
|
1861
2191
|
],
|
|
@@ -1874,15 +2204,31 @@ export const FUNCTIONS = [
|
|
|
1874
2204
|
minArgs: 2,
|
|
1875
2205
|
maxArgs: 2,
|
|
1876
2206
|
category: 'MobileConnect',
|
|
1877
|
-
description:
|
|
2207
|
+
description:
|
|
2208
|
+
'Ends an active SMS conversation with a contact from within a MobileConnect message. Returns true when the conversation is ended inside a MobileConnect message context, and false in any other context (for example a CloudPage or email). The success path cannot be exercised outside a live MobileConnect send.',
|
|
2209
|
+
isConfirmed: false,
|
|
2210
|
+
verificationBlocked: true,
|
|
2211
|
+
verificationBlockedReason: 'no-working-invocation',
|
|
2212
|
+
differsFromOfficialDocs: true,
|
|
2213
|
+
officialDocsNote:
|
|
2214
|
+
'Runtime-observed on cred/DEV (MID 510007949), the only BU available (no parent-BU escalation). This is an ordinary function call, so it compiles and runs on a CloudPage: called there with a real short code and the authorized destination number, it returned the literal boolean false (Empty() false) and the page rendered fully with no exception — no SMS was sent and no conversation state changed. This confirms the ampscript.guide claim that the function returns false outside a MobileConnect message context; the official Salesforce reference omits this and describes only the in-context behaviour (true on success, exception on failure). The success path (true, real conversation end) requires a live MobileConnect message context that cannot be captured on this tenant, so the function is recorded blocked for the success path while the CloudPage false-return is proven. The catalogued signature was corrected here: the two parameters are originationNumber and destinationNumber, and the return is a boolean, not void.',
|
|
1878
2215
|
params: [
|
|
1879
|
-
{
|
|
1880
|
-
|
|
2216
|
+
{
|
|
2217
|
+
name: 'originationNumber',
|
|
2218
|
+
description: 'The MobileConnect short code or long code used to send',
|
|
2219
|
+
type: 'string',
|
|
2220
|
+
},
|
|
2221
|
+
{
|
|
2222
|
+
name: 'destinationNumber',
|
|
2223
|
+
description: "The contact's phone number, including country code",
|
|
2224
|
+
type: 'string',
|
|
2225
|
+
},
|
|
1881
2226
|
],
|
|
1882
|
-
returnType: '
|
|
1883
|
-
returnDescription:
|
|
1884
|
-
|
|
1885
|
-
|
|
2227
|
+
returnType: 'boolean',
|
|
2228
|
+
returnDescription:
|
|
2229
|
+
'true when the conversation is ended inside a MobileConnect message context; false in any other context (proven on a CloudPage). Fails with an exception in-context if unsuccessful.',
|
|
2230
|
+
syntax: 'EndSmsConversation(originationNumber, destinationNumber)',
|
|
2231
|
+
example: '%%=EndSmsConversation("12345", MOBILE_NUMBER)=%%',
|
|
1886
2232
|
},
|
|
1887
2233
|
{
|
|
1888
2234
|
name: 'ExecuteFilter',
|
|
@@ -1891,7 +2237,10 @@ export const FUNCTIONS = [
|
|
|
1891
2237
|
mcnNotes: null,
|
|
1892
2238
|
docUrl: 'https://developer.salesforce.com/docs/marketing/marketing-cloud-ampscript/references/mc-ampscript-data-extension/mc-ampscript-reference-data-extension-execute-filter.html',
|
|
1893
2239
|
guideUrl: 'https://ampscript.guide/executefilter/',
|
|
1894
|
-
|
|
2240
|
+
sfmcGuideUrl: 'https://sfmc.guide/engagement/ampscript/functions/executefilter/',
|
|
2241
|
+
isConfirmed: true,
|
|
2242
|
+
differsFromOfficialDocs: false,
|
|
2243
|
+
minArgs: 1,
|
|
1895
2244
|
maxArgs: 1,
|
|
1896
2245
|
category: 'Data Extension',
|
|
1897
2246
|
description: 'Executes a predefined data filter and returns the resulting rowset.',
|
|
@@ -1915,6 +2264,9 @@ export const FUNCTIONS = [
|
|
|
1915
2264
|
mcnNotes: null,
|
|
1916
2265
|
docUrl: 'https://developer.salesforce.com/docs/marketing/marketing-cloud-ampscript/references/mc-ampscript-data-extension/mc-ampscript-reference-data-extension-execute-filter-ordered-rows.html',
|
|
1917
2266
|
guideUrl: 'https://ampscript.guide/executefilterorderedrows/',
|
|
2267
|
+
sfmcGuideUrl: 'https://sfmc.guide/engagement/ampscript/functions/executefilterorderedrows/',
|
|
2268
|
+
isConfirmed: true,
|
|
2269
|
+
differsFromOfficialDocs: false,
|
|
1918
2270
|
minArgs: 3,
|
|
1919
2271
|
maxArgs: 3,
|
|
1920
2272
|
category: 'Data Extension',
|
|
@@ -1948,14 +2300,19 @@ export const FUNCTIONS = [
|
|
|
1948
2300
|
{
|
|
1949
2301
|
name: 'Field',
|
|
1950
2302
|
mcnSince: 67,
|
|
1951
|
-
handlebarsEquivalent:
|
|
2303
|
+
handlebarsEquivalent: 'get',
|
|
2304
|
+
handlebarsExact: false,
|
|
1952
2305
|
mcnNotes: null,
|
|
1953
2306
|
docUrl: 'https://developer.salesforce.com/docs/marketing/marketing-cloud-ampscript/references/mc-ampscript-data-extension/mc-ampscript-reference-data-extension-field.html',
|
|
1954
2307
|
guideUrl: 'https://ampscript.guide/field/',
|
|
2308
|
+
sfmcGuideUrl: 'https://sfmc.guide/engagement/ampscript/functions/field/',
|
|
2309
|
+
isConfirmed: true,
|
|
2310
|
+
differsFromOfficialDocs: false,
|
|
1955
2311
|
minArgs: 2,
|
|
1956
2312
|
maxArgs: 3,
|
|
1957
2313
|
category: 'Data Extension',
|
|
1958
|
-
description:
|
|
2314
|
+
description:
|
|
2315
|
+
'Retrieves the value of a named field from a rowset row. The two-argument form aborts the page when the column is absent; pass the optional third argument as 0 (or false) to get an empty string for a possibly-missing column instead.',
|
|
1959
2316
|
params: [
|
|
1960
2317
|
{ name: 'row', description: 'Row object from a rowset', type: 'row' },
|
|
1961
2318
|
{ name: 'fieldName', description: 'Column name to retrieve', type: 'string' },
|
|
@@ -1979,52 +2336,92 @@ export const FUNCTIONS = [
|
|
|
1979
2336
|
name: 'Format',
|
|
1980
2337
|
mcnSince: 67,
|
|
1981
2338
|
handlebarsEquivalent: 'format',
|
|
2339
|
+
handlebarsExact: false,
|
|
1982
2340
|
mcnNotes: null,
|
|
1983
2341
|
docUrl: 'https://developer.salesforce.com/docs/marketing/marketing-cloud-ampscript/references/mc-ampscript-string/mc-ampscript-reference-string-format.html',
|
|
1984
2342
|
guideUrl: 'https://ampscript.guide/format/',
|
|
1985
2343
|
minArgs: 2,
|
|
1986
2344
|
maxArgs: 4,
|
|
1987
2345
|
category: 'Utility',
|
|
1988
|
-
|
|
2346
|
+
isConfirmed: true,
|
|
2347
|
+
differsFromOfficialDocs: true,
|
|
2348
|
+
officialDocsNote:
|
|
2349
|
+
'Proven on the child BU MCDEV_Training_QA (MID 518005426). The official reference names two possible values for the third parameter, Date and Number, but at runtime only Date is usable. Passing the literal Number aborts the page with HTTP 422 and discards all output, whether or not a locale follows it — Format(1234.555, "C2", "Number") and Format(1234.555, "C2", "Number", "de-DE") both aborted, exactly like the invented value Banana. Date works in any capitalisation, and the empty string works and still allows a locale in the fourth parameter, so Format(1234.555, "C2", "", "de-DE") is the way to format a localised number. Number formatting also happens correctly with the third parameter omitted entirely, so the documented value is not merely optional, it is unusable.',
|
|
2350
|
+
sfmcGuideUrl: 'https://sfmc.guide/engagement/ampscript/functions/format/',
|
|
2351
|
+
description:
|
|
2352
|
+
'Formats a number, a date or a string with a .NET format pattern. The third parameter only accepts Date or the empty string; the documented value Number aborts the page.',
|
|
1989
2353
|
params: [
|
|
1990
|
-
{ name: 'value', description: 'Value to format' },
|
|
1991
|
-
{ name: 'formatString', description: '.NET format string', type: 'string' },
|
|
1992
2354
|
{
|
|
1993
|
-
name: '
|
|
2355
|
+
name: 'value',
|
|
2356
|
+
description:
|
|
2357
|
+
'The value to format; a number, a numeric string, a date value or a parseable date string',
|
|
2358
|
+
type: 'string|number|date',
|
|
2359
|
+
},
|
|
2360
|
+
{
|
|
2361
|
+
name: 'formatString',
|
|
2362
|
+
description:
|
|
2363
|
+
'Standard or custom .NET format pattern; an unusable pattern is echoed back instead of failing',
|
|
2364
|
+
type: 'string',
|
|
2365
|
+
},
|
|
2366
|
+
{
|
|
2367
|
+
name: 'dataFormat',
|
|
1994
2368
|
mcnSince: null,
|
|
1995
2369
|
mcnNotes: null,
|
|
1996
|
-
description:
|
|
2370
|
+
description:
|
|
2371
|
+
'Only Date, in any capitalisation, or the empty string; any other value including the documented Number aborts the page',
|
|
2372
|
+
type: 'string',
|
|
2373
|
+
optional: true,
|
|
2374
|
+
},
|
|
2375
|
+
{
|
|
2376
|
+
name: 'cultureCode',
|
|
2377
|
+
description:
|
|
2378
|
+
'The locale for separators, symbols and month and day names, written with either a hyphen or an underscore',
|
|
1997
2379
|
type: 'string',
|
|
1998
2380
|
optional: true,
|
|
1999
2381
|
},
|
|
2000
|
-
{ name: 'timeZone', description: 'Target time zone', type: 'string', optional: true },
|
|
2001
2382
|
],
|
|
2002
2383
|
returnType: 'string',
|
|
2003
|
-
returnDescription:
|
|
2004
|
-
|
|
2005
|
-
|
|
2384
|
+
returnDescription:
|
|
2385
|
+
'The formatted value, or an unformatted echo of the input or of the pattern when the pattern does not suit the input.',
|
|
2386
|
+
syntax: 'Format(value, formatString[, dataFormat, cultureCode])',
|
|
2387
|
+
example: '%%=Format("2026-03-04 13:52:07", "yyyy-MM-dd HH:mm:ss", "Date")=%%',
|
|
2006
2388
|
},
|
|
2007
2389
|
{
|
|
2008
2390
|
name: 'FormatCurrency',
|
|
2009
2391
|
mcnSince: 67,
|
|
2010
2392
|
handlebarsEquivalent: 'formatCurrency',
|
|
2393
|
+
handlebarsExact: false,
|
|
2011
2394
|
mcnNotes: null,
|
|
2012
2395
|
docUrl: 'https://developer.salesforce.com/docs/marketing/marketing-cloud-ampscript/references/mc-ampscript-utilities/mc-ampscript-reference-utilities-formatCurrency.html',
|
|
2013
2396
|
guideUrl: 'https://ampscript.guide/formatcurrency/',
|
|
2014
2397
|
minArgs: 2,
|
|
2015
2398
|
maxArgs: 4,
|
|
2016
2399
|
category: 'Utility',
|
|
2017
|
-
|
|
2400
|
+
isConfirmed: true,
|
|
2401
|
+
differsFromOfficialDocs: false,
|
|
2402
|
+
sfmcGuideUrl: 'https://sfmc.guide/engagement/ampscript/functions/formatcurrency/',
|
|
2403
|
+
description:
|
|
2404
|
+
'Formats a number as a currency amount for a locale, choosing the symbol, the separators and the symbol position from that locale. Rounding is half-up.',
|
|
2018
2405
|
params: [
|
|
2019
|
-
{
|
|
2020
|
-
|
|
2406
|
+
{
|
|
2407
|
+
name: 'value',
|
|
2408
|
+
description:
|
|
2409
|
+
'The amount to format, as a number or as a numeric string; a string may carry thousands separators',
|
|
2410
|
+
type: 'string|number',
|
|
2411
|
+
},
|
|
2412
|
+
{
|
|
2413
|
+
name: 'locale',
|
|
2414
|
+
description:
|
|
2415
|
+
'The locale that supplies the symbol, the separators and the symbol position, written with either a hyphen or an underscore; a language-only code works and an unknown code falls back to a generic currency sign',
|
|
2416
|
+
type: 'string',
|
|
2417
|
+
},
|
|
2021
2418
|
{
|
|
2022
2419
|
name: 'decimalPlaces',
|
|
2023
2420
|
mcnSince: null,
|
|
2024
2421
|
mcnNotes: null,
|
|
2025
2422
|
description:
|
|
2026
|
-
'Number of decimal places;
|
|
2027
|
-
type: 'number',
|
|
2423
|
+
'Number of decimal places; without it the locale decides, which is zero places for currencies that have no minor unit',
|
|
2424
|
+
type: 'string|number',
|
|
2028
2425
|
optional: true,
|
|
2029
2426
|
default: 2,
|
|
2030
2427
|
},
|
|
@@ -2032,20 +2429,22 @@ export const FUNCTIONS = [
|
|
|
2032
2429
|
name: 'symbol',
|
|
2033
2430
|
mcnSince: null,
|
|
2034
2431
|
mcnNotes: null,
|
|
2035
|
-
description:
|
|
2432
|
+
description:
|
|
2433
|
+
"Replaces the locale's currency symbol while keeping the locale's separators and symbol position; requires decimalPlaces to be supplied as well",
|
|
2036
2434
|
type: 'string',
|
|
2037
2435
|
optional: true,
|
|
2038
2436
|
},
|
|
2039
2437
|
],
|
|
2040
2438
|
returnType: 'string',
|
|
2041
|
-
returnDescription: 'The
|
|
2439
|
+
returnDescription: 'The amount formatted as a currency string for the requested locale.',
|
|
2042
2440
|
syntax: 'FormatCurrency(value, locale[, decimalPlaces, symbol])',
|
|
2043
|
-
example: "%%=FormatCurrency(1234.
|
|
2441
|
+
example: "%%=FormatCurrency(1234.555, 'en-US')=%%",
|
|
2044
2442
|
},
|
|
2045
2443
|
{
|
|
2046
2444
|
name: 'FormatDate',
|
|
2047
2445
|
mcnSince: 67,
|
|
2048
|
-
handlebarsEquivalent:
|
|
2446
|
+
handlebarsEquivalent: 'format',
|
|
2447
|
+
handlebarsExact: false,
|
|
2049
2448
|
mcnNotes:
|
|
2050
2449
|
'In MCN, uses Java SimpleDateFormat format strings instead of .NET. Omitting dateFormat returns the G standard format (e.g. "5/15/2026 1:23:45 PM").',
|
|
2051
2450
|
docUrl: 'https://developer.salesforce.com/docs/marketing/marketing-cloud-ampscript/references/mc-ampscript-date-time/mc-ampscript-reference-date-time-format-date.html',
|
|
@@ -2053,37 +2452,47 @@ export const FUNCTIONS = [
|
|
|
2053
2452
|
minArgs: 1,
|
|
2054
2453
|
maxArgs: 4,
|
|
2055
2454
|
category: 'Date and Time',
|
|
2455
|
+
isConfirmed: true,
|
|
2456
|
+
differsFromOfficialDocs: true,
|
|
2457
|
+
officialDocsNote:
|
|
2458
|
+
'Proven on the child BU MCDEV_Training_QA (MID 518005426). The official reference presents one .NET-style custom-pattern table and shows it applied to the dateFormat argument, but at runtime the two format arguments use SEPARATE, case-INSENSITIVE token sets. In dateFormat, mm and MM both render the MONTH, so the documented pattern yyyy-MM-dd HH:mm:ss returned 2026-03-04 13:03:07 for the instant 2026-03-04 13:52:07 — the minutes position printed 03, the month. The same pattern moved to timeFormat returned 13:52:07 correctly, because there mm and MM mean minutes. Single-letter tokens also disagree with the doc: d rendered the whole short date 3/4/2026 rather than the day number, M rendered March 4 rather than 3, and h or H alone in timeFormat aborts the page with HTTP 422 instead of rendering an hour. The day-name tokens are off by one repetition — dddd rendered Wed where the doc promises Wednesday, ddddd rendered Wednesday, and ddd rendered the corrupted string We4ne74a26 in which digits from the date replaced letters of the day name.',
|
|
2459
|
+
sfmcGuideUrl: 'https://sfmc.guide/engagement/ampscript/functions/formatdate/',
|
|
2056
2460
|
description:
|
|
2057
|
-
'Formats a date
|
|
2461
|
+
'Formats a date according to a date pattern, a time pattern and a locale. The two pattern arguments use separate, case-insensitive token sets: in the date pattern mm means month, and minutes are only reachable from the time pattern.',
|
|
2058
2462
|
params: [
|
|
2059
2463
|
{
|
|
2060
2464
|
name: 'dateString',
|
|
2061
|
-
description:
|
|
2062
|
-
|
|
2465
|
+
description:
|
|
2466
|
+
'The date to format, either a real date value or a parseable date string',
|
|
2467
|
+
type: 'string|date',
|
|
2063
2468
|
},
|
|
2064
2469
|
{
|
|
2065
2470
|
name: 'dateFormat',
|
|
2066
2471
|
mcnSince: 67,
|
|
2067
2472
|
mcnNotes: null,
|
|
2068
|
-
description:
|
|
2473
|
+
description:
|
|
2474
|
+
'The date pattern, or a single-letter standard format such as D, G or s. Case-insensitive, and mm here means month, not minutes',
|
|
2069
2475
|
type: 'string',
|
|
2070
2476
|
optional: true,
|
|
2071
2477
|
},
|
|
2072
2478
|
{
|
|
2073
2479
|
name: 'timeFormat',
|
|
2074
|
-
description:
|
|
2480
|
+
description:
|
|
2481
|
+
'The time pattern. Case-insensitive, and this is the only argument in which mm means minutes',
|
|
2075
2482
|
type: 'string',
|
|
2076
2483
|
optional: true,
|
|
2077
2484
|
},
|
|
2078
2485
|
{
|
|
2079
2486
|
name: 'localeCode',
|
|
2080
|
-
description:
|
|
2487
|
+
description:
|
|
2488
|
+
'The locale for month and day names and for the standard formats, written with either a hyphen or an underscore',
|
|
2081
2489
|
type: 'string',
|
|
2082
2490
|
optional: true,
|
|
2083
2491
|
},
|
|
2084
2492
|
],
|
|
2085
2493
|
returnType: 'string',
|
|
2086
|
-
returnDescription:
|
|
2494
|
+
returnDescription:
|
|
2495
|
+
'The formatted date, or an empty string when the first argument cannot be parsed as a date.',
|
|
2087
2496
|
syntax: 'FormatDate(dateString[, dateFormat, timeFormat, localeCode])',
|
|
2088
2497
|
example: '%%=FormatDate(Now(), "dddd, MMMM d yyyy", "HH:mm:ss")=%%',
|
|
2089
2498
|
},
|
|
@@ -2091,22 +2500,43 @@ export const FUNCTIONS = [
|
|
|
2091
2500
|
name: 'FormatNumber',
|
|
2092
2501
|
mcnSince: 67,
|
|
2093
2502
|
handlebarsEquivalent: 'formatNumber',
|
|
2503
|
+
handlebarsExact: true,
|
|
2094
2504
|
mcnNotes: null,
|
|
2095
2505
|
docUrl: 'https://developer.salesforce.com/docs/marketing/marketing-cloud-ampscript/references/mc-ampscript-utilities/mc-ampscript-reference-utilities-formatNumber.html',
|
|
2096
2506
|
guideUrl: 'https://ampscript.guide/formatnumber/',
|
|
2097
2507
|
minArgs: 2,
|
|
2098
2508
|
maxArgs: 3,
|
|
2099
2509
|
category: 'Utility',
|
|
2100
|
-
|
|
2510
|
+
isConfirmed: true,
|
|
2511
|
+
differsFromOfficialDocs: false,
|
|
2512
|
+
sfmcGuideUrl: 'https://sfmc.guide/engagement/ampscript/functions/formatnumber/',
|
|
2513
|
+
description:
|
|
2514
|
+
'Formats a number with a standard or custom .NET numeric pattern, optionally for a locale. Rounding is half-up.',
|
|
2101
2515
|
params: [
|
|
2102
|
-
{
|
|
2103
|
-
|
|
2104
|
-
|
|
2516
|
+
{
|
|
2517
|
+
name: 'number',
|
|
2518
|
+
description:
|
|
2519
|
+
'The value to format, as a number or as a numeric string; a string may carry thousands separators',
|
|
2520
|
+
type: 'string|number',
|
|
2521
|
+
},
|
|
2522
|
+
{
|
|
2523
|
+
name: 'format',
|
|
2524
|
+
description:
|
|
2525
|
+
'Standard pattern letter with an optional precision digit, such as N2 or C0, or a custom pattern; an unrecognised pattern is echoed back',
|
|
2526
|
+
type: 'string',
|
|
2527
|
+
},
|
|
2528
|
+
{
|
|
2529
|
+
name: 'locale',
|
|
2530
|
+
description:
|
|
2531
|
+
'The locale that supplies separators and the currency symbol, written with either a hyphen or an underscore; an unknown code falls back rather than failing',
|
|
2532
|
+
type: 'string',
|
|
2533
|
+
optional: true,
|
|
2534
|
+
},
|
|
2105
2535
|
],
|
|
2106
2536
|
returnType: 'string',
|
|
2107
|
-
returnDescription: 'The number formatted according to the supplied
|
|
2537
|
+
returnDescription: 'The number formatted according to the supplied pattern.',
|
|
2108
2538
|
syntax: 'FormatNumber(number, format[, locale])',
|
|
2109
|
-
example: "%%=FormatNumber(1234.
|
|
2539
|
+
example: "%%=FormatNumber(1234.555, 'N2', 'de-DE')=%%",
|
|
2110
2540
|
},
|
|
2111
2541
|
{
|
|
2112
2542
|
name: 'GetJWT',
|
|
@@ -2118,24 +2548,34 @@ export const FUNCTIONS = [
|
|
|
2118
2548
|
minArgs: 3,
|
|
2119
2549
|
maxArgs: 3,
|
|
2120
2550
|
category: 'Encryption and Encoding',
|
|
2121
|
-
description:
|
|
2551
|
+
description:
|
|
2552
|
+
'Generates a JSON Web Token signed with the supplied inline secret. The payload is passed through verbatim and is only Base64url-encoded, never encrypted.',
|
|
2122
2553
|
params: [
|
|
2123
|
-
{
|
|
2554
|
+
{
|
|
2555
|
+
name: 'secret',
|
|
2556
|
+
description:
|
|
2557
|
+
'Secret used to sign the token; the empty string aborts the page rather than signing with an empty key',
|
|
2558
|
+
type: 'string',
|
|
2559
|
+
},
|
|
2124
2560
|
{
|
|
2125
2561
|
name: 'algorithm',
|
|
2126
|
-
description:
|
|
2562
|
+
description:
|
|
2563
|
+
'HMAC algorithm name, matched case-insensitively; an unknown name aborts the page',
|
|
2127
2564
|
type: 'string',
|
|
2128
2565
|
enum: ['HS256', 'HS384', 'HS512'],
|
|
2129
2566
|
},
|
|
2130
2567
|
{
|
|
2131
2568
|
name: 'jsonPayload',
|
|
2132
2569
|
description:
|
|
2133
|
-
|
|
2570
|
+
'Payload to encode. It is copied into the token untouched and is not validated as JSON, so a non-JSON string is signed just as readily.',
|
|
2134
2571
|
type: 'string',
|
|
2135
2572
|
},
|
|
2136
2573
|
],
|
|
2137
2574
|
returnType: 'string',
|
|
2138
|
-
returnDescription:
|
|
2575
|
+
returnDescription:
|
|
2576
|
+
'The token as three Base64url segments joined by dots, with no padding. The same arguments always produce the same token.',
|
|
2577
|
+
isConfirmed: true,
|
|
2578
|
+
sfmcGuideUrl: 'https://sfmc.guide/engagement/ampscript/functions/getjwt/',
|
|
2139
2579
|
syntax: 'GetJWT(secret, algorithm, jsonPayload)',
|
|
2140
2580
|
example: "%%=GetJWT(@secret, 'HS256', @payload)=%%",
|
|
2141
2581
|
},
|
|
@@ -2167,6 +2607,8 @@ export const FUNCTIONS = [
|
|
|
2167
2607
|
],
|
|
2168
2608
|
returnType: 'string',
|
|
2169
2609
|
returnDescription: 'A signed JSON Web Token string created with the named key.',
|
|
2610
|
+
isConfirmed: true,
|
|
2611
|
+
sfmcGuideUrl: 'https://sfmc.guide/engagement/ampscript/functions/getjwtbykeyname/',
|
|
2170
2612
|
syntax: 'GetJWTByKeyName(keyName, algorithm, jsonPayload)',
|
|
2171
2613
|
example: "%%=GetJWTByKeyName('MyKeyName', 'HS256', @payload)=%%",
|
|
2172
2614
|
},
|
|
@@ -2192,6 +2634,10 @@ export const FUNCTIONS = [
|
|
|
2192
2634
|
returnDescription: 'The content of the requested Portfolio item.',
|
|
2193
2635
|
syntax: 'GetPortfolioItem(itemExternalKey)',
|
|
2194
2636
|
example: "%%=GetPortfolioItem('my-portfolio-key')=%%",
|
|
2637
|
+
isConfirmed: true,
|
|
2638
|
+
nonFunctionalAtRuntime: true,
|
|
2639
|
+
officialDocsNote:
|
|
2640
|
+
'Classic Portfolio is retired on this tenant, so no Portfolio item exists to retrieve. A reached call with an external key that does not resolve aborted the page with HTTP 422 and no partial output, on both the child QA BU (MID 518005426) and the parent BU (MID 7281698); the same call gated behind an unmatched query-string branch left the page at HTTP 200, confirming a runtime abort of the reached call. No valid key could be sourced because Portfolio asset creation and applications were retired, so the documented success path could not be exercised here.',
|
|
2195
2641
|
},
|
|
2196
2642
|
{
|
|
2197
2643
|
name: 'GetPublishedSocialContent',
|
|
@@ -2211,6 +2657,10 @@ export const FUNCTIONS = [
|
|
|
2211
2657
|
returnDescription: 'The published social content for the supplied identifier.',
|
|
2212
2658
|
syntax: 'GetPublishedSocialContent(socialContentId)',
|
|
2213
2659
|
example: "%%=GetPublishedSocialContent('socialContentId')=%%",
|
|
2660
|
+
isConfirmed: true,
|
|
2661
|
+
nonFunctionalAtRuntime: true,
|
|
2662
|
+
officialDocsNote:
|
|
2663
|
+
'The community guide flags this as usable only inside Microsites and Landing Pages and only for content regions built in Classic Content, which is retired on this tenant. A reached call aborted the page with HTTP 422 and no partial output for both a string region name and a numeric region id, on the child QA BU (MID 518005426) and again on the parent BU (MID 7281698). The same call gated behind an unmatched query-string branch left the page at HTTP 200, confirming a runtime abort of the reached call rather than a compile-time failure. No Classic Content region exists here to source a resolvable identifier, so the documented success path could not be exercised.',
|
|
2214
2664
|
},
|
|
2215
2665
|
{
|
|
2216
2666
|
name: 'GetSendTime',
|
|
@@ -2223,21 +2673,29 @@ export const FUNCTIONS = [
|
|
|
2223
2673
|
maxArgs: 1,
|
|
2224
2674
|
category: 'Date and Time',
|
|
2225
2675
|
description:
|
|
2226
|
-
'Returns the
|
|
2676
|
+
'Returns a send timestamp: by default the time the send completed for the individual subscriber, or with a true argument the job start or publish time. Outside a send context, such as on a CloudPage, it returns the current system time instead of a send time, in every argument spelling.',
|
|
2227
2677
|
params: [
|
|
2228
2678
|
{
|
|
2229
|
-
name: '
|
|
2679
|
+
name: 'boolAllSubscribers',
|
|
2230
2680
|
mcnSince: null,
|
|
2231
2681
|
mcnNotes: null,
|
|
2232
|
-
description:
|
|
2233
|
-
|
|
2682
|
+
description:
|
|
2683
|
+
'If true, return the job start or publish time instead of the individual subscriber send-completed time; outside a send context it makes no difference. Accepts 1/0, true/false, or those spellings quoted, and is not validated',
|
|
2684
|
+
type: 'string|boolean|number',
|
|
2234
2685
|
optional: true,
|
|
2235
2686
|
},
|
|
2236
2687
|
],
|
|
2237
2688
|
returnType: 'date',
|
|
2238
|
-
returnDescription:
|
|
2239
|
-
|
|
2689
|
+
returnDescription:
|
|
2690
|
+
'A real date value the other date functions accept directly, in the same system time zone as Now().',
|
|
2691
|
+
syntax: 'GetSendTime([boolAllSubscribers])',
|
|
2240
2692
|
example: '%%=GetSendTime(1)=%%',
|
|
2693
|
+
isConfirmed: false,
|
|
2694
|
+
verificationBlocked: true,
|
|
2695
|
+
verificationBlockedReason: 'needs-auth-context',
|
|
2696
|
+
differsFromOfficialDocs: false,
|
|
2697
|
+
officialDocsNote:
|
|
2698
|
+
'Send-context semantics could not be proven: a CloudPage GET has no send, so both documented paths collapse. Probed on the child BU MCDEV_Training_QA (MID 518005426), one deploy and eight gated fetches. GetSendTime() rendered 8/8/2026 7:35:16 PM against Now()=8/8/2026 7:35:16 PM in the same render, with FormatDate(..., "ffffff") giving 507042 for both, so the two are the same instant to the microsecond rather than merely the same second. Every argument spelling (1, 0, true, false, "1", "0", "true", "false", and the non-flag word spring) was accepted at HTTP 200 and returned that same current time, and DateDiff(GetSendTime(1), Now(), "MI") was 0. What IS proven on a CloudPage: the value is a real date (FormatDate gave 2026-08-08, DatePart gave 2026 and 7, DateAdd of three hours advanced it, DateDiff measured that gap as 3), it renders as a US short date plus a 12-hour clock (Length 19 for that instant), Empty() over it is False, it sits on the system side of the clock (DateDiff to SystemDateToLocalDate was 480 minutes, identical to the same measurement over Now()), arity 0 and 1 both work and arity 2 aborts the page with HTTP 422. What is NOT proven and needs a real list, data extension, triggered or journey send: the individual subscriber send-completed time, the job start time, the job publish time and the STO-optimized time.',
|
|
2241
2699
|
},
|
|
2242
2700
|
{
|
|
2243
2701
|
name: 'GetSocialPublishURL',
|
|
@@ -2246,16 +2704,18 @@ export const FUNCTIONS = [
|
|
|
2246
2704
|
mcnNotes: null,
|
|
2247
2705
|
docUrl: 'https://developer.salesforce.com/docs/marketing/marketing-cloud-ampscript/references/mc-ampscript-social/mc-ampscript-reference-social-get-social-publish-url.html',
|
|
2248
2706
|
guideUrl: 'https://ampscript.guide/getsocialpublishurl/',
|
|
2707
|
+
sfmcGuideUrl: 'https://sfmc.guide/engagement/ampscript/functions/getsocialpublishurl/',
|
|
2249
2708
|
minArgs: 2,
|
|
2250
2709
|
maxArgs: INF,
|
|
2251
2710
|
category: 'Social',
|
|
2711
|
+
isConfirmed: true,
|
|
2252
2712
|
description:
|
|
2253
2713
|
'Returns HTML for sharing a content region on a supported social network via Social Forward. Optionally accepts repeating key/value parameter pairs.',
|
|
2254
2714
|
params: [
|
|
2255
2715
|
{
|
|
2256
2716
|
name: 'socialNetworkCode',
|
|
2257
2717
|
description: 'The number code of the social network to share to',
|
|
2258
|
-
type: 'number',
|
|
2718
|
+
type: 'string|number',
|
|
2259
2719
|
},
|
|
2260
2720
|
{
|
|
2261
2721
|
name: 'contentRegion',
|
|
@@ -2300,9 +2760,12 @@ export const FUNCTIONS = [
|
|
|
2300
2760
|
mcnNotes: null,
|
|
2301
2761
|
docUrl: 'https://developer.salesforce.com/docs/marketing/marketing-cloud-ampscript/references/mc-ampscript-social/mc-ampscript-reference-social-get-social-publish-url-by-name.html',
|
|
2302
2762
|
guideUrl: 'https://ampscript.guide/getsocialpublishurlbyname/',
|
|
2763
|
+
sfmcGuideUrl:
|
|
2764
|
+
'https://sfmc.guide/engagement/ampscript/functions/getsocialpublishurlbyname/',
|
|
2303
2765
|
minArgs: 3,
|
|
2304
2766
|
maxArgs: INF,
|
|
2305
2767
|
category: 'Social',
|
|
2768
|
+
isConfirmed: true,
|
|
2306
2769
|
description:
|
|
2307
2770
|
'Returns HTML for sharing a content region on a supported social network (identified by name) via Social Forward. Optionally accepts repeating key/value parameter pairs.',
|
|
2308
2771
|
params: [
|
|
@@ -2355,23 +2818,30 @@ export const FUNCTIONS = [
|
|
|
2355
2818
|
mcnNotes: null,
|
|
2356
2819
|
docUrl: 'https://developer.salesforce.com/docs/marketing/marketing-cloud-ampscript/references/mc-ampscript-utilities/mc-ampscript-reference-utilities-guid.html',
|
|
2357
2820
|
guideUrl: 'https://ampscript.guide/guid/',
|
|
2821
|
+
sfmcGuideUrl: 'https://sfmc.guide/engagement/ampscript/functions/guid/',
|
|
2358
2822
|
minArgs: 0,
|
|
2359
2823
|
maxArgs: 0,
|
|
2360
2824
|
category: 'Utility',
|
|
2361
|
-
description:
|
|
2825
|
+
description:
|
|
2826
|
+
'Generates a new globally unique identifier. Every call returns a different value, so store the result in a variable when the same identifier is needed twice.',
|
|
2362
2827
|
params: [],
|
|
2363
2828
|
returnType: 'string',
|
|
2364
|
-
returnDescription:
|
|
2829
|
+
returnDescription:
|
|
2830
|
+
'A 36-character lowercase identifier in the eight-four-four-four-twelve hyphenated form, without surrounding braces.',
|
|
2365
2831
|
syntax: 'GUID()',
|
|
2366
2832
|
example: '%%=GUID()=%%',
|
|
2833
|
+
isConfirmed: true,
|
|
2834
|
+
differsFromOfficialDocs: false,
|
|
2367
2835
|
},
|
|
2368
2836
|
{
|
|
2369
2837
|
name: 'HTTPGet',
|
|
2370
2838
|
mcnSince: null,
|
|
2371
2839
|
handlebarsEquivalent: null,
|
|
2372
2840
|
mcnNotes: null,
|
|
2841
|
+
isConfirmed: true,
|
|
2373
2842
|
docUrl: 'https://developer.salesforce.com/docs/marketing/marketing-cloud-ampscript/references/mc-ampscript-http/mc-ampscript-reference-http-get.html',
|
|
2374
2843
|
guideUrl: 'https://ampscript.guide/httpget/',
|
|
2844
|
+
sfmcGuideUrl: 'https://sfmc.guide/engagement/ampscript/functions/httpget/',
|
|
2375
2845
|
minArgs: 1,
|
|
2376
2846
|
maxArgs: 4,
|
|
2377
2847
|
category: 'HTTP',
|
|
@@ -2391,25 +2861,27 @@ export const FUNCTIONS = [
|
|
|
2391
2861
|
optional: true,
|
|
2392
2862
|
},
|
|
2393
2863
|
{
|
|
2394
|
-
name: '
|
|
2864
|
+
name: 'emptyContentHandling',
|
|
2395
2865
|
mcnSince: null,
|
|
2396
2866
|
mcnNotes: null,
|
|
2397
|
-
description:
|
|
2398
|
-
|
|
2867
|
+
description:
|
|
2868
|
+
'How empty content is handled: 0 allows empty content, 1 returns an error, 2 skips the subscriber in a send',
|
|
2869
|
+
type: 'number',
|
|
2399
2870
|
optional: true,
|
|
2400
2871
|
},
|
|
2401
2872
|
{
|
|
2402
|
-
name: '
|
|
2873
|
+
name: 'status',
|
|
2403
2874
|
mcnSince: null,
|
|
2404
2875
|
mcnNotes: null,
|
|
2405
|
-
description:
|
|
2406
|
-
|
|
2876
|
+
description:
|
|
2877
|
+
'Output variable that receives the function status: 0 success, -1 not found, -2 HTTP request error, -3 empty content',
|
|
2878
|
+
type: 'number',
|
|
2407
2879
|
optional: true,
|
|
2408
2880
|
},
|
|
2409
2881
|
],
|
|
2410
2882
|
returnType: 'string',
|
|
2411
2883
|
returnDescription: 'The body of the HTTP response as a string.',
|
|
2412
|
-
syntax: 'HTTPGet(httpGetUrl[, continueOnError,
|
|
2884
|
+
syntax: 'HTTPGet(httpGetUrl[, continueOnError, emptyContentHandling, status])',
|
|
2413
2885
|
example: "%%=HTTPGet('https://example.com/api')=%%",
|
|
2414
2886
|
},
|
|
2415
2887
|
{
|
|
@@ -2419,11 +2891,16 @@ export const FUNCTIONS = [
|
|
|
2419
2891
|
mcnNotes: null,
|
|
2420
2892
|
docUrl: 'https://developer.salesforce.com/docs/marketing/marketing-cloud-ampscript/references/mc-ampscript-http/mc-ampscript-reference-http-post.html',
|
|
2421
2893
|
guideUrl: 'https://ampscript.guide/httppost/',
|
|
2894
|
+
sfmcGuideUrl: 'https://sfmc.guide/engagement/ampscript/functions/httppost/',
|
|
2422
2895
|
minArgs: 3,
|
|
2423
2896
|
maxArgs: INF,
|
|
2424
2897
|
category: 'HTTP',
|
|
2898
|
+
isConfirmed: true,
|
|
2899
|
+
differsFromOfficialDocs: true,
|
|
2900
|
+
officialDocsNote:
|
|
2901
|
+
'The official reference labels the fourth argument as an output parameter holding the "status" of the request, but on a live Engagement CloudPage (child MID 518005426) that variable receives the response BODY, not the status. The HTTP status code is the function return value. A non-2xx response (proven with a 404) and an empty URL both abort the whole page rather than returning the status, so a failing status can never be read from the return value.',
|
|
2425
2902
|
description:
|
|
2426
|
-
'Performs an HTTP POST request. The response body is
|
|
2903
|
+
'Performs an HTTP POST request and returns the HTTP status code. The response body is written to the optional output variable.',
|
|
2427
2904
|
params: [
|
|
2428
2905
|
{
|
|
2429
2906
|
name: 'urlEndpoint',
|
|
@@ -2444,7 +2921,7 @@ export const FUNCTIONS = [
|
|
|
2444
2921
|
name: 'response',
|
|
2445
2922
|
mcnSince: null,
|
|
2446
2923
|
mcnNotes: null,
|
|
2447
|
-
description: 'Output variable that
|
|
2924
|
+
description: 'Output variable that receives the response body',
|
|
2448
2925
|
type: 'string',
|
|
2449
2926
|
optional: true,
|
|
2450
2927
|
},
|
|
@@ -2487,11 +2964,16 @@ export const FUNCTIONS = [
|
|
|
2487
2964
|
mcnNotes: null,
|
|
2488
2965
|
docUrl: 'https://developer.salesforce.com/docs/marketing/marketing-cloud-ampscript/references/mc-ampscript-http/mc-ampscript-reference-http-post2.html',
|
|
2489
2966
|
guideUrl: 'https://ampscript.guide/httppost2/',
|
|
2967
|
+
sfmcGuideUrl: 'https://sfmc.guide/engagement/ampscript/functions/httppost2/',
|
|
2490
2968
|
minArgs: 3,
|
|
2491
2969
|
maxArgs: INF,
|
|
2492
2970
|
category: 'HTTP',
|
|
2971
|
+
isConfirmed: true,
|
|
2972
|
+
differsFromOfficialDocs: true,
|
|
2973
|
+
officialDocsNote:
|
|
2974
|
+
'The official reference labels the fifth argument (response) as storing the "status" of the request, but on a live Engagement CloudPage (child MID 518005426) it receives the response BODY and the sixth argument (responseRowSet) receives the response HEADERS as a rowset (11 header rows observed). The HTTP status code is the function return value. The boolean exceptionOnError flag is accepted at position four.',
|
|
2493
2975
|
description:
|
|
2494
|
-
'Performs an HTTP POST
|
|
2976
|
+
'Performs an HTTP POST and returns the HTTP status code. The response body and the response headers (as a rowset) are written to optional output variables.',
|
|
2495
2977
|
params: [
|
|
2496
2978
|
{ name: 'url', description: 'Request URL', type: 'string' },
|
|
2497
2979
|
{ name: 'contentType', description: 'Content-Type header', type: 'string' },
|
|
@@ -2556,11 +3038,16 @@ export const FUNCTIONS = [
|
|
|
2556
3038
|
mcnNotes: null,
|
|
2557
3039
|
docUrl: 'https://developer.salesforce.com/docs/marketing/marketing-cloud-ampscript/references/mc-ampscript-http/mc-ampscript-reference-http-post-with-retry.html',
|
|
2558
3040
|
guideUrl: 'https://ampscript.guide/httppostwithretry/',
|
|
3041
|
+
sfmcGuideUrl: 'https://sfmc.guide/engagement/ampscript/functions/httppostwithretry/',
|
|
2559
3042
|
minArgs: 3,
|
|
2560
3043
|
maxArgs: INF,
|
|
2561
3044
|
category: 'HTTP',
|
|
3045
|
+
isConfirmed: true,
|
|
3046
|
+
differsFromOfficialDocs: true,
|
|
3047
|
+
officialDocsNote:
|
|
3048
|
+
'The official reference labels the responseStatus argument as storing the "status" of the request, but on a live Engagement CloudPage (child MID 518005426) it receives the response BODY and responseContentRowset receives the response HEADERS as a rowset (11 header rows observed). The HTTP status code is the function return value. The numRetries, reschedule and returnExceptionOnError arguments are all accepted at runtime; retry-on-failure is documented but was not forced here because a transient failure could not be induced safely against the echo endpoint.',
|
|
2562
3049
|
description:
|
|
2563
|
-
'Posts content to the specified URL with automatic retry logic on failure. Similar to HTTPPost2 but adds configurable retries and rescheduling.',
|
|
3050
|
+
'Posts content to the specified URL with automatic retry logic on failure, and returns the HTTP status code. Similar to HTTPPost2 but adds configurable retries and rescheduling; the response body and headers (as a rowset) are written to optional output variables.',
|
|
2564
3051
|
params: [
|
|
2565
3052
|
{ name: 'urlEndpoint', description: 'The URL to send the content to', type: 'string' },
|
|
2566
3053
|
{
|
|
@@ -2597,7 +3084,7 @@ export const FUNCTIONS = [
|
|
|
2597
3084
|
},
|
|
2598
3085
|
{
|
|
2599
3086
|
name: 'responseStatus',
|
|
2600
|
-
description: 'An AMPscript variable that
|
|
3087
|
+
description: 'An AMPscript variable that receives the response body',
|
|
2601
3088
|
type: 'string',
|
|
2602
3089
|
optional: true,
|
|
2603
3090
|
},
|
|
@@ -2643,8 +3130,13 @@ export const FUNCTIONS = [
|
|
|
2643
3130
|
mcnSince: null,
|
|
2644
3131
|
handlebarsEquivalent: null,
|
|
2645
3132
|
mcnNotes: null,
|
|
3133
|
+
isConfirmed: true,
|
|
3134
|
+
differsFromOfficialDocs: true,
|
|
3135
|
+
officialDocsNote:
|
|
3136
|
+
'Runtime-verified on a live Marketing Cloud Engagement CloudPage (child BU MID 518005426). The official reference states this function can only retrieve the standard HTTP headers listed in RFC 7231, but at runtime it also returns the value of a non-standard custom request header: a request sent with an X-Amp-Probe header returned that exact value, so the RFC 7231 restriction is not enforced when reading headers. A header that is absent from the request (for example Referer when none was sent) returns the empty string, matching the documented note.',
|
|
2646
3137
|
docUrl: 'https://developer.salesforce.com/docs/marketing/marketing-cloud-ampscript/references/mc-ampscript-http/mc-ampscript-reference-http-request-header.html',
|
|
2647
3138
|
guideUrl: 'https://ampscript.guide/httprequestheader/',
|
|
3139
|
+
sfmcGuideUrl: 'https://sfmc.guide/engagement/ampscript/functions/httprequestheader/',
|
|
2648
3140
|
minArgs: 1,
|
|
2649
3141
|
maxArgs: 1,
|
|
2650
3142
|
category: 'HTTP',
|
|
@@ -2666,21 +3158,38 @@ export const FUNCTIONS = [
|
|
|
2666
3158
|
name: 'IIf',
|
|
2667
3159
|
mcnSince: 67,
|
|
2668
3160
|
handlebarsEquivalent: 'iif',
|
|
3161
|
+
handlebarsExact: true,
|
|
2669
3162
|
mcnNotes: null,
|
|
2670
3163
|
docUrl: 'https://developer.salesforce.com/docs/marketing/marketing-cloud-ampscript/references/mc-ampscript-utilities/mc-ampscript-reference-utilities-iif.html',
|
|
2671
3164
|
guideUrl: 'https://ampscript.guide/iif/',
|
|
3165
|
+
sfmcGuideUrl: 'https://sfmc.guide/engagement/ampscript/functions/iif/',
|
|
2672
3166
|
minArgs: 3,
|
|
2673
3167
|
maxArgs: 3,
|
|
2674
3168
|
category: 'Utility',
|
|
2675
|
-
description:
|
|
3169
|
+
description:
|
|
3170
|
+
'Returns one of two values based on a boolean expression (inline if). Only a real comparison or a boolean-returning function selects the true branch; a plain string or number always selects the false branch. Only the selected branch is evaluated, so a call that would abort the page is safe in the branch that is not taken.',
|
|
2676
3171
|
params: [
|
|
2677
|
-
{
|
|
2678
|
-
|
|
2679
|
-
|
|
3172
|
+
{
|
|
3173
|
+
name: 'expression',
|
|
3174
|
+
description:
|
|
3175
|
+
'Boolean expression to evaluate; a non-boolean value always selects the false branch',
|
|
3176
|
+
type: 'boolean',
|
|
3177
|
+
},
|
|
3178
|
+
{
|
|
3179
|
+
name: 'trueValue',
|
|
3180
|
+
description: 'Value returned when true; evaluated only when true is selected',
|
|
3181
|
+
type: 'string|number|boolean|date',
|
|
3182
|
+
},
|
|
3183
|
+
{
|
|
3184
|
+
name: 'falseValue',
|
|
3185
|
+
description: 'Value returned when false; evaluated only when false is selected',
|
|
3186
|
+
type: 'string|number|boolean|date',
|
|
3187
|
+
},
|
|
2680
3188
|
],
|
|
2681
3189
|
returnType: 'string',
|
|
2682
3190
|
returnDescription:
|
|
2683
3191
|
'The second argument when the condition is true, otherwise the third argument.',
|
|
3192
|
+
isConfirmed: true,
|
|
2684
3193
|
syntax: 'IIf(expression, trueValue, falseValue)',
|
|
2685
3194
|
example: "%%=IIf(Empty(@name), 'Friend', @name)=%%",
|
|
2686
3195
|
},
|
|
@@ -2717,26 +3226,48 @@ export const FUNCTIONS = [
|
|
|
2717
3226
|
returnDescription: 'An HTML img tag for the referenced image.',
|
|
2718
3227
|
syntax: 'Image(imageExternalKey[, defaultImageExternalKey])',
|
|
2719
3228
|
example: "%%=Image('CorpLogo', 'DefaultImage')=%%",
|
|
3229
|
+
isConfirmed: true,
|
|
3230
|
+
nonFunctionalAtRuntime: true,
|
|
3231
|
+
deprecated: true,
|
|
3232
|
+
deprecatedReason:
|
|
3233
|
+
'The classic Portfolio / Classic Content area this function reads from was retired in April 2023, so no image assets exist for it to reference on any current tenant, and every invocation aborts the page at runtime. Use ContentImageByKey or ContentImageByID against Content Builder image assets instead.',
|
|
3234
|
+
officialDocsNote:
|
|
3235
|
+
'No working invocation was found on either the child QA BU (MID 518005426) or the parent BU (MID 7281698). Image resolves images from the legacy Portfolio, whose creation and applications have been retired; no Portfolio assets exist on either BU to reference. Every attempt aborted the CloudPage with HTTP 422 and no output: a literal URL, a Content Builder asset external key, and a plausible Portfolio-style key were all tried on the child BU, and a Portfolio-style key on the parent BU. Use ContentImageByKey or ContentImageByID against Content Builder image assets instead.',
|
|
2720
3236
|
},
|
|
2721
3237
|
{
|
|
2722
3238
|
name: 'IndexOf',
|
|
2723
3239
|
mcnSince: 67,
|
|
2724
3240
|
handlebarsEquivalent: 'indexOf',
|
|
3241
|
+
handlebarsExact: false,
|
|
2725
3242
|
mcnNotes: null,
|
|
2726
3243
|
docUrl: 'https://developer.salesforce.com/docs/marketing/marketing-cloud-ampscript/references/mc-ampscript-string/mc-ampscript-reference-string-index-of.html',
|
|
2727
3244
|
guideUrl: 'https://ampscript.guide/indexof/',
|
|
3245
|
+
sfmcGuideUrl: 'https://sfmc.guide/engagement/ampscript/functions/indexof/',
|
|
2728
3246
|
minArgs: 2,
|
|
2729
|
-
maxArgs:
|
|
3247
|
+
maxArgs: 3,
|
|
2730
3248
|
category: 'String',
|
|
2731
|
-
description:
|
|
3249
|
+
description:
|
|
3250
|
+
'Returns the 1-based position of a substring, matching case-insensitively. An undocumented third argument selects which occurrence to locate.',
|
|
2732
3251
|
params: [
|
|
2733
|
-
{
|
|
2734
|
-
|
|
3252
|
+
{
|
|
3253
|
+
name: 'sourceString',
|
|
3254
|
+
description: 'String to search in',
|
|
3255
|
+
type: 'string|number',
|
|
3256
|
+
},
|
|
3257
|
+
{ name: 'substring', description: 'Substring to find', type: 'string|number' },
|
|
3258
|
+
{
|
|
3259
|
+
name: 'occurrence',
|
|
3260
|
+
description: 'Which occurrence to locate, as a whole number; defaults to the first',
|
|
3261
|
+
type: 'string|number',
|
|
3262
|
+
},
|
|
2735
3263
|
],
|
|
2736
3264
|
returnType: 'number',
|
|
2737
|
-
returnDescription:
|
|
2738
|
-
|
|
3265
|
+
returnDescription:
|
|
3266
|
+
'The 1-based position of the substring, or 0 when it is not found or the requested occurrence does not exist.',
|
|
3267
|
+
syntax: 'IndexOf(sourceString, substring[, occurrence])',
|
|
2739
3268
|
example: "%%=IndexOf('Hello World', 'World')=%%",
|
|
3269
|
+
isConfirmed: true,
|
|
3270
|
+
differsFromOfficialDocs: false,
|
|
2740
3271
|
},
|
|
2741
3272
|
{
|
|
2742
3273
|
name: 'InsertData',
|
|
@@ -2745,6 +3276,9 @@ export const FUNCTIONS = [
|
|
|
2745
3276
|
mcnNotes: null,
|
|
2746
3277
|
docUrl: 'https://developer.salesforce.com/docs/marketing/marketing-cloud-ampscript/references/mc-ampscript-data-extension/mc-ampscript-reference-data-extension-insert-data.html',
|
|
2747
3278
|
guideUrl: 'https://ampscript.guide/insertdata/',
|
|
3279
|
+
sfmcGuideUrl: 'https://sfmc.guide/engagement/ampscript/functions/insertdata/',
|
|
3280
|
+
isConfirmed: true,
|
|
3281
|
+
differsFromOfficialDocs: false,
|
|
2748
3282
|
minArgs: 3,
|
|
2749
3283
|
maxArgs: INF,
|
|
2750
3284
|
category: 'Data Extension',
|
|
@@ -2787,6 +3321,9 @@ export const FUNCTIONS = [
|
|
|
2787
3321
|
mcnNotes: null,
|
|
2788
3322
|
docUrl: 'https://developer.salesforce.com/docs/marketing/marketing-cloud-ampscript/references/mc-ampscript-data-extension/mc-ampscript-reference-data-extension-insert-de.html',
|
|
2789
3323
|
guideUrl: 'https://ampscript.guide/insertde/',
|
|
3324
|
+
sfmcGuideUrl: 'https://sfmc.guide/engagement/ampscript/functions/insertde/',
|
|
3325
|
+
isConfirmed: true,
|
|
3326
|
+
differsFromOfficialDocs: false,
|
|
2790
3327
|
minArgs: 3,
|
|
2791
3328
|
maxArgs: INF,
|
|
2792
3329
|
category: 'Data Extension',
|
|
@@ -2830,6 +3367,7 @@ export const FUNCTIONS = [
|
|
|
2830
3367
|
mcnNotes: null,
|
|
2831
3368
|
docUrl: 'https://developer.salesforce.com/docs/marketing/marketing-cloud-ampscript/references/mc-ampscript-api/mc-ampscript-reference-api-invoke-create.html',
|
|
2832
3369
|
guideUrl: 'https://ampscript.guide/invokecreate/',
|
|
3370
|
+
sfmcGuideUrl: 'https://sfmc.guide/engagement/ampscript/functions/invokecreate/',
|
|
2833
3371
|
minArgs: 3,
|
|
2834
3372
|
maxArgs: 4,
|
|
2835
3373
|
category: 'Marketing Cloud API',
|
|
@@ -2860,9 +3398,12 @@ export const FUNCTIONS = [
|
|
|
2860
3398
|
},
|
|
2861
3399
|
],
|
|
2862
3400
|
returnType: 'string',
|
|
2863
|
-
returnDescription:
|
|
3401
|
+
returnDescription:
|
|
3402
|
+
"The SOAP OverallStatus as a string — 'OK' on success, 'Error' on failure. The human-readable message goes to the statusMessage out-variable and the numeric error code to errorCode.",
|
|
3403
|
+
returnEnum: ['OK', 'Error'],
|
|
2864
3404
|
syntax: 'InvokeCreate(apiObject, @statusMessage, @errorCode[, createOptionsObject])',
|
|
2865
3405
|
example: '%%=InvokeCreate(@apiObject, @statusMessage, @errorCode)=%%',
|
|
3406
|
+
isConfirmed: true,
|
|
2866
3407
|
},
|
|
2867
3408
|
{
|
|
2868
3409
|
name: 'InvokeDelete',
|
|
@@ -2871,6 +3412,7 @@ export const FUNCTIONS = [
|
|
|
2871
3412
|
mcnNotes: null,
|
|
2872
3413
|
docUrl: 'https://developer.salesforce.com/docs/marketing/marketing-cloud-ampscript/references/mc-ampscript-api/mc-ampscript-reference-api-invoke-delete.html',
|
|
2873
3414
|
guideUrl: 'https://ampscript.guide/invokedelete/',
|
|
3415
|
+
sfmcGuideUrl: 'https://sfmc.guide/engagement/ampscript/functions/invokedelete/',
|
|
2874
3416
|
minArgs: 3,
|
|
2875
3417
|
maxArgs: 4,
|
|
2876
3418
|
category: 'Marketing Cloud API',
|
|
@@ -2901,9 +3443,12 @@ export const FUNCTIONS = [
|
|
|
2901
3443
|
},
|
|
2902
3444
|
],
|
|
2903
3445
|
returnType: 'string',
|
|
2904
|
-
returnDescription:
|
|
3446
|
+
returnDescription:
|
|
3447
|
+
"The SOAP OverallStatus as a string — 'OK' on success, 'Error' on failure. The human-readable message goes to the statusMessage out-variable and the numeric error code to errorCode.",
|
|
3448
|
+
returnEnum: ['OK', 'Error'],
|
|
2905
3449
|
syntax: 'InvokeDelete(apiObject, @statusMessage, @errorCode[, deleteOptionsObject])',
|
|
2906
3450
|
example: '%%=InvokeDelete(@apiObject, @statusMessage, @errorCode)=%%',
|
|
3451
|
+
isConfirmed: true,
|
|
2907
3452
|
},
|
|
2908
3453
|
{
|
|
2909
3454
|
name: 'InvokeExecute',
|
|
@@ -2912,6 +3457,7 @@ export const FUNCTIONS = [
|
|
|
2912
3457
|
mcnNotes: null,
|
|
2913
3458
|
docUrl: 'https://developer.salesforce.com/docs/marketing/marketing-cloud-ampscript/references/mc-ampscript-api/mc-ampscript-reference-api-invoke-execute.html',
|
|
2914
3459
|
guideUrl: 'https://ampscript.guide/invokeexecute/',
|
|
3460
|
+
sfmcGuideUrl: 'https://sfmc.guide/engagement/ampscript/functions/invokeexecute/',
|
|
2915
3461
|
minArgs: 1,
|
|
2916
3462
|
maxArgs: 3,
|
|
2917
3463
|
category: 'Marketing Cloud API',
|
|
@@ -2936,9 +3482,10 @@ export const FUNCTIONS = [
|
|
|
2936
3482
|
],
|
|
2937
3483
|
returnType: 'rowset',
|
|
2938
3484
|
returnDescription:
|
|
2939
|
-
'A rowset containing the API
|
|
3485
|
+
'A rowset containing the API Results. Use Row() and Field() to read each result — StatusCode, StatusMessage and ErrorCode. The optional @statusMessage out-variable receives the OverallStatus string and @requestId receives the RequestID GUID.',
|
|
2940
3486
|
syntax: 'InvokeExecute(apiObject[, @statusMessage, @requestId])',
|
|
2941
3487
|
example: '%%[ SET @rows = InvokeExecute(@apiObject, @statusMessage, @requestId) ]%%',
|
|
3488
|
+
isConfirmed: true,
|
|
2942
3489
|
},
|
|
2943
3490
|
{
|
|
2944
3491
|
name: 'InvokePerform',
|
|
@@ -2947,6 +3494,7 @@ export const FUNCTIONS = [
|
|
|
2947
3494
|
mcnNotes: null,
|
|
2948
3495
|
docUrl: 'https://developer.salesforce.com/docs/marketing/marketing-cloud-ampscript/references/mc-ampscript-api/mc-ampscript-reference-api-invoke-perform.html',
|
|
2949
3496
|
guideUrl: 'https://ampscript.guide/invokeperform/',
|
|
3497
|
+
sfmcGuideUrl: 'https://sfmc.guide/engagement/ampscript/functions/invokeperform/',
|
|
2950
3498
|
minArgs: 2,
|
|
2951
3499
|
maxArgs: 3,
|
|
2952
3500
|
category: 'Marketing Cloud API',
|
|
@@ -2968,9 +3516,12 @@ export const FUNCTIONS = [
|
|
|
2968
3516
|
},
|
|
2969
3517
|
],
|
|
2970
3518
|
returnType: 'string',
|
|
2971
|
-
returnDescription:
|
|
3519
|
+
returnDescription:
|
|
3520
|
+
"The SOAP OverallStatus as a string — 'OK' on success, 'Error' on failure. The human-readable message goes to the optional @statusMessage out-variable.",
|
|
3521
|
+
returnEnum: ['OK', 'Error'],
|
|
2972
3522
|
syntax: 'InvokePerform(apiObject, actionToPerform[, @statusMessage])',
|
|
2973
3523
|
example: "%%=InvokePerform(@apiObject, 'Start', @statusMessage)=%%",
|
|
3524
|
+
isConfirmed: true,
|
|
2974
3525
|
},
|
|
2975
3526
|
{
|
|
2976
3527
|
name: 'InvokeRetrieve',
|
|
@@ -2979,6 +3530,7 @@ export const FUNCTIONS = [
|
|
|
2979
3530
|
mcnNotes: null,
|
|
2980
3531
|
docUrl: 'https://developer.salesforce.com/docs/marketing/marketing-cloud-ampscript/references/mc-ampscript-api/mc-ampscript-reference-api-invoke-retrieve.html',
|
|
2981
3532
|
guideUrl: 'https://ampscript.guide/invokeretrieve/',
|
|
3533
|
+
sfmcGuideUrl: 'https://sfmc.guide/engagement/ampscript/functions/invokeretrieve/',
|
|
2982
3534
|
minArgs: 1,
|
|
2983
3535
|
maxArgs: 3,
|
|
2984
3536
|
category: 'Marketing Cloud API',
|
|
@@ -3010,6 +3562,7 @@ export const FUNCTIONS = [
|
|
|
3010
3562
|
returnDescription: 'A rowset containing the retrieved API records.',
|
|
3011
3563
|
syntax: 'InvokeRetrieve(apiObject[, @statusMessage, @requestId])',
|
|
3012
3564
|
example: '%%[ SET @rows = InvokeRetrieve(@apiObject, @statusMessage, @requestId) ]%%',
|
|
3565
|
+
isConfirmed: true,
|
|
3013
3566
|
},
|
|
3014
3567
|
{
|
|
3015
3568
|
name: 'InvokeUpdate',
|
|
@@ -3018,6 +3571,7 @@ export const FUNCTIONS = [
|
|
|
3018
3571
|
mcnNotes: null,
|
|
3019
3572
|
docUrl: 'https://developer.salesforce.com/docs/marketing/marketing-cloud-ampscript/references/mc-ampscript-api/mc-ampscript-reference-api-invoke-update.html',
|
|
3020
3573
|
guideUrl: 'https://ampscript.guide/invokeupdate/',
|
|
3574
|
+
sfmcGuideUrl: 'https://sfmc.guide/engagement/ampscript/functions/invokeupdate/',
|
|
3021
3575
|
minArgs: 1,
|
|
3022
3576
|
maxArgs: 4,
|
|
3023
3577
|
category: 'Marketing Cloud API',
|
|
@@ -3050,9 +3604,12 @@ export const FUNCTIONS = [
|
|
|
3050
3604
|
},
|
|
3051
3605
|
],
|
|
3052
3606
|
returnType: 'string',
|
|
3053
|
-
returnDescription:
|
|
3607
|
+
returnDescription:
|
|
3608
|
+
"The SOAP OverallStatus as a string — 'OK' on success, 'Error' on failure. The human-readable message goes to the statusMessage out-variable and the numeric error code to errorCode.",
|
|
3609
|
+
returnEnum: ['OK', 'Error'],
|
|
3054
3610
|
syntax: 'InvokeUpdate(apiObject[, @statusMessage, @errorCode, updateOptions])',
|
|
3055
3611
|
example: '%%=InvokeUpdate(@apiObject, @statusMessage, @errorCode)=%%',
|
|
3612
|
+
isConfirmed: true,
|
|
3056
3613
|
},
|
|
3057
3614
|
{
|
|
3058
3615
|
name: 'IsCHTMLBrowser',
|
|
@@ -3061,12 +3618,22 @@ export const FUNCTIONS = [
|
|
|
3061
3618
|
mcnNotes: null,
|
|
3062
3619
|
docUrl: 'https://developer.salesforce.com/docs/marketing/marketing-cloud-ampscript/references/mc-ampscript-http/mc-ampscript-reference-http-is-chtml-browser.html',
|
|
3063
3620
|
guideUrl: 'https://ampscript.guide/ischtmlbrowser/',
|
|
3621
|
+
sfmcGuideUrl: 'https://sfmc.guide/engagement/ampscript/functions/ischtmlbrowser/',
|
|
3064
3622
|
minArgs: 1,
|
|
3065
3623
|
maxArgs: 1,
|
|
3624
|
+
isConfirmed: true,
|
|
3625
|
+
differsFromOfficialDocs: false,
|
|
3066
3626
|
category: 'Utility',
|
|
3067
3627
|
description:
|
|
3068
|
-
|
|
3069
|
-
params: [
|
|
3628
|
+
'Tests a user agent string for a compact HTML (cHTML) feature-phone browser. Feature-phone agents such as i-mode and KDDI handsets are recognised; modern desktop and mobile agents are not.',
|
|
3629
|
+
params: [
|
|
3630
|
+
{
|
|
3631
|
+
name: 'userAgent',
|
|
3632
|
+
description:
|
|
3633
|
+
'User agent string to test, typically HTTPRequestHeader("user-agent") on a CloudPage',
|
|
3634
|
+
type: 'string',
|
|
3635
|
+
},
|
|
3636
|
+
],
|
|
3070
3637
|
returnType: 'boolean',
|
|
3071
3638
|
returnDescription: 'True when the user agent indicates a cHTML browser, otherwise false.',
|
|
3072
3639
|
returnEnum: [true, false],
|
|
@@ -3080,11 +3647,24 @@ export const FUNCTIONS = [
|
|
|
3080
3647
|
mcnNotes: null,
|
|
3081
3648
|
docUrl: 'https://developer.salesforce.com/docs/marketing/marketing-cloud-ampscript/references/mc-ampscript-utilities/mc-ampscript-reference-utilities-is-email-address.html',
|
|
3082
3649
|
guideUrl: 'https://ampscript.guide/isemailaddress/',
|
|
3650
|
+
sfmcGuideUrl: 'https://sfmc.guide/engagement/ampscript/functions/isemailaddress/',
|
|
3083
3651
|
minArgs: 1,
|
|
3084
3652
|
maxArgs: 1,
|
|
3653
|
+
isConfirmed: true,
|
|
3654
|
+
differsFromOfficialDocs: true,
|
|
3655
|
+
officialDocsNote:
|
|
3656
|
+
'The official reference states that an address whose domain has no top-level domain is accepted, giving a call on a bare single-label domain as an example of a true result. On a live Engagement CloudPage on the child business unit (MID 518005426) that shape returned False, in a gate that printed its own start and done markers at HTTP 200 alongside a known-good control block. Every other example in the same table matched: the missing at sign, the double at sign, the missing local part and the missing second-level domain all returned False, and a well-formed address returned True. Surrounding whitespace is also rejected, which no source mentions.',
|
|
3085
3657
|
category: 'Utility',
|
|
3086
|
-
description:
|
|
3087
|
-
|
|
3658
|
+
description:
|
|
3659
|
+
'Checks a value against email address syntax only; it never tests whether the mailbox or domain exists. Surrounding whitespace and a domain without a top-level domain are both rejected.',
|
|
3660
|
+
params: [
|
|
3661
|
+
{
|
|
3662
|
+
name: 'value',
|
|
3663
|
+
description:
|
|
3664
|
+
'Value to validate; trim it first, as a leading or trailing space fails',
|
|
3665
|
+
type: 'string',
|
|
3666
|
+
},
|
|
3667
|
+
],
|
|
3088
3668
|
returnType: 'boolean',
|
|
3089
3669
|
returnDescription:
|
|
3090
3670
|
'True when the value is a syntactically valid email address, otherwise false.',
|
|
@@ -3095,38 +3675,65 @@ export const FUNCTIONS = [
|
|
|
3095
3675
|
{
|
|
3096
3676
|
name: 'IsNull',
|
|
3097
3677
|
mcnSince: 67,
|
|
3098
|
-
handlebarsEquivalent:
|
|
3678
|
+
handlebarsEquivalent: 'isEmpty',
|
|
3679
|
+
handlebarsExact: false,
|
|
3099
3680
|
mcnNotes: null,
|
|
3100
3681
|
docUrl: 'https://developer.salesforce.com/docs/marketing/marketing-cloud-ampscript/references/mc-ampscript-utilities/mc-ampscript-reference-utilities-is-null.html',
|
|
3101
3682
|
guideUrl: 'https://ampscript.guide/isnull/',
|
|
3683
|
+
sfmcGuideUrl: 'https://sfmc.guide/engagement/ampscript/functions/isnull/',
|
|
3102
3684
|
minArgs: 1,
|
|
3103
3685
|
maxArgs: 1,
|
|
3104
3686
|
category: 'Utility',
|
|
3105
|
-
description:
|
|
3106
|
-
|
|
3687
|
+
description:
|
|
3688
|
+
'Returns true only for a genuine null, which in practice means a data extension field with no value. An unset or undeclared variable, an empty string, whitespace and every ordinary value all return false, so this is not a general emptiness test.',
|
|
3689
|
+
params: [
|
|
3690
|
+
{
|
|
3691
|
+
name: 'value',
|
|
3692
|
+
description:
|
|
3693
|
+
'Value to test; typically a data extension field value retrieved with Lookup',
|
|
3694
|
+
type: 'string|number|boolean|date',
|
|
3695
|
+
},
|
|
3696
|
+
],
|
|
3107
3697
|
returnType: 'boolean',
|
|
3108
|
-
returnDescription:
|
|
3109
|
-
|
|
3698
|
+
returnDescription:
|
|
3699
|
+
'True when the value is null, otherwise false. Prefer Empty when the intent is to detect a missing or blank value.',
|
|
3700
|
+
isConfirmed: true,
|
|
3701
|
+
differsFromOfficialDocs: true,
|
|
3702
|
+
officialDocsNote:
|
|
3703
|
+
'The official reference shows a variable declared with VAR and never assigned, and states IsNull returns true for it. On a live Engagement CloudPage on the child business unit (MID 518005426) that exact shape returned False, in a gate that printed its own start and done markers at HTTP 200 alongside a known-good control block. The same False came back for an undeclared variable, an empty string, whitespace, 0, "0", "false", a real value, a date, an absent attribute, an absent request parameter and the subscriber-context tokens. Use Empty for a missing-value test.',
|
|
3110
3704
|
syntax: 'IsNull(value)',
|
|
3111
3705
|
example: '%%=IsNull(@value)=%%',
|
|
3112
3706
|
},
|
|
3113
3707
|
{
|
|
3114
3708
|
name: 'IsNullDefault',
|
|
3115
3709
|
mcnSince: null,
|
|
3116
|
-
handlebarsEquivalent:
|
|
3710
|
+
handlebarsEquivalent: 'fallback',
|
|
3711
|
+
handlebarsExact: false,
|
|
3117
3712
|
mcnNotes: null,
|
|
3118
3713
|
docUrl: 'https://developer.salesforce.com/docs/marketing/marketing-cloud-ampscript/references/mc-ampscript-sites/mc-ampscript-reference-sites-is-null-default.html',
|
|
3119
3714
|
guideUrl: 'https://ampscript.guide/isnulldefault/',
|
|
3715
|
+
sfmcGuideUrl: 'https://sfmc.guide/engagement/ampscript/functions/isnulldefault/',
|
|
3120
3716
|
minArgs: 2,
|
|
3121
3717
|
maxArgs: 2,
|
|
3122
3718
|
category: 'Utility',
|
|
3123
|
-
description:
|
|
3719
|
+
description:
|
|
3720
|
+
'Returns the value if not null, otherwise returns the default. Outside a Smart Capture form the default is never reached: on a CloudPage every empty-ish input returns the empty string instead, so it cannot be used as a general fallback.',
|
|
3124
3721
|
params: [
|
|
3125
|
-
{
|
|
3126
|
-
|
|
3722
|
+
{
|
|
3723
|
+
name: 'value',
|
|
3724
|
+
description: 'Value to test; returned unchanged whenever it is present',
|
|
3725
|
+
type: 'string|number|boolean|date',
|
|
3726
|
+
},
|
|
3727
|
+
{
|
|
3728
|
+
name: 'defaultValue',
|
|
3729
|
+
description:
|
|
3730
|
+
'Default to return when the value is null; only reached in a Smart Capture form context',
|
|
3731
|
+
type: 'string|number|boolean|date',
|
|
3732
|
+
},
|
|
3127
3733
|
],
|
|
3128
3734
|
returnType: 'string',
|
|
3129
3735
|
returnDescription: 'The original value, or the default value when the original is null.',
|
|
3736
|
+
isConfirmed: true,
|
|
3130
3737
|
syntax: 'IsNullDefault(value, defaultValue)',
|
|
3131
3738
|
example: "%%=IsNullDefault(@name, 'Friend')=%%",
|
|
3132
3739
|
},
|
|
@@ -3137,24 +3744,37 @@ export const FUNCTIONS = [
|
|
|
3137
3744
|
mcnNotes: null,
|
|
3138
3745
|
docUrl: 'https://developer.salesforce.com/docs/marketing/marketing-cloud-ampscript/references/mc-ampscript-utilities/mc-ampscript-reference-utilities-is-phone-number.html',
|
|
3139
3746
|
guideUrl: 'https://ampscript.guide/isphonenumber/',
|
|
3747
|
+
sfmcGuideUrl: 'https://sfmc.guide/engagement/ampscript/functions/isphonenumber/',
|
|
3140
3748
|
minArgs: 1,
|
|
3141
3749
|
maxArgs: 1,
|
|
3750
|
+
isConfirmed: true,
|
|
3751
|
+
differsFromOfficialDocs: false,
|
|
3142
3752
|
category: 'Utility',
|
|
3143
|
-
description:
|
|
3144
|
-
|
|
3753
|
+
description:
|
|
3754
|
+
'Checks a value against the North American Numbering Plan. Dashes, dots, spaces and parentheses are tolerated, but a leading plus sign, any letter, a number outside the plan and a leading country-code digit all fail.',
|
|
3755
|
+
params: [
|
|
3756
|
+
{
|
|
3757
|
+
name: 'value',
|
|
3758
|
+
description:
|
|
3759
|
+
'Phone number to validate; strip any leading plus sign or country code first',
|
|
3760
|
+
type: 'string|number',
|
|
3761
|
+
},
|
|
3762
|
+
],
|
|
3145
3763
|
returnType: 'boolean',
|
|
3146
3764
|
returnDescription: 'True when the value is a valid phone number, otherwise false.',
|
|
3147
3765
|
returnEnum: [true, false],
|
|
3148
3766
|
syntax: 'IsPhoneNumber(value)',
|
|
3149
|
-
example: "%%=IsPhoneNumber('
|
|
3767
|
+
example: "%%=IsPhoneNumber('425-555-0142')=%%",
|
|
3150
3768
|
},
|
|
3151
3769
|
{
|
|
3152
3770
|
name: 'Length',
|
|
3153
3771
|
mcnSince: 67,
|
|
3154
3772
|
handlebarsEquivalent: 'length',
|
|
3773
|
+
handlebarsExact: true,
|
|
3155
3774
|
mcnNotes: null,
|
|
3156
3775
|
docUrl: 'https://developer.salesforce.com/docs/marketing/marketing-cloud-ampscript/references/mc-ampscript-string/mc-ampscript-reference-string-length.html',
|
|
3157
3776
|
guideUrl: 'https://ampscript.guide/length/',
|
|
3777
|
+
sfmcGuideUrl: 'https://sfmc.guide/engagement/ampscript/functions/length/',
|
|
3158
3778
|
minArgs: 1,
|
|
3159
3779
|
maxArgs: 1,
|
|
3160
3780
|
isConfirmed: true,
|
|
@@ -3185,6 +3805,13 @@ export const FUNCTIONS = [
|
|
|
3185
3805
|
maxArgs: 2,
|
|
3186
3806
|
category: 'Content',
|
|
3187
3807
|
description: 'Generates a URL to a microsite page that serves live, dynamic content.',
|
|
3808
|
+
isConfirmed: true,
|
|
3809
|
+
nonFunctionalAtRuntime: true,
|
|
3810
|
+
deprecated: true,
|
|
3811
|
+
deprecatedReason:
|
|
3812
|
+
'Live Offers (Live Content) was removed from Marketing Cloud in 2019 and the Classic Microsites this URL points at were retired in June 2022, so there is no provisionable modern equivalent and every invocation aborts the page at runtime.',
|
|
3813
|
+
officialDocsNote:
|
|
3814
|
+
"Attempted on both the child QA BU (MID 518005426) and the parent BU (MID 7281698). Every invocation shape aborted the CloudPage with HTTP 200 lost to a 422 page abort: the documented-valid LiveContentMicrositeURL('coupon','MyCoupon'), an unknown content type, and an empty external key all failed identically. The function resolves a Live Offers (Live Content) coupon by external key, and no such Live Content asset is provisioned on either BU, so no working invocation could be produced. Left blocked pending a tenant with a real Live Offers coupon.",
|
|
3188
3815
|
params: [
|
|
3189
3816
|
{
|
|
3190
3817
|
name: 'contentType',
|
|
@@ -3207,25 +3834,32 @@ export const FUNCTIONS = [
|
|
|
3207
3834
|
{
|
|
3208
3835
|
name: 'LocalDateToSystemDate',
|
|
3209
3836
|
mcnSince: null,
|
|
3210
|
-
handlebarsEquivalent:
|
|
3837
|
+
handlebarsEquivalent: 'timeZoneConversion',
|
|
3838
|
+
handlebarsExact: false,
|
|
3211
3839
|
mcnNotes: null,
|
|
3212
3840
|
docUrl: 'https://developer.salesforce.com/docs/marketing/marketing-cloud-ampscript/references/mc-ampscript-date-time/mc-ampscript-reference-date-time-local-date-to-system-date.html',
|
|
3213
3841
|
guideUrl: 'https://ampscript.guide/localdatetosystemdate/',
|
|
3214
3842
|
minArgs: 1,
|
|
3215
3843
|
maxArgs: 1,
|
|
3216
3844
|
category: 'Date and Time',
|
|
3217
|
-
description:
|
|
3845
|
+
description:
|
|
3846
|
+
'Converts a date in the time zone configured on the account to the Marketing Cloud system date (Central Time, no daylight saving). The shift is not constant: the local side observes daylight saving, so a summer instant moves one hour further than a winter one. A value the date parser cannot read aborts the page instead of returning a sentinel.',
|
|
3218
3847
|
params: [
|
|
3219
3848
|
{
|
|
3220
3849
|
name: 'timeToConvert',
|
|
3221
|
-
description:
|
|
3222
|
-
|
|
3850
|
+
description:
|
|
3851
|
+
'The local time value to convert, as a date value or a parseable date string',
|
|
3852
|
+
type: 'string|date',
|
|
3223
3853
|
},
|
|
3224
3854
|
],
|
|
3225
|
-
returnType: '
|
|
3226
|
-
returnDescription:
|
|
3855
|
+
returnType: 'date',
|
|
3856
|
+
returnDescription:
|
|
3857
|
+
'A real date value the other date functions accept directly. Rendered on its own it prints as a US short date followed by a 12-hour clock with an AM/PM suffix.',
|
|
3227
3858
|
syntax: 'LocalDateToSystemDate(timeToConvert)',
|
|
3228
3859
|
example: '%%=LocalDateToSystemDate(Now())=%%',
|
|
3860
|
+
isConfirmed: true,
|
|
3861
|
+
differsFromOfficialDocs: false,
|
|
3862
|
+
sfmcGuideUrl: 'https://sfmc.guide/engagement/ampscript/functions/localdatetosystemdate/',
|
|
3229
3863
|
},
|
|
3230
3864
|
{
|
|
3231
3865
|
name: 'LongSFID',
|
|
@@ -3234,6 +3868,9 @@ export const FUNCTIONS = [
|
|
|
3234
3868
|
mcnNotes: null,
|
|
3235
3869
|
docUrl: 'https://developer.salesforce.com/docs/marketing/marketing-cloud-ampscript/references/mc-ampscript-salesforce/mc-ampscript-reference-salesforce-long-sfid.html',
|
|
3236
3870
|
guideUrl: 'https://ampscript.guide/longsfid/',
|
|
3871
|
+
sfmcGuideUrl: 'https://sfmc.guide/engagement/ampscript/functions/longsfid/',
|
|
3872
|
+
isConfirmed: true,
|
|
3873
|
+
differsFromOfficialDocs: false,
|
|
3237
3874
|
minArgs: 1,
|
|
3238
3875
|
maxArgs: 1,
|
|
3239
3876
|
category: 'Sales and Service Cloud',
|
|
@@ -3248,16 +3885,20 @@ export const FUNCTIONS = [
|
|
|
3248
3885
|
{
|
|
3249
3886
|
name: 'Lookup',
|
|
3250
3887
|
mcnSince: 67,
|
|
3251
|
-
handlebarsEquivalent:
|
|
3888
|
+
handlebarsEquivalent: 'queryFirst',
|
|
3889
|
+
handlebarsExact: false,
|
|
3252
3890
|
mcnNotes:
|
|
3253
3891
|
'In MCN, search arguments must be provided in column/value pairs - an odd count causes an error. All filter keys must fully specify the composite primary key.',
|
|
3254
3892
|
docUrl: 'https://developer.salesforce.com/docs/marketing/marketing-cloud-ampscript/references/mc-ampscript-data-extension/mc-ampscript-reference-data-extension-lookup.html',
|
|
3255
3893
|
guideUrl: 'https://ampscript.guide/lookup/',
|
|
3894
|
+
sfmcGuideUrl: 'https://sfmc.guide/engagement/ampscript/functions/lookup/',
|
|
3895
|
+
isConfirmed: true,
|
|
3896
|
+
differsFromOfficialDocs: false,
|
|
3256
3897
|
minArgs: 4,
|
|
3257
3898
|
maxArgs: INF,
|
|
3258
3899
|
category: 'Data Extension',
|
|
3259
3900
|
description:
|
|
3260
|
-
'Returns a single field value from the first matching row in a data extension.',
|
|
3901
|
+
'Returns a single field value from the first matching row in a data extension. A no-match returns an empty string.',
|
|
3261
3902
|
params: [
|
|
3262
3903
|
{
|
|
3263
3904
|
name: 'dataObject',
|
|
@@ -3295,10 +3936,14 @@ export const FUNCTIONS = [
|
|
|
3295
3936
|
{
|
|
3296
3937
|
name: 'LookupOrderedRows',
|
|
3297
3938
|
mcnSince: null,
|
|
3298
|
-
handlebarsEquivalent:
|
|
3939
|
+
handlebarsEquivalent: 'query',
|
|
3940
|
+
handlebarsExact: false,
|
|
3299
3941
|
mcnNotes: null,
|
|
3300
3942
|
docUrl: 'https://developer.salesforce.com/docs/marketing/marketing-cloud-ampscript/references/mc-ampscript-data-extension/mc-ampscript-reference-data-extension-lookup-ordered-rows.html',
|
|
3301
3943
|
guideUrl: 'https://ampscript.guide/lookuporderedrows/',
|
|
3944
|
+
sfmcGuideUrl: 'https://sfmc.guide/engagement/ampscript/functions/lookuporderedrows/',
|
|
3945
|
+
isConfirmed: true,
|
|
3946
|
+
differsFromOfficialDocs: false,
|
|
3302
3947
|
minArgs: 5,
|
|
3303
3948
|
maxArgs: INF,
|
|
3304
3949
|
category: 'Data Extension',
|
|
@@ -3349,10 +3994,14 @@ export const FUNCTIONS = [
|
|
|
3349
3994
|
{
|
|
3350
3995
|
name: 'LookupOrderedRowsCS',
|
|
3351
3996
|
mcnSince: null,
|
|
3352
|
-
handlebarsEquivalent:
|
|
3997
|
+
handlebarsEquivalent: 'query',
|
|
3998
|
+
handlebarsExact: false,
|
|
3353
3999
|
mcnNotes: null,
|
|
3354
4000
|
docUrl: 'https://developer.salesforce.com/docs/marketing/marketing-cloud-ampscript/references/mc-ampscript-data-extension/mc-ampscript-reference-data-extension-lookup-ordered-rows-cs.html',
|
|
3355
4001
|
guideUrl: 'https://ampscript.guide/lookuporderedrowscs/',
|
|
4002
|
+
sfmcGuideUrl: 'https://sfmc.guide/engagement/ampscript/functions/lookuporderedrowscs/',
|
|
4003
|
+
isConfirmed: true,
|
|
4004
|
+
differsFromOfficialDocs: false,
|
|
3356
4005
|
minArgs: 5,
|
|
3357
4006
|
maxArgs: INF,
|
|
3358
4007
|
category: 'Data Extension',
|
|
@@ -3402,10 +4051,14 @@ export const FUNCTIONS = [
|
|
|
3402
4051
|
{
|
|
3403
4052
|
name: 'LookupRows',
|
|
3404
4053
|
mcnSince: null,
|
|
3405
|
-
handlebarsEquivalent:
|
|
4054
|
+
handlebarsEquivalent: 'query',
|
|
4055
|
+
handlebarsExact: false,
|
|
3406
4056
|
mcnNotes: null,
|
|
3407
4057
|
docUrl: 'https://developer.salesforce.com/docs/marketing/marketing-cloud-ampscript/references/mc-ampscript-data-extension/mc-ampscript-reference-data-extension-lookup-rows.html',
|
|
3408
4058
|
guideUrl: 'https://ampscript.guide/lookuprows/',
|
|
4059
|
+
sfmcGuideUrl: 'https://sfmc.guide/engagement/ampscript/functions/lookuprows/',
|
|
4060
|
+
isConfirmed: true,
|
|
4061
|
+
differsFromOfficialDocs: false,
|
|
3409
4062
|
minArgs: 3,
|
|
3410
4063
|
maxArgs: INF,
|
|
3411
4064
|
category: 'Data Extension',
|
|
@@ -3441,10 +4094,14 @@ export const FUNCTIONS = [
|
|
|
3441
4094
|
{
|
|
3442
4095
|
name: 'LookupRowsCS',
|
|
3443
4096
|
mcnSince: null,
|
|
3444
|
-
handlebarsEquivalent:
|
|
4097
|
+
handlebarsEquivalent: 'query',
|
|
4098
|
+
handlebarsExact: false,
|
|
3445
4099
|
mcnNotes: null,
|
|
3446
4100
|
docUrl: 'https://developer.salesforce.com/docs/marketing/marketing-cloud-ampscript/references/mc-ampscript-data-extension/mc-ampscript-reference-data-extension-lookup-rows-cs.html',
|
|
3447
4101
|
guideUrl: 'https://ampscript.guide/lookuprowscs/',
|
|
4102
|
+
sfmcGuideUrl: 'https://sfmc.guide/engagement/ampscript/functions/lookuprowscs/',
|
|
4103
|
+
isConfirmed: true,
|
|
4104
|
+
differsFromOfficialDocs: false,
|
|
3448
4105
|
minArgs: 3,
|
|
3449
4106
|
maxArgs: INF,
|
|
3450
4107
|
category: 'Data Extension',
|
|
@@ -3481,9 +4138,11 @@ export const FUNCTIONS = [
|
|
|
3481
4138
|
name: 'Lowercase',
|
|
3482
4139
|
mcnSince: 67,
|
|
3483
4140
|
handlebarsEquivalent: 'lowercase',
|
|
4141
|
+
handlebarsExact: true,
|
|
3484
4142
|
mcnNotes: null,
|
|
3485
4143
|
docUrl: 'https://developer.salesforce.com/docs/marketing/marketing-cloud-ampscript/references/mc-ampscript-string/mc-ampscript-reference-string-lowercase.html',
|
|
3486
4144
|
guideUrl: 'https://ampscript.guide/lowercase/',
|
|
4145
|
+
sfmcGuideUrl: 'https://sfmc.guide/engagement/ampscript/functions/lowercase/',
|
|
3487
4146
|
minArgs: 1,
|
|
3488
4147
|
maxArgs: 1,
|
|
3489
4148
|
isConfirmed: true,
|
|
@@ -3509,27 +4168,37 @@ export const FUNCTIONS = [
|
|
|
3509
4168
|
mcnNotes: null,
|
|
3510
4169
|
docUrl: 'https://developer.salesforce.com/docs/marketing/marketing-cloud-ampscript/references/mc-ampscript-encryption/mc-ampscript-reference-encryption-md5.html',
|
|
3511
4170
|
guideUrl: 'https://ampscript.guide/md5/',
|
|
4171
|
+
sfmcGuideUrl: 'https://sfmc.guide/engagement/ampscript/functions/md5/',
|
|
3512
4172
|
minArgs: 1,
|
|
3513
4173
|
maxArgs: 2,
|
|
3514
4174
|
category: 'Encryption and Encoding',
|
|
3515
|
-
description:
|
|
4175
|
+
description:
|
|
4176
|
+
'Returns the MD5 hash of the input value. The bytes hashed are the UTF-8 encoding of the input unless charSet names another encoding, and a number or date argument is hashed as the text it renders as.',
|
|
3516
4177
|
params: [
|
|
3517
|
-
{
|
|
4178
|
+
{
|
|
4179
|
+
name: 'stringToConvert',
|
|
4180
|
+
description:
|
|
4181
|
+
'The value to hash; a number or date is hashed as its rendered text, and the empty string yields the well-known empty-input digest',
|
|
4182
|
+
type: 'string|number|date',
|
|
4183
|
+
},
|
|
3518
4184
|
{
|
|
3519
4185
|
name: 'charSet',
|
|
3520
4186
|
mcnSince: null,
|
|
3521
4187
|
mcnNotes: null,
|
|
3522
|
-
description:
|
|
4188
|
+
description:
|
|
4189
|
+
'Name of the character encoding applied before hashing; any encoding name the platform recognises works, and an unrecognised or empty name aborts the page',
|
|
3523
4190
|
type: 'string',
|
|
3524
|
-
enum: ['UTF-8', 'UTF-16'],
|
|
4191
|
+
enum: ['UTF-8', 'UTF-16', 'UTF-16BE', 'UTF-32', 'ASCII', 'ISO-8859-1'],
|
|
3525
4192
|
optional: true,
|
|
3526
4193
|
default: 'UTF-8',
|
|
3527
4194
|
},
|
|
3528
4195
|
],
|
|
3529
4196
|
returnType: 'string',
|
|
3530
|
-
returnDescription: 'The MD5 hash of the input as
|
|
4197
|
+
returnDescription: 'The MD5 hash of the input as 32 lowercase hexadecimal characters.',
|
|
3531
4198
|
syntax: 'MD5(stringToConvert[, charSet])',
|
|
3532
4199
|
example: '%%=MD5("This is a string of text.")=%%',
|
|
4200
|
+
isConfirmed: true,
|
|
4201
|
+
differsFromOfficialDocs: false,
|
|
3533
4202
|
},
|
|
3534
4203
|
{
|
|
3535
4204
|
name: 'MMS_Content_URL',
|
|
@@ -3543,6 +4212,11 @@ export const FUNCTIONS = [
|
|
|
3543
4212
|
category: 'MobileConnect',
|
|
3544
4213
|
description:
|
|
3545
4214
|
'Returns the URL of MMS content from an inbound mobile-originated (MO) message. Only usable in MobileConnect.',
|
|
4215
|
+
isConfirmed: false,
|
|
4216
|
+
verificationBlocked: true,
|
|
4217
|
+
verificationBlockedReason: 'no-working-invocation',
|
|
4218
|
+
officialDocsNote:
|
|
4219
|
+
'Could not runtime-verify on the only available context (a CloudPage GET on cred/DEV, MID 510007949; no parent-BU escalation is configured on this tenant). Including an MMS_Content_URL(0) call in the injected content block aborted the whole page at compile time (HTTP 422) even when the call sat inside a non-matching IF branch, while an otherwise identical page with the call removed rendered HTTP 200. This matches the official reference, which states the function is usable only in MobileConnect and not in landing pages or other content types; there is no mobile-originated message context on a CloudPage to exercise it against.',
|
|
3546
4220
|
params: [
|
|
3547
4221
|
{
|
|
3548
4222
|
name: 'position',
|
|
@@ -3566,9 +4240,13 @@ export const FUNCTIONS = [
|
|
|
3566
4240
|
minArgs: 1,
|
|
3567
4241
|
maxArgs: INF,
|
|
3568
4242
|
category: 'Utility',
|
|
3569
|
-
description:
|
|
4243
|
+
description:
|
|
4244
|
+
'Builds a Classic Content microsite URL whose single encrypted query string carries the page reference and any extra name-value pairs. Every call produces a fresh token, so two calls with identical arguments never match.',
|
|
4245
|
+
isConfirmed: true,
|
|
4246
|
+
differsFromOfficialDocs: false,
|
|
4247
|
+
sfmcGuideUrl: 'https://sfmc.guide/engagement/ampscript/functions/micrositeurl/',
|
|
3570
4248
|
params: [
|
|
3571
|
-
{ name: 'pageId', description: 'Microsite page ID', type: 'number' },
|
|
4249
|
+
{ name: 'pageId', description: 'Microsite page ID', type: 'string|number' },
|
|
3572
4250
|
{
|
|
3573
4251
|
name: 'paramName1',
|
|
3574
4252
|
description: 'Query parameter name',
|
|
@@ -3595,7 +4273,8 @@ export const FUNCTIONS = [
|
|
|
3595
4273
|
},
|
|
3596
4274
|
],
|
|
3597
4275
|
returnType: 'string',
|
|
3598
|
-
returnDescription:
|
|
4276
|
+
returnDescription:
|
|
4277
|
+
'A microsite page URL carrying one encrypted token; extra name-value pairs are folded into that token rather than appended as readable query parameters.',
|
|
3599
4278
|
repeat: [{ startIndex: 1, groupSize: 2, minGroups: 0 }],
|
|
3600
4279
|
syntax: 'MicrositeURL(pageId[, paramName1, paramValue1, paramNameN, paramValueN, ...])',
|
|
3601
4280
|
example: '%%=MicrositeURL(12345)=%%',
|
|
@@ -3604,9 +4283,11 @@ export const FUNCTIONS = [
|
|
|
3604
4283
|
name: 'Mod',
|
|
3605
4284
|
mcnSince: 67,
|
|
3606
4285
|
handlebarsEquivalent: 'modulo',
|
|
4286
|
+
handlebarsExact: true,
|
|
3607
4287
|
mcnNotes: null,
|
|
3608
4288
|
docUrl: 'https://developer.salesforce.com/docs/marketing/marketing-cloud-ampscript/references/mc-ampscript-math/mc-ampscript-reference-math-mod.html',
|
|
3609
4289
|
guideUrl: 'https://ampscript.guide/mod/',
|
|
4290
|
+
sfmcGuideUrl: 'https://sfmc.guide/engagement/ampscript/functions/mod/',
|
|
3610
4291
|
minArgs: 2,
|
|
3611
4292
|
maxArgs: 2,
|
|
3612
4293
|
category: 'Math',
|
|
@@ -3636,6 +4317,11 @@ export const FUNCTIONS = [
|
|
|
3636
4317
|
category: 'MobileConnect',
|
|
3637
4318
|
description:
|
|
3638
4319
|
'Returns the content of an inbound mobile-originated (MO) message. Only usable in MobileConnect. The only accepted argument value is 0.',
|
|
4320
|
+
isConfirmed: false,
|
|
4321
|
+
verificationBlocked: true,
|
|
4322
|
+
verificationBlockedReason: 'no-working-invocation',
|
|
4323
|
+
officialDocsNote:
|
|
4324
|
+
'Could not runtime-verify on the only available context (a CloudPage GET on cred/DEV, MID 510007949; no parent-BU escalation is configured on this tenant). A page containing a Msg(0) call aborted at compile time (HTTP 422) even when the call sat inside a non-matching IF branch, whereas the same page with no Msg construct rendered HTTP 200 — so the abort happens at parse time, before any runtime gate. This matches the official reference, which states the function is usable only in MobileConnect and not in landing pages or other content types; a CloudPage supplies no mobile-originated message to read.',
|
|
3639
4325
|
params: [
|
|
3640
4326
|
{
|
|
3641
4327
|
name: 'index',
|
|
@@ -3652,9 +4338,11 @@ export const FUNCTIONS = [
|
|
|
3652
4338
|
name: 'Multiply',
|
|
3653
4339
|
mcnSince: 67,
|
|
3654
4340
|
handlebarsEquivalent: 'multiply',
|
|
4341
|
+
handlebarsExact: true,
|
|
3655
4342
|
mcnNotes: null,
|
|
3656
4343
|
docUrl: 'https://developer.salesforce.com/docs/marketing/marketing-cloud-ampscript/references/mc-ampscript-math/mc-ampscript-reference-math-multiply.html',
|
|
3657
4344
|
guideUrl: 'https://ampscript.guide/multiply/',
|
|
4345
|
+
sfmcGuideUrl: 'https://sfmc.guide/engagement/ampscript/functions/multiply/',
|
|
3658
4346
|
minArgs: 2,
|
|
3659
4347
|
maxArgs: 2,
|
|
3660
4348
|
category: 'Math',
|
|
@@ -3682,6 +4370,11 @@ export const FUNCTIONS = [
|
|
|
3682
4370
|
category: 'MobileConnect',
|
|
3683
4371
|
description:
|
|
3684
4372
|
'Returns a single word that follows the keyword in an inbound mobile-originated (MO) message, by position. Only usable in MobileConnect, chained off Msg(0).',
|
|
4373
|
+
isConfirmed: false,
|
|
4374
|
+
verificationBlocked: true,
|
|
4375
|
+
verificationBlockedReason: 'no-working-invocation',
|
|
4376
|
+
officialDocsNote:
|
|
4377
|
+
'Could not runtime-verify on the only available context (a CloudPage GET on cred/DEV, MID 510007949; no parent-BU escalation on this tenant). Noun is chained off Msg(0), and any page containing a Msg(0) construct aborts at compile time (HTTP 422) on a CloudPage while an otherwise identical page without it renders HTTP 200. This matches the official reference, which restricts the function to MobileConnect and forbids landing pages / other content types; a CloudPage supplies no mobile-originated message to parse.',
|
|
3685
4378
|
params: [
|
|
3686
4379
|
{
|
|
3687
4380
|
name: 'position',
|
|
@@ -3707,6 +4400,11 @@ export const FUNCTIONS = [
|
|
|
3707
4400
|
category: 'MobileConnect',
|
|
3708
4401
|
description:
|
|
3709
4402
|
'Returns all message content that follows the keyword in an inbound mobile-originated (MO) message. Only usable in MobileConnect, chained off Msg(0). Takes no arguments.',
|
|
4403
|
+
isConfirmed: false,
|
|
4404
|
+
verificationBlocked: true,
|
|
4405
|
+
verificationBlockedReason: 'no-working-invocation',
|
|
4406
|
+
officialDocsNote:
|
|
4407
|
+
'Could not runtime-verify on the only available context (a CloudPage GET on cred/DEV, MID 510007949; no parent-BU escalation on this tenant). Nouns is chained off Msg(0), and any page containing a Msg(0) construct aborts at compile time (HTTP 422) on a CloudPage while an otherwise identical page without it renders HTTP 200. This matches the official reference, which restricts the function to MobileConnect and forbids landing pages / other content types; a CloudPage supplies no mobile-originated message to parse.',
|
|
3710
4408
|
params: [],
|
|
3711
4409
|
returnType: 'string',
|
|
3712
4410
|
returnDescription: 'All content that follows the keyword in the inbound message.',
|
|
@@ -3717,26 +4415,32 @@ export const FUNCTIONS = [
|
|
|
3717
4415
|
name: 'Now',
|
|
3718
4416
|
mcnSince: 67,
|
|
3719
4417
|
handlebarsEquivalent: 'now',
|
|
4418
|
+
handlebarsExact: false,
|
|
3720
4419
|
mcnNotes: null,
|
|
3721
4420
|
docUrl: 'https://developer.salesforce.com/docs/marketing/marketing-cloud-ampscript/references/mc-ampscript-date-time/mc-ampscript-reference-date-time-now.html',
|
|
3722
4421
|
guideUrl: 'https://ampscript.guide/now/',
|
|
4422
|
+
sfmcGuideUrl: 'https://sfmc.guide/engagement/ampscript/functions/now/',
|
|
3723
4423
|
minArgs: 0,
|
|
3724
4424
|
maxArgs: 1,
|
|
3725
4425
|
category: 'Date and Time',
|
|
3726
4426
|
description:
|
|
3727
|
-
'Returns the current system date and time
|
|
4427
|
+
'Returns the current system date and time in Central Standard Time, with no daylight-saving adjustment. Every call within one render returns the same instant.',
|
|
4428
|
+
isConfirmed: true,
|
|
4429
|
+
differsFromOfficialDocs: false,
|
|
3728
4430
|
params: [
|
|
3729
4431
|
{
|
|
3730
4432
|
name: 'persistFormat',
|
|
3731
4433
|
mcnSince: null,
|
|
3732
4434
|
mcnNotes: null,
|
|
3733
|
-
description:
|
|
3734
|
-
|
|
4435
|
+
description:
|
|
4436
|
+
'In a send context, a true value returns the send job start or publish time instead of the current time; on a CloudPage it makes no difference. Accepts 1/0, true/false, or those spellings quoted',
|
|
4437
|
+
type: 'string|boolean|number',
|
|
3735
4438
|
optional: true,
|
|
3736
4439
|
},
|
|
3737
4440
|
],
|
|
3738
4441
|
returnType: 'date',
|
|
3739
|
-
returnDescription:
|
|
4442
|
+
returnDescription:
|
|
4443
|
+
'The system date and time, as a date value that the other date functions accept directly.',
|
|
3740
4444
|
syntax: 'Now([persistFormat])',
|
|
3741
4445
|
example: '%%=Now()=%%',
|
|
3742
4446
|
},
|
|
@@ -3747,16 +4451,28 @@ export const FUNCTIONS = [
|
|
|
3747
4451
|
mcnNotes: null,
|
|
3748
4452
|
docUrl: 'https://developer.salesforce.com/docs/marketing/marketing-cloud-ampscript/references/mc-ampscript-utilities/mc-ampscript-reference-utilities-output.html',
|
|
3749
4453
|
guideUrl: 'https://ampscript.guide/output/',
|
|
3750
|
-
|
|
3751
|
-
|
|
4454
|
+
sfmcGuideUrl: 'https://sfmc.guide/engagement/ampscript/functions/output/',
|
|
4455
|
+
minArgs: 0,
|
|
4456
|
+
maxArgs: Infinity,
|
|
3752
4457
|
category: 'Utility',
|
|
3753
4458
|
description:
|
|
3754
|
-
'Writes a
|
|
3755
|
-
params: [
|
|
4459
|
+
'Writes the result of a nested function call into the rendered content. A string literal, a bare variable or a number renders nothing at all, without raising an error.',
|
|
4460
|
+
params: [
|
|
4461
|
+
{
|
|
4462
|
+
name: 'content',
|
|
4463
|
+
description:
|
|
4464
|
+
'Function call whose result is written; a literal or bare variable renders nothing',
|
|
4465
|
+
},
|
|
4466
|
+
],
|
|
3756
4467
|
returnType: 'void',
|
|
3757
|
-
returnDescription:
|
|
4468
|
+
returnDescription:
|
|
4469
|
+
'No value is returned, so the call cannot be nested inside another function; the result is written straight into the rendered content.',
|
|
3758
4470
|
syntax: 'Output(content)',
|
|
3759
4471
|
example: "%%=Output(Concat('Hello ', @firstName))=%%",
|
|
4472
|
+
isConfirmed: true,
|
|
4473
|
+
differsFromOfficialDocs: true,
|
|
4474
|
+
officialDocsNote:
|
|
4475
|
+
'The official reference states that a value which is not a function call, such as a string literal, makes the function return an error. On a live Engagement CloudPage on the child business unit (MID 518005426) a literal argument, a bare variable and a bare number each rendered nothing at all while the page still returned HTTP 200 and every surrounding marker printed, so no error surfaced anywhere. The same page also accepted zero arguments and up to three arguments, writing each one in turn.',
|
|
3760
4476
|
},
|
|
3761
4477
|
{
|
|
3762
4478
|
name: 'OutputLine',
|
|
@@ -3765,31 +4481,49 @@ export const FUNCTIONS = [
|
|
|
3765
4481
|
mcnNotes: null,
|
|
3766
4482
|
docUrl: 'https://developer.salesforce.com/docs/marketing/marketing-cloud-ampscript/references/mc-ampscript-utilities/mc-ampscript-reference-utilities-output-line.html',
|
|
3767
4483
|
guideUrl: 'https://ampscript.guide/outputline/',
|
|
3768
|
-
|
|
3769
|
-
|
|
4484
|
+
sfmcGuideUrl: 'https://sfmc.guide/engagement/ampscript/functions/outputline/',
|
|
4485
|
+
minArgs: 0,
|
|
4486
|
+
maxArgs: Infinity,
|
|
3770
4487
|
category: 'Utility',
|
|
3771
|
-
description:
|
|
3772
|
-
|
|
4488
|
+
description:
|
|
4489
|
+
'Writes the result of a nested function call into the rendered content, followed by a carriage return and line feed. A string literal, a bare variable or a number renders only the line break. The break is not an HTML line break, so an HTML view keeps everything on one line unless the content sits inside a preformatted element.',
|
|
4490
|
+
params: [
|
|
4491
|
+
{
|
|
4492
|
+
name: 'content',
|
|
4493
|
+
description:
|
|
4494
|
+
'Function call whose result is written; a literal or bare variable renders only the line break',
|
|
4495
|
+
},
|
|
4496
|
+
],
|
|
3773
4497
|
returnType: 'void',
|
|
3774
|
-
returnDescription:
|
|
4498
|
+
returnDescription:
|
|
4499
|
+
'No value is returned, so the call cannot be nested inside another function; the result and a carriage return plus line feed are written straight into the rendered content.',
|
|
3775
4500
|
syntax: 'OutputLine(content)',
|
|
3776
4501
|
example: "%%=OutputLine(Concat('Hello ', @firstName))=%%",
|
|
4502
|
+
isConfirmed: true,
|
|
4503
|
+
differsFromOfficialDocs: false,
|
|
3777
4504
|
},
|
|
3778
4505
|
{
|
|
3779
4506
|
name: 'ProperCase',
|
|
3780
4507
|
mcnSince: 67,
|
|
3781
4508
|
handlebarsEquivalent: 'properCase',
|
|
4509
|
+
handlebarsExact: true,
|
|
3782
4510
|
mcnNotes: null,
|
|
3783
4511
|
docUrl: 'https://developer.salesforce.com/docs/marketing/marketing-cloud-ampscript/references/mc-ampscript-string/mc-ampscript-reference-string-propercase.html',
|
|
3784
4512
|
guideUrl: 'https://ampscript.guide/propercase/',
|
|
4513
|
+
sfmcGuideUrl: 'https://sfmc.guide/engagement/ampscript/functions/propercase/',
|
|
3785
4514
|
minArgs: 1,
|
|
3786
4515
|
maxArgs: 1,
|
|
4516
|
+
isConfirmed: true,
|
|
4517
|
+
differsFromOfficialDocs: false,
|
|
3787
4518
|
category: 'String',
|
|
3788
4519
|
description:
|
|
3789
|
-
'Converts a
|
|
3790
|
-
params: [
|
|
4520
|
+
'Converts a value to proper (title) case. Every letter after the first of a word is forced to lower case, so existing internal capitals are lost.',
|
|
4521
|
+
params: [
|
|
4522
|
+
{ name: 'sourceString', description: 'Value to convert', type: 'string|number|date' },
|
|
4523
|
+
],
|
|
3791
4524
|
returnType: 'string',
|
|
3792
|
-
returnDescription:
|
|
4525
|
+
returnDescription:
|
|
4526
|
+
'The value with the first letter of each word capitalized and the rest lower-cased.',
|
|
3793
4527
|
syntax: 'ProperCase(sourceString)',
|
|
3794
4528
|
example: "%%=ProperCase('hello world')=%%",
|
|
3795
4529
|
},
|
|
@@ -3800,29 +4534,40 @@ export const FUNCTIONS = [
|
|
|
3800
4534
|
mcnNotes: null,
|
|
3801
4535
|
docUrl: 'https://developer.salesforce.com/docs/marketing/marketing-cloud-ampscript/references/mc-ampscript-sites/mc-ampscript-reference-sites-query-parameter.html',
|
|
3802
4536
|
guideUrl: 'https://ampscript.guide/queryparameter/',
|
|
4537
|
+
sfmcGuideUrl: 'https://sfmc.guide/engagement/ampscript/functions/queryparameter/',
|
|
3803
4538
|
minArgs: 1,
|
|
3804
4539
|
maxArgs: 1,
|
|
3805
4540
|
category: 'Utility',
|
|
3806
4541
|
description:
|
|
3807
|
-
'Returns the value of a URL query string parameter from the current page request.',
|
|
3808
|
-
params: [
|
|
4542
|
+
'Returns the value of a URL query string parameter from the current page request. The name is matched without regard to case, percent-encoded characters arrive decoded, and a name supplied more than once yields the values joined by a comma.',
|
|
4543
|
+
params: [
|
|
4544
|
+
{
|
|
4545
|
+
name: 'parameterName',
|
|
4546
|
+
description: 'Query parameter name, matched without regard to case',
|
|
4547
|
+
type: 'string',
|
|
4548
|
+
},
|
|
4549
|
+
],
|
|
3809
4550
|
returnType: 'string',
|
|
3810
|
-
returnDescription:
|
|
4551
|
+
returnDescription:
|
|
4552
|
+
'The decoded value of the named query-string parameter, or an empty string when the request carries no such parameter. The value is returned exactly as supplied, so escape it before rendering it into markup.',
|
|
3811
4553
|
syntax: 'QueryParameter(parameterName)',
|
|
3812
4554
|
example: "%%=QueryParameter('utm_source')=%%",
|
|
4555
|
+
isConfirmed: true,
|
|
3813
4556
|
},
|
|
3814
4557
|
{
|
|
3815
4558
|
name: 'RaiseError',
|
|
3816
4559
|
mcnSince: 67,
|
|
3817
4560
|
handlebarsEquivalent: 'raiseError',
|
|
4561
|
+
handlebarsExact: false,
|
|
3818
4562
|
mcnNotes: null,
|
|
3819
4563
|
docUrl: 'https://developer.salesforce.com/docs/marketing/marketing-cloud-ampscript/references/mc-ampscript-utilities/mc-ampscript-reference-utilities-raise-error.html',
|
|
3820
4564
|
guideUrl: 'https://ampscript.guide/raiseerror/',
|
|
4565
|
+
sfmcGuideUrl: 'https://sfmc.guide/engagement/ampscript/functions/raiseerror/',
|
|
3821
4566
|
minArgs: 1,
|
|
3822
4567
|
maxArgs: 5,
|
|
3823
4568
|
category: 'Utility',
|
|
3824
4569
|
description:
|
|
3825
|
-
'Raises a runtime error, optionally skipping the current subscriber or returning an API error.',
|
|
4570
|
+
'Raises a runtime error, optionally skipping the current subscriber or returning an API error. Outside a send it is not a graceful abort: on a landing page it discards everything already written and answers the same generic failure any other aborting call gives, with the message nowhere in the response.',
|
|
3826
4571
|
params: [
|
|
3827
4572
|
{ name: 'message', description: 'Error message', type: 'string' },
|
|
3828
4573
|
{
|
|
@@ -3831,7 +4576,7 @@ export const FUNCTIONS = [
|
|
|
3831
4576
|
mcnNotes: null,
|
|
3832
4577
|
description:
|
|
3833
4578
|
'If true, the function skips only the subscriber for which the error was raised, and proceeds with the rest of the email job. If false, the function stops the entire email job when an error is raised. The default value is false.',
|
|
3834
|
-
type: 'boolean',
|
|
4579
|
+
type: 'string|boolean|number',
|
|
3835
4580
|
optional: true,
|
|
3836
4581
|
},
|
|
3837
4582
|
{
|
|
@@ -3861,17 +4606,22 @@ export const FUNCTIONS = [
|
|
|
3861
4606
|
},
|
|
3862
4607
|
],
|
|
3863
4608
|
returnType: 'void',
|
|
3864
|
-
returnDescription:
|
|
4609
|
+
returnDescription:
|
|
4610
|
+
'No value is returned; processing is halted. On a landing page the whole request is abandoned and the response body is a fixed failure notice rather than the supplied message.',
|
|
3865
4611
|
syntax: 'RaiseError(message[, skipSubscriber, apiErrorCode, apiErrorNumber, preserveDataExt])',
|
|
3866
4612
|
example: "RaiseError('Missing required field', 0)",
|
|
4613
|
+
isConfirmed: true,
|
|
4614
|
+
differsFromOfficialDocs: false,
|
|
3867
4615
|
},
|
|
3868
4616
|
{
|
|
3869
4617
|
name: 'Random',
|
|
3870
4618
|
mcnSince: 67,
|
|
3871
4619
|
handlebarsEquivalent: 'random',
|
|
4620
|
+
handlebarsExact: true,
|
|
3872
4621
|
mcnNotes: null,
|
|
3873
4622
|
docUrl: 'https://developer.salesforce.com/docs/marketing/marketing-cloud-ampscript/references/mc-ampscript-utilities/mc-ampscript-reference-utilities-random.html',
|
|
3874
4623
|
guideUrl: 'https://ampscript.guide/random/',
|
|
4624
|
+
sfmcGuideUrl: 'https://sfmc.guide/engagement/ampscript/functions/random/',
|
|
3875
4625
|
minArgs: 2,
|
|
3876
4626
|
maxArgs: 2,
|
|
3877
4627
|
category: 'Math',
|
|
@@ -3909,6 +4659,11 @@ export const FUNCTIONS = [
|
|
|
3909
4659
|
returnDescription: 'An HTML string of star images representing the rating.',
|
|
3910
4660
|
syntax: 'RatingStars(rating, maxRating, imageUrl)',
|
|
3911
4661
|
example: "%%=RatingStars(4, 5, 'https://example.com/star.png')=%%",
|
|
4662
|
+
isConfirmed: false,
|
|
4663
|
+
verificationBlocked: true,
|
|
4664
|
+
verificationBlockedReason: 'no-test-data',
|
|
4665
|
+
officialDocsNote:
|
|
4666
|
+
'No working CloudPage invocation was found. Any valid-arity call aborts the whole page with HTTP 422 at compile time, even when placed inside an unreached IF gate, so it cannot be probed behind a query-string switch. Two signature shapes were each deployed as the whole page: the catalog form RatingStars(4, 5, "https://example.com/star.png") and the ampscript.guide form RatingStars(5, "yellow", 25). Both returned HTTP 422 on the child BU (MID 518005426) and again on the parent BU (MID 7281698). The surrounding harness structure (RequestParameter gating, IF/ELSE/ENDIF) returned HTTP 200 once the RatingStars call was removed, confirming the abort is caused by the function itself, not the harness. RatingStars is an Einstein Email Recommendations helper that appears to resolve only inside the recommendations rendering context, which a bare CloudPage does not supply.',
|
|
3912
4667
|
},
|
|
3913
4668
|
{
|
|
3914
4669
|
name: 'Redirect',
|
|
@@ -3917,15 +4672,20 @@ export const FUNCTIONS = [
|
|
|
3917
4672
|
mcnNotes: null,
|
|
3918
4673
|
docUrl: 'https://developer.salesforce.com/docs/marketing/marketing-cloud-ampscript/references/mc-ampscript-sites/mc-ampscript-reference-sites-redirect.html',
|
|
3919
4674
|
guideUrl: 'https://ampscript.guide/redirect/',
|
|
4675
|
+
sfmcGuideUrl: 'https://sfmc.guide/engagement/ampscript/functions/redirect/',
|
|
3920
4676
|
minArgs: 1,
|
|
3921
4677
|
maxArgs: 1,
|
|
3922
4678
|
category: 'Utility',
|
|
3923
|
-
description:
|
|
3924
|
-
|
|
4679
|
+
description:
|
|
4680
|
+
'Performs an HTTP redirect to the specified URL. Landing pages only. The response is a 302 whose Location is the supplied value verbatim, and everything written before the call is discarded along with the page body. Not to be confused with RedirectTo, which emits no redirect at all.',
|
|
4681
|
+
params: [{ name: 'url', description: 'Target URL', type: 'string|number' }],
|
|
3925
4682
|
returnType: 'void',
|
|
3926
|
-
returnDescription:
|
|
4683
|
+
returnDescription:
|
|
4684
|
+
'No value is returned; the request answers 302 and the supplied value becomes the Location header unchanged, even when it is not an absolute URL.',
|
|
3927
4685
|
syntax: 'Redirect(url)',
|
|
3928
4686
|
example: "Redirect('https://example.com')",
|
|
4687
|
+
isConfirmed: true,
|
|
4688
|
+
differsFromOfficialDocs: false,
|
|
3929
4689
|
},
|
|
3930
4690
|
{
|
|
3931
4691
|
name: 'RedirectTo',
|
|
@@ -3937,10 +4697,15 @@ export const FUNCTIONS = [
|
|
|
3937
4697
|
minArgs: 1,
|
|
3938
4698
|
maxArgs: 1,
|
|
3939
4699
|
category: 'Utility',
|
|
3940
|
-
description:
|
|
3941
|
-
|
|
4700
|
+
description:
|
|
4701
|
+
'Marks a URL held in a variable or field as a tracked email link. It never redirects the current request and never halts the script; outside a tracked send it hands the value straight back.',
|
|
4702
|
+
isConfirmed: true,
|
|
4703
|
+
differsFromOfficialDocs: false,
|
|
4704
|
+
sfmcGuideUrl: 'https://sfmc.guide/engagement/ampscript/functions/redirectto/',
|
|
4705
|
+
params: [{ name: 'url', description: 'Target URL', type: 'string|number' }],
|
|
3942
4706
|
returnType: 'string',
|
|
3943
|
-
returnDescription:
|
|
4707
|
+
returnDescription:
|
|
4708
|
+
'The link-tracking target for the supplied address during a tracked send; on a CloudPage the supplied value unchanged.',
|
|
3944
4709
|
syntax: 'RedirectTo(url)',
|
|
3945
4710
|
example: '%%=RedirectTo(@targetUrl)=%%',
|
|
3946
4711
|
},
|
|
@@ -3951,13 +4716,20 @@ export const FUNCTIONS = [
|
|
|
3951
4716
|
mcnNotes: null,
|
|
3952
4717
|
docUrl: 'https://developer.salesforce.com/docs/marketing/marketing-cloud-ampscript/references/mc-ampscript-string/mc-ampscript-reference-string-regex-match.html',
|
|
3953
4718
|
guideUrl: 'https://ampscript.guide/regexmatch/',
|
|
4719
|
+
sfmcGuideUrl: 'https://sfmc.guide/engagement/ampscript/functions/regexmatch/',
|
|
4720
|
+
isConfirmed: true,
|
|
4721
|
+
differsFromOfficialDocs: false,
|
|
3954
4722
|
minArgs: 3,
|
|
3955
|
-
maxArgs:
|
|
4723
|
+
maxArgs: Infinity,
|
|
3956
4724
|
category: 'String',
|
|
3957
4725
|
description:
|
|
3958
|
-
'
|
|
4726
|
+
'Returns the first occurrence of a regular expression match in a string, selected by capture group. Matching is case-sensitive unless the IgnoreCase option is passed.',
|
|
3959
4727
|
params: [
|
|
3960
|
-
{
|
|
4728
|
+
{
|
|
4729
|
+
name: 'sourceString',
|
|
4730
|
+
description: 'String to match against',
|
|
4731
|
+
type: 'string|number',
|
|
4732
|
+
},
|
|
3961
4733
|
{
|
|
3962
4734
|
name: 'regExPattern',
|
|
3963
4735
|
description: 'The regular expression to use in the search',
|
|
@@ -3965,20 +4737,28 @@ export const FUNCTIONS = [
|
|
|
3965
4737
|
},
|
|
3966
4738
|
{
|
|
3967
4739
|
name: 'returnValue',
|
|
3968
|
-
description:
|
|
3969
|
-
|
|
4740
|
+
description:
|
|
4741
|
+
'Index or name of the capture group to return; 0 returns the whole match',
|
|
4742
|
+
type: 'string|number',
|
|
3970
4743
|
},
|
|
3971
4744
|
{
|
|
3972
4745
|
name: 'regExOptions',
|
|
3973
4746
|
description:
|
|
3974
|
-
'A .NET RegexOptions
|
|
4747
|
+
'A .NET RegexOptions member name to apply to the search, such as IgnoreCase or Multiline',
|
|
4748
|
+
type: 'string',
|
|
4749
|
+
optional: true,
|
|
4750
|
+
},
|
|
4751
|
+
{
|
|
4752
|
+
name: 'regExOptionsN',
|
|
4753
|
+
description: 'Additional RegexOptions member name',
|
|
3975
4754
|
type: 'string',
|
|
3976
4755
|
optional: true,
|
|
3977
4756
|
},
|
|
3978
4757
|
],
|
|
3979
4758
|
returnType: 'string',
|
|
3980
|
-
returnDescription:
|
|
3981
|
-
|
|
4759
|
+
returnDescription:
|
|
4760
|
+
'The text of the selected capture group, or an empty string when the pattern does not match or the group does not exist.',
|
|
4761
|
+
syntax: 'RegExMatch(sourceString, regExPattern, returnValue[, regExOptions, ...])',
|
|
3982
4762
|
example:
|
|
3983
4763
|
'Var @couponCode, @regEx, @regExMatch\n' +
|
|
3984
4764
|
'Set @couponCode = "SAVE23"\n' +
|
|
@@ -3989,21 +4769,32 @@ export const FUNCTIONS = [
|
|
|
3989
4769
|
name: 'Replace',
|
|
3990
4770
|
mcnSince: 67,
|
|
3991
4771
|
handlebarsEquivalent: 'replace',
|
|
4772
|
+
handlebarsExact: false,
|
|
3992
4773
|
mcnNotes: null,
|
|
3993
4774
|
docUrl: 'https://developer.salesforce.com/docs/marketing/marketing-cloud-ampscript/references/mc-ampscript-string/mc-ampscript-reference-string-replace.html',
|
|
3994
4775
|
guideUrl: 'https://ampscript.guide/replace/',
|
|
3995
|
-
|
|
4776
|
+
sfmcGuideUrl: 'https://sfmc.guide/engagement/ampscript/functions/replace/',
|
|
4777
|
+
isConfirmed: true,
|
|
4778
|
+
differsFromOfficialDocs: false,
|
|
4779
|
+
minArgs: 2,
|
|
3996
4780
|
maxArgs: 3,
|
|
3997
4781
|
category: 'String',
|
|
3998
|
-
description:
|
|
4782
|
+
description:
|
|
4783
|
+
'Replaces all occurrences of a substring with a new value, matching case-insensitively. The source is scanned once, so text formed by a replacement is not replaced again.',
|
|
3999
4784
|
params: [
|
|
4000
|
-
{ name: 'sourceString', description: 'Source string', type: 'string' },
|
|
4001
|
-
{ name: 'searchSubstring', description: 'Substring to find', type: 'string' },
|
|
4002
|
-
{
|
|
4785
|
+
{ name: 'sourceString', description: 'Source string', type: 'string|number' },
|
|
4786
|
+
{ name: 'searchSubstring', description: 'Substring to find', type: 'string|number' },
|
|
4787
|
+
{
|
|
4788
|
+
name: 'replacementSubstring',
|
|
4789
|
+
description: 'Replacement string. If omitted, the search text is removed.',
|
|
4790
|
+
type: 'string|number',
|
|
4791
|
+
optional: true,
|
|
4792
|
+
},
|
|
4003
4793
|
],
|
|
4004
4794
|
returnType: 'string',
|
|
4005
|
-
returnDescription:
|
|
4006
|
-
|
|
4795
|
+
returnDescription:
|
|
4796
|
+
'The string with every occurrence of the search text replaced, or the source unchanged when the search text is not found.',
|
|
4797
|
+
syntax: 'Replace(sourceString, searchSubstring[, replacementSubstring])',
|
|
4007
4798
|
example: "%%=Replace('Hello World', 'World', 'There')=%%",
|
|
4008
4799
|
},
|
|
4009
4800
|
{
|
|
@@ -4016,24 +4807,28 @@ export const FUNCTIONS = [
|
|
|
4016
4807
|
minArgs: 3,
|
|
4017
4808
|
maxArgs: INF,
|
|
4018
4809
|
category: 'String',
|
|
4019
|
-
description:
|
|
4810
|
+
description:
|
|
4811
|
+
'Replaces every occurrence of each supplied search value with one common replacement value, matching case-insensitively. The search values are applied one after another in the order given, so text produced by an earlier replacement can still be matched by a later one.',
|
|
4020
4812
|
params: [
|
|
4021
|
-
{ name: 'sourceString', description: 'Source string', type: 'string' },
|
|
4022
|
-
{ name: 'replacementString', description: 'Replacement string', type: 'string' },
|
|
4023
|
-
{ name: 'searchString1', description: 'First value to replace', type: 'string' },
|
|
4813
|
+
{ name: 'sourceString', description: 'Source string', type: 'string|number' },
|
|
4814
|
+
{ name: 'replacementString', description: 'Replacement string', type: 'string|number' },
|
|
4815
|
+
{ name: 'searchString1', description: 'First value to replace', type: 'string|number' },
|
|
4024
4816
|
{
|
|
4025
4817
|
name: 'searchStringN',
|
|
4026
4818
|
description: 'Additional value to replace',
|
|
4027
|
-
type: 'string',
|
|
4819
|
+
type: 'string|number',
|
|
4028
4820
|
optional: true,
|
|
4029
4821
|
},
|
|
4030
4822
|
],
|
|
4031
4823
|
returnType: 'string',
|
|
4032
4824
|
returnDescription:
|
|
4033
|
-
'The string with every supplied search value replaced by the replacement.',
|
|
4825
|
+
'The string with every supplied search value replaced by the replacement, or the source unchanged when none of them is found.',
|
|
4034
4826
|
repeat: [{ startIndex: 2, groupSize: 1, minGroups: 1 }],
|
|
4035
4827
|
syntax: 'ReplaceList(sourceString, replacementString, searchString1[, searchStringN, ...])',
|
|
4036
4828
|
example: "%%=ReplaceList('a-b/c', '_', '-', '/')=%%",
|
|
4829
|
+
isConfirmed: true,
|
|
4830
|
+
differsFromOfficialDocs: false,
|
|
4831
|
+
sfmcGuideUrl: 'https://sfmc.guide/engagement/ampscript/functions/replacelist/',
|
|
4037
4832
|
},
|
|
4038
4833
|
{
|
|
4039
4834
|
name: 'RequestParameter',
|
|
@@ -4042,16 +4837,25 @@ export const FUNCTIONS = [
|
|
|
4042
4837
|
mcnNotes: null,
|
|
4043
4838
|
docUrl: 'https://developer.salesforce.com/docs/marketing/marketing-cloud-ampscript/references/mc-ampscript-sites/mc-ampscript-reference-sites-request-parameter.html',
|
|
4044
4839
|
guideUrl: 'https://ampscript.guide/requestparameter/',
|
|
4840
|
+
sfmcGuideUrl: 'https://sfmc.guide/engagement/ampscript/functions/requestparameter/',
|
|
4045
4841
|
minArgs: 1,
|
|
4046
4842
|
maxArgs: 1,
|
|
4047
4843
|
category: 'Utility',
|
|
4048
4844
|
description:
|
|
4049
|
-
'Returns the value of a form post or query string parameter from the current request.',
|
|
4050
|
-
params: [
|
|
4845
|
+
'Returns the value of a form post or query string parameter from the current request. The name is matched without regard to case, percent-encoded characters arrive decoded, and a name supplied more than once yields the values joined by a comma.',
|
|
4846
|
+
params: [
|
|
4847
|
+
{
|
|
4848
|
+
name: 'parameterName',
|
|
4849
|
+
description: 'Parameter name, matched without regard to case',
|
|
4850
|
+
type: 'string',
|
|
4851
|
+
},
|
|
4852
|
+
],
|
|
4051
4853
|
returnType: 'string',
|
|
4052
|
-
returnDescription:
|
|
4854
|
+
returnDescription:
|
|
4855
|
+
'The decoded value of the named request parameter, or an empty string when the request carries no such parameter. The value is returned exactly as supplied, so escape it before rendering it into markup.',
|
|
4053
4856
|
syntax: 'RequestParameter(parameterName)',
|
|
4054
4857
|
example: "%%=RequestParameter('id')=%%",
|
|
4858
|
+
isConfirmed: true,
|
|
4055
4859
|
},
|
|
4056
4860
|
{
|
|
4057
4861
|
name: 'RetrieveMSCRMRecords',
|
|
@@ -4095,6 +4899,11 @@ export const FUNCTIONS = [
|
|
|
4095
4899
|
syntax: 'RetrieveMSCRMRecords(entityName, fieldsToRetrieve, queryFieldName, queryFieldOperator, queryFieldValue)',
|
|
4096
4900
|
example:
|
|
4097
4901
|
"%%[ SET @rows = RetrieveMSCRMRecords('contact', 'fullname,emailaddress1', 'lastname', 'eq', 'Smith') ]%%",
|
|
4902
|
+
isConfirmed: true,
|
|
4903
|
+
nonFunctionalAtRuntime: true,
|
|
4904
|
+
deprecated: true,
|
|
4905
|
+
deprecatedReason:
|
|
4906
|
+
'The Marketing Cloud Connector for Microsoft Dynamics CRM was retired (online integration in December 2020, on-premises in October 2021), so the Dynamics CRM AMPscript functions no longer have a live integration to call and are non-functional. No replacement AMPscript function exists; integrate Dynamics data through the SFTP import/export or a custom API instead.',
|
|
4098
4907
|
},
|
|
4099
4908
|
{
|
|
4100
4909
|
name: 'RetrieveMSCRMRecordsFetchXML',
|
|
@@ -4112,6 +4921,11 @@ export const FUNCTIONS = [
|
|
|
4112
4921
|
returnDescription: 'A rowset of CRM records matching the FetchXML query.',
|
|
4113
4922
|
syntax: 'RetrieveMSCRMRecordsFetchXML(fetchXml)',
|
|
4114
4923
|
example: '%%[ SET @rows = RetrieveMSCRMRecordsFetchXML(@fetchXml) ]%%',
|
|
4924
|
+
isConfirmed: true,
|
|
4925
|
+
nonFunctionalAtRuntime: true,
|
|
4926
|
+
deprecated: true,
|
|
4927
|
+
deprecatedReason:
|
|
4928
|
+
'The Marketing Cloud Connector for Microsoft Dynamics CRM was retired (online integration in December 2020, on-premises in October 2021), so the Dynamics CRM AMPscript functions no longer have a live integration to call and are non-functional. No replacement AMPscript function exists; integrate Dynamics data through the SFTP import/export or a custom API instead.',
|
|
4115
4929
|
},
|
|
4116
4930
|
{
|
|
4117
4931
|
name: 'RetrieveSalesforceJobSources',
|
|
@@ -4120,27 +4934,45 @@ export const FUNCTIONS = [
|
|
|
4120
4934
|
mcnNotes: null,
|
|
4121
4935
|
docUrl: 'https://developer.salesforce.com/docs/marketing/marketing-cloud-ampscript/references/mc-ampscript-salesforce/mc-ampscript-reference-salesforce-retrieve-job-sources.html',
|
|
4122
4936
|
guideUrl: 'https://ampscript.guide/retrievesalesforcejobsources/',
|
|
4937
|
+
sfmcGuideUrl:
|
|
4938
|
+
'https://sfmc.guide/engagement/ampscript/functions/retrievesalesforcejobsources/',
|
|
4939
|
+
isConfirmed: true,
|
|
4940
|
+
differsFromOfficialDocs: false,
|
|
4123
4941
|
minArgs: 1,
|
|
4124
4942
|
maxArgs: 1,
|
|
4125
4943
|
category: 'Sales and Service Cloud',
|
|
4126
|
-
description:
|
|
4127
|
-
|
|
4944
|
+
description:
|
|
4945
|
+
'Retrieves the source records (SourceID, SourceType, IsInclusionSource) that made up the audience of a Salesforce-triggered send, matched by its numeric job ID, and returns them as a rowset. Requires an active Marketing Cloud Connect integration. A job ID with no matching sources returns an empty rowset rather than an error; the function reports nothing about the job status.',
|
|
4946
|
+
params: [
|
|
4947
|
+
{
|
|
4948
|
+
name: 'jobId',
|
|
4949
|
+
description: 'The numeric job ID of the Salesforce send',
|
|
4950
|
+
type: 'number',
|
|
4951
|
+
},
|
|
4952
|
+
],
|
|
4128
4953
|
returnType: 'rowset',
|
|
4129
|
-
returnDescription:
|
|
4954
|
+
returnDescription:
|
|
4955
|
+
'A rowset of the send sources (SourceID, SourceType, IsInclusionSource); an empty rowset when the job ID has no matching sources.',
|
|
4130
4956
|
syntax: 'RetrieveSalesforceJobSources(jobId)',
|
|
4131
4957
|
example: '%%[ SET @rows = RetrieveSalesforceJobSources(@jobId) ]%%',
|
|
4132
4958
|
},
|
|
4133
4959
|
{
|
|
4134
4960
|
name: 'RetrieveSalesforceObjects',
|
|
4135
4961
|
mcnSince: 67,
|
|
4136
|
-
handlebarsEquivalent:
|
|
4962
|
+
handlebarsEquivalent: 'query',
|
|
4963
|
+
handlebarsExact: false,
|
|
4137
4964
|
mcnNotes: null,
|
|
4138
4965
|
docUrl: 'https://developer.salesforce.com/docs/marketing/marketing-cloud-ampscript/references/mc-ampscript-salesforce/mc-ampscript-reference-salesforce-retrieve-objects.html',
|
|
4139
4966
|
guideUrl: 'https://ampscript.guide/retrievesalesforceobjects/',
|
|
4967
|
+
sfmcGuideUrl:
|
|
4968
|
+
'https://sfmc.guide/engagement/ampscript/functions/retrievesalesforceobjects/',
|
|
4969
|
+
isConfirmed: true,
|
|
4970
|
+
differsFromOfficialDocs: false,
|
|
4140
4971
|
minArgs: 5,
|
|
4141
4972
|
maxArgs: INF,
|
|
4142
4973
|
category: 'Sales and Service Cloud',
|
|
4143
|
-
description:
|
|
4974
|
+
description:
|
|
4975
|
+
'Retrieves records from a connected Salesforce Sales or Service Cloud object via Marketing Cloud Connect and returns them as a rowset. Requires an active Marketing Cloud Connect integration; a call against an unknown object name aborts the page.',
|
|
4144
4976
|
params: [
|
|
4145
4977
|
{
|
|
4146
4978
|
name: 'objectName',
|
|
@@ -4193,14 +5025,19 @@ export const FUNCTIONS = [
|
|
|
4193
5025
|
{
|
|
4194
5026
|
name: 'Row',
|
|
4195
5027
|
mcnSince: 67,
|
|
4196
|
-
handlebarsEquivalent:
|
|
5028
|
+
handlebarsEquivalent: 'get',
|
|
5029
|
+
handlebarsExact: false,
|
|
4197
5030
|
mcnNotes: null,
|
|
4198
5031
|
docUrl: 'https://developer.salesforce.com/docs/marketing/marketing-cloud-ampscript/references/mc-ampscript-data-extension/mc-ampscript-reference-data-extension-row.html',
|
|
4199
5032
|
guideUrl: 'https://ampscript.guide/row/',
|
|
5033
|
+
sfmcGuideUrl: 'https://sfmc.guide/engagement/ampscript/functions/row/',
|
|
5034
|
+
isConfirmed: true,
|
|
5035
|
+
differsFromOfficialDocs: false,
|
|
4200
5036
|
minArgs: 2,
|
|
4201
5037
|
maxArgs: 2,
|
|
4202
5038
|
category: 'Data Extension',
|
|
4203
|
-
description:
|
|
5039
|
+
description:
|
|
5040
|
+
'Returns a specific row from a rowset by its 1-based index. Index 0 (or any out-of-range index) aborts the page rather than returning an empty row.',
|
|
4204
5041
|
params: [
|
|
4205
5042
|
{ name: 'rowset', description: 'Rowset to access', type: 'rowset' },
|
|
4206
5043
|
{ name: 'rowIndex', description: '1-based row index', type: 'number' },
|
|
@@ -4213,10 +5050,14 @@ export const FUNCTIONS = [
|
|
|
4213
5050
|
{
|
|
4214
5051
|
name: 'RowCount',
|
|
4215
5052
|
mcnSince: 67,
|
|
4216
|
-
handlebarsEquivalent:
|
|
5053
|
+
handlebarsEquivalent: 'length',
|
|
5054
|
+
handlebarsExact: false,
|
|
4217
5055
|
mcnNotes: null,
|
|
4218
5056
|
docUrl: 'https://developer.salesforce.com/docs/marketing/marketing-cloud-ampscript/references/mc-ampscript-data-extension/mc-ampscript-reference-data-extension-row-count.html',
|
|
4219
5057
|
guideUrl: 'https://ampscript.guide/rowcount/',
|
|
5058
|
+
sfmcGuideUrl: 'https://sfmc.guide/engagement/ampscript/functions/rowcount/',
|
|
5059
|
+
isConfirmed: true,
|
|
5060
|
+
differsFromOfficialDocs: false,
|
|
4220
5061
|
minArgs: 1,
|
|
4221
5062
|
maxArgs: 1,
|
|
4222
5063
|
category: 'Data Extension',
|
|
@@ -4234,6 +5075,7 @@ export const FUNCTIONS = [
|
|
|
4234
5075
|
mcnNotes: null,
|
|
4235
5076
|
docUrl: 'https://developer.salesforce.com/docs/marketing/marketing-cloud-ampscript/references/mc-ampscript-api/mc-ampscript-reference-api-set-object-property.html',
|
|
4236
5077
|
guideUrl: 'https://ampscript.guide/setobjectproperty/',
|
|
5078
|
+
sfmcGuideUrl: 'https://sfmc.guide/engagement/ampscript/functions/setobjectproperty/',
|
|
4237
5079
|
minArgs: 3,
|
|
4238
5080
|
maxArgs: 3,
|
|
4239
5081
|
category: 'Marketing Cloud API',
|
|
@@ -4255,26 +5097,48 @@ export const FUNCTIONS = [
|
|
|
4255
5097
|
returnDescription: 'No value is returned; the named property is set on the object.',
|
|
4256
5098
|
syntax: 'SetObjectProperty(apiObject, propertyName, propertyValue)',
|
|
4257
5099
|
example: "SetObjectProperty(@apiObject, 'LastName', 'Smith')",
|
|
5100
|
+
isConfirmed: true,
|
|
4258
5101
|
},
|
|
4259
5102
|
{
|
|
4260
5103
|
name: 'SetSmsConversationNextKeyword',
|
|
4261
5104
|
mcnSince: null,
|
|
4262
5105
|
handlebarsEquivalent: null,
|
|
4263
5106
|
mcnNotes: null,
|
|
5107
|
+
docUrl: 'https://developer.salesforce.com/docs/marketing/marketing-cloud-ampscript/references/mc-ampscript-sms/mc-ampscript-reference-sms-set-sms-conversation-next-keyword.html',
|
|
4264
5108
|
guideUrl: 'https://ampscript.guide/setsmsconversationnextkeyword/',
|
|
4265
5109
|
minArgs: 3,
|
|
4266
5110
|
maxArgs: 3,
|
|
4267
5111
|
category: 'MobileConnect',
|
|
4268
|
-
description:
|
|
5112
|
+
description:
|
|
5113
|
+
'Sets the keyword for the next path of an existing SMS conversation, applied when the contact next replies. Does not create a new conversation. Returns true when set inside a MobileConnect message context, and false in any other context (for example a CloudPage or email). The success path cannot be exercised outside a live MobileConnect send.',
|
|
5114
|
+
isConfirmed: false,
|
|
5115
|
+
verificationBlocked: true,
|
|
5116
|
+
verificationBlockedReason: 'no-working-invocation',
|
|
5117
|
+
differsFromOfficialDocs: true,
|
|
5118
|
+
officialDocsNote:
|
|
5119
|
+
'Runtime-observed on cred/DEV (MID 510007949), the only BU available (no parent-BU escalation). This is an ordinary function call, so it compiles and runs on a CloudPage: called there with a real short code, the authorized destination number and a keyword, it returned the literal boolean false (Empty() false) and the page rendered fully with no exception — no SMS was sent and no conversation state changed. This confirms the ampscript.guide claim that the function returns false outside a MobileConnect message context; the official Salesforce reference omits this and describes only the in-context behaviour. The success path (true, keyword actually set) requires a live MobileConnect message context that cannot be captured on this tenant, so the function is recorded blocked for the success path while the CloudPage false-return is proven. The catalogued signature was corrected here: the three parameters are originationNumber, destinationNumber and keyword, and the return is a boolean, not void. A docUrl to the official reference was also added.',
|
|
4269
5120
|
params: [
|
|
4270
|
-
{
|
|
4271
|
-
|
|
4272
|
-
|
|
5121
|
+
{
|
|
5122
|
+
name: 'originationNumber',
|
|
5123
|
+
description: 'The MobileConnect short code or long code used to send',
|
|
5124
|
+
type: 'string',
|
|
5125
|
+
},
|
|
5126
|
+
{
|
|
5127
|
+
name: 'destinationNumber',
|
|
5128
|
+
description: "The contact's phone number, including country code",
|
|
5129
|
+
type: 'string',
|
|
5130
|
+
},
|
|
5131
|
+
{
|
|
5132
|
+
name: 'keyword',
|
|
5133
|
+
description: 'The string to set as the next conversation keyword',
|
|
5134
|
+
type: 'string',
|
|
5135
|
+
},
|
|
4273
5136
|
],
|
|
4274
|
-
returnType: '
|
|
4275
|
-
returnDescription:
|
|
4276
|
-
|
|
4277
|
-
|
|
5137
|
+
returnType: 'boolean',
|
|
5138
|
+
returnDescription:
|
|
5139
|
+
'true when the next keyword is set inside a MobileConnect message context; false in any other context (proven on a CloudPage). Fails with an exception in-context if unsuccessful.',
|
|
5140
|
+
syntax: 'SetSmsConversationNextKeyword(originationNumber, destinationNumber, keyword)',
|
|
5141
|
+
example: '%%=SetSmsConversationNextKeyword("12345", MOBILE_NUMBER, "EXAMPLE")=%%',
|
|
4278
5142
|
},
|
|
4279
5143
|
{
|
|
4280
5144
|
name: 'SetStateMscrmRecord',
|
|
@@ -4315,6 +5179,11 @@ export const FUNCTIONS = [
|
|
|
4315
5179
|
returnDescription: 'No value is returned; the record state and status are updated.',
|
|
4316
5180
|
syntax: 'SetStateMscrmRecord(recordGuid, entityName, stateToSet, statusToSet)',
|
|
4317
5181
|
example: "SetStateMscrmRecord(@guid, 'contact', 'active', 1)",
|
|
5182
|
+
isConfirmed: true,
|
|
5183
|
+
nonFunctionalAtRuntime: true,
|
|
5184
|
+
deprecated: true,
|
|
5185
|
+
deprecatedReason:
|
|
5186
|
+
'The Marketing Cloud Connector for Microsoft Dynamics CRM was retired (online integration in December 2020, on-premises in October 2021), so the Dynamics CRM AMPscript functions no longer have a live integration to call and are non-functional. No replacement AMPscript function exists; integrate Dynamics data through the SFTP import/export or a custom API instead.',
|
|
4318
5187
|
},
|
|
4319
5188
|
{
|
|
4320
5189
|
name: 'SHA1',
|
|
@@ -4323,27 +5192,37 @@ export const FUNCTIONS = [
|
|
|
4323
5192
|
mcnNotes: null,
|
|
4324
5193
|
docUrl: 'https://developer.salesforce.com/docs/marketing/marketing-cloud-ampscript/references/mc-ampscript-encryption/mc-ampscript-reference-encryption-sha1.html',
|
|
4325
5194
|
guideUrl: 'https://ampscript.guide/sha1/',
|
|
5195
|
+
sfmcGuideUrl: 'https://sfmc.guide/engagement/ampscript/functions/sha1/',
|
|
4326
5196
|
minArgs: 1,
|
|
4327
5197
|
maxArgs: 2,
|
|
4328
5198
|
category: 'Encryption and Encoding',
|
|
4329
|
-
description:
|
|
5199
|
+
description:
|
|
5200
|
+
'Returns the SHA-1 hash of the input value. The bytes hashed are the UTF-8 encoding of the input unless charSet names another encoding, and a number or date argument is hashed as the text it renders as.',
|
|
4330
5201
|
params: [
|
|
4331
|
-
{
|
|
5202
|
+
{
|
|
5203
|
+
name: 'stringToConvert',
|
|
5204
|
+
description:
|
|
5205
|
+
'The value to hash; a number or date is hashed as its rendered text, and the empty string yields the well-known empty-input digest',
|
|
5206
|
+
type: 'string|number|date',
|
|
5207
|
+
},
|
|
4332
5208
|
{
|
|
4333
5209
|
name: 'charSet',
|
|
4334
5210
|
mcnSince: null,
|
|
4335
5211
|
mcnNotes: null,
|
|
4336
|
-
description:
|
|
5212
|
+
description:
|
|
5213
|
+
'Name of the character encoding applied before hashing; any encoding name the platform recognises works, and an unrecognised or empty name aborts the page',
|
|
4337
5214
|
type: 'string',
|
|
4338
|
-
enum: ['UTF-8', 'UTF-16'],
|
|
5215
|
+
enum: ['UTF-8', 'UTF-16', 'UTF-16BE', 'UTF-32', 'ASCII', 'ISO-8859-1'],
|
|
4339
5216
|
optional: true,
|
|
4340
5217
|
default: 'UTF-8',
|
|
4341
5218
|
},
|
|
4342
5219
|
],
|
|
4343
5220
|
returnType: 'string',
|
|
4344
|
-
returnDescription: 'The SHA-1 hash of the input as
|
|
5221
|
+
returnDescription: 'The SHA-1 hash of the input as 40 lowercase hexadecimal characters.',
|
|
4345
5222
|
syntax: 'SHA1(stringToConvert[, charSet])',
|
|
4346
5223
|
example: "%%=SHA1('This is a string of text.')=%%",
|
|
5224
|
+
isConfirmed: true,
|
|
5225
|
+
differsFromOfficialDocs: false,
|
|
4347
5226
|
},
|
|
4348
5227
|
{
|
|
4349
5228
|
name: 'SHA256',
|
|
@@ -4352,27 +5231,37 @@ export const FUNCTIONS = [
|
|
|
4352
5231
|
mcnNotes: null,
|
|
4353
5232
|
docUrl: 'https://developer.salesforce.com/docs/marketing/marketing-cloud-ampscript/references/mc-ampscript-encryption/mc-ampscript-reference-encryption-sha256.html',
|
|
4354
5233
|
guideUrl: 'https://ampscript.guide/sha256/',
|
|
5234
|
+
sfmcGuideUrl: 'https://sfmc.guide/engagement/ampscript/functions/sha256/',
|
|
4355
5235
|
minArgs: 1,
|
|
4356
5236
|
maxArgs: 2,
|
|
4357
5237
|
category: 'Encryption and Encoding',
|
|
4358
|
-
description:
|
|
5238
|
+
description:
|
|
5239
|
+
'Returns the SHA-256 hash of the input value. The bytes hashed are the UTF-8 encoding of the input unless charSet names another encoding, and a number or date argument is hashed as the text it renders as.',
|
|
4359
5240
|
params: [
|
|
4360
|
-
{
|
|
5241
|
+
{
|
|
5242
|
+
name: 'stringToConvert',
|
|
5243
|
+
description:
|
|
5244
|
+
'The value to hash; a number or date is hashed as its rendered text, and the empty string yields the well-known empty-input digest',
|
|
5245
|
+
type: 'string|number|date',
|
|
5246
|
+
},
|
|
4361
5247
|
{
|
|
4362
5248
|
name: 'charSet',
|
|
4363
5249
|
mcnSince: null,
|
|
4364
5250
|
mcnNotes: null,
|
|
4365
|
-
description:
|
|
5251
|
+
description:
|
|
5252
|
+
'Name of the character encoding applied before hashing; any encoding name the platform recognises works, and an unrecognised or empty name aborts the page',
|
|
4366
5253
|
type: 'string',
|
|
4367
|
-
enum: ['UTF-8', 'UTF-16'],
|
|
5254
|
+
enum: ['UTF-8', 'UTF-16', 'UTF-16BE', 'UTF-32', 'ASCII', 'ISO-8859-1'],
|
|
4368
5255
|
optional: true,
|
|
4369
5256
|
default: 'UTF-8',
|
|
4370
5257
|
},
|
|
4371
5258
|
],
|
|
4372
5259
|
returnType: 'string',
|
|
4373
|
-
returnDescription: 'The SHA-256 hash of the input as
|
|
5260
|
+
returnDescription: 'The SHA-256 hash of the input as 64 lowercase hexadecimal characters.',
|
|
4374
5261
|
syntax: 'SHA256(stringToConvert[, charSet])',
|
|
4375
5262
|
example: '%%=SHA256("This is a string of text.")=%%',
|
|
5263
|
+
isConfirmed: true,
|
|
5264
|
+
differsFromOfficialDocs: false,
|
|
4376
5265
|
},
|
|
4377
5266
|
{
|
|
4378
5267
|
name: 'SHA512',
|
|
@@ -4381,27 +5270,37 @@ export const FUNCTIONS = [
|
|
|
4381
5270
|
mcnNotes: null,
|
|
4382
5271
|
docUrl: 'https://developer.salesforce.com/docs/marketing/marketing-cloud-ampscript/references/mc-ampscript-encryption/mc-ampscript-reference-encryption-sha512.html',
|
|
4383
5272
|
guideUrl: 'https://ampscript.guide/sha512/',
|
|
5273
|
+
sfmcGuideUrl: 'https://sfmc.guide/engagement/ampscript/functions/sha512/',
|
|
4384
5274
|
minArgs: 1,
|
|
4385
5275
|
maxArgs: 2,
|
|
4386
5276
|
category: 'Encryption and Encoding',
|
|
4387
|
-
description:
|
|
5277
|
+
description:
|
|
5278
|
+
'Returns the SHA-512 hash of the input value. The bytes hashed are the UTF-8 encoding of the input unless charSet names another encoding, and a number or date argument is hashed as the text it renders as.',
|
|
4388
5279
|
params: [
|
|
4389
|
-
{
|
|
5280
|
+
{
|
|
5281
|
+
name: 'stringToConvert',
|
|
5282
|
+
description:
|
|
5283
|
+
'The value to hash; a number or date is hashed as its rendered text, and the empty string yields the well-known empty-input digest',
|
|
5284
|
+
type: 'string|number|date',
|
|
5285
|
+
},
|
|
4390
5286
|
{
|
|
4391
5287
|
name: 'charSet',
|
|
4392
5288
|
mcnSince: null,
|
|
4393
5289
|
mcnNotes: null,
|
|
4394
|
-
description:
|
|
5290
|
+
description:
|
|
5291
|
+
'Name of the character encoding applied before hashing; any encoding name the platform recognises works, and an unrecognised or empty name aborts the page',
|
|
4395
5292
|
type: 'string',
|
|
4396
|
-
enum: ['UTF-8', 'UTF-16'],
|
|
5293
|
+
enum: ['UTF-8', 'UTF-16', 'UTF-16BE', 'UTF-32', 'ASCII', 'ISO-8859-1'],
|
|
4397
5294
|
optional: true,
|
|
4398
5295
|
default: 'UTF-8',
|
|
4399
5296
|
},
|
|
4400
5297
|
],
|
|
4401
5298
|
returnType: 'string',
|
|
4402
|
-
returnDescription: 'The SHA-512 hash of the input as
|
|
5299
|
+
returnDescription: 'The SHA-512 hash of the input as 128 lowercase hexadecimal characters.',
|
|
4403
5300
|
syntax: 'SHA512(stringToConvert[, charSet])',
|
|
4404
5301
|
example: "%%=SHA512('This is a string of text.')=%%",
|
|
5302
|
+
isConfirmed: true,
|
|
5303
|
+
differsFromOfficialDocs: false,
|
|
4405
5304
|
},
|
|
4406
5305
|
{
|
|
4407
5306
|
name: 'StringToDate',
|
|
@@ -4411,15 +5310,27 @@ export const FUNCTIONS = [
|
|
|
4411
5310
|
'In MCN, returns a locale-formatted string (G standard format, e.g. "5/15/2026 1:23:45 PM") instead of a dateTime object. Cannot be reliably passed to FormatDate() or other date functions in MCN - use FormatDate() directly instead.',
|
|
4412
5311
|
docUrl: 'https://developer.salesforce.com/docs/marketing/marketing-cloud-ampscript/references/mc-ampscript-date-time/mc-ampscript-reference-date-time-string-to-date.html',
|
|
4413
5312
|
guideUrl: 'https://ampscript.guide/stringtodate/',
|
|
5313
|
+
sfmcGuideUrl: 'https://sfmc.guide/engagement/ampscript/functions/stringtodate/',
|
|
4414
5314
|
minArgs: 1,
|
|
4415
5315
|
maxArgs: 1,
|
|
4416
5316
|
category: 'Date and Time',
|
|
4417
|
-
description:
|
|
4418
|
-
|
|
5317
|
+
description:
|
|
5318
|
+
'Converts a date string to a date value. Behaves identically to DateParse for every input format tested, but takes no second argument, so DateParse is the only one of the two that can return the instant in UTC. A string the parser cannot read aborts the page instead of returning a sentinel, and an ambiguous day-first string such as 5/8/2026 is silently read month-first rather than rejected.',
|
|
5319
|
+
params: [
|
|
5320
|
+
{
|
|
5321
|
+
name: 'dateString',
|
|
5322
|
+
description:
|
|
5323
|
+
'A date or timestamp string, or an existing date value; anything the parser cannot read aborts the page',
|
|
5324
|
+
type: 'string|date',
|
|
5325
|
+
},
|
|
5326
|
+
],
|
|
4419
5327
|
returnType: 'date',
|
|
4420
|
-
returnDescription:
|
|
5328
|
+
returnDescription:
|
|
5329
|
+
'A real date value the other date functions accept directly. Rendered on its own it prints as a US short date followed by a 12-hour clock with an AM/PM suffix.',
|
|
4421
5330
|
syntax: 'StringToDate(dateString)',
|
|
4422
5331
|
example: "%%=StringToDate('2026-01-15')=%%",
|
|
5332
|
+
isConfirmed: true,
|
|
5333
|
+
differsFromOfficialDocs: false,
|
|
4423
5334
|
},
|
|
4424
5335
|
{
|
|
4425
5336
|
name: 'StringToHex',
|
|
@@ -4431,54 +5342,70 @@ export const FUNCTIONS = [
|
|
|
4431
5342
|
minArgs: 1,
|
|
4432
5343
|
maxArgs: 2,
|
|
4433
5344
|
category: 'Encryption and Encoding',
|
|
4434
|
-
description:
|
|
5345
|
+
description:
|
|
5346
|
+
'Converts a string to its hexadecimal representation. The bytes rendered are the UTF-8 encoding of the input unless charSet names another encoding.',
|
|
4435
5347
|
params: [
|
|
4436
5348
|
{
|
|
4437
5349
|
name: 'sourceString',
|
|
4438
|
-
description:
|
|
5350
|
+
description:
|
|
5351
|
+
'The string to convert to hexadecimal character codes; the empty string yields the empty string',
|
|
4439
5352
|
type: 'string',
|
|
4440
5353
|
},
|
|
4441
5354
|
{
|
|
4442
5355
|
name: 'charSet',
|
|
4443
|
-
description:
|
|
5356
|
+
description:
|
|
5357
|
+
'Character set to use for encoding; any encoding name the platform recognises works, and an unrecognised or empty name aborts the page',
|
|
4444
5358
|
type: 'string',
|
|
4445
|
-
enum: ['UTF-8', 'UTF-16'],
|
|
5359
|
+
enum: ['UTF-8', 'UTF-16', 'UTF-16BE', 'UTF-32', 'ASCII', 'ISO-8859-1'],
|
|
4446
5360
|
optional: true,
|
|
4447
5361
|
default: 'UTF-8',
|
|
4448
5362
|
},
|
|
4449
5363
|
],
|
|
4450
5364
|
returnType: 'string',
|
|
4451
|
-
returnDescription:
|
|
5365
|
+
returnDescription:
|
|
5366
|
+
'The hexadecimal representation of the input string, in lowercase digits with no separators.',
|
|
4452
5367
|
syntax: 'StringToHex(sourceString[, charSet])',
|
|
4453
5368
|
example: "%%=StringToHex('AB')=%%",
|
|
5369
|
+
isConfirmed: true,
|
|
5370
|
+
differsFromOfficialDocs: false,
|
|
5371
|
+
sfmcGuideUrl: 'https://sfmc.guide/engagement/ampscript/functions/stringtohex/',
|
|
4454
5372
|
},
|
|
4455
5373
|
{
|
|
4456
5374
|
name: 'Substring',
|
|
4457
5375
|
mcnSince: 67,
|
|
4458
5376
|
handlebarsEquivalent: 'substring',
|
|
5377
|
+
handlebarsExact: true,
|
|
4459
5378
|
mcnNotes: null,
|
|
4460
5379
|
docUrl: 'https://developer.salesforce.com/docs/marketing/marketing-cloud-ampscript/references/mc-ampscript-string/mc-ampscript-reference-string-substring.html',
|
|
4461
5380
|
guideUrl: 'https://ampscript.guide/substring/',
|
|
5381
|
+
sfmcGuideUrl: 'https://sfmc.guide/engagement/ampscript/functions/substring/',
|
|
5382
|
+
isConfirmed: true,
|
|
5383
|
+
differsFromOfficialDocs: false,
|
|
4462
5384
|
minArgs: 2,
|
|
4463
5385
|
maxArgs: 3,
|
|
4464
5386
|
category: 'String',
|
|
4465
5387
|
description:
|
|
4466
|
-
'Extracts a portion of a string starting at the given index for the specified length.',
|
|
5388
|
+
'Extracts a portion of a string starting at the given index for the specified length. A start position below 1 is treated as the first character.',
|
|
4467
5389
|
params: [
|
|
4468
|
-
{ name: 'sourceString', description: 'Source string', type: 'string' },
|
|
4469
|
-
{
|
|
5390
|
+
{ name: 'sourceString', description: 'Source string', type: 'string|number' },
|
|
5391
|
+
{
|
|
5392
|
+
name: 'startPosition',
|
|
5393
|
+
description: '1-based start position, as a whole number',
|
|
5394
|
+
type: 'string|number',
|
|
5395
|
+
},
|
|
4470
5396
|
{
|
|
4471
5397
|
name: 'substringLength',
|
|
4472
5398
|
mcnSince: 67,
|
|
4473
5399
|
mcnNotes: null,
|
|
4474
5400
|
description:
|
|
4475
|
-
'Number of characters to extract. If omitted, returns the remainder of the string.',
|
|
4476
|
-
type: 'number',
|
|
5401
|
+
'Number of characters to extract, as a whole number. If omitted, returns the remainder of the string.',
|
|
5402
|
+
type: 'string|number',
|
|
4477
5403
|
optional: true,
|
|
4478
5404
|
},
|
|
4479
5405
|
],
|
|
4480
5406
|
returnType: 'string',
|
|
4481
|
-
returnDescription:
|
|
5407
|
+
returnDescription:
|
|
5408
|
+
'The requested portion of the string, or an empty string when the start position is past the end of the source.',
|
|
4482
5409
|
syntax: 'Substring(sourceString, startPosition[, substringLength])',
|
|
4483
5410
|
example: "%%=Substring('Hello World', 1, 5)=%%",
|
|
4484
5411
|
},
|
|
@@ -4486,9 +5413,11 @@ export const FUNCTIONS = [
|
|
|
4486
5413
|
name: 'Subtract',
|
|
4487
5414
|
mcnSince: 67,
|
|
4488
5415
|
handlebarsEquivalent: 'subtract',
|
|
5416
|
+
handlebarsExact: true,
|
|
4489
5417
|
mcnNotes: null,
|
|
4490
5418
|
docUrl: 'https://developer.salesforce.com/docs/marketing/marketing-cloud-ampscript/references/mc-ampscript-math/mc-ampscript-reference-math-subtract.html',
|
|
4491
5419
|
guideUrl: 'https://ampscript.guide/subtract/',
|
|
5420
|
+
sfmcGuideUrl: 'https://sfmc.guide/engagement/ampscript/functions/subtract/',
|
|
4492
5421
|
minArgs: 2,
|
|
4493
5422
|
maxArgs: 2,
|
|
4494
5423
|
category: 'Math',
|
|
@@ -4507,7 +5436,8 @@ export const FUNCTIONS = [
|
|
|
4507
5436
|
{
|
|
4508
5437
|
name: 'SystemDateToLocalDate',
|
|
4509
5438
|
mcnSince: null,
|
|
4510
|
-
handlebarsEquivalent:
|
|
5439
|
+
handlebarsEquivalent: 'timeZoneConversion',
|
|
5440
|
+
handlebarsExact: false,
|
|
4511
5441
|
mcnNotes: null,
|
|
4512
5442
|
docUrl: 'https://developer.salesforce.com/docs/marketing/marketing-cloud-ampscript/references/mc-ampscript-date-time/mc-ampscript-reference-date-time-system-date-to-local-date.html',
|
|
4513
5443
|
guideUrl: 'https://ampscript.guide/systemdatetolocaldate/',
|
|
@@ -4515,16 +5445,21 @@ export const FUNCTIONS = [
|
|
|
4515
5445
|
maxArgs: 1,
|
|
4516
5446
|
category: 'Date and Time',
|
|
4517
5447
|
description:
|
|
4518
|
-
|
|
5448
|
+
'Converts a Marketing Cloud system date (Central Time, no daylight saving) to the time zone configured on the account. The shift is not constant: the local side observes daylight saving, so a summer instant moves one hour further than a winter one. A value the date parser cannot read aborts the page instead of returning a sentinel.',
|
|
4519
5449
|
params: [
|
|
4520
5450
|
{
|
|
4521
5451
|
name: 'systemTime',
|
|
4522
|
-
description:
|
|
4523
|
-
|
|
5452
|
+
description:
|
|
5453
|
+
'The system time value to convert, as a date value or a parseable date string',
|
|
5454
|
+
type: 'string|date',
|
|
4524
5455
|
},
|
|
4525
5456
|
],
|
|
4526
|
-
returnType: '
|
|
4527
|
-
returnDescription:
|
|
5457
|
+
returnType: 'date',
|
|
5458
|
+
returnDescription:
|
|
5459
|
+
'A real date value the other date functions accept directly. Rendered on its own it prints as a US short date followed by a 12-hour clock with an AM/PM suffix.',
|
|
5460
|
+
isConfirmed: true,
|
|
5461
|
+
differsFromOfficialDocs: false,
|
|
5462
|
+
sfmcGuideUrl: 'https://sfmc.guide/engagement/ampscript/functions/systemdatetolocaldate/',
|
|
4528
5463
|
syntax: 'SystemDateToLocalDate(systemTime)',
|
|
4529
5464
|
example: '%%=SystemDateToLocalDate(Now())=%%',
|
|
4530
5465
|
},
|
|
@@ -4535,10 +5470,12 @@ export const FUNCTIONS = [
|
|
|
4535
5470
|
mcnNotes: null,
|
|
4536
5471
|
docUrl: 'https://developer.salesforce.com/docs/marketing/marketing-cloud-ampscript/references/mc-ampscript-content/mc-ampscript-reference-content-transform-xml.html',
|
|
4537
5472
|
guideUrl: 'https://ampscript.guide/transformxml/',
|
|
5473
|
+
sfmcGuideUrl: 'https://sfmc.guide/engagement/ampscript/functions/transformxml/',
|
|
4538
5474
|
minArgs: 2,
|
|
4539
5475
|
maxArgs: 2,
|
|
4540
5476
|
category: 'Content',
|
|
4541
5477
|
description: 'Transforms an XML document using an XSLT stylesheet.',
|
|
5478
|
+
isConfirmed: true,
|
|
4542
5479
|
params: [
|
|
4543
5480
|
{ name: 'xmlDocument', description: 'XML document string', type: 'string' },
|
|
4544
5481
|
{ name: 'xslDocument', description: 'XSLT stylesheet string', type: 'string' },
|
|
@@ -4555,11 +5492,14 @@ export const FUNCTIONS = [
|
|
|
4555
5492
|
mcnNotes: null,
|
|
4556
5493
|
docUrl: 'https://developer.salesforce.com/docs/marketing/marketing-cloud-ampscript/references/mc-ampscript-content/mc-ampscript-reference-content-treat-as-content.html',
|
|
4557
5494
|
guideUrl: 'https://ampscript.guide/treatascontent/',
|
|
5495
|
+
sfmcGuideUrl: 'https://sfmc.guide/engagement/ampscript/functions/treatascontent/',
|
|
4558
5496
|
minArgs: 1,
|
|
4559
5497
|
maxArgs: 1,
|
|
5498
|
+
isConfirmed: true,
|
|
5499
|
+
differsFromOfficialDocs: false,
|
|
4560
5500
|
category: 'Content',
|
|
4561
5501
|
description:
|
|
4562
|
-
'Evaluates a string as AMPscript content, rendering any embedded AMPscript expressions.',
|
|
5502
|
+
'Evaluates a string as AMPscript content, rendering any embedded AMPscript expressions, and returns the rendered string. Plain text and the empty string pass through unchanged.',
|
|
4563
5503
|
params: [
|
|
4564
5504
|
{
|
|
4565
5505
|
name: 'stringToReturn',
|
|
@@ -4581,11 +5521,14 @@ export const FUNCTIONS = [
|
|
|
4581
5521
|
mcnNotes: null,
|
|
4582
5522
|
docUrl: 'https://developer.salesforce.com/docs/marketing/marketing-cloud-ampscript/references/mc-ampscript-content/mc-ampscript-reference-content-treat-as-content-area.html',
|
|
4583
5523
|
guideUrl: 'https://ampscript.guide/treatascontentarea/',
|
|
5524
|
+
sfmcGuideUrl: 'https://sfmc.guide/engagement/ampscript/functions/treatascontentarea/',
|
|
4584
5525
|
minArgs: 2,
|
|
4585
5526
|
maxArgs: 3,
|
|
5527
|
+
isConfirmed: true,
|
|
5528
|
+
differsFromOfficialDocs: false,
|
|
4586
5529
|
category: 'Content',
|
|
4587
5530
|
description:
|
|
4588
|
-
'
|
|
5531
|
+
'Stores a content string under a key for the duration of a send and renders it, evaluating any embedded AMPscript. An optional third argument names an impression region.',
|
|
4589
5532
|
params: [
|
|
4590
5533
|
{ name: 'contentKey', description: 'Content area key identifier', type: 'string' },
|
|
4591
5534
|
{ name: 'contentValue', description: 'HTML/AMPscript content', type: 'string' },
|
|
@@ -4607,14 +5550,21 @@ export const FUNCTIONS = [
|
|
|
4607
5550
|
name: 'Trim',
|
|
4608
5551
|
mcnSince: 67,
|
|
4609
5552
|
handlebarsEquivalent: 'trim',
|
|
5553
|
+
handlebarsExact: true,
|
|
4610
5554
|
mcnNotes: null,
|
|
4611
5555
|
docUrl: 'https://developer.salesforce.com/docs/marketing/marketing-cloud-ampscript/references/mc-ampscript-string/mc-ampscript-reference-string-trim.html',
|
|
4612
5556
|
guideUrl: 'https://ampscript.guide/trim/',
|
|
5557
|
+
sfmcGuideUrl: 'https://sfmc.guide/engagement/ampscript/functions/trim/',
|
|
4613
5558
|
minArgs: 1,
|
|
4614
5559
|
maxArgs: 1,
|
|
5560
|
+
isConfirmed: true,
|
|
5561
|
+
differsFromOfficialDocs: false,
|
|
4615
5562
|
category: 'String',
|
|
4616
|
-
description:
|
|
4617
|
-
|
|
5563
|
+
description:
|
|
5564
|
+
'Removes leading and trailing whitespace from a value. Tabs, line breaks and the non-breaking space count as whitespace.',
|
|
5565
|
+
params: [
|
|
5566
|
+
{ name: 'sourceString', description: 'Value to trim', type: 'string|number|date' },
|
|
5567
|
+
],
|
|
4618
5568
|
returnType: 'string',
|
|
4619
5569
|
returnDescription: 'The string with leading and trailing whitespace removed.',
|
|
4620
5570
|
syntax: 'Trim(sourceString)',
|
|
@@ -4627,6 +5577,9 @@ export const FUNCTIONS = [
|
|
|
4627
5577
|
mcnNotes: null,
|
|
4628
5578
|
docUrl: 'https://developer.salesforce.com/docs/marketing/marketing-cloud-ampscript/references/mc-ampscript-data-extension/mc-ampscript-reference-data-extension-update-data.html',
|
|
4629
5579
|
guideUrl: 'https://ampscript.guide/updatedata/',
|
|
5580
|
+
sfmcGuideUrl: 'https://sfmc.guide/engagement/ampscript/functions/updatedata/',
|
|
5581
|
+
isConfirmed: true,
|
|
5582
|
+
differsFromOfficialDocs: false,
|
|
4630
5583
|
minArgs: 6,
|
|
4631
5584
|
maxArgs: INF,
|
|
4632
5585
|
category: 'Data Extension',
|
|
@@ -4692,6 +5645,9 @@ export const FUNCTIONS = [
|
|
|
4692
5645
|
mcnNotes: null,
|
|
4693
5646
|
docUrl: 'https://developer.salesforce.com/docs/marketing/marketing-cloud-ampscript/references/mc-ampscript-data-extension/mc-ampscript-reference-data-extension-update-de.html',
|
|
4694
5647
|
guideUrl: 'https://ampscript.guide/updatede/',
|
|
5648
|
+
sfmcGuideUrl: 'https://sfmc.guide/engagement/ampscript/functions/updatede/',
|
|
5649
|
+
isConfirmed: true,
|
|
5650
|
+
differsFromOfficialDocs: false,
|
|
4695
5651
|
minArgs: 6,
|
|
4696
5652
|
maxArgs: INF,
|
|
4697
5653
|
category: 'Data Extension',
|
|
@@ -4798,6 +5754,11 @@ export const FUNCTIONS = [
|
|
|
4798
5754
|
repeat: [{ startIndex: 2, groupSize: 2, minGroups: 1 }],
|
|
4799
5755
|
syntax: 'UpdateMSCRMRecords(entityName, guidsToUpdate, attributeName1, attributeValue1[, attributeNameN, attributeValueN, ...])',
|
|
4800
5756
|
example: "%%=UpdateMSCRMRecords('contact', @guids, 'lastname', 'Smith')=%%",
|
|
5757
|
+
isConfirmed: true,
|
|
5758
|
+
nonFunctionalAtRuntime: true,
|
|
5759
|
+
deprecated: true,
|
|
5760
|
+
deprecatedReason:
|
|
5761
|
+
'The Marketing Cloud Connector for Microsoft Dynamics CRM was retired (online integration in December 2020, on-premises in October 2021), so the Dynamics CRM AMPscript functions no longer have a live integration to call and are non-functional. No replacement AMPscript function exists; integrate Dynamics data through the SFTP import/export or a custom API instead.',
|
|
4801
5762
|
},
|
|
4802
5763
|
{
|
|
4803
5764
|
name: 'UpdateSingleSalesforceObject',
|
|
@@ -4806,11 +5767,17 @@ export const FUNCTIONS = [
|
|
|
4806
5767
|
mcnNotes: null,
|
|
4807
5768
|
docUrl: 'https://developer.salesforce.com/docs/marketing/marketing-cloud-ampscript/references/mc-ampscript-salesforce/mc-ampscript-reference-salesforce-update-single-object.html',
|
|
4808
5769
|
guideUrl: 'https://ampscript.guide/updatesinglesalesforceobject/',
|
|
5770
|
+
sfmcGuideUrl:
|
|
5771
|
+
'https://sfmc.guide/engagement/ampscript/functions/updatesinglesalesforceobject/',
|
|
4809
5772
|
minArgs: 4,
|
|
4810
5773
|
maxArgs: INF,
|
|
4811
5774
|
category: 'Sales and Service Cloud',
|
|
4812
5775
|
description:
|
|
4813
|
-
'Updates a single record in a connected Salesforce
|
|
5776
|
+
'Updates a single record in a connected Salesforce Sales or Service Cloud object via Marketing Cloud Connect. Accepts one or more field name and value pairs. Returns 1 on success; per the official reference it returns 0 on failure, but on a CloudPage a failed update (unknown object, malformed or non-existent record ID) instead surfaces the SOAP fault as an uncatchable page abort rather than returning 0.',
|
|
5777
|
+
isConfirmed: true,
|
|
5778
|
+
differsFromOfficialDocs: false,
|
|
5779
|
+
officialDocsNote:
|
|
5780
|
+
'The success token 1 was runtime-proven on cred/DEV (MID 510007949), which has an active Marketing Cloud Connect integration to a real Salesforce org: updating one field of a record created moments earlier in the same run (a benign Task) returned the literal 1 with the page rendering fully. The failure token 0 is NOT observable in CloudPage GET context: every safe induced failure (unknown object, a malformed ID, and a well-formed but non-existent Lead ID at both 15 and 18 characters, on a real field) aborted the whole page with HTTP 422 — the SOAP fault propagates as an uncatchable page abort (identical to CreateSalesforceObject and RetrieveSalesforceObjects against a bad target), so the documented 0 return never materialises to be read. returnEnum is therefore left unset: only 1 is provable here, and asserting a [0,1] enum would ship the unproven 0 token. returnType stays number and the 0/1 semantics are retained in the description as a documented fact attributed to the official reference. The 0-on-CloudPage-abort behaviour is a context observation, not a contradiction of the send/preview-context 0/1 contract, so differsFromOfficialDocs stays false.',
|
|
4814
5781
|
params: [
|
|
4815
5782
|
{
|
|
4816
5783
|
name: 'objectName',
|
|
@@ -4833,8 +5800,8 @@ export const FUNCTIONS = [
|
|
|
4833
5800
|
{ name: 'fieldValueN', description: 'Additional field value', optional: true },
|
|
4834
5801
|
],
|
|
4835
5802
|
returnType: 'number',
|
|
4836
|
-
returnDescription:
|
|
4837
|
-
|
|
5803
|
+
returnDescription:
|
|
5804
|
+
'1 when the record was updated successfully (runtime-proven). Per the official reference a failed update returns 0, but on a CloudPage a failure aborts the page (HTTP 422) instead of returning 0, so the 0 token is not observable in that context.',
|
|
4838
5805
|
repeat: [{ startIndex: 2, groupSize: 2, minGroups: 1 }],
|
|
4839
5806
|
syntax: 'UpdateSingleSalesforceObject(objectName, idToUpdate, fieldName1, fieldValue1[, fieldNameN, fieldValueN, ...])',
|
|
4840
5807
|
example: "%%=UpdateSingleSalesforceObject('Contact', @recordId, 'LastName', 'Smith')=%%",
|
|
@@ -4843,9 +5810,11 @@ export const FUNCTIONS = [
|
|
|
4843
5810
|
name: 'Uppercase',
|
|
4844
5811
|
mcnSince: 67,
|
|
4845
5812
|
handlebarsEquivalent: 'uppercase',
|
|
5813
|
+
handlebarsExact: true,
|
|
4846
5814
|
mcnNotes: null,
|
|
4847
5815
|
docUrl: 'https://developer.salesforce.com/docs/marketing/marketing-cloud-ampscript/references/mc-ampscript-string/mc-ampscript-reference-string-uppercase.html',
|
|
4848
5816
|
guideUrl: 'https://ampscript.guide/uppercase/',
|
|
5817
|
+
sfmcGuideUrl: 'https://sfmc.guide/engagement/ampscript/functions/uppercase/',
|
|
4849
5818
|
minArgs: 1,
|
|
4850
5819
|
maxArgs: 1,
|
|
4851
5820
|
isConfirmed: true,
|
|
@@ -4872,11 +5841,16 @@ export const FUNCTIONS = [
|
|
|
4872
5841
|
mcnNotes: null,
|
|
4873
5842
|
docUrl: 'https://developer.salesforce.com/docs/marketing/marketing-cloud-ampscript/references/mc-ampscript-contacts/mc-ampscript-reference-contacts-upsert-contact.html',
|
|
4874
5843
|
guideUrl: 'https://ampscript.guide/upsertcontact/',
|
|
5844
|
+
sfmcGuideUrl: 'https://sfmc.guide/engagement/ampscript/functions/upsertcontact/',
|
|
4875
5845
|
minArgs: 5,
|
|
4876
5846
|
maxArgs: INF,
|
|
4877
5847
|
category: 'MobileConnect',
|
|
4878
5848
|
description:
|
|
4879
|
-
|
|
5849
|
+
"Upserts attributes onto a mobile contact matched by phone number. If the contact exists it is updated; otherwise a new contact is created. Returns a status code: 0 when the upsert succeeds and 1 when an error occurs. The only supported channel is 'mobile' and the only supported match attribute is 'phone'. An unknown attribute name returns the error status without writing anything.",
|
|
5850
|
+
isConfirmed: true,
|
|
5851
|
+
differsFromOfficialDocs: false,
|
|
5852
|
+
officialDocsNote:
|
|
5853
|
+
'Both return tokens were runtime-proven on cred/DEV (MID 510007949). The success status 0 was proven by creating a brand-new mobile contact keyed on an opaque, unreachable phone number in a reserved test range with a documented system attribute (_ZipCode); calling the same key a second time with a different value updated that contact and again returned 0, so both the create and update branches of the upsert return 0. The error status 1 was proven three independent ways (unsupported channel, unsupported match attribute, non-numeric phone) and again by passing an attribute name that is not a defined MobileConnect attribute — each returned 1 with the page rendering fully and no write performed. The return is a status code (0 success / 1 error), not a count of records. The phone-number argument accepts both an integer literal and a numeric string (both returned 0 for a successful create). runtime matches the official reference, so differsFromOfficialDocs stays false.',
|
|
4880
5854
|
params: [
|
|
4881
5855
|
{
|
|
4882
5856
|
name: 'channel',
|
|
@@ -4892,7 +5866,7 @@ export const FUNCTIONS = [
|
|
|
4892
5866
|
{
|
|
4893
5867
|
name: 'phoneNumber',
|
|
4894
5868
|
description: 'The phone number of the contact, including the country code',
|
|
4895
|
-
type: 'number',
|
|
5869
|
+
type: 'string|number',
|
|
4896
5870
|
},
|
|
4897
5871
|
{
|
|
4898
5872
|
name: 'keyToUpsert1',
|
|
@@ -4915,10 +5889,12 @@ export const FUNCTIONS = [
|
|
|
4915
5889
|
{ name: 'valueToUpsertN', description: 'Additional attribute value', optional: true },
|
|
4916
5890
|
],
|
|
4917
5891
|
returnType: 'number',
|
|
4918
|
-
|
|
5892
|
+
returnEnum: [0, 1],
|
|
5893
|
+
returnDescription:
|
|
5894
|
+
'A status code: 0 when the upsert succeeds (both creating a new contact and updating an existing one), 1 when an error occurs. Both tokens were proven at runtime.',
|
|
4919
5895
|
repeat: [{ startIndex: 3, groupSize: 2, minGroups: 1 }],
|
|
4920
5896
|
syntax: 'UpsertContact(channel, attribute, phoneNumber, keyToUpsert1, valueToUpsert1[, keyToUpsertN, valueToUpsertN, ...])',
|
|
4921
|
-
example: "%%=UpsertContact('
|
|
5897
|
+
example: "%%=UpsertContact('mobile', 'phone', 14255550142, '_ZipCode', '98026')=%%",
|
|
4922
5898
|
},
|
|
4923
5899
|
{
|
|
4924
5900
|
name: 'UpsertData',
|
|
@@ -4927,6 +5903,9 @@ export const FUNCTIONS = [
|
|
|
4927
5903
|
mcnNotes: null,
|
|
4928
5904
|
docUrl: 'https://developer.salesforce.com/docs/marketing/marketing-cloud-ampscript/references/mc-ampscript-data-extension/mc-ampscript-reference-data-extension-upsert-data.html',
|
|
4929
5905
|
guideUrl: 'https://ampscript.guide/upsertdata/',
|
|
5906
|
+
sfmcGuideUrl: 'https://sfmc.guide/engagement/ampscript/functions/upsertdata/',
|
|
5907
|
+
isConfirmed: true,
|
|
5908
|
+
differsFromOfficialDocs: false,
|
|
4930
5909
|
minArgs: 6,
|
|
4931
5910
|
maxArgs: INF,
|
|
4932
5911
|
category: 'Data Extension',
|
|
@@ -5002,6 +5981,9 @@ export const FUNCTIONS = [
|
|
|
5002
5981
|
mcnNotes: null,
|
|
5003
5982
|
docUrl: 'https://developer.salesforce.com/docs/marketing/marketing-cloud-ampscript/references/mc-ampscript-data-extension/mc-ampscript-reference-data-extension-upsert-de.html',
|
|
5004
5983
|
guideUrl: 'https://ampscript.guide/upsertde/',
|
|
5984
|
+
sfmcGuideUrl: 'https://sfmc.guide/engagement/ampscript/functions/upsertde/',
|
|
5985
|
+
isConfirmed: true,
|
|
5986
|
+
differsFromOfficialDocs: false,
|
|
5005
5987
|
minArgs: 6,
|
|
5006
5988
|
maxArgs: INF,
|
|
5007
5989
|
category: 'Data Extension',
|
|
@@ -5136,6 +6118,11 @@ export const FUNCTIONS = [
|
|
|
5136
6118
|
syntax: 'UpsertMSCRMRecord(entityName, sortField, sortType, numPairsForRetrieve, filterAttributeName, filterAttributeValue, numPairsForUpdate, updateAttributeName, updateAttributeValue)',
|
|
5137
6119
|
example:
|
|
5138
6120
|
"%%=UpsertMSCRMRecord('contact', 'createdon', 'DESC', 1, 'emailaddress1', @email, 1, 'lastname', 'Smith')=%%",
|
|
6121
|
+
isConfirmed: true,
|
|
6122
|
+
nonFunctionalAtRuntime: true,
|
|
6123
|
+
deprecated: true,
|
|
6124
|
+
deprecatedReason:
|
|
6125
|
+
'The Marketing Cloud Connector for Microsoft Dynamics CRM was retired (online integration in December 2020, on-premises in October 2021), so the Dynamics CRM AMPscript functions no longer have a live integration to call and are non-functional. No replacement AMPscript function exists; integrate Dynamics data through the SFTP import/export or a custom API instead.',
|
|
5139
6126
|
},
|
|
5140
6127
|
{
|
|
5141
6128
|
name: 'URLEncode',
|
|
@@ -5147,28 +6134,32 @@ export const FUNCTIONS = [
|
|
|
5147
6134
|
minArgs: 1,
|
|
5148
6135
|
maxArgs: 3,
|
|
5149
6136
|
category: 'Encryption and Encoding',
|
|
5150
|
-
description:
|
|
6137
|
+
description:
|
|
6138
|
+
'URL-encodes a string for safe inclusion in a URL. By default only the part after a question mark is touched, so a value that is not a URL passes through unchanged unless the third argument is switched on.',
|
|
6139
|
+
isConfirmed: true,
|
|
6140
|
+
differsFromOfficialDocs: false,
|
|
6141
|
+
sfmcGuideUrl: 'https://sfmc.guide/engagement/ampscript/functions/urlencode/',
|
|
5151
6142
|
params: [
|
|
5152
6143
|
{
|
|
5153
6144
|
name: 'urlToEncode',
|
|
5154
6145
|
description: 'The string to convert to a format that is safe to include in URLs',
|
|
5155
|
-
type: 'string',
|
|
6146
|
+
type: 'string|number',
|
|
5156
6147
|
},
|
|
5157
6148
|
{
|
|
5158
6149
|
name: 'encodeAllChars',
|
|
5159
6150
|
mcnSince: null,
|
|
5160
6151
|
mcnNotes: null,
|
|
5161
6152
|
description:
|
|
5162
|
-
'
|
|
5163
|
-
type: 'boolean',
|
|
6153
|
+
'When switched on, every reserved character of the query string is percent-encoded and spaces become plus signs; when off, only spaces are encoded, as %20. Accepts 1/0, true/false, or those spellings quoted. Defaults to off',
|
|
6154
|
+
type: 'string|boolean|number',
|
|
5164
6155
|
optional: true,
|
|
5165
6156
|
default: false,
|
|
5166
6157
|
},
|
|
5167
6158
|
{
|
|
5168
6159
|
name: 'encodeAllStrings',
|
|
5169
6160
|
description:
|
|
5170
|
-
'
|
|
5171
|
-
type: 'boolean',
|
|
6161
|
+
'When switched on, the whole input is encoded even if it is not a URL; when off, only the part after a question mark is encoded. Accepts 1/0, true/false, or those spellings quoted. Defaults to off',
|
|
6162
|
+
type: 'string|boolean|number',
|
|
5172
6163
|
optional: true,
|
|
5173
6164
|
},
|
|
5174
6165
|
],
|
|
@@ -5189,6 +6180,11 @@ export const FUNCTIONS = [
|
|
|
5189
6180
|
category: 'MobileConnect',
|
|
5190
6181
|
description:
|
|
5191
6182
|
'Returns the keyword (verb) from an inbound mobile-originated (MO) message. Only usable in MobileConnect, chained off Msg(0). Takes no arguments.',
|
|
6183
|
+
isConfirmed: false,
|
|
6184
|
+
verificationBlocked: true,
|
|
6185
|
+
verificationBlockedReason: 'no-working-invocation',
|
|
6186
|
+
officialDocsNote:
|
|
6187
|
+
'Could not runtime-verify on the only available context (a CloudPage GET on cred/DEV, MID 510007949; no parent-BU escalation on this tenant). Verb is chained off Msg(0), and any page containing a Msg(0) construct aborts at compile time (HTTP 422) on a CloudPage while an otherwise identical page without it renders HTTP 200. This matches the official reference, which restricts the function to MobileConnect and forbids landing pages / other content types; a CloudPage supplies no mobile-originated message to parse.',
|
|
5192
6188
|
params: [],
|
|
5193
6189
|
returnType: 'string',
|
|
5194
6190
|
returnDescription: 'The keyword (first word) of the inbound mobile-originated message.',
|
|
@@ -5202,16 +6198,24 @@ export const FUNCTIONS = [
|
|
|
5202
6198
|
mcnNotes: null,
|
|
5203
6199
|
docUrl: 'https://developer.salesforce.com/docs/marketing/marketing-cloud-ampscript/references/mc-ampscript-utilities/mc-ampscript-reference-utilities-v.html',
|
|
5204
6200
|
guideUrl: 'https://ampscript.guide/v/',
|
|
6201
|
+
sfmcGuideUrl: 'https://sfmc.guide/engagement/ampscript/functions/v/',
|
|
5205
6202
|
minArgs: 1,
|
|
5206
6203
|
maxArgs: 1,
|
|
5207
6204
|
category: 'Utility',
|
|
5208
6205
|
description:
|
|
5209
|
-
'
|
|
5210
|
-
params: [
|
|
6206
|
+
'Outputs a value inline, normally a variable reference. A string or number literal and a nested function call are accepted as well, each rendering its own value.',
|
|
6207
|
+
params: [
|
|
6208
|
+
{
|
|
6209
|
+
name: 'variableName',
|
|
6210
|
+
description: 'Variable reference, literal or nested function call to output',
|
|
6211
|
+
type: 'string|number',
|
|
6212
|
+
},
|
|
6213
|
+
],
|
|
5211
6214
|
returnType: 'string',
|
|
5212
|
-
returnDescription: 'The value
|
|
6215
|
+
returnDescription: 'The referenced value rendered as a string.',
|
|
5213
6216
|
syntax: 'v(variableName)',
|
|
5214
6217
|
example: '%%=v(@myVar)=%%',
|
|
6218
|
+
isConfirmed: true,
|
|
5215
6219
|
},
|
|
5216
6220
|
{
|
|
5217
6221
|
name: 'WAT',
|
|
@@ -5249,6 +6253,9 @@ export const FUNCTIONS = [
|
|
|
5249
6253
|
repeat: [{ startIndex: 1, groupSize: 1, minGroups: 1 }],
|
|
5250
6254
|
syntax: 'WAT(parameterSetKey, parameterValue1[, parameterValueN, ...])',
|
|
5251
6255
|
example: "%%=WAT('Omniture', '1234', '5678')=%%",
|
|
6256
|
+
isConfirmed: false,
|
|
6257
|
+
verificationBlocked: true,
|
|
6258
|
+
verificationBlockedReason: 'no-working-invocation',
|
|
5252
6259
|
},
|
|
5253
6260
|
{
|
|
5254
6261
|
name: 'WATP',
|
|
@@ -5274,6 +6281,9 @@ export const FUNCTIONS = [
|
|
|
5274
6281
|
'The parameter value supplied to the WAT function at the given ordinal position.',
|
|
5275
6282
|
syntax: 'WATP(ordinal)',
|
|
5276
6283
|
example: '%%=urlencode(WATP(1))=%%',
|
|
6284
|
+
isConfirmed: false,
|
|
6285
|
+
verificationBlocked: true,
|
|
6286
|
+
verificationBlockedReason: 'no-working-invocation',
|
|
5277
6287
|
},
|
|
5278
6288
|
{
|
|
5279
6289
|
name: 'WrapLongURL',
|
|
@@ -5285,10 +6295,17 @@ export const FUNCTIONS = [
|
|
|
5285
6295
|
minArgs: 1,
|
|
5286
6296
|
maxArgs: 1,
|
|
5287
6297
|
category: 'Utility',
|
|
5288
|
-
description:
|
|
5289
|
-
|
|
6298
|
+
description:
|
|
6299
|
+
'Shortens a long URL for email clients that truncate long hyperlinks. Outside an email send the argument comes back unchanged, so a CloudPage never sees a shortened link.',
|
|
6300
|
+
isConfirmed: true,
|
|
6301
|
+
differsFromOfficialDocs: true,
|
|
6302
|
+
officialDocsNote:
|
|
6303
|
+
'The official reference states that a URL longer than 975 characters comes back as a shortened link that redirects through the platform. On a live Engagement CloudPage on the child business unit (MID 518005426) a 1048-character URL was returned byte for byte unchanged at the same length, twice in one render, and the same held for a 27-character URL, an empty string and a string that is not a URL at all. The community guide notes that shortening only happens on a send, which the official page does not mention.',
|
|
6304
|
+
sfmcGuideUrl: 'https://sfmc.guide/engagement/ampscript/functions/wraplongurl/',
|
|
6305
|
+
params: [{ name: 'url', description: 'URL to shorten', type: 'string|number' }],
|
|
5290
6306
|
returnType: 'string',
|
|
5291
|
-
returnDescription:
|
|
6307
|
+
returnDescription:
|
|
6308
|
+
'The shortened URL when the call happens during a send; in any other context the supplied value unchanged.',
|
|
5292
6309
|
syntax: 'WrapLongURL(url)',
|
|
5293
6310
|
example: "%%=WrapLongURL('https://example.com/a/very/long/path')=%%",
|
|
5294
6311
|
},
|
|
@@ -5398,47 +6415,186 @@ export const deprecatedFunctionLookup = new Map(
|
|
|
5398
6415
|
* - `name` the keyword as written in source
|
|
5399
6416
|
* - `description` short human-readable explanation
|
|
5400
6417
|
* - `snippet` completion body with `${n:placeholder}` tab stops
|
|
6418
|
+
* - `handlebarsEquivalent` (OPTIONAL): name of the Handlebars helper/construct that plays the
|
|
6419
|
+
* same role, or `null` when the keyword has no counterpart. Handlebars models control flow
|
|
6420
|
+
* and logic as helpers, so language constructs (not just functions) map across.
|
|
6421
|
+
* - `handlebarsNote` (OPTIONAL): human-readable caveat about how the Handlebars construct differs
|
|
6422
|
+
* from the AMPscript keyword. Only set when `handlebarsEquivalent` is non-null.
|
|
5401
6423
|
*
|
|
5402
|
-
* @type {{name: string, description: string, snippet: string}[]}
|
|
6424
|
+
* @type {{name: string, description: string, snippet: string, handlebarsEquivalent?: string | null, handlebarsNote?: string | null}[]}
|
|
5403
6425
|
*/
|
|
5404
6426
|
export const AMPSCRIPT_KEYWORDS = [
|
|
5405
6427
|
{
|
|
5406
6428
|
name: 'var',
|
|
5407
6429
|
description: 'Declares one or more variables',
|
|
5408
6430
|
snippet: 'var @${1:variableName}',
|
|
6431
|
+
handlebarsEquivalent: 'set',
|
|
6432
|
+
handlebarsNote: 'Handlebars set is block-scoped and does not persist outside its block.',
|
|
5409
6433
|
},
|
|
5410
6434
|
{
|
|
5411
6435
|
name: 'set',
|
|
5412
6436
|
description: 'Assigns a value to a variable',
|
|
5413
6437
|
snippet: 'set @${1:variableName} = ${2:value}',
|
|
6438
|
+
handlebarsEquivalent: 'set',
|
|
6439
|
+
handlebarsNote: 'Handlebars set is block-scoped and does not persist outside its block.',
|
|
5414
6440
|
},
|
|
5415
6441
|
{
|
|
5416
6442
|
name: 'if',
|
|
5417
6443
|
description: 'Begins a conditional block',
|
|
5418
6444
|
snippet: 'if ${1:condition} then\n\t${2}\nendif',
|
|
6445
|
+
handlebarsEquivalent: 'if',
|
|
6446
|
+
handlebarsNote: 'elseif/else become {{else if}} / {{else}} inside the same block.',
|
|
6447
|
+
},
|
|
6448
|
+
{
|
|
6449
|
+
name: 'then',
|
|
6450
|
+
description: 'Follows an if/elseif condition',
|
|
6451
|
+
snippet: 'then',
|
|
6452
|
+
handlebarsEquivalent: null,
|
|
5419
6453
|
},
|
|
5420
|
-
{ name: 'then', description: 'Follows an if/elseif condition', snippet: 'then' },
|
|
5421
6454
|
{
|
|
5422
6455
|
name: 'elseif',
|
|
5423
6456
|
description: 'Additional condition in an if block',
|
|
5424
6457
|
snippet: 'elseif ${1:condition} then',
|
|
6458
|
+
handlebarsEquivalent: 'if',
|
|
6459
|
+
handlebarsNote: 'Written as {{else if condition}} inside the enclosing {{#if}} block.',
|
|
6460
|
+
},
|
|
6461
|
+
{
|
|
6462
|
+
name: 'else',
|
|
6463
|
+
description: 'Fallback branch in an if block',
|
|
6464
|
+
snippet: 'else',
|
|
6465
|
+
handlebarsEquivalent: 'if',
|
|
6466
|
+
handlebarsNote: 'Written as {{else}} inside the enclosing {{#if}} block.',
|
|
6467
|
+
},
|
|
6468
|
+
{
|
|
6469
|
+
name: 'endif',
|
|
6470
|
+
description: 'Closes an if block',
|
|
6471
|
+
snippet: 'endif',
|
|
6472
|
+
handlebarsEquivalent: null,
|
|
5425
6473
|
},
|
|
5426
|
-
{ name: 'else', description: 'Fallback branch in an if block', snippet: 'else' },
|
|
5427
|
-
{ name: 'endif', description: 'Closes an if block', snippet: 'endif' },
|
|
5428
6474
|
{
|
|
5429
6475
|
name: 'for',
|
|
5430
6476
|
description: 'Begins a counting loop',
|
|
5431
6477
|
snippet: 'for @${1:i} = ${2:1} to ${3:rowCount} do\n\t${4}\nnext @${1:i}',
|
|
6478
|
+
handlebarsEquivalent: 'each',
|
|
6479
|
+
handlebarsNote:
|
|
6480
|
+
'Use {{#repeat}} for a plain counting loop; {{#each}} iterates a collection.',
|
|
6481
|
+
},
|
|
6482
|
+
{
|
|
6483
|
+
name: 'to',
|
|
6484
|
+
description: 'Ascending direction in a for loop',
|
|
6485
|
+
snippet: 'to',
|
|
6486
|
+
handlebarsEquivalent: null,
|
|
6487
|
+
},
|
|
6488
|
+
{
|
|
6489
|
+
name: 'downto',
|
|
6490
|
+
description: 'Descending direction in a for loop',
|
|
6491
|
+
snippet: 'downto',
|
|
6492
|
+
handlebarsEquivalent: null,
|
|
6493
|
+
},
|
|
6494
|
+
{
|
|
6495
|
+
name: 'do',
|
|
6496
|
+
description: 'Marks the start of a loop body',
|
|
6497
|
+
snippet: 'do',
|
|
6498
|
+
handlebarsEquivalent: null,
|
|
6499
|
+
},
|
|
6500
|
+
{
|
|
6501
|
+
name: 'next',
|
|
6502
|
+
description: 'Ends a for loop iteration',
|
|
6503
|
+
snippet: 'next',
|
|
6504
|
+
handlebarsEquivalent: null,
|
|
6505
|
+
},
|
|
6506
|
+
{
|
|
6507
|
+
name: 'and',
|
|
6508
|
+
description: 'Logical AND operator',
|
|
6509
|
+
snippet: 'and',
|
|
6510
|
+
handlebarsEquivalent: 'and',
|
|
6511
|
+
},
|
|
6512
|
+
{ name: 'or', description: 'Logical OR operator', snippet: 'or', handlebarsEquivalent: 'or' },
|
|
6513
|
+
{
|
|
6514
|
+
name: 'not',
|
|
6515
|
+
description: 'Logical NOT operator',
|
|
6516
|
+
snippet: 'not',
|
|
6517
|
+
handlebarsEquivalent: 'not',
|
|
6518
|
+
},
|
|
6519
|
+
{
|
|
6520
|
+
name: 'true',
|
|
6521
|
+
description: 'Boolean true constant',
|
|
6522
|
+
snippet: 'true',
|
|
6523
|
+
handlebarsEquivalent: null,
|
|
6524
|
+
},
|
|
6525
|
+
{
|
|
6526
|
+
name: 'false',
|
|
6527
|
+
description: 'Boolean false constant',
|
|
6528
|
+
snippet: 'false',
|
|
6529
|
+
handlebarsEquivalent: null,
|
|
6530
|
+
},
|
|
6531
|
+
];
|
|
6532
|
+
|
|
6533
|
+
// ── Operators ────────────────────────────────────────────────────────────────
|
|
6534
|
+
|
|
6535
|
+
/**
|
|
6536
|
+
* AMPscript symbolic operator with its Handlebars counterpart. These glyphs are not valid
|
|
6537
|
+
* keyword names (they fail the identifier grammar), so they live in a dedicated export rather
|
|
6538
|
+
* than in AMPSCRIPT_KEYWORDS.
|
|
6539
|
+
* - `name` the operator glyph as written in source
|
|
6540
|
+
* - `category` 'comparison' or 'assignment'
|
|
6541
|
+
* - `description` short human-readable explanation
|
|
6542
|
+
* - `handlebarsEquivalent` name of the Handlebars helper that plays the same role, or `null`
|
|
6543
|
+
* - `handlebarsNote` caveat about how the Handlebars helper is invoked; only set when
|
|
6544
|
+
* `handlebarsEquivalent` is non-null
|
|
6545
|
+
*
|
|
6546
|
+
* @type {{name: string, category: 'comparison' | 'assignment', description: string, handlebarsEquivalent: string | null, handlebarsNote: string | null}[]}
|
|
6547
|
+
*/
|
|
6548
|
+
export const AMPSCRIPT_OPERATORS = [
|
|
6549
|
+
{
|
|
6550
|
+
name: '==',
|
|
6551
|
+
category: 'comparison',
|
|
6552
|
+
description: 'Equality comparison',
|
|
6553
|
+
handlebarsEquivalent: 'equals',
|
|
6554
|
+
handlebarsNote: null,
|
|
6555
|
+
},
|
|
6556
|
+
{
|
|
6557
|
+
name: '!=',
|
|
6558
|
+
category: 'comparison',
|
|
6559
|
+
description: 'Inequality comparison',
|
|
6560
|
+
handlebarsEquivalent: 'compare',
|
|
6561
|
+
handlebarsNote: 'Pass "!=" as the operator argument to compare.',
|
|
6562
|
+
},
|
|
6563
|
+
{
|
|
6564
|
+
name: '>',
|
|
6565
|
+
category: 'comparison',
|
|
6566
|
+
description: 'Greater-than comparison',
|
|
6567
|
+
handlebarsEquivalent: 'compare',
|
|
6568
|
+
handlebarsNote: 'Pass ">" as the operator argument to compare.',
|
|
6569
|
+
},
|
|
6570
|
+
{
|
|
6571
|
+
name: '>=',
|
|
6572
|
+
category: 'comparison',
|
|
6573
|
+
description: 'Greater-than-or-equal comparison',
|
|
6574
|
+
handlebarsEquivalent: 'compare',
|
|
6575
|
+
handlebarsNote: 'Pass ">=" as the operator argument to compare.',
|
|
6576
|
+
},
|
|
6577
|
+
{
|
|
6578
|
+
name: '<',
|
|
6579
|
+
category: 'comparison',
|
|
6580
|
+
description: 'Less-than comparison',
|
|
6581
|
+
handlebarsEquivalent: 'compare',
|
|
6582
|
+
handlebarsNote: 'Pass "<" as the operator argument to compare.',
|
|
6583
|
+
},
|
|
6584
|
+
{
|
|
6585
|
+
name: '<=',
|
|
6586
|
+
category: 'comparison',
|
|
6587
|
+
description: 'Less-than-or-equal comparison',
|
|
6588
|
+
handlebarsEquivalent: 'compare',
|
|
6589
|
+
handlebarsNote: 'Pass "<=" as the operator argument to compare.',
|
|
6590
|
+
},
|
|
6591
|
+
{
|
|
6592
|
+
name: '=',
|
|
6593
|
+
category: 'assignment',
|
|
6594
|
+
description: 'Assignment operator (inside set)',
|
|
6595
|
+
handlebarsEquivalent: 'set',
|
|
6596
|
+
handlebarsNote: 'Handlebars set is block-scoped and does not persist outside its block.',
|
|
5432
6597
|
},
|
|
5433
|
-
{ name: 'to', description: 'Ascending direction in a for loop', snippet: 'to' },
|
|
5434
|
-
{ name: 'downto', description: 'Descending direction in a for loop', snippet: 'downto' },
|
|
5435
|
-
{ name: 'do', description: 'Marks the start of a loop body', snippet: 'do' },
|
|
5436
|
-
{ name: 'next', description: 'Ends a for loop iteration', snippet: 'next' },
|
|
5437
|
-
{ name: 'and', description: 'Logical AND operator', snippet: 'and' },
|
|
5438
|
-
{ name: 'or', description: 'Logical OR operator', snippet: 'or' },
|
|
5439
|
-
{ name: 'not', description: 'Logical NOT operator', snippet: 'not' },
|
|
5440
|
-
{ name: 'true', description: 'Boolean true constant', snippet: 'true' },
|
|
5441
|
-
{ name: 'false', description: 'Boolean false constant', snippet: 'false' },
|
|
5442
6598
|
];
|
|
5443
6599
|
|
|
5444
6600
|
// ── Personalization strings ──────────────────────────────────────────────────
|