Email Configuration

What can you do with EmailConfiguration?


Properties

Property Details
id
"id": 903
Type: Number
This is the unique numeric identifier for the EmailConfiguration
name
"name": "Hello World"
Type: String
eventSubscriptionId
"eventSubscriptionId": 444
Type: Number
Unique identifier for the associated EventSubscription object.
emailTemplateId
"emailTemplateId": 179
Type: Number
Unique identifier for the associated EmailTemplate object.


Update Request Filters

When updating an object you use the update request header with the list of properties to update. Then you need only supply the new values in the body of your request. Please note, this header can only be used with PUT or PATCH requests.

Field List:

  • name
  • eventSubscriptionId
  • emailTemplateId

Patch Types

The PATCH verb allows you to update an object. Just like a put, you only need to supply the fields that will be updated in the payload. However, a patch allows you to update many objects at once.

PATCH operations can be used as a standard API call or nested within the envelope of a DataFlow. Below you will find the child objects that can be updated as part of PATCH operations for the EmailConfiguration object.

Standard PATCH objects:

DataFlow PATCH objects:


End Points

DELETEapi/v1/EmailConfiguration/{id:int}
Delete an instance of the EmailConfiguration object.
GETapi/v1/EmailConfiguration
Retrieve all of the EmailConfiguration objects.
GETapi/v1/EmailConfiguration/Metadata
Retrieve all of the meta data details of the EmailConfiguration object.
GETapi/v1/EmailConfiguration/Metadata/{option}
Retrieve all the meta data details of the EmailConfiguration object based on provided options.
{option}Metadata options for the EmailConfiguration object.
GETapi/v1/EmailConfiguration/Paged
Retreive all of the EmailConfiguration objects in a paged fashion.
GETapi/v1/EmailConfiguration/Paged/Detail
Retreive all of the EmailConfiguration objects in a paged fashion with all object details.
GETapi/v1/EmailConfiguration/{id:int}
Retrieve an instance of the EmailConfiguration object by it's ID.
{id:int}Unique identifier for the EmailConfiguration object.
GETapi/v1/EmailConfiguration/{id:int}/Detail
Retreive all of the Detail objects for the specified EmailConfiguration.
{id:int}Unique identifier for the EmailConfiguration object.
PATCHapi/v1/EmailConfiguration/{id:int}
Update the EmailConfiguration object and optionally make changes to any child objects.
POSTapi/v1/EmailConfiguration
Create a new instance of the EmailConfiguration object.
PUTapi/v1/EmailConfiguration/{id:int}
Update an existing instance of the EmailConfiguration object.