Difference between revisions of "PEC-Developer/Current/SCAPI/EmailNamespace"

From Genesys Documentation
Jump to: navigation, search
m (Text replacement - "\|Platform=([^\|]*)GenesysEngage-onpremises([\|]*)" to "|Platform=$1GenesysEngage-cloud$2")
 
Line 6: Line 6:
 
|ComingSoon=No
 
|ComingSoon=No
 
|Platform=GenesysEngage-cloud
 
|Platform=GenesysEngage-cloud
|Prereq=
 
 
|Section={{Section
 
|Section={{Section
 
|sectionHeading=Methods
 
|sectionHeading=Methods
 
|anchor=Methods
 
|anchor=Methods
 
|alignment=Vertical
 
|alignment=Vertical
|Media=
 
|image=
 
 
|structuredtext=The Email namespace includes the following methods:
 
|structuredtext=The Email namespace includes the following methods:
  
Line 20: Line 17:
 
{{{!}}
 
{{{!}}
 
!Signature
 
!Signature
{{!}}<static> create(''destination'', ''userData'')
+
{{!}}<static> create(''destination'', ''userData, succeeded, failed'')
 
{{!}}-
 
{{!}}-
 
!Description
 
!Description
Line 42: Line 39:
 
{{!}}<optional>
 
{{!}}<optional>
 
{{!}}The attached user data key/value object that is updated with each interaction event.
 
{{!}}The attached user data key/value object that is updated with each interaction event.
 +
{{!}}-
 +
{{!}}succeeded
 +
{{!}}function
 +
{{!}}
 +
{{!}}A function called when the operation succeeds.
 +
{{!}}-
 +
{{!}}failed
 +
{{!}}function
 +
{{!}}
 +
{{!}}A function called when the operation fails.
 
{{!}}}
 
{{!}}}
 
{{!}}}
 
{{!}}}
|structuredtextwide=
 
|FAQHeading=
 
 
|Status=No
 
|Status=No
 
}}
 
}}
 
}}
 
}}

Latest revision as of 13:44, February 22, 2023

This topic is part of the manual Service Client API Reference for version Current of Developer.

Learn about the Email namespace methods in the Service Client API.

Methods

The Email namespace includes the following methods:

create

Signature <static> create(destination, userData, succeeded, failed)
Description Creates a new empty email.
Parameters
Name Type Argument Description
destination string The destination address for the email.
userData object <optional> The attached user data key/value object that is updated with each interaction event.
succeeded function A function called when the operation succeeds.
failed function A function called when the operation fails.
Comments or questions about this documentation? Contact us for support!