Modify Service
Use this API, to get the serivce providers updated as per the request provided.
Resource Informations
| Name | Value |
|---|---|
| Requires authentication? | Yes |
| Rate limited? | Yes |
Request
Request headers
| Key | Value |
|---|---|
| Authorization | Bearer token |
| Content-Type | application/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 Name | Type | Description |
|---|---|---|
| name | String | Name of the service |
| uuid | UUID | UUID of the service you want to modify |
| type | String | Type of the service. Possible values chat, MiniApp, InformationApp |
| position | Integer | Position of the service where it needs to be placed in the app |
| allowNewMessagesByUser | boolean | To restrict user messages to the service use false |
| subtype | String | Sub type of the service |
| communicationType | String | Define communication type of the service |
| displayName | Object | Name to be displayed for the service |
| description | Object | Description of the service |
| openUrl | URL | Url of the service |
| avatarPicture | Object | Picture which should be displayed in app for the service. Applicable for Operator, Backend and Partner Services. |
| informationPicture | Object | Picture which should be displayed in app for the service. Applicable only for information Service. |
| tags (Required) | 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
| Status | Type | Description |
|---|---|---|
| 200 | OK | For successfull update |
| 400 | status | Bad request |
| 401 | status | Unauthorized |