Email Entity

The following are the attributes in the body of a email service.
Attribute Type Updatable Comments
 id  UUID  no (Required for PUT only)For PUT the ID in body must valid ID and must match step on the URL.

For POST this is ignored.
 name  string  yes (Required) Unique among other email objects. A Valid SQL Identifier.
 fromEmail  string  yes (Optional) xCL expression that evaluates to an email address.

Please refer to xCL manual for proper xCL syntax. If you want to add a string literal then you have to enclose it in single quotes. E.g. “fromEmail”:”‘testuser@xactlycorp.com‘” )
 toEmails  string  yes (Required) xCL expression that evaluates to a ResultSet of email addresses.

Please refer to xCL manual for proper xCL syntax. If you want to add a string literal then you have to enclose it in single quotes. E.g. “fromEmail”:”‘testuser@xactlycorp.com‘” )
 ccEmails  string  yes (Optional) xCL expression that evaluates to a ResultSet of email addresses.

Please refer to xCL manual for proper xCL syntax. If you want to add a string literal then you have to enclose it in single quotes. E.g. “fromEmail”:”‘testuser@xactlycorp.com‘” )
 bccEmails  string  yes (Optional) xCL expression that evaluates to a ResultSet of email addresses.

Please refer to xCL manual for proper xCL syntax. If you want to add a string literal then you have to enclose it in single quotes. E.g. “fromEmail”:”‘testuser@xactlycorp.com‘” )
 replyToEmails  string  yes (Optional) xCL expression that evaluates to an email address.

Please refer to xCL manual for proper xCL syntax. If you want to add a string literal then you have to enclose it in single quotes. E.g. “fromEmail”:”‘testuser@xactlycorp.com‘” )
 subject  string  yes (Optional) xCL expression that evaluates to a subject string.

Please refer to xCL manual for proper xCL syntax. If you want to add a string literal then you have to enclose it in single quotes. E.g. “fromEmail”:”‘testuser@xactlycorp.com‘” )
 body  string  yes (Required) xCL expression that evaluates to the body of the email.

Please refer to xCL manual for proper xCL syntax. If you want to add a string literal then you have to enclose it in single quotes. E.g. “fromEmail”:”‘testuser@xactlycorp.com‘” )
 contentType  string  yes (Optional) A mime-type string.

Please refer to xCL manual for proper xCL syntax. If you want to add a string literal then you have to enclose it in single quotes. E.g. “fromEmail”:”‘testuser@xactlycorp.com‘” )
 description  string  yes (Optional)
 attachments  List<EmailAttachment>  yes (Optional) Refer to next table for EmailAttachment entity attributes.
 createdInstant  datetime  no (Optional)
createdBy  string  no (Optional) Username associated with session
modifiedInstant  datetime  no (Optional)
modifiedBy  string  no (Optional) Username associated with session

EmailAttachment Entity

The following are the attributes in the body of a email service.
Attribute Type Updatable Comments
 command  string  no (Optional) The xCL expression that evaluates to a the attachment string.

Please refer to xCL manual for proper xCL syntax. If you want to add a string literal then you have to enclose it in single quotes. E.g. “show steps”).
 type  string  no (Optional) The type of the attachment (e.g. csv, text, etc.).

Please refer to xCL manual for proper xCL syntax. If you want to add a string literal then you have to enclose it in single quotes. E.g. “type”:”‘text'” ).

List of APIs

Note: We have tried to keep this list up to date. However, for the most up to date list, see the interactive docs: https://connect-i1.xactlycorp.com/connect/docs/swagger-ui.html

POST /connect/v1/emails
Create an Email definition that can later be sent. Returns the resulting Email ID in the Location header.
DELETE /connect/v1/emails/{id}
Delete a Email from the repository.
GET /connect/v1/emails
Get a paginated list of all Email definitions. You can provide a page number (default 0) and a page size (default 100, max 1000).
GET /connect/v1/emails/{id}
Get a single Email definition. You have to provide a valid email ID
POST /connect/v1/emails/{id}/instances
Send the Email. The resulting email instance resource location is returned in the Location header.  The service will make a best effort to send the email but does not know with 100% certainty whether it was received.
PUT /connect/v1/emails/{id}
Update a Email definition. You have to provide a valid email definition ID in the URL and in the payload. The ID attribute can not be updated.