Skip to main content

Modify Service

Use this API, to get the serivce providers updated as per the request provided.

Resource Informations

NameValue
Requires authentication?Yes
Rate limited?Yes

Request

Request headers

KeyValue
AuthorizationBearer token
Content-Typeapplication/json

HTTP request URL for SSMS

PUT https://{tenantId}.{hostname}/digitanium/v3/mpower/services/?category=<CATEGORY>

HTTP request URL for SHIFT

PUT https://{hostname}/auth/realms/{tenantId}/mpower/v1/services/?category={CATEGORY}
note

API requests must be made over https. Calls made over plain http will fail.

Request body(*Required)

Field NameTypeDescription
nameStringName of the service
uuidUUIDUUID of the service you want to modify
typeStringType of the service. Possible values chat, MiniApp, InformationApp
positionIntegerPosition of the service where it needs to be placed in the app
allowNewMessagesByUserbooleanTo restrict user messages to the service use false
subtypeStringSub type of the service
communicationTypeStringDefine communication type of the service
displayNameObjectName to be displayed for the service
descriptionObjectDescription of the service
openUrlURLUrl of the service
avatarPictureObjectPicture which should be displayed in app for the service. Applicable for Operator, Backend and Partner Services.
informationPictureObjectPicture which should be displayed in app for the service. Applicable only for information Service.
  • tags | String | Add respective tag category (Example : recommended).

Sample Request

{
"uuid": "14af364d-1987-447a-b966-cd14efb6d715",
"name": "info2",
"type": "informationapp",
"position": 1,
"displayName": {
"de": "Info Mod"
},
"description": {
"de": "Info Mod"
},
"tags": ["tag3", "test3"],
"openUrl": "https://www.kobil.com",
"informationPicture": {
"mimetype": "image/jpeg",
"data": "test from API"
},
"allowNewMessagesByUser": true
}

Response Status Information

StatusTypeDescription
200OKFor successfull update
400statusBad request
401statusUnauthorized