TAG LINE
TAG LINE
SMALL TITLE
identity READ-ONLY | "identity": 10 Type: Number This is the unique numeric identifier for the EmailSetting |
ownerId READ-ONLY | "ownerId": 16 Type: Number Unique identifier for the associated Owner object. |
ownerName READ-ONLY | "ownerName": "Sample Name" Type: String The name of the object associated with the ownerId property. |
name | "name": "Hello World" Type: String |
fromEmailAddress | "fromEmailAddress": "Hello World" Type: String |
fromName | "fromName": "Hello World" Type: String |
useSecureConnection | "useSecureConnection": true Type: Boolean |
maxAttachmentsSizeInMiB | "maxAttachmentsSizeInMiB": 24 Type: Number |
failureNotificationUserId | "failureNotificationUserId": 19 Type: Number Unique identifier for the associated User object. |
failureNotificationUserName | "failureNotificationUserName": "Sample Name" Type: String The name of the object associated with the failureNotificationUserId property. |
emailHostTypeId | "emailHostTypeId": 25 Type: Number Unique identifier for the associated EmailHostType object. |
emailHostTypeName | "emailHostTypeName": "Sample Name" Type: String The name of the object associated with the emailHostTypeId property. |
emailSettingsKeyName | "emailSettingsKeyName": "Hello World" Type: String |
| DELETE | EmailSetting/{id} |
| Delete an instance of the EmailSetting object. Upon successful delete, this API will return a record of all of the related objects deleted with this operation. The specifics on which objects have been deleted will depend on which related objects have been populated in the system. | |
| {id} | Unique identifier for the EmailSetting object. |
Delete an instance of the EmailSetting object. DELETE EmailSetting/{id}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"type": "delete",
"results": {
"totalCount": 4,
"items": [
{
"identity": 1,
"action": "deleted",
"dtoTypeKey": "emailSetting"
},
{
"lhsId": 2,
"rhsId": 2,
"action": "detached",
"dtoTypeKey": "sampleObjectConnector"
},
{
"foreignKeyIdentity": 2,
"action": "deleted",
"dtoTypeKey": "sampleObject"
}
]
}
} | |
| GET | EmailSetting/GoogleJWT/{id} |
| Retrieve an instance of the EmailSetting object by its ID. | |
| {id} | Unique identifier for the EmailSetting object. |
Retrieve an instance of the EmailSetting object by its ID. GET EmailSetting/GoogleJWT/{id}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"instance": {
"identity": 1,
"ownerId": 4,
"ownerName": "Sample Text Data",
"name": "Sample Text Data",
"fromEmailAddress": "Sample Text Data",
"fromName": "Sample Text Data",
"useSecureConnection": true,
"maxAttachmentsSizeInMiB": 0,
"failureNotificationUserId": 6,
"failureNotificationUserName": "Sample Text Data",
"emailHostTypeId": 21,
"emailHostTypeName": "Sample Text Data",
"emailSettingsKeyName": "Sample Text Data"
}
} | |
| GET | EmailSetting/SMTPAuth/{id} |
| Retrieve an instance of the EmailSetting object by its ID. | |
| {id} | Unique identifier for the EmailSetting object. |
Retrieve an instance of the EmailSetting object by its ID. GET EmailSetting/SMTPAuth/{id}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"instance": {
"identity": 1,
"ownerId": 15,
"ownerName": "Sample Text Data",
"name": "Sample Text Data",
"fromEmailAddress": "Sample Text Data",
"fromName": "Sample Text Data",
"useSecureConnection": true,
"maxAttachmentsSizeInMiB": 2,
"failureNotificationUserId": 0,
"failureNotificationUserName": "Sample Text Data",
"emailHostTypeId": 2,
"emailHostTypeName": "Sample Text Data",
"emailSettingsKeyName": "Sample Text Data"
}
} | |
| POST | EmailSetting/GoogleJWT |
| Create a new instance of the EmailSetting object. | |
Create a new instance of the EmailSetting object. POST EmailSetting/GoogleJWT
{
"name": "Sample Text Data",
"fromEmailAddress": "Sample Text Data",
"fromName": "Sample Text Data",
"useSecureConnection": true,
"maxAttachmentsSizeInMiB": 10,
"failureNotificationUserId": 27,
"emailHostTypeId": 23,
"emailSettingsKeyName": "Sample Text Data"
}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"type": "create",
"results": {
"totalCount": 1,
"items": [
{
"identity": 1,
"ownerId": 19,
"ownerName": "Sample Text Data",
"name": "Sample Text Data",
"fromEmailAddress": "Sample Text Data",
"fromName": "Sample Text Data",
"useSecureConnection": true,
"maxAttachmentsSizeInMiB": 2,
"failureNotificationUserId": 26,
"failureNotificationUserName": "Sample Text Data",
"emailHostTypeId": 22,
"emailHostTypeName": "Sample Text Data",
"emailSettingsKeyName": "Sample Text Data"
}
]
}
} | |
| POST | EmailSetting/SMTPAuth |
| Create a new instance of the EmailSetting object. | |
Create a new instance of the EmailSetting object. POST EmailSetting/SMTPAuth
{
"name": "Sample Text Data",
"fromEmailAddress": "Sample Text Data",
"fromName": "Sample Text Data",
"useSecureConnection": true,
"maxAttachmentsSizeInMiB": 21,
"failureNotificationUserId": 15,
"emailHostTypeId": 3,
"emailSettingsKeyName": "Sample Text Data"
}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"type": "create",
"results": {
"totalCount": 1,
"items": [
{
"identity": 1,
"ownerId": 19,
"ownerName": "Sample Text Data",
"name": "Sample Text Data",
"fromEmailAddress": "Sample Text Data",
"fromName": "Sample Text Data",
"useSecureConnection": true,
"maxAttachmentsSizeInMiB": 27,
"failureNotificationUserId": 25,
"failureNotificationUserName": "Sample Text Data",
"emailHostTypeId": 26,
"emailHostTypeName": "Sample Text Data",
"emailSettingsKeyName": "Sample Text Data"
}
]
}
} | |
| PUT | EmailSetting/GoogleJWT/{id} |
| Update an existing instance of the EmailSetting object. | |
Update an existing instance of the EmailSetting object. PUT EmailSetting/GoogleJWT/{id}
{
"identity": 1,
"name": "Sample Text Data",
"fromEmailAddress": "Sample Text Data",
"fromName": "Sample Text Data",
"useSecureConnection": true,
"maxAttachmentsSizeInMiB": 20,
"failureNotificationUserId": 24,
"emailHostTypeId": 1,
"emailSettingsKeyName": "Sample Text Data"
}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"type": "update",
"results": {
"totalCount": 1,
"items": [
{
"identity": 1,
"ownerId": 11,
"ownerName": "Sample Text Data",
"name": "Sample Text Data",
"fromEmailAddress": "Sample Text Data",
"fromName": "Sample Text Data",
"useSecureConnection": true,
"maxAttachmentsSizeInMiB": 24,
"failureNotificationUserId": 7,
"failureNotificationUserName": "Sample Text Data",
"emailHostTypeId": 12,
"emailHostTypeName": "Sample Text Data",
"emailSettingsKeyName": "Sample Text Data"
}
]
}
} | |
| PUT | EmailSetting/SMTPAuth/{id} |
| Update an existing instance of the EmailSetting object. | |
Update an existing instance of the EmailSetting object. PUT EmailSetting/SMTPAuth/{id}
{
"identity": 1,
"name": "Sample Text Data",
"fromEmailAddress": "Sample Text Data",
"fromName": "Sample Text Data",
"useSecureConnection": true,
"maxAttachmentsSizeInMiB": 5,
"failureNotificationUserId": 5,
"emailHostTypeId": 8,
"emailSettingsKeyName": "Sample Text Data"
}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"type": "update",
"results": {
"totalCount": 1,
"items": [
{
"identity": 1,
"ownerId": 5,
"ownerName": "Sample Text Data",
"name": "Sample Text Data",
"fromEmailAddress": "Sample Text Data",
"fromName": "Sample Text Data",
"useSecureConnection": true,
"maxAttachmentsSizeInMiB": 15,
"failureNotificationUserId": 4,
"failureNotificationUserName": "Sample Text Data",
"emailHostTypeId": 21,
"emailHostTypeName": "Sample Text Data",
"emailSettingsKeyName": "Sample Text Data"
}
]
}
} | |