Register new app

1min

POST
https://{base_url}/core/api/v1/notification-service/apps
API for registering a new app:
ParameterDescriptionTypeValidation
name*Application name.string
appPlatform*Application platform.stringEnum: [android, ios]
appId*Application ID generated on firebase/apn project.string
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
201 - 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.
409 - ConflictThe request conflicts with another request (perhaps due to using the same idempotent key).
Header Parameters
X-COREOS-REQUEST-ID
string
*
X-COREOS-TID
string
*
X-COREOS-ACCESS
string
*
X-COREOS-USERINFO
string
Body Parameters
body
App
Description
Register new app
name
string
*
appPlatform
string<android,ios | ios | android>
*
appId
string
*
enableNotification
boolean
accountConfig
AccountConfig
*
Responses
201
OK
SuccessResponseWithData
All Of
SuccessResponse  +
error
Error
request
Request
*
data
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
*
409
Error Occurred
ErrorResponse
error
Error
*
request
Request
*
Curl
JS
Ruby
Python
curl --location --globoff 'https://{base_url}/core/api/v1/notification-service/apps' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
  "name": "",
  "appPlatform": "",
  "appId": "",
  "accountConfig": {
    "android": {
      "projectId": "",
      "clientEmail": "",
      "privateKey": ""
    },
    "ios": {
      "projectId": "",
      "clientEmail": "",
      "privateKey": ""
    }
  }
}'
curl --location --globoff 'https://{base_url}/core/api/v1/notification-service/apps' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
  "name": "",
  "appPlatform": "",
  "appId": "",
  "accountConfig": {
    "android": {
      "projectId": "",
      "clientEmail": "",
      "privateKey": ""
    },
    "ios": {
      "projectId": "",
      "clientEmail": "",
      "privateKey": ""
    }
  }
}'
Responses
201
400
401
403
409
// OK 
{
  "error": {
    "code": "",
    "description": "",
    "additionalInfo": {}
  },
  "request": {
    "uri": "",
    "method": "",
    "queryString": "",
    "body": {}
  },
  "data": {
    "id": ""
  }
}
// OK 
{
  "error": {
    "code": "",
    "description": "",
    "additionalInfo": {}
  },
  "request": {
    "uri": "",
    "method": "",
    "queryString": "",
    "body": {}
  },
  "data": {
    "id": ""
  }
}
﻿
﻿

Parameter	Description	Type	Validation
`name`*	Application name.	string
`appPlatform`*	Application platform.	string	Enum: [android, ios]
`appId`*	Application ID generated on firebase/apn project.	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
201 - 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.
409 - Conflict	The request conflicts with another request (perhaps due to using the same idempotent key).

Updated 23 Apr 2024

Did this page help you?

update notification accces modes

Get all registered apps