Skip to main content
POST
/
message-templates
Criar template de mensagem
curl --request POST \
  --url https://api.example.com/message-templates \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <api-key>' \
  --data '
{
  "name": "<string>",
  "category": "UTILITY",
  "components": [
    {
      "type": "HEADER",
      "text": "<string>",
      "buttons": [
        {
          "text": "<string>",
          "type": "<string>"
        }
      ],
      "example": {
        "body_text": [
          [
            "<string>"
          ]
        ],
        "body_text_named_params": [
          {
            "param_name": "<string>",
            "example": "<string>"
          }
        ],
        "header_text": [
          "<string>"
        ],
        "header_text_named_params": [
          {
            "param_name": "<string>",
            "example": "<string>"
          }
        ],
        "button_text": [
          "<string>"
        ],
        "button_text_named_params": [
          {
            "param_name": "<string>",
            "example": "<string>"
          }
        ]
      }
    }
  ],
  "language": "pt_BR"
}
'

Authorizations

X-Api-Key
string
header
required

Chave privada da API

Body

application/json
name
string
required

Nome do template. Deve ser em letras minúsculas, sem acentuação e sem espaços em branco, podendo ter underscore (_)

category
enum<string>
required

Categoria do template. Opções: UTILITY, MARKETING, AUTHENTICATION

Available options:
UTILITY,
MARKETING,
AUTHENTICATION
components
object[]
required
language
string
default:pt_BR

Idioma do template (padrão: pt_BR)

Response

200

Default Response