Update app registration detail

1min

PUT
https://{base_url}/core/api/v1/notification-service/apps/{appId}
API for updating app registration detail:
ParameterDescriptionTypeValidation
nameApplication namestring
enableNotificationbooleandefault: true
accountConfig*
ㅤ↳androidmaxProperties: 1
ㅤㅤㅤ↳projectId*SDS key for the globally unique, user-assigned ID of the parent project for the app.string
ㅤㅤㅤ↳clientEmail*SDS key for firebase service account.string
ㅤㅤㅤ↳privateKey*SDS key for private key for firebase service account.string
*This is required. HTTP Status Code Summary
CodeDescription
200 - OKEverything worked as expected.
400 - Bad RequestThe request was unacceptable, often due to missing a required parameter.
401 - UnauthorizedNo valid API key provided.
403 - ForbiddenThe API key doesn't have permissions to perform the request.
404 - Not FoundThe requested resource doesn't exist.
Path Parameters
appId
AppId
*
Header Parameters
X-COREOS-REQUEST-ID
string
*
X-COREOS-TID
string
*
X-COREOS-ACCESS
string
*
X-COREOS-USERINFO
string
Body Parameters
body
UpdateAppRequest
Description
Update configuration of registered app
name
string
enableNotification
boolean
accountConfig
AccountConfig
Responses
200
OK
AppGetResponse
All Of
SuccessResponse  +
error
Error
request
Request
*
data
object
All Of
object  +
400
Error Occurred
ErrorResponse
error
Error
*
request
Request
*
401
Error Occurred
ErrorResponse
error
Error
*
request
Request
*
403
Error Occurred
ErrorResponse
error
Error
*
request
Request
*
404
Error Occurred
ErrorResponse
error
Error
*
request
Request
*
Curl
JS
Ruby
Python
curl --location --globoff --request PUT 'https://{base_url}/core/api/v1/notification-service/apps/{appId}' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{}'
curl --location --globoff --request PUT 'https://{base_url}/core/api/v1/notification-service/apps/{appId}' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{}'
Responses
200
400
401
403
404
// OK 
{
  "error": {
    "code": "",
    "description": "",
    "additionalInfo": {}
  },
  "request": {
    "uri": "",
    "method": "",
    "queryString": "",
    "body": {}
  },
  "data": {}
}
// OK 
{
  "error": {
    "code": "",
    "description": "",
    "additionalInfo": {}
  },
  "request": {
    "uri": "",
    "method": "",
    "queryString": "",
    "body": {}
  },
  "data": {}
}
﻿
﻿

Parameter	Description	Type	Validation
`name`	Application name	string
`enableNotification`		boolean	default: true
`accountConfig`*
ㅤ↳`android`			maxProperties: 1
ㅤㅤㅤ↳`projectId`*	SDS key for the globally unique, user-assigned ID of the parent project for the app.	string
ㅤㅤㅤ↳`clientEmail`*	SDS key for firebase service account.	string
ㅤㅤㅤ↳`privateKey`*	SDS key for private key for firebase service account.	string
This is required. HTTP Status Code Summary*

Code	Description
200 - OK	Everything worked as expected.
400 - Bad Request	The request was unacceptable, often due to missing a required parameter.
401 - Unauthorized	No valid API key provided.
403 - Forbidden	The API key doesn't have permissions to perform the request.
404 - Not Found	The requested resource doesn't exist.

Updated 23 Apr 2024

Did this page help you?

Get app registration detail

Add app notification configuration