Boomi MFT - AFT Management API Reference (v1) - FlowEndpointEmailNotifications

Toggle Pane

• FlowEndpointEmailNotifications
  • getRetrieves a specific email notification configuration by ID
  • delDeletes a specific email notification configuration
  • getRetrieves all email notification configurations for a specific flow endpoint
  • postCreates a new email notification configuration for a flow endpoint
  • putUpdates an existing email notification configuration for a flow endpoint
  • putSaves email notification configuration (creates new or updates existing based on ID)
  • delDeletes all email notification configurations for a specific flow endpoint

API docs by Redocly

Download OpenAPI Specification: Download

For more information about Postman collections, forking, and making your first API call, refer to the Working with Boomi APIs on Postman page.

FlowEndpointEmailNotifications

Retrieves a specific email notification configuration by ID

Returns email notification configuration including recipients and trigger events.

Authorizations:

ApiKeyBearer

path Parameters

flowEndpointEmailNotificationId required

integer <int32> Unique identifier of the email notification configuration

Responses

Response Schema:

text/plainapplication/jsontext/jsontext/plain

id	integer <int32>
flowEndpointId	integer <int32>
email	string or null
notifyQueueDepth	boolean
notifyInactivity	boolean
notifyError	boolean
notifyTranferComplete	boolean
notifyQuarantined	boolean
createdBy	string or null
createdDate	string or null <date-time>
updatedBy	string or null
updatedDate	string or null <date-time>
deletedBy	string or null
deletedDate	string or null <date-time>

https://us.thruinc.com/api/FlowEndpointEmailNotifications/{flowEndpointEmailNotificationId}

https://uk.thruinc.com/api/FlowEndpointEmailNotifications/{flowEndpointEmailNotificationId}

https://eu.thruinc.com/api/FlowEndpointEmailNotifications/{flowEndpointEmailNotificationId}

https://au.thruinc.com/api/FlowEndpointEmailNotifications/{flowEndpointEmailNotificationId}

Response samples

• 200
• 403
• 500

Content type

text/plainapplication/jsontext/jsontext/plain

No sample

Deletes a specific email notification configuration

Removes email notification configuration from flow endpoint.

Authorizations:

ApiKeyBearer

path Parameters

flowEndpointEmailNotificationId required

integer <int32> Unique identifier of the email notification configuration to delete

Responses

Response Schema:

text/plainapplication/jsontext/jsontext/plain

	object (thruStatus)
data	any or null

https://us.thruinc.com/api/FlowEndpointEmailNotifications/{flowEndpointEmailNotificationId}

https://uk.thruinc.com/api/FlowEndpointEmailNotifications/{flowEndpointEmailNotificationId}

https://eu.thruinc.com/api/FlowEndpointEmailNotifications/{flowEndpointEmailNotificationId}

https://au.thruinc.com/api/FlowEndpointEmailNotifications/{flowEndpointEmailNotificationId}

Response samples

• 200
• 403
• 500

Content type

text/plainapplication/jsontext/jsontext/plain

No sample

Retrieves all email notification configurations for a specific flow endpoint

Returns list of email notification configurations for a flow endpoint.

Authorizations:

ApiKeyBearer

query Parameters

flowEndpointId required

integer <int32> Unique identifier of the flow endpoint

Responses

Response Schema:

text/plainapplication/jsontext/jsontext/plain

Array

id	integer <int32>
flowEndpointId	integer <int32>
email	string or null
notifyQueueDepth	boolean
notifyInactivity	boolean
notifyError	boolean
notifyTranferComplete	boolean
notifyQuarantined	boolean
createdBy	string or null
createdDate	string or null <date-time>
updatedBy	string or null
updatedDate	string or null <date-time>
deletedBy	string or null
deletedDate	string or null <date-time>

https://us.thruinc.com/api/FlowEndpointEmailNotifications/getFlowEndpointServerUsersList

https://uk.thruinc.com/api/FlowEndpointEmailNotifications/getFlowEndpointServerUsersList

https://eu.thruinc.com/api/FlowEndpointEmailNotifications/getFlowEndpointServerUsersList

https://au.thruinc.com/api/FlowEndpointEmailNotifications/getFlowEndpointServerUsersList

Response samples

• 200
• 403
• 500

Content type

text/plainapplication/jsontext/jsontext/plain

No sample

Creates a new email notification configuration for a flow endpoint

Establishes new email notification with specified recipients and event triggers.

Authorizations:

ApiKeyBearer

Request Body schema:

application/jsontext/jsonapplication/*+jsonapplication/json

Email notification configuration details including recipients and triggers

id	integer <int32>
flowEndpointId	integer <int32>
email	string or null
notifyQueueDepth	boolean
notifyInactivity	boolean
notifyError	boolean
notifyTranferComplete	boolean
notifyQuarantined	boolean
createdBy	string or null
createdDate	string or null <date-time>
updatedBy	string or null
updatedDate	string or null <date-time>
deletedBy	string or null
deletedDate	string or null <date-time>

Responses

Response Schema:

text/plainapplication/jsontext/jsontext/plain

id	integer <int32>
flowEndpointId	integer <int32>
email	string or null
notifyQueueDepth	boolean
notifyInactivity	boolean
notifyError	boolean
notifyTranferComplete	boolean
notifyQuarantined	boolean
createdBy	string or null
createdDate	string or null <date-time>
updatedBy	string or null
updatedDate	string or null <date-time>
deletedBy	string or null
deletedDate	string or null <date-time>

https://us.thruinc.com/api/FlowEndpointEmailNotifications

https://uk.thruinc.com/api/FlowEndpointEmailNotifications

https://eu.thruinc.com/api/FlowEndpointEmailNotifications

https://au.thruinc.com/api/FlowEndpointEmailNotifications

Request samples

• Payload

Content type

application/jsontext/jsonapplication/*+jsonapplication/json

{

• "id": 0,
• "flowEndpointId": 0,
• "email": "string",
• "notifyQueueDepth": true,
• "notifyInactivity": true,
• "notifyError": true,
• "notifyTranferComplete": true,
• "notifyQuarantined": true,
• "createdBy": "string",
• "createdDate": "2019-08-24T14:15:22Z",
• "updatedBy": "string",
• "updatedDate": "2019-08-24T14:15:22Z",
• "deletedBy": "string",
• "deletedDate": "2019-08-24T14:15:22Z"

}

Response samples

• 200
• 403
• 500

Content type

text/plainapplication/jsontext/jsontext/plain

No sample

Updates an existing email notification configuration for a flow endpoint

Modifies existing email notification configuration including recipients and triggers.

Authorizations:

ApiKeyBearer

Request Body schema:

application/jsontext/jsonapplication/*+jsonapplication/json

Updated email notification configuration details

id	integer <int32>
flowEndpointId	integer <int32>
email	string or null
notifyQueueDepth	boolean
notifyInactivity	boolean
notifyError	boolean
notifyTranferComplete	boolean
notifyQuarantined	boolean
createdBy	string or null
createdDate	string or null <date-time>
updatedBy	string or null
updatedDate	string or null <date-time>
deletedBy	string or null
deletedDate	string or null <date-time>

Responses

Response Schema:

text/plainapplication/jsontext/jsontext/plain

id	integer <int32>
flowEndpointId	integer <int32>
email	string or null
notifyQueueDepth	boolean
notifyInactivity	boolean
notifyError	boolean
notifyTranferComplete	boolean
notifyQuarantined	boolean
createdBy	string or null
createdDate	string or null <date-time>
updatedBy	string or null
updatedDate	string or null <date-time>
deletedBy	string or null
deletedDate	string or null <date-time>

https://us.thruinc.com/api/FlowEndpointEmailNotifications

https://uk.thruinc.com/api/FlowEndpointEmailNotifications

https://eu.thruinc.com/api/FlowEndpointEmailNotifications

https://au.thruinc.com/api/FlowEndpointEmailNotifications

Request samples

• Payload

Content type

application/jsontext/jsonapplication/*+jsonapplication/json

{

• "id": 0,
• "flowEndpointId": 0,
• "email": "string",
• "notifyQueueDepth": true,
• "notifyInactivity": true,
• "notifyError": true,
• "notifyTranferComplete": true,
• "notifyQuarantined": true,
• "createdBy": "string",
• "createdDate": "2019-08-24T14:15:22Z",
• "updatedBy": "string",
• "updatedDate": "2019-08-24T14:15:22Z",
• "deletedBy": "string",
• "deletedDate": "2019-08-24T14:15:22Z"

}

Response samples

• 200
• 403
• 500

Content type

text/plainapplication/jsontext/jsontext/plain

No sample

Saves email notification configuration (creates new or updates existing based on ID)

Performs upsert operation: creates new configuration if ID is 0, otherwise updates existing configuration

Authorizations:

ApiKeyBearer

Request Body schema:

application/jsontext/jsonapplication/*+jsonapplication/json

Email notification configuration to save (performs upsert based on record ID)

id	integer <int32>
flowEndpointId	integer <int32>
email	string or null
notifyQueueDepth	boolean
notifyInactivity	boolean
notifyError	boolean
notifyTranferComplete	boolean
notifyQuarantined	boolean
createdBy	string or null
createdDate	string or null <date-time>
updatedBy	string or null
updatedDate	string or null <date-time>
deletedBy	string or null
deletedDate	string or null <date-time>

Responses

Response Schema:

text/plainapplication/jsontext/jsontext/plain

id	integer <int32>
flowEndpointId	integer <int32>
email	string or null
notifyQueueDepth	boolean
notifyInactivity	boolean
notifyError	boolean
notifyTranferComplete	boolean
notifyQuarantined	boolean
createdBy	string or null
createdDate	string or null <date-time>
updatedBy	string or null
updatedDate	string or null <date-time>
deletedBy	string or null
deletedDate	string or null <date-time>

https://us.thruinc.com/api/FlowEndpointEmailNotifications/save

https://uk.thruinc.com/api/FlowEndpointEmailNotifications/save

https://eu.thruinc.com/api/FlowEndpointEmailNotifications/save

https://au.thruinc.com/api/FlowEndpointEmailNotifications/save

Request samples

• Payload

Content type

application/jsontext/jsonapplication/*+jsonapplication/json

{

• "id": 0,
• "flowEndpointId": 0,
• "email": "string",
• "notifyQueueDepth": true,
• "notifyInactivity": true,
• "notifyError": true,
• "notifyTranferComplete": true,
• "notifyQuarantined": true,
• "createdBy": "string",
• "createdDate": "2019-08-24T14:15:22Z",
• "updatedBy": "string",
• "updatedDate": "2019-08-24T14:15:22Z",
• "deletedBy": "string",
• "deletedDate": "2019-08-24T14:15:22Z"

}

Response samples

• 200
• 403
• 500

Content type

text/plainapplication/jsontext/jsontext/plain

No sample

Deletes all email notification configurations for a specific flow endpoint

Removes all email notification configurations from a flow endpoint.

Authorizations:

ApiKeyBearer

query Parameters

flowEndpointId required

integer <int32> Unique identifier of the flow endpoint to remove all email notification configurations for

Responses

Response Schema:

text/plainapplication/jsontext/jsontext/plain

	object (thruStatus)
data	any or null

https://us.thruinc.com/api/FlowEndpointEmailNotifications/deleteByFlowEndpointId

https://uk.thruinc.com/api/FlowEndpointEmailNotifications/deleteByFlowEndpointId

https://eu.thruinc.com/api/FlowEndpointEmailNotifications/deleteByFlowEndpointId

https://au.thruinc.com/api/FlowEndpointEmailNotifications/deleteByFlowEndpointId

Response samples

• 200
• 403
• 500

Content type

text/plainapplication/jsontext/jsontext/plain

No sample