| Action: | GET | |||||||||||||||||||||||||
| Method: | GET | |||||||||||||||||||||||||
| URL: | /api/v1/static/emailsummary/getsettings | |||||||||||||||||||||||||
| Description: | Retrieve the current settings for potential match summary emails | |||||||||||||||||||||||||
| Type | Key | DataType | Notes | |||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Headers | api-key | String | Your Api-Key | |||||||||||||||||||||||
| Params | BusinessUnitID | Int32 | Business Unit ID | |||||||||||||||||||||||
| Params | ReturnFormat | String | Json or Xml | |||||||||||||||||||||||
| Return Data: |
Json or XML of the settings object. { "Id": 1, "BusinessUnitId": 10, "EnableAutomatedEmails": true, "ScheduleType": "2", "WeeklyDayOfWeek": "Monday", "MonthlyDayOfMonth": null, "OneOffDate": null, "LastChangedAt": "2020-12-31T12:34:56Z", "LastChangedByUser": 101, "Recipients": [ { "UserId": 101, "EmailAddress": "admin@kyc360.com" } ] } |
|
||||||||||||||||||||||||
| Action: | UPDATE | |||
| Method: | PUT | |||
| URL: | /api/v1/static/emailsummary/savesettings | |||
| Description: | Overwrite the settings for potential match summary emails | |||
| Type | Key | DataType | Notes | |
|---|---|---|---|---|
| Headers | api-key | String | Your Api-Key | |
| Params | BusinessUnitID | Int32 | Business Unit ID | |
| Params | EnableAutomatedEmails | Boolean | Whether to enable automated summary emails | |
| Params | ScheduleType | Enum | Schedule type: Daily = 1, Weekly = 2, Monthly = 3, or OneOff = 4 (nullable) | |
| Params | WeeklyDayOfWeek | Int32 | Day of week for weekly schedule (nullable) | |
| Params | MonthlyDayOfMonth | Int32 | Day of month for monthly schedule (nullable) | |
| Params | OneOffDate | DateTime | Date for one-off schedule (nullable) | |
| Params | LastChangedByUser | Int32 | The ID of the user making the change | |
| Params | Recipients | List | A list of recipient objects: { "UserId": Int32, "EmailAddress": String } | |
| Return Data: |
200 OK
|
|||
| Action: | SEND | |||
| Method: | POST | |||
| URL: | /api/v1/static/emailsummary/send | |||
| Description: | Send a potential match summary email to specified recipients | |||
| Type | Key | DataType | Notes | |
|---|---|---|---|---|
| Headers | api-key | String | Your Api-Key | |
| Params | BusinessUnitId | Int32 | Business Unit ID | |
| Params | Recipients | List | A list of recipient objects: { "UserId": Int32, "EmailAddress": String } | |
| Return Data: |
200 OK
|
|||