inbox.quick_reply_create

Criar resposta rápida. Cria uma resposta rápida com nome, texto (até 1024) e atalho opcional, único na conta, sem espaço nem barra. type: "interactive" exige contents.buttons (até 3 de resposta, ou 1 de link https; não combinam) e aceita contents.header de texto (até 60) e contents.footer (até 60); títulos de botão até 20. channelKind limita a um canal (null = todos). Variáveis no texto: {nome}, {primeiro_nome}, {telefone}, {email}, {atendente}. Anexo e cabeçalho de mídia ainda não são suportados.

Endpoint: POST https://app.atomiks.com.br/api/v1/inbox.quick_reply_create (corpo JSON)
Quem pode chamar: administrador da conta
Escopo da chave: messages:manage
Grava dados: sim
Pela chave de API: sim
Ferramenta MCP: inbox_quick_reply_create
Ficha em JSON: https://app.atomiks.com.br/api/v1/openapi.json (operationId inbox.quick_reply_create)

Entrada

Campo	Tipo	Obrigatório
`name`	string	sim
`shortcut`	string \| null	não
`body`	string	sim
`uploadId`	string (uuid) \| null	não
`channelKind`	"whatsapp_cloud" \| "whatsapp_web" \| "instagram" \| null	não
`type`	"text" \| "interactive"	não
`contents`	object	não

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "minLength": 1,
      "maxLength": 80
    },
    "shortcut": {
      "anyOf": [
        {
          "type": "string",
          "minLength": 1,
          "maxLength": 40,
          "pattern": "^[^\\s/]+$"
        },
        {
          "type": "null"
        }
      ]
    },
    "body": {
      "type": "string",
      "minLength": 1,
      "maxLength": 1024
    },
    "uploadId": {
      "anyOf": [
        {
          "type": "string",
          "format": "uuid",
          "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
        },
        {
          "type": "null"
        }
      ]
    },
    "channelKind": {
      "anyOf": [
        {
          "type": "string",
          "enum": [
            "whatsapp_cloud",
            "whatsapp_web",
            "instagram"
          ]
        },
        {
          "type": "null"
        }
      ]
    },
    "type": {
      "type": "string",
      "enum": [
        "text",
        "interactive"
      ]
    },
    "contents": {
      "type": "object",
      "properties": {
        "header": {
          "oneOf": [
            {
              "type": "object",
              "properties": {
                "kind": {
                  "type": "string",
                  "const": "text"
                },
                "text": {
                  "type": "string",
                  "minLength": 1,
                  "maxLength": 60
                }
              },
              "required": [
                "kind",
                "text"
              ],
              "additionalProperties": false
            },
            {
              "type": "object",
              "properties": {
                "kind": {
                  "type": "string",
                  "enum": [
                    "image",
                    "video",
                    "document"
                  ]
                },
                "uploadId": {
                  "type": "string",
                  "format": "uuid",
                  "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
                },
                "filename": {
                  "type": "string",
                  "maxLength": 255
                }
              },
              "required": [
                "kind",
                "uploadId"
              ],
              "additionalProperties": false
            }
          ]
        },
        "footer": {
          "type": "string",
          "minLength": 1,
          "maxLength": 60
        },
        "buttons": {
          "minItems": 1,
          "maxItems": 3,
          "type": "array",
          "items": {
            "oneOf": [
              {
                "type": "object",
                "properties": {
                  "kind": {
                    "type": "string",
                    "const": "reply"
                  },
                  "label": {
                    "type": "string",
                    "minLength": 1,
                    "maxLength": 20
                  }
                },
                "required": [
                  "kind",
                  "label"
                ],
                "additionalProperties": false
              },
              {
                "type": "object",
                "properties": {
                  "kind": {
                    "type": "string",
                    "const": "url"
                  },
                  "label": {
                    "type": "string",
                    "minLength": 1,
                    "maxLength": 20
                  },
                  "url": {
                    "type": "string",
                    "maxLength": 2000,
                    "pattern": "^https:\\/\\/"
                  }
                },
                "required": [
                  "kind",
                  "label",
                  "url"
                ],
                "additionalProperties": false
              }
            ]
          }
        }
      },
      "additionalProperties": false
    }
  },
  "required": [
    "name",
    "body"
  ]
}

Exemplo

curl -X POST https://app.atomiks.com.br/api/v1/inbox.quick_reply_create \
  -H "Authorization: Bearer $ATOMIKS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"Saudação","shortcut":"ola","body":"Olá! Como posso ajudar?"}'

CLI:

node cli/atomiks.mjs inbox.quick_reply_create --json '{"name":"Saudação","shortcut":"ola","body":"Olá! Como posso ajudar?"}'

MCP: ferramenta inbox_quick_reply_create com a mesma entrada.

Saída

Sucesso: {"data": ...} com o formato abaixo.

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "shortcut": {
      "type": [
        "string",
        "null"
      ]
    },
    "body": {
      "type": "string"
    },
    "uploadId": {
      "type": [
        "string",
        "null"
      ]
    },
    "updatedAt": {
      "type": "string"
    },
    "channelKind": {
      "anyOf": [
        {
          "type": "string",
          "enum": [
            "whatsapp_cloud",
            "whatsapp_web",
            "instagram"
          ]
        },
        {
          "type": "null"
        }
      ]
    },
    "type": {
      "type": "string",
      "enum": [
        "text",
        "interactive"
      ]
    },
    "contents": {
      "type": "object",
      "properties": {
        "header": {
          "oneOf": [
            {
              "type": "object",
              "properties": {
                "kind": {
                  "type": "string",
                  "const": "text"
                },
                "text": {
                  "type": "string",
                  "minLength": 1,
                  "maxLength": 60
                }
              },
              "required": [
                "kind",
                "text"
              ],
              "additionalProperties": false
            },
            {
              "type": "object",
              "properties": {
                "kind": {
                  "type": "string",
                  "enum": [
                    "image",
                    "video",
                    "document"
                  ]
                },
                "uploadId": {
                  "type": "string",
                  "format": "uuid",
                  "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
                },
                "filename": {
                  "type": "string",
                  "maxLength": 255
                }
              },
              "required": [
                "kind",
                "uploadId"
              ],
              "additionalProperties": false
            }
          ]
        },
        "footer": {
          "type": "string",
          "minLength": 1,
          "maxLength": 60
        },
        "buttons": {
          "minItems": 1,
          "maxItems": 3,
          "type": "array",
          "items": {
            "oneOf": [
              {
                "type": "object",
                "properties": {
                  "kind": {
                    "type": "string",
                    "const": "reply"
                  },
                  "label": {
                    "type": "string",
                    "minLength": 1,
                    "maxLength": 20
                  }
                },
                "required": [
                  "kind",
                  "label"
                ],
                "additionalProperties": false
              },
              {
                "type": "object",
                "properties": {
                  "kind": {
                    "type": "string",
                    "const": "url"
                  },
                  "label": {
                    "type": "string",
                    "minLength": 1,
                    "maxLength": 20
                  },
                  "url": {
                    "type": "string",
                    "maxLength": 2000,
                    "pattern": "^https:\\/\\/"
                  }
                },
                "required": [
                  "kind",
                  "label",
                  "url"
                ],
                "additionalProperties": false
              }
            ]
          }
        }
      },
      "additionalProperties": false
    },
    "usesVariables": {
      "type": "boolean"
    }
  },
  "required": [
    "id",
    "name",
    "shortcut",
    "body",
    "uploadId",
    "updatedAt",
    "channelKind",
    "type",
    "contents",
    "usesVariables"
  ],
  "additionalProperties": false
}

Erros

{"error": {"code", "message", "requestId"}}. Códigos: invalid_input (400), unauthorized (401), forbidden / account_pending / scope_missing (403), not_found (404), limit_reached (409), internal (500).