| 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, "Recipients": "admin@kyc360.com", "EnableAutomatedEmails": true, "Frequency": "weekly", } |
|
||||||||||||||
| 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 | Recipients | String | Recipients of summary emails | |
| Params | EnableAutomatedEmails | Boolean | Whether to enable automated summary emails | |
| Params | Frequency | String | Frequency of automated summary emails | |
| Return Data: |
200 OK
|
|||