POST /email-messages
Creates an email message.
Servers
- https://api-sandbox.rebilly.com/organizations/{organizationId}
- https://api.rebilly.com/organizations/{organizationId}
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
responseCode |
Integer | No |
Status code returned by a mail service after an attempt to send email. |
credentialHash |
String | No |
ID of the SMTP or Email Service Provider (ESP) credential. |
sentTime |
String | No |
Date and time when the email is sent. |
createdTime |
String | No |
Date and time when the resource is created. This value is set automatically when the resource is created. |
metadata |
Object | No |
Metadata associated with the email message. |
status |
String | No |
Status of the email message. Valid values:
Default value: "draft" |
subject |
String | Yes |
Subject of the email message. |
initiatedTime |
String | No |
Date and time when the email is initiated. |
from |
String | Yes |
Email address of the sender. |
id |
String | No |
ID of the email message. |
to[] |
Array | Yes |
List of email addresses to which the email message is sent. |
_links[] |
Array | No |
Related links. |
_links[].href |
String | No |
Link URL. |
_links[].rel |
String | No |
Type of link. Valid values:
|
html |
String | Yes |
Body of the email message in HTML format. |
text |
String | Yes |
Body of the email message in plain text. |
updatedTime |
String | No |
Date and time when the resource is updated. This value is set automatically when the resource is updated. |
cc[] |
Array | No |
List of CC email addresses to which the email message is sent. |
bcc[] |
Array | No |
List of BCC email addresses to which the email message is sent. |
attachments[] |
Array | No |
Attachments of the email message. |
attachments[].resourceId |
String | Yes |
ID of the attachment resource. |
attachments[].resourceType |
String | Yes |
Type of attachment resource. |
responseBody |
String | No |
Body of response returned by a mail service after an attempt to send email. |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.