Apps

Operações

GET/v1/appsPOST/v1/appsGET/v1/apps/{app_id}DELETE/v1/apps/{app_id}PATCH/v1/apps/{app_id}POST/v1/apps/{app_id}/credentials/apnsPOST/v1/apps/{app_id}/credentials/fcmPOST/v1/apps/{app_id}/disablePOST/v1/apps/{app_id}/enablePOST/v1/apps/{app_id}/keys/rotate

---

List apps for a company

GET

/v1/apps

Lists every App belonging to the company in ?company_id=, filtered to the caller's accessible apps unless the caller is an owner. Each item carries the App's current MAU (subscribed, non-deleted devices seen in the last 30 days); mau is null when it could not be computed, and the list itself is still returned.

Autorizações

SessionAuth

Admin session cookie set by POST /v1/auth/login. Dashboard-only management.

Tipo

API Key (cookie: notti_session)

Parâmetros

Parâmetros de Consulta

company_id*

Company ID

Tipo

string

Obrigatório

Respostas

OK

Content-Type

application/json

[

  

{

  

  

"apns_configured": true,

  

  

"apns_environment": "string",

  

  

"client_key_prefix": "string",

  

  

"client_key_rotated_at": "string",

  

  

"company_id": "string",

  

  

"created_at": "string",

  

  

"disabled": true,

  

  

"fcm_configured": true,

  

  

"id": "string",

  

  

"mau": 0,

  

  

"min_rich_push_version": "string",

  

  

"name": "string",

  

  

"rest_key_prefix": "string",

  

  

"rest_key_rotated_at": "string",

  

  

"timezone": "string"

  

}

]

GET

/v1/apps

Playground

Autorização

SessionAuth

Variáveis

Chave

Valor

company_id*

Exemplos

---

Create an app

POST

/v1/apps

Creates an App under the given company and returns its one-time-reveal REST and Client keys.

Autorizações

SessionAuth

Admin session cookie set by POST /v1/auth/login. Dashboard-only management.

Tipo

API Key (cookie: notti_session)

Corpo da Requisição

application/json

{

  

"company_id": "string",

  

"name": "string"

}

Respostas

Created

Content-Type

application/json

{

  

"apns_configured": true,

  

"apns_environment": "string",

  

"client_key": "string",

  

"client_key_prefix": "string",

  

"client_key_rotated_at": "string",

  

"company_id": "string",

  

"created_at": "string",

  

"disabled": true,

  

"fcm_configured": true,

  

"id": "string",

  

"min_rich_push_version": "string",

  

"name": "string",

  

"rest_key": "string",

  

"rest_key_prefix": "string",

  

"rest_key_rotated_at": "string",

  

"timezone": "string"

}

POST

/v1/apps

Playground

Autorização

SessionAuth

Corpo

Exemplos

---

Get an app

GET

/v1/apps/{app_id}

Fetches a single App by ID, scoped to the caller's company.

Autorizações

SessionAuth

Admin session cookie set by POST /v1/auth/login. Dashboard-only management.

Tipo

API Key (cookie: notti_session)

Parâmetros

Parâmetros de Caminho

app_id*

App ID

Tipo

string

Obrigatório

Respostas

OK

Content-Type

application/json

{

  

"apns_configured": true,

  

"apns_environment": "string",

  

"client_key_prefix": "string",

  

"client_key_rotated_at": "string",

  

"company_id": "string",

  

"created_at": "string",

  

"disabled": true,

  

"fcm_configured": true,

  

"id": "string",

  

"min_rich_push_version": "string",

  

"name": "string",

  

"rest_key_prefix": "string",

  

"rest_key_rotated_at": "string",

  

"timezone": "string"

}

GET

/v1/apps/{app_id}

Playground

Autorização

SessionAuth

Variáveis

Chave

Valor

app_id*

Exemplos

---

Delete an app

DELETE

/v1/apps/{app_id}

Deletes an App. Fails if the App still has dependent records (devices, templates, segments, notifications, or webhooks).

Autorizações

SessionAuth

Admin session cookie set by POST /v1/auth/login. Dashboard-only management.

Tipo

API Key (cookie: notti_session)

Parâmetros

Parâmetros de Caminho

app_id*

App ID

Tipo

string

Obrigatório

Respostas

No Content

DELETE

/v1/apps/{app_id}

Playground

Autorização

SessionAuth

Variáveis

Chave

Valor

app_id*

Exemplos

---

Update app settings

PATCH

/v1/apps/{app_id}

Partially updates the App: display name, IANA timezone used for Overview day and hour buckets (default America/Sao_Paulo), and the minimum app version that renders rich push, as 2, 2.4 or 2.4.0 (null clears it). Omitted fields are left unchanged; at least one is required.

Autorizações

SessionAuth

Admin session cookie set by POST /v1/auth/login. Dashboard-only management.

Tipo

API Key (cookie: notti_session)

Parâmetros

Parâmetros de Caminho

app_id*

App ID

Tipo

string

Obrigatório

Corpo da Requisição

application/json

{

  

"min_rich_push_version": "string",

  

"name": "string",

  

"timezone": "string"

}

Respostas

OK

Content-Type

application/json

{

  

"apns_configured": true,

  

"apns_environment": "string",

  

"client_key_prefix": "string",

  

"client_key_rotated_at": "string",

  

"company_id": "string",

  

"created_at": "string",

  

"disabled": true,

  

"fcm_configured": true,

  

"id": "string",

  

"min_rich_push_version": "string",

  

"name": "string",

  

"rest_key_prefix": "string",

  

"rest_key_rotated_at": "string",

  

"timezone": "string"

}

PATCH

/v1/apps/{app_id}

Playground

Autorização

SessionAuth

Variáveis

Chave

Valor

app_id*

Corpo

Exemplos

---

Set APNS credentials

POST

/v1/apps/{app_id}/credentials/apns

Stores the App's Apple Push Notification service credential (certificate or token-based key), encrypted at rest.

Autorizações

SessionAuth

Admin session cookie set by POST /v1/auth/login. Dashboard-only management.

Tipo

API Key (cookie: notti_session)

Parâmetros

Parâmetros de Caminho

app_id*

App ID

Tipo

string

Obrigatório

Corpo da Requisição

application/json

{

  

"bundle_id": "string",

  

"cert_base64": "string",

  

"credential_type": "string",

  

"environment": "string",

  

"key_base64": "string",

  

"key_id": "string",

  

"password": "string",

  

"team_id": "string"

}

Respostas

OK

Content-Type

application/json

{

  

"apns_configured": true,

  

"apns_environment": "string",

  

"client_key_prefix": "string",

  

"client_key_rotated_at": "string",

  

"company_id": "string",

  

"created_at": "string",

  

"disabled": true,

  

"fcm_configured": true,

  

"id": "string",

  

"min_rich_push_version": "string",

  

"name": "string",

  

"rest_key_prefix": "string",

  

"rest_key_rotated_at": "string",

  

"timezone": "string"

}

POST

/v1/apps/{app_id}/credentials/apns

Playground

Autorização

SessionAuth

Variáveis

Chave

Valor

app_id*

Corpo

Exemplos

---

Set FCM credentials

POST

/v1/apps/{app_id}/credentials/fcm

Stores the App's Firebase Cloud Messaging service-account JSON, encrypted at rest.

Autorizações

SessionAuth

Admin session cookie set by POST /v1/auth/login. Dashboard-only management.

Tipo

API Key (cookie: notti_session)

Parâmetros

Parâmetros de Caminho

app_id*

App ID

Tipo

string

Obrigatório

Corpo da Requisição

application/json

{

  

"service_account_json": {

  

}

}

Respostas

OK

Content-Type

application/json

{

  

"apns_configured": true,

  

"apns_environment": "string",

  

"client_key_prefix": "string",

  

"client_key_rotated_at": "string",

  

"company_id": "string",

  

"created_at": "string",

  

"disabled": true,

  

"fcm_configured": true,

  

"id": "string",

  

"min_rich_push_version": "string",

  

"name": "string",

  

"rest_key_prefix": "string",

  

"rest_key_rotated_at": "string",

  

"timezone": "string"

}

POST

/v1/apps/{app_id}/credentials/fcm

Playground

Autorização

SessionAuth

Variáveis

Chave

Valor

app_id*

Corpo

Exemplos

---

Disable an app

POST

/v1/apps/{app_id}/disable

Disables an App so no new notifications are delivered. Idempotent.

Autorizações

SessionAuth

Admin session cookie set by POST /v1/auth/login. Dashboard-only management.

Tipo

API Key (cookie: notti_session)

Parâmetros

Parâmetros de Caminho

app_id*

App ID

Tipo

string

Obrigatório

Respostas

OK

Content-Type

application/json

{

  

"apns_configured": true,

  

"apns_environment": "string",

  

"client_key_prefix": "string",

  

"client_key_rotated_at": "string",

  

"company_id": "string",

  

"created_at": "string",

  

"disabled": true,

  

"fcm_configured": true,

  

"id": "string",

  

"min_rich_push_version": "string",

  

"name": "string",

  

"rest_key_prefix": "string",

  

"rest_key_rotated_at": "string",

  

"timezone": "string"

}

POST

/v1/apps/{app_id}/disable

Playground

Autorização

SessionAuth

Variáveis

Chave

Valor

app_id*

Exemplos

---

Enable an app

POST

/v1/apps/{app_id}/enable

Re-enables an App so notifications are delivered again. Idempotent.

Autorizações

SessionAuth

Admin session cookie set by POST /v1/auth/login. Dashboard-only management.

Tipo

API Key (cookie: notti_session)

Parâmetros

Parâmetros de Caminho

app_id*

App ID

Tipo

string

Obrigatório

Respostas

OK

Content-Type

application/json

{

  

"apns_configured": true,

  

"apns_environment": "string",

  

"client_key_prefix": "string",

  

"client_key_rotated_at": "string",

  

"company_id": "string",

  

"created_at": "string",

  

"disabled": true,

  

"fcm_configured": true,

  

"id": "string",

  

"min_rich_push_version": "string",

  

"name": "string",

  

"rest_key_prefix": "string",

  

"rest_key_rotated_at": "string",

  

"timezone": "string"

}

POST

/v1/apps/{app_id}/enable

Playground

Autorização

SessionAuth

Variáveis

Chave

Valor

app_id*

Exemplos

---

Rotate an app's REST or Client key

POST

/v1/apps/{app_id}/keys/rotate

Generates a new REST or Client key for the App and invalidates the old one. The new plaintext key is returned exactly once.

Autorizações

SessionAuth

Admin session cookie set by POST /v1/auth/login. Dashboard-only management.

Tipo

API Key (cookie: notti_session)

Parâmetros

Parâmetros de Caminho

app_id*

App ID

Tipo

string

Obrigatório

Corpo da Requisição

application/json

{

  

"key_type": "string"

}

Respostas

OK

Content-Type

application/json

{

  

"key": "string",

  

"key_type": "string"

}

POST

/v1/apps/{app_id}/keys/rotate

Playground

Autorização

SessionAuth

Variáveis

Chave

Valor

app_id*

Corpo

Exemplos

---

Desenvolvido por VitePress OpenAPI