| 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, "Frequency": "weekly", "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 | Frequency | String | Frequency of automated summary emails | |
| 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
|
|||