InitRequest · AtendroZAP Docs

InitRequest

Estrutura de dados do contrato OpenAPI.

Campos

Campo	Tipo	Presença	Descrição
`name`	`string`	obrigatório	Obrigatório, até 128 bytes UTF-8, sem controle ou espaços nas extremidades. Comprimento mínimo: `1`. Comprimento máximo: `128`
`systemName`	`string`	opcional	Até 128 bytes; recomendado Atendro. Comprimento máximo: `128`
`companyId`	`string`	opcional	Até 128 bytes; vínculo com tenant no consumidor. Filtro de lista, não autorização. Comprimento máximo: `128`
`kind`	`string`	opcional	Imutável após criar. calls exige o módulo habilitado e pareamento próprio. Valores: `"whatsapp"`, `"calls"`. Padrão: `"whatsapp"`

Definição OpenAPI

json

{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "Obrigatório, até 128 bytes UTF-8, sem controle ou espaços nas extremidades.",
      "minLength": 1,
      "maxLength": 128
    },
    "systemName": {
      "type": "string",
      "description": "Até 128 bytes; recomendado Atendro.",
      "maxLength": 128
    },
    "companyId": {
      "type": "string",
      "description": "Até 128 bytes; vínculo com tenant no consumidor. Filtro de lista, não autorização.",
      "maxLength": 128
    },
    "kind": {
      "type": "string",
      "enum": [
        "whatsapp",
        "calls"
      ],
      "default": "whatsapp",
      "description": "Imutável após criar. calls exige o módulo habilitado e pareamento próprio."
    }
  },
  "required": [
    "name"
  ]
}