curl --request POST \
--url https://api.notifique.dev/v1/templates \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "alerta_pedido",
"category": "TRANSACTIONAL",
"language": "pt_BR",
"variableDefaults": {
"name": "Cliente"
},
"sms": {
"enabled": true,
"payload": {
"content": "Pedido {{codigo}} despachado, {{name}}."
}
},
"whatsapp": {
"enabled": true,
"payload": {
"content": "Ola {{name}}, pedido {{codigo}} saiu para entrega.",
"mediaUrl": null,
"buttons": null
}
},
"email": {
"enabled": true,
"payload": {
"subject": "Pedido {{codigo}}",
"html": "<p>Ola {{name}}, seu pedido saiu.</p>"
}
},
"telegram": {
"enabled": false,
"payload": {}
},
"rcs": {
"enabled": false,
"payload": {}
},
"push": {
"enabled": false,
"payload": {}
},
"voice": {
"enabled": false,
"payload": {}
}
}
'{
"success": true,
"data": {
"id": "cltmpl01abc",
"workspaceId": "clws01xyz",
"name": "alerta_pedido",
"category": "TRANSACTIONAL",
"language": "pt_BR",
"source": null,
"status": "ACTIVE",
"metaId": null,
"type": null,
"components": null,
"variables": [
"codigo",
"name"
],
"variableDefaults": {
"name": "Cliente"
},
"usageCount": 12,
"lastUsedAt": "2026-07-08T10:15:00.000Z",
"marketingTopicId": null,
"appendPreferencesLink": true,
"localeTranslations": null,
"enabledChannels": [
"sms",
"email",
"whatsapp"
],
"sms": {
"enabled": true,
"payload": {
"content": "Pedido {{codigo}} despachado, {{name}}."
}
},
"whatsapp": {
"enabled": true,
"payload": {
"content": "Ola {{name}}, pedido {{codigo}} saiu para entrega.",
"mediaUrl": null,
"buttons": null
}
},
"telegram": {
"enabled": false,
"payload": {
"content": "",
"mediaUrl": null,
"buttons": null
}
},
"email": {
"enabled": true,
"payload": {
"subject": "Pedido {{codigo}}",
"html": "<p>Ola {{name}}, seu pedido saiu.</p>",
"containerWidth": 600,
"containerPadding": 24,
"imageUrls": null,
"buttons": null
}
},
"rcs": {
"enabled": false,
"payload": {
"payload": null,
"type": "basic"
}
},
"push": {
"enabled": false,
"payload": {
"title": null,
"body": null,
"url": null,
"icon": null,
"image": null,
"data": null
}
},
"voice": {
"enabled": false,
"payload": {
"speakText": "",
"speakVoice": null,
"gather": null
}
},
"createdAt": "2026-06-01T12:00:00.000Z",
"updatedAt": "2026-07-01T09:30:00.000Z"
}
}{
"success": false,
"error": "Bad Request",
"code": "VALIDATION_ERROR",
"message": "Campo inválido ou ausente."
}Templates
Criar template
Cria um template. Cada canal usa { enabled, payload }. Canais desligados usam payload: {} no body de criacao.
POST
/
v1
/
templates
curl --request POST \
--url https://api.notifique.dev/v1/templates \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "alerta_pedido",
"category": "TRANSACTIONAL",
"language": "pt_BR",
"variableDefaults": {
"name": "Cliente"
},
"sms": {
"enabled": true,
"payload": {
"content": "Pedido {{codigo}} despachado, {{name}}."
}
},
"whatsapp": {
"enabled": true,
"payload": {
"content": "Ola {{name}}, pedido {{codigo}} saiu para entrega.",
"mediaUrl": null,
"buttons": null
}
},
"email": {
"enabled": true,
"payload": {
"subject": "Pedido {{codigo}}",
"html": "<p>Ola {{name}}, seu pedido saiu.</p>"
}
},
"telegram": {
"enabled": false,
"payload": {}
},
"rcs": {
"enabled": false,
"payload": {}
},
"push": {
"enabled": false,
"payload": {}
},
"voice": {
"enabled": false,
"payload": {}
}
}
'{
"success": true,
"data": {
"id": "cltmpl01abc",
"workspaceId": "clws01xyz",
"name": "alerta_pedido",
"category": "TRANSACTIONAL",
"language": "pt_BR",
"source": null,
"status": "ACTIVE",
"metaId": null,
"type": null,
"components": null,
"variables": [
"codigo",
"name"
],
"variableDefaults": {
"name": "Cliente"
},
"usageCount": 12,
"lastUsedAt": "2026-07-08T10:15:00.000Z",
"marketingTopicId": null,
"appendPreferencesLink": true,
"localeTranslations": null,
"enabledChannels": [
"sms",
"email",
"whatsapp"
],
"sms": {
"enabled": true,
"payload": {
"content": "Pedido {{codigo}} despachado, {{name}}."
}
},
"whatsapp": {
"enabled": true,
"payload": {
"content": "Ola {{name}}, pedido {{codigo}} saiu para entrega.",
"mediaUrl": null,
"buttons": null
}
},
"telegram": {
"enabled": false,
"payload": {
"content": "",
"mediaUrl": null,
"buttons": null
}
},
"email": {
"enabled": true,
"payload": {
"subject": "Pedido {{codigo}}",
"html": "<p>Ola {{name}}, seu pedido saiu.</p>",
"containerWidth": 600,
"containerPadding": 24,
"imageUrls": null,
"buttons": null
}
},
"rcs": {
"enabled": false,
"payload": {
"payload": null,
"type": "basic"
}
},
"push": {
"enabled": false,
"payload": {
"title": null,
"body": null,
"url": null,
"icon": null,
"image": null,
"data": null
}
},
"voice": {
"enabled": false,
"payload": {
"speakText": "",
"speakVoice": null,
"gather": null
}
},
"createdAt": "2026-06-01T12:00:00.000Z",
"updatedAt": "2026-07-01T09:30:00.000Z"
}
}{
"success": false,
"error": "Bad Request",
"code": "VALIDATION_ERROR",
"message": "Campo inválido ou ausente."
}Autorizações
BearerAuthApiKeyHeader
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Corpo
application/json
Exemplo:
"alerta_pedido"
Opções disponíveis:
MARKETING, TRANSACTIONAL, NOTIFICATION, AUTHENTICATION, CUSTOM Exemplo:
"TRANSACTIONAL"
Exemplo:
"pt_BR"
Exemplo:
["codigo", "name"]
Valores padrao por chave. Requer o array variables listando todas as chaves de placeholder usadas no template.
Show child attributes
Show child attributes
Exemplo:
{ "name": "Cliente" }
Exemplo:
true
Bloco por canal na criacao/edicao. enabled liga o canal; payload depende do canal.
Show child attributes
Show child attributes
Exemplo:
{ "enabled": true, "payload": {} }
Bloco por canal na criacao/edicao. enabled liga o canal; payload depende do canal.
Show child attributes
Show child attributes
Exemplo:
{ "enabled": true, "payload": {} }
Bloco por canal na criacao/edicao. enabled liga o canal; payload depende do canal.
Show child attributes
Show child attributes
Exemplo:
{ "enabled": true, "payload": {} }
Bloco por canal na criacao/edicao. enabled liga o canal; payload depende do canal.
Show child attributes
Show child attributes
Exemplo:
{ "enabled": true, "payload": {} }
Bloco por canal na criacao/edicao. enabled liga o canal; payload depende do canal.
Show child attributes
Show child attributes
Exemplo:
{ "enabled": true, "payload": {} }
Bloco por canal na criacao/edicao. enabled liga o canal; payload depende do canal.
Show child attributes
Show child attributes
Exemplo:
{ "enabled": true, "payload": {} }
Bloco por canal na criacao/edicao. enabled liga o canal; payload depende do canal.
Show child attributes
Show child attributes
Exemplo:
{ "enabled": true, "payload": {} }
Bloco por canal na criacao/edicao. enabled liga o canal; payload depende do canal.
Show child attributes
Show child attributes
Exemplo:
{ "enabled": true, "payload": {} }
Bloco por canal na criacao/edicao. enabled liga o canal; payload depende do canal.
Show child attributes
Show child attributes
Exemplo:
{ "enabled": true, "payload": {} }
Resposta
Template criado
Exemplo:
true
Show child attributes
Show child attributes
Exemplo:
{
"id": "cltmpl01abc",
"workspaceId": "clws01xyz",
"name": "alerta_pedido",
"category": "TRANSACTIONAL",
"language": "pt_BR",
"source": null,
"status": "ACTIVE",
"metaId": null,
"type": null,
"components": null,
"variables": ["codigo", "name"],
"variableDefaults": { "name": "Cliente" },
"usageCount": 12,
"lastUsedAt": "2026-07-08T10:15:00.000Z",
"marketingTopicId": null,
"appendPreferencesLink": true,
"localeTranslations": null,
"enabledChannels": ["sms", "email", "whatsapp"],
"sms": {
"enabled": true,
"payload": {
"content": "Pedido {{codigo}} despachado, {{name}}."
}
},
"whatsapp": {
"enabled": true,
"payload": {
"content": "Ola {{name}}, pedido {{codigo}} saiu para entrega.",
"mediaUrl": null,
"buttons": null
}
},
"telegram": {
"enabled": false,
"payload": {
"content": "",
"mediaUrl": null,
"buttons": null
}
},
"email": {
"enabled": true,
"payload": {
"subject": "Pedido {{codigo}}",
"html": "<p>Ola {{name}}, seu pedido saiu.</p>",
"containerWidth": 600,
"containerPadding": 24,
"imageUrls": null,
"buttons": null
}
},
"rcs": {
"enabled": false,
"payload": { "message": "", "payload": null }
},
"push": {
"enabled": false,
"payload": {
"title": null,
"body": null,
"url": null,
"icon": null,
"image": null,
"data": null
}
},
"voice": {
"enabled": false,
"payload": {
"speakText": "",
"speakVoice": null,
"gather": null
}
},
"createdAt": "2026-06-01T12:00:00.000Z",
"updatedAt": "2026-07-01T09:30:00.000Z",
"instagram": {
"enabled": false,
"payload": { "content": "", "mediaUrl": null }
},
"whatsapp_call": {
"enabled": false,
"payload": {
"speakText": "",
"speakVoice": null,
"mediaUrl": null
}
}
}
Esta página foi útil?