API : HelpCenterSettings Update

Introduction

Creates or updates a single help center in a customer's HelpCenterSettings, with the data needed to interact with Microsoft Graph.

Request

URL	https://api.telecomx.dk/helpcenter/helpcentersettings/SETTINGS_ID
Method	POST
Access level	RESELLER_ADMIN with HELPCENTER feature, or ADMIN.
Param	SETTINGS_ID	Id of the HelpCenterSettings to update - the id of the customer owning the help centers.
Body	id	ObjectId	`[optional]` Id of the help center to update. Omit to create a new help center.
	name	String	Name of the HelpCenter.
	emailAddress	String	Email address the help center uses to connect to Microsoft Graph.
	applicationId	String	Application ID (GUID) in Azure to setup connection to Microsoft.
	tenantId	String	Tenant ID (GUID) in Azure to setup connection to Microsoft.
	appClientValue	String	Client secret in Azure to setup connection to Microsoft.
	signature	String	The signature that will be used in all outgoing emails from the HelpCenter.
	startDate	String	`[optional]` Which date to fetch emails from, and onward.
	initialized	Boolean	True when the help center has completed its initial mail import.

The body is a single help center object. When updating an existing help center, fields not sent keep their stored values.

Request body example

{
  "id": "650000000000000000000001",
  "name": "Example Support",
  "emailAddress": "support@example.dk",
  "applicationId": "00000000-0000-0000-0000-000000000000",
  "tenantId": "00000000-0000-0000-0000-000000000000",
  "appClientValue": "<CLIENT_SECRET>",
  "signature": "Best regards, Example Support",
  "startDate": "01-03-2026",
  "initialized": false
}

Response

JSON object
success	Boolean	True on success

Example

{
  "success": true
}

Errors

Error code	Message	Description
422	id	Invalid helpCenterSettingsId
404	customer	Customer not found
422	helpCenterSettings	HelpCenterSettings does not exist
404	helpCenter.id	HelpCenter ID not found in HelpCenters
422	name	Name is not valid
422	emailAddress	Email address is not valid
422	applicationId	ApplicationId is not valid
422	tenantId	TenantId is not valid
422	appClientValue	Client secret is not valid
403	access_denied	Insufficient access level
500	internal_error	<Unspecified>

WIKI

Table of Contents