Templates

Operações

GET/v1/apps/{app_id}/templatesPOST/v1/apps/{app_id}/templatesGET/v1/apps/{app_id}/templates/{id}DELETE/v1/apps/{app_id}/templates/{id}PATCH/v1/apps/{app_id}/templates/{id}

---

List templates for an app

GET

/v1/apps/{app_id}/templates

Lists every template belonging to the App, ordered by creation time. Each template with deliveries in the last 30 days carries stats (sent_30d, ctr_30d); templates without deliveries have no stats field.

Autorizações

SessionAuth

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

Tipo

API Key (cookie: notti_session)

ou

RESTKeyAuth

App REST key (rk_...). Server-to-server calls.

Tipo

HTTP (bearer)

Parâmetros

Parâmetros de Caminho

app_id*

App ID

Tipo

string

Obrigatório

Parâmetros de Consulta

label

Filter by label; repeatable for AND (case-insensitive)

Tipo

string

Respostas

OK

Content-Type

application/json

[

  

{

  

  

"app_id": "string",

  

  

"body": "string",

  

  

"created_at": "string",

  

  

"deep_link": "string",

  

  

"id": "string",

  

  

"image_url": "string",

  

  

"labels": [

  

  

  

"string"

  

  

],

  

  

"name": "string",

  

  

"stats": {

  

  

  

"ctr_30d": 0,

  

  

  

"sent_30d": 0

  

  

},

  

  

"subtitle": "string",

  

  

"title": "string",

  

  

"updated_at": "string"

  

}

]

GET

/v1/apps/{app_id}/templates

Playground

Autorização

SessionAuth

Variáveis

Chave

Valor

app_id*

label

Exemplos

---

Create a template

POST

/v1/apps/{app_id}/templates

Creates a notification template (title/body, plus optional subtitle, deep_link and image_url) scoped to the App.

Autorizações

SessionAuth

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

Tipo

API Key (cookie: notti_session)

ou

RESTKeyAuth

App REST key (rk_...). Server-to-server calls.

Tipo

HTTP (bearer)

Parâmetros

Parâmetros de Caminho

app_id*

App ID

Tipo

string

Obrigatório

Corpo da Requisição

application/json

{

  

"body": "string",

  

"deep_link": "string",

  

"image_url": "string",

  

"labels": [

  

  

"string"

  

],

  

"name": "string",

  

"subtitle": "string",

  

"title": "string"

}

Respostas

Created

Content-Type

application/json

{

  

"app_id": "string",

  

"body": "string",

  

"created_at": "string",

  

"deep_link": "string",

  

"id": "string",

  

"image_url": "string",

  

"labels": [

  

  

"string"

  

],

  

"name": "string",

  

"stats": {

  

  

"ctr_30d": 0,

  

  

"sent_30d": 0

  

},

  

"subtitle": "string",

  

"title": "string",

  

"updated_at": "string"

}

POST

/v1/apps/{app_id}/templates

Playground

Autorização

SessionAuth

Variáveis

Chave

Valor

app_id*

Corpo

Exemplos

---

Get a template

GET

/v1/apps/{app_id}/templates/{id}

Fetches a single template by ID, scoped to the App.

Autorizações

SessionAuth

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

Tipo

API Key (cookie: notti_session)

ou

RESTKeyAuth

App REST key (rk_...). Server-to-server calls.

Tipo

HTTP (bearer)

Parâmetros

Parâmetros de Caminho

app_id*

App ID

Tipo

string

Obrigatório

id*

Template ID

Tipo

string

Obrigatório

Respostas

OK

Content-Type

application/json

{

  

"app_id": "string",

  

"body": "string",

  

"created_at": "string",

  

"deep_link": "string",

  

"id": "string",

  

"image_url": "string",

  

"labels": [

  

  

"string"

  

],

  

"name": "string",

  

"stats": {

  

  

"ctr_30d": 0,

  

  

"sent_30d": 0

  

},

  

"subtitle": "string",

  

"title": "string",

  

"updated_at": "string"

}

GET

/v1/apps/{app_id}/templates/{id}

Playground

Autorização

SessionAuth

Variáveis

Chave

Valor

app_id*

id*

Exemplos

---

Delete a template

DELETE

/v1/apps/{app_id}/templates/{id}

Deletes a template by ID, scoped to the App.

Autorizações

SessionAuth

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

Tipo

API Key (cookie: notti_session)

ou

RESTKeyAuth

App REST key (rk_...). Server-to-server calls.

Tipo

HTTP (bearer)

Parâmetros

Parâmetros de Caminho

app_id*

App ID

Tipo

string

Obrigatório

id*

Template ID

Tipo

string

Obrigatório

Respostas

No Content

DELETE

/v1/apps/{app_id}/templates/{id}

Playground

Autorização

SessionAuth

Variáveis

Chave

Valor

app_id*

id*

Exemplos

---

Update a template

PATCH

/v1/apps/{app_id}/templates/{id}

Partially updates a template. An omitted or empty name, title or body keeps its stored value; subtitle, deep_link and image_url keep it when the key is omitted and are cleared by null or an empty string.

Autorizações

SessionAuth

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

Tipo

API Key (cookie: notti_session)

ou

RESTKeyAuth

App REST key (rk_...). Server-to-server calls.

Tipo

HTTP (bearer)

Parâmetros

Parâmetros de Caminho

app_id*

App ID

Tipo

string

Obrigatório

id*

Template ID

Tipo

string

Obrigatório

Corpo da Requisição

application/json

{

  

"body": "string",

  

"deep_link": "string",

  

"image_url": "string",

  

"labels": [

  

  

"string"

  

],

  

"name": "string",

  

"subtitle": "string",

  

"title": "string"

}

Respostas

OK

Content-Type

application/json

{

  

"app_id": "string",

  

"body": "string",

  

"created_at": "string",

  

"deep_link": "string",

  

"id": "string",

  

"image_url": "string",

  

"labels": [

  

  

"string"

  

],

  

"name": "string",

  

"stats": {

  

  

"ctr_30d": 0,

  

  

"sent_30d": 0

  

},

  

"subtitle": "string",

  

"title": "string",

  

"updated_at": "string"

}

PATCH

/v1/apps/{app_id}/templates/{id}

Playground

Autorização

SessionAuth

Variáveis

Chave

Valor

app_id*

id*

Corpo

Exemplos

---

Desenvolvido por VitePress OpenAPI