api:helpcenter:helpcentersettings:update
Table of Contents
API : HelpCenterSettings Update
Introduction
Updates a HelpCenterSettings object with the data needed to interact with Microsoft Graph
Request
| URL | https://api.telecomx.dk/helpcenter/helpcentersettings/HELPCENTER_ID | ||
|---|---|---|---|
| Method | POST | ||
| Access Level | RESELLER_ADMIN OR ADMIN | ||
| Param | HELPCENTER_ID | Id of the helpcenter to be updated. | |
| Body | helpCenters[] | Array | Array of helpcenter settings |
| helpCenters.name | String | Name of the HelpCenter | |
| helpCenters.emailAddress | String | Emailaddress the HelpCenterSettings will be using to connect to Microsoft Graph | |
| helpCenters.applicationId | String | Application ID in Azure to setup connection to Microsoft | |
| helpCenters.tenantId | String | Tenant ID in Azure to setup connection to Microsoft | |
| helpCenters.signature | String | The signature that'll be used in all outgoing emails coming from the HelpCenter | |
| helpCenters.startDate | Date | [optional] If needed, which date to fetch all emails from, and onward |
|
Body Example
{ id: '1234578901234567890ABCD', helpCenters: { [ name: 'PowerNet', emailaddress: 'Test@pn.dk', applicationId: '12345abcde', tenantId: 'abcde12345', signature: 'Med venlig hilsen, PowerNets support team', startDate: 01-01-2024, ], [ name: emailaddress: 'Mikkel@test.dk', applicationId: 'abcde12345', tenantId: 'test1234', signature: 'Hilsen Mikkel', startDate: 01-03-2024, ] } }
Response
The response will be a success: true.
| JSON object | |
|---|---|
| success | true |
Example
{ success: true }
Errors
| Error code | Message | Description |
|---|---|---|
| 403 | access_denied | Insufficient access level |
| 404 | customer | Customer not found |
| 422 | id | Invalid helpcenterId |
| 422 | helpCenterSettings | HelpCenterSetting does not exist |
| 422 | helpCenters | Invalid help center array |
| 422 | name | Invalid name |
| 422 | emailAddress | Invalid emailAddress |
| 422 | emailAddress | Email address already exists |
| 422 | applicationId | Invalid applicationId |
| 422 | tenantId | Invalid tenantId |
| 500 | internal_error | <Unspecificed error> |
api/helpcenter/helpcentersettings/update.txt · Last modified: 2025/02/13 22:45 by Per Møller